This commit is contained in:
@@ -26,6 +26,12 @@ Users are accessed in the following ways:
|
||||
|
||||
User accounts are used to grant access to AyaNova and also to track and schedule service technician and sub-contractor type Users known as "scheduleable users".
|
||||
|
||||
#### Controlling user access rights
|
||||
|
||||
User access to the various features and business object types in AyaNova is controlled by a combination of the [User Type](#user-type) and the [authorization roles](ay-biz-admin-roles.md) settings for that User.
|
||||
|
||||
For example if a user is set to a User type of Subcontractor they will not be able to see Part costs and prices no matter what their roles are.
|
||||
|
||||
#### Licensing and Scheduleable Users
|
||||
|
||||
Only active, scheduleable type users consume a "service technician" license, see the [licensing page](adm-license.md#service-technician-scheduleable-users-and-licensing) for details.
|
||||
@@ -36,7 +42,7 @@ Scheduleable Users only appear in the [schedule form](svc-schedule.md) if they a
|
||||
|
||||
#### Do not share User accounts
|
||||
|
||||
Every User of AyaNova **must** have their own account.
|
||||
Every User of AyaNova **must** have their own account.
|
||||
|
||||
AyaNova does _not_ support multiple simultaneous logins with the same User account; a fresh login automatically revokes prior logins so logging in as a User that is already logged in will kick out the originally logged in User.
|
||||
|
||||
|
||||
@@ -1,7 +1,18 @@
|
||||
# DEVELOPERS API
|
||||
|
||||
[under construction]
|
||||
[UNDER CONSTRUCTION]
|
||||
todo: update link from v7 to v8 specific development forum when it's available
|
||||
|
||||
AyaNova features a RESTful API that can be used by developers to integrate their applications with AyaNova.
|
||||
|
||||
The AyaNova user interface web application uses this same API for all access to AyaNova so it is possible by using the REST API to automate or integrate with anything that can be done in the AyaNova application.
|
||||
|
||||
AyaNova comes with a [API explorer console](api-console.md) that can be used by developers to test and experiment with each API route without writing code and view the format of the data as well as documentation on the [API Request format](api-request-format.md), [API Response format](api-response-format.md) and [API Error codes](api-error-codes.md) table.
|
||||
|
||||
In addition we have a [developers forum](https://forum.ayanova.com/c/ayanova-reporting-development/66) available for peer to peer and occasionally AyaNova development department response as time permits.
|
||||
|
||||
Note that support for development integration (writing code) is beyond the scope of the technical support we provide, however any technical issues (problems) found with the API itself *are* available for support.
|
||||
|
||||
|
||||
|
||||
AyaNova features a REST API that can be used by developers to integrate with AyaNova.
|
||||
|
||||
todo: consolidate api api-error-codes / request / response / upload route stuff here into this document
|
||||
|
||||
@@ -19,7 +19,7 @@ The [API explorer console](api-console.md) on your server is always the best sou
|
||||
|
||||
## Dates and times
|
||||
|
||||
All dates and times sent or retrieved from the REST interface **must** be ISO 8601 format in UTC / GMT time zone ONLY. For example, "2007-04-05T14:30Z" or "2007-04-05T14:30". The server does not expect dates to be in any other time zone or format.
|
||||
All dates and times sent or retrieved from the REST interface **must** be ISO 8601 format in UTC / GMT time zone ONLY. For example, "2027-04-05T14:30Z" or "2027-04-05T14:30". The server does not expect dates to be in any other time zone or format.
|
||||
|
||||
## Translation
|
||||
|
||||
|
||||
@@ -4,75 +4,72 @@ AyaNova has several API routes for uploading files.
|
||||
|
||||
These routes are all `POST` routes:
|
||||
|
||||
- `/api/v{version}/Attachment`
|
||||
- `/api/v{version}/ImportAyaNova7`
|
||||
- `/api/v{version}/Restore`
|
||||
- `/api/v{version}/attachment`
|
||||
- `/api/v{version}/import`
|
||||
- `/api/v{version}/logo`
|
||||
|
||||
Upload routes are not testable from the API explorer.
|
||||
Upload routes are not testable from the [API explorer console](api-console.md).
|
||||
|
||||
Upload routes expect a form to be uploaded with file content disposition (multipart/form-data).
|
||||
|
||||
AyaNova will allow a maximum of 12gb per file upload for "Utility" routes such as restore and import routes.
|
||||
|
||||
User file routes such as attachments may have a smaller limit, see the User documentation section for those features for limit details.
|
||||
AyaNova limits the size of files uploaded to each of the upload routes documented in the [API explorer console](api-console.md) comments with those routes.
|
||||
|
||||
Here is a sample minimal HTML form that works with AyaNova file routes:
|
||||
|
||||
```html
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title></title>
|
||||
<script
|
||||
src="https://code.jquery.com/jquery-3.2.1.min.js"
|
||||
integrity="sha256-hwg4gsxgFZhOsEEamdOYGBf13FyQuiTwlAQgxVSNgt4="
|
||||
crossorigin="anonymous"
|
||||
></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function () {
|
||||
$("#upload").click(function (evt) {
|
||||
var fileUpload = $("#files").get(0);
|
||||
var files = fileUpload.files;
|
||||
var data = new FormData();
|
||||
for (var i = 0; i < files.length; i++) {
|
||||
data.append(files[i].name, files[i]);
|
||||
}
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title></title>
|
||||
<script src="https://code.jquery.com/jquery-3.2.1.min.js"
|
||||
integrity="sha256-hwg4gsxgFZhOsEEamdOYGBf13FyQuiTwlAQgxVSNgt4="
|
||||
crossorigin="anonymous"></script>
|
||||
<script type="text/javascript">
|
||||
$(document).ready(function () {
|
||||
$("#upload").click(function (evt) {
|
||||
var fileUpload = $("#files").get(0);
|
||||
var files = fileUpload.files;
|
||||
var data = new FormData();
|
||||
for (var i = 0; i < files.length; i++) {
|
||||
data.append(files[i].name, files[i]);
|
||||
}
|
||||
//Attachment upload route requires further form data to designate
|
||||
//the object being attached to by it's type and id:
|
||||
//data.append('AttachToAType','2');
|
||||
//data.append('AttachToObjectId','200');
|
||||
|
||||
//Attachment upload route requires further form data to designate
|
||||
//the object being attached to by it's type and id:
|
||||
//data.append('AttachToAType','2');
|
||||
//data.append('AttachToObjectId','200');
|
||||
$.ajax({
|
||||
type: "POST",
|
||||
url: "http://yourserver:7575/api/v8.0/attachment",
|
||||
headers: {
|
||||
Authorization: "Bearer JWTTokenHere"
|
||||
},
|
||||
contentType: false,
|
||||
processData: false,
|
||||
data: data,
|
||||
success: function (message) {
|
||||
alert("upload successful!");
|
||||
console.log(message);
|
||||
},
|
||||
error: function (error) {
|
||||
console.log(error);
|
||||
alert("There was an error uploading files!");
|
||||
}
|
||||
});
|
||||
});
|
||||
});
|
||||
</script>
|
||||
</head>
|
||||
|
||||
$.ajax({
|
||||
type: "POST",
|
||||
url: "http://yourserver:7575/api/v8.0/Attachment",
|
||||
headers: {
|
||||
Authorization: "Bearer JWTTokenHere"
|
||||
},
|
||||
contentType: false,
|
||||
processData: false,
|
||||
data: data,
|
||||
success: function (message) {
|
||||
alert("upload successful!");
|
||||
console.log(message);
|
||||
},
|
||||
error: function (error) {
|
||||
console.log(error);
|
||||
alert("There was an error uploading files!");
|
||||
}
|
||||
});
|
||||
});
|
||||
});
|
||||
</script>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<form method="post" enctype="multipart/form-data">
|
||||
<input type="file" id="files" name="files" multiple />
|
||||
<input type="button" id="upload" value="Upload file(s)" />
|
||||
|
||||
</form>
|
||||
</body>
|
||||
<body>
|
||||
<form method="post" enctype="multipart/form-data">
|
||||
<input type="file" id="files" name="files" multiple />
|
||||
<input type="button" id="upload" value="Upload file(s)" />
|
||||
</form>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
@@ -1,5 +1,104 @@
|
||||
# MISC-ABOUT Placeholder
|
||||
# About AyaNova
|
||||
|
||||
[UNDER CONSTRUCTION]
|
||||
The About form displays version information and technical support resources.
|
||||
|
||||
#b4beta
|
||||
## Authorization Roles required
|
||||
|
||||
This form is available to all users.
|
||||
|
||||
## How to access About
|
||||
|
||||
The About form is accessed from the bottom menu item option in any main AyaNova [form](ay-start-form-overview.md) (blue banner at top) that is not a specific object edit form (green banner at top).
|
||||
|
||||
## About form display
|
||||
|
||||
### AyaNova App section
|
||||
|
||||
This section provides information regarding the AyaNova web app client running in your browser.
|
||||
|
||||
#### Version
|
||||
|
||||
This is the version number of the AyaNova web application. When a new version of AyaNova is released this number will go up. AyaNova uses the industry standard [semantic versioning system](https://semver.org/) which is 3 numbers separated by periods for example `8.1.2`.
|
||||
|
||||
The leftmost number, for example **8**.1.2 is the major release version indicating major changes to the program that are not backwards compatible to the prior major release version.
|
||||
|
||||
The middle number, for example 8.**1**.2 indicates added functionality in a backwards compatible manner.
|
||||
|
||||
The third number, for example 8.1.**2** in the rightmost 'patch' position indicates a backwards compatible bug fix.
|
||||
|
||||
Major version changes are not compatible with prior major releases whereas all minor and patch version changes are compatible within that major version release.
|
||||
|
||||
#### User
|
||||
|
||||
This displays the current logged in [User](adm-users.md) account. You can also view this at the top of the navigation pane if you need to quickly check which user you are logged in as.
|
||||
|
||||
#### 12h
|
||||
|
||||
This displays whether the current [user setting](home-user-settings.md#12-hour-clock) is set to use a 12 hour time format (e.g. "4:30pm") with am and pm designators or a 24 hour time format (e.g. "16:30") without am and pm designators.
|
||||
|
||||
#### Effective time zone
|
||||
|
||||
This displays the effective current time zone setting, either the browsers default based on the local system or as overridden in [user settings](home-user-settings.md#language-code-override-time-zone-override)
|
||||
|
||||
#### Effective language code
|
||||
|
||||
This displays the effective language code setting, either the web browser's default based on the local operating system or as overridden in [user settings](home-user-settings.md#language-code-override-time-zone-override)
|
||||
|
||||
#### Currency code
|
||||
|
||||
This displays the currency code setting as selected in [user settings](home-user-settings.md#currency-code)
|
||||
|
||||
### Browser section
|
||||
|
||||
This displays information about the current web browser in use and it's capabilities and may be of use for technical support.
|
||||
|
||||
### Server section
|
||||
|
||||
This area is information about the AyaNova server itself which may be useful for technical support purposes when troubleshooting issues at the web app "client" end of things. Far more detailed information about the server is available in the [Operations server information](ops-server-information.md) form for use when troubleshooting deeper server related issues.
|
||||
|
||||
#### Server address
|
||||
|
||||
The URL of the AyaNova server that the web app is currently connected to.
|
||||
|
||||
#### Server Version
|
||||
|
||||
Display of the full AyaNova server version using the semantic versioning system [detailed above](#version).
|
||||
The AyaNova server and web app version should match and the web app is designed to upgrade automatically when it detects a newer version at the server however in some rare cases it's possible for the web app to be out of date and not refreshed so if the web app version is lower than the server version clicking on the refresh button will likely resolve the issue.
|
||||
|
||||
#### Schema version
|
||||
|
||||
This displays the version of the database "schema", that is the current configuration of tables and columns in the AyaNova database. This is normally taken care of by the server update process and provided here so AyaNova support department can rule out a failed database schema update as a cause for an issue.
|
||||
|
||||
#### Server time
|
||||
|
||||
This is the current time as known to the AyaNova server and is useful for some troubleshooting steps. It is not important or expected that the server time will exactly match the local web app client time due to differences in time zones etc; AyaNova handles that automatically.
|
||||
|
||||
#### Server time zone
|
||||
|
||||
This is the time zone that the AyaNova server's operating system is set to and is helpful for some troubleshooting steps. It is not important or expected that the server time zone will match the local web app client time zone; AyaNova handles that automatically.
|
||||
|
||||
### License
|
||||
|
||||
The license section displays information about the current AyaNova software license in effect at the server. See the [license](adm-license.md) documentation for details.
|
||||
|
||||
### Licensed options
|
||||
|
||||
The license section displays information about the current AyaNova software licensed options in effect at the server. See the [license](adm-license.md) documentation for details.
|
||||
|
||||
## About form menu options
|
||||
|
||||
In addition to the standard help link to this documentation, the About form has the following menu options:
|
||||
|
||||
#### Copy support information
|
||||
|
||||
This menu option will copy to clipboard all the information displayed on the About page as well as a copy of the local AyaNova web app error log (if any) and is provided as a quick way to gather up all the potentially useful information for support purposes by using the Copy support information button and pasting into a message to support.
|
||||
|
||||
#### Log
|
||||
|
||||
The log menu option will display the current contents of the local AyaNova web app error log. This error log contains the most recent 100 log items. When a new item is added and the log already has 100 items, the 100th item is dropped from the log.
|
||||
|
||||
You can easily copy the log contents to clipboard by using the [copy support information](#copy-support-information) menu option.
|
||||
|
||||
#### Technical support
|
||||
|
||||
This menu option will connect you to the AyaNova support contact form on our website and in addition will automatically fill in your registered company name and database ID so support can quickly find your site information for support purposes.
|
||||
|
||||
Reference in New Issue
Block a user