diff --git a/docs/8.0/ayanova/docs/adm-getting-started.md b/docs/8.0/ayanova/docs/adm-getting-started.md index e71595cf..1967bbf0 100644 --- a/docs/8.0/ayanova/docs/adm-getting-started.md +++ b/docs/8.0/ayanova/docs/adm-getting-started.md @@ -1,4 +1,4 @@ -# ADMINISTRATION - GETTING STARTED +# Administration - getting started [UNDER CONSTRUCTION] diff --git a/docs/8.0/ayanova/docs/adm-report-templates.md b/docs/8.0/ayanova/docs/adm-report-templates.md index dd40f5ab..56c1d51e 100644 --- a/docs/8.0/ayanova/docs/adm-report-templates.md +++ b/docs/8.0/ayanova/docs/adm-report-templates.md @@ -47,4 +47,4 @@ The number of records selected to report and the amount of memory, disk speed an For example, reporting on a month at a time rather than a whole year at a time of records by [filtering](ay-start-form-data-tables.md#filtering-columns) the data table being reported. -If a report takes too long to render and goes over the configurable timeout setting you will receive a timeout message instead of your report and should further limit the amount of data selected or, if report rendering speed / timeouts is a recurring issue, we have [report rendering timeout tips](ops-config-report-rendering-timeout.md##what-to-do-if-running-into-timeout-issues) specifically for the I.T. system operator responsible for AyaNova server maintenance who may need to adjust the timeout configuration setting or provide more resources to the AyaNova server to alleviate the problem. +If a report takes too long to render and goes over the configurable timeout setting you will receive a timeout message instead of your report and should further limit the amount of data selected or, if report rendering speed / timeouts is a recurring issue, we have [report rendering timeout tips](ops-config-report-rendering-timeout.md#what-to-do-if-running-into-timeout-issues) specifically for the I.T. system operator responsible for AyaNova server maintenance who may need to adjust the timeout configuration setting or provide more resources to the AyaNova server to alleviate the problem. diff --git a/docs/8.0/ayanova/docs/api-console.md b/docs/8.0/ayanova/docs/api-console.md index b2c8c1a0..efcce48a 100644 --- a/docs/8.0/ayanova/docs/api-console.md +++ b/docs/8.0/ayanova/docs/api-console.md @@ -1,4 +1,4 @@ -# API EXPLORER CONSOLE +# API explorer console The AyaNova server uses [Swagger-ui](https://www.swagger.io) to provide an interactive live api explorer and documentation console for developers to learn about and experiment with the AyaNova REST API. diff --git a/docs/8.0/ayanova/docs/api-error-codes.md b/docs/8.0/ayanova/docs/api-error-codes.md index 81e865cc..4b086e2a 100644 --- a/docs/8.0/ayanova/docs/api-error-codes.md +++ b/docs/8.0/ayanova/docs/api-error-codes.md @@ -1,4 +1,4 @@ -# API ERROR CODES +# API error codes The AyaNova API will return an [error response](api-response-format.md#error-responses) when an error condition arises. diff --git a/docs/8.0/ayanova/docs/api-intro.md b/docs/8.0/ayanova/docs/api-intro.md index 485f9df3..dd9bda47 100644 --- a/docs/8.0/ayanova/docs/api-intro.md +++ b/docs/8.0/ayanova/docs/api-intro.md @@ -1,18 +1,11 @@ -# DEVELOPERS API - -[UNDER CONSTRUCTION] -todo: update link from v7 to v8 specific development forum when it's available +# Developers API 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. +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. - - - - +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. diff --git a/docs/8.0/ayanova/docs/api-upload-routes.md b/docs/8.0/ayanova/docs/api-upload-routes.md index 1f780bcf..ff6ca409 100644 --- a/docs/8.0/ayanova/docs/api-upload-routes.md +++ b/docs/8.0/ayanova/docs/api-upload-routes.md @@ -1,4 +1,4 @@ -# API UPLOAD ROUTES +# API upload routes AyaNova has several API routes for uploading files. diff --git a/docs/8.0/ayanova/docs/ay-report.md b/docs/8.0/ayanova/docs/ay-report.md index 59a8790e..94a3e6c6 100644 --- a/docs/8.0/ayanova/docs/ay-report.md +++ b/docs/8.0/ayanova/docs/ay-report.md @@ -48,4 +48,4 @@ The number of records selected to report and the amount of memory, disk speed an For example, reporting on a month at a time rather than a whole year at a time of records by [filtering](ay-start-form-data-tables.md#filtering-columns) the data table being reported. -If report rendering speed / timeouts is a recurring issue, we have [report rendering timeout tips](ops-config-report-rendering-timeout.md##what-to-do-if-running-into-timeout-issues) specifically for the I.T. system operator responsible for AyaNova server maintenance who may need to adjust the timeout configuration setting or provide more resources to the AyaNova server to alleviate the problem. +If report rendering speed / timeouts is a recurring issue, we have [report rendering timeout tips](ops-config-report-rendering-timeout.md#what-to-do-if-running-into-timeout-issues) specifically for the I.T. system operator responsible for AyaNova server maintenance who may need to adjust the timeout configuration setting or provide more resources to the AyaNova server to alleviate the problem. diff --git a/docs/8.0/ayanova/docs/ay-start-common-controls.md b/docs/8.0/ayanova/docs/ay-start-common-controls.md index f4387a78..ae00c5dd 100644 --- a/docs/8.0/ayanova/docs/ay-start-common-controls.md +++ b/docs/8.0/ayanova/docs/ay-start-common-controls.md @@ -2,8 +2,6 @@ AyaNova [forms](ay-start-form-overview.md) have a common set of controls that are used to enter and display information. -## Input controls - ### Address ![address control image](img/control-address.png) @@ -20,7 +18,7 @@ The street address context menu is accessed by clicking on the 3 vertical dot co - `Copy to clipboard` copies the street address to the device clipboard. - `Copy to Postal address` copies the street address fields into the same Postal address fields to save typing if identical -- `Set co-ordinates to current location` will attempt to set the longitude and latitude automatically. Note that this depends upon the capabilities of the device in use and whether the browser is allowed to access the location. When clicking on this button it can take a second or two to determine the location / display an error message if it can't be done. +- `Set co-ordinates to current location` will attempt to set the longitude and latitude automatically. Note that this depends upon the capabilities of the device in use and whether the browser is permitted to access the device's location. When you click on this button it can take a second or two to determine the location and set it in the form or display an error message if it can't be done. #### Postal address context menu diff --git a/docs/8.0/ayanova/docs/img/control-address.png b/docs/8.0/ayanova/docs/img/control-address.png index 2b1deadc..9e4f24df 100644 Binary files a/docs/8.0/ayanova/docs/img/control-address.png and b/docs/8.0/ayanova/docs/img/control-address.png differ