diff --git a/docs/8.0/ayanova/docs/ay-start-edit-forms.md b/docs/8.0/ayanova/docs/ay-start-edit-forms.md index e05d0768..4a7658b3 100644 --- a/docs/8.0/ayanova/docs/ay-start-edit-forms.md +++ b/docs/8.0/ayanova/docs/ay-start-edit-forms.md @@ -1,16 +1,18 @@ # Edit forms -AyaNova business objects are created and modified in "edit forms". Here we detail the common features of edit forms. Not all features are available to all edit forms. +AyaNova business objects are created and modified in "edit forms" and most have the same common features. ### Browser page refresh or reload -If you reload or refresh any edit form it will lose any local changes made that have not yet been saved to the server. This is both useful and dangerous; it's useful in that you can reset a form back to the version saved at the server if you don't want to keep any changes made locally but dangerous in that you could lose work with an accidental refresh or reload. +If you reload or refresh any edit form it will lose any local changes made that have not yet been saved to the server. -It's always a good idea to save a form as you work in it, particularly large forms with many fields such as a [work order](svc-workorders.md). +This is both useful and dangerous; it's useful in that you can reset a form back to the version saved at the server if you don't want to keep any changes made locally but dangerous in that you could lose work with an accidental refresh or reload. + +It's always a good idea to save changes in an edit form regularly, particularly large forms with many fields such as a [work order](svc-workorders.md). ### Navigating away with unsaved changes -Unlike a full browser page reload, navigation events are able to be intercepted by AyaNova an it will prompt you if there are any unsaved changes before leaving the form. +Unlike a browser page reload, navigation events like moving to another page are able to be intercepted by AyaNova which will prompt you if there are any unsaved changes before leaving the form. ### Top Application bar @@ -22,7 +24,9 @@ The app bar in the image above is green indicating the User has the ability to e ![narrow edit form appbar gray image](img/edit-form-appbar-gray-narrow.png) -The app bar in the image above is grey indicating the User is not permitted to to edit the current record. Grey app bars can indicate an object is also in a read-only state rather than the User not having sufficient privileges. For example when a service work order is temporarily set to a read only status. +The app bar in the image above is grey indicating the User is not permitted to to edit the current record. Grey app bars can indicate an object is in a read-only state rather than the User not having sufficient privileges. + +For example when a service work order is set to a read only status. #### App bar controls @@ -42,7 +46,7 @@ The object name is displayed at the top as a visual reminder of which exact obje ##### Notification icon -The notification bell icon is always visible in AyaNova and indicates when there are new [notifications](home-notifications.md) that have arrived and how many. +The notification bell icon is always visible in AyaNova and indicates when there are new "in-app" delivered [notifications](home-notifications.md) that have arrived and how many new ones. ##### Surfaced menu items @@ -50,7 +54,9 @@ When there is enough width to fit, AyaNova will "surface" commonly used menu ico ##### Menu icon -Menu's that can be opened are always represented in AyaNova by the three vertical dots icon. Menus at the top of edit forms contain controls related to the overall object. Menus inside the edit form contain controls related to a specific sub-section of the edit form. Look for menu controls to see further actions that can be taken in forms. +Menu's that can be opened are always represented in AyaNova by the three vertical dots icon. + +Menus at the top of edit forms contain controls related to the overall object. Menus inside the edit form contain controls related to a specific sub-section of the edit form. Look for menu controls to see further actions that can be taken in forms. ### Edit form body and fields @@ -64,6 +70,10 @@ In narrow view devices such as smart phones and small tablets AyaNova will displ Nearly all static text displayed in AyaNova is customizable via the [Translation feature](adm-translations.md) +#### Customizable entry fields + +All main business object edit forms in AyaNova can be [customized](ay-customize.md) to hide fields or make them _required_ for entry. + #### Error and alerts ![edit form alert types image](img/edit-form-alert-types.png) @@ -72,7 +82,11 @@ The above image shows all types of alerts you may see on an edit form. ##### Errors -Validation and server errors will appear as a red alert box with a triangular /!\ exclamation mark icon. A validation error usually indicates there is something on the form that needs to be addressed, in this example the Summary field was left empty but is flagged as a required entry field in the [form customization settings](ay-customize.md#requiring-fields). +Validation and server errors will appear as a red alert box with a triangular /!\ exclamation mark icon. + +A validation error usually indicates there is something on the form below that needs to be addressed and the field in question will also be highlighted in red with the description of the issue below it. + +In this example the Summary field was left empty but is a required field. ##### Alert notes @@ -90,7 +104,7 @@ This example is displaying Service tech notes that were entered previously into #### Save -The Save button submits to the AyaNova server any changes made to the object. +The Save button submits to the AyaNova server any local changes made to the object. When the save button is disabled it means that there were no changes detected that need to be saved or there are errors on the form that need to be corrected before saving again. @@ -98,7 +112,9 @@ When the save button is disabled it means that there were no changes detected th The delete button permanently removes the record from the server. If the button is not present or grayed out it means there is insufficient rights to delete the object or it is not deleteable for other reasons indicated. -If an object that is being deleted is found to be linked to other objects at the server, an error message will be returned indicating it is not deleteable due to this condition and which types of other objects this object is linked to in case the User wants to track down and remove all connections so they can delete this object. For example attempting to delete a Customer that is selected on work orders. +If an object that is being deleted is found to be linked to other objects at the server, an error message will be returned indicating it is not deleteable due to this condition and which types of other objects this object is linked to in case the User wants to track down and remove all connections so they can delete this object. + +For example attempting to delete a Customer that is selected on work orders. #### Report @@ -106,25 +122,29 @@ This menu option opens a [list of reports](ay-report.md) available to be rendere #### Last report -This menu item shows the name of the last report rendered in this form to save time in selection when the same report is regularly used. +This menu item shows the name of the last report selected and displayed from this form to save time in selection when the same report is regularly used. + +It is automatically set to the last report selected. #### New -New is used to create a new object. +New is used to create a new object. The new object will exist only in the local web browser until it is saved to the server at which point it will be assigned an id number and in some cases the server will fill in some values for you automatically. For this reason it's a good idea to save a new record as soon as possible and save often while completing all entry required. #### Duplicate -Duplicate creates a _local_ duplicate copy of the object. This copy is not yet present at the server until saved. +Duplicate creates a _local_ duplicate copy of the object. This copy is a new record not yet present at the server until saved. -Duplicate is particularly useful when creating a new object that shares many similar field values to an existing object and can save time during entry. +Duplicate is particularly useful for using existing objects as "templates" when creating a new object that shares many similar field values to save time during entry. #### View on map -Edit forms for objects with [address controls](ay-start-common-controls.md#address) will have a "View on map" menu item which when clicked will attempt to display the current objects location on a map provided there is enough information to determine the location. The most accurate location is had by entering the latitude and longitude into the fields provided in the "Street" address section however most map providers can match to a postal code or street address when required. +Edit forms for objects with [address controls](ay-start-common-controls.md#address) will have a "View on map" menu item which when clicked will attempt to display the current objects location on a map provided there is enough information to determine the location. + +The most accurate location is had by entering the latitude and longitude into the fields provided in the "Street" address section however most map providers can match to a postal code or street address when required. AyaNova can automatically fill in the latitude and longitude when using a supported device see the [address controls](ay-start-common-controls.md#address) documentation for details. -For items that are mobile or may not have a street address such as a Customer unit in remote locations the latitude and longitude are provided for mapping and location purposes. +For addressable items that are mobile or may not have a street address such as a Customer unit in remote locations the latitude and longitude are provided for mapping and location purposes. The default map provider is Google Maps but you can select from many other options or add your own under [User settings map url template](home-user-settings.md#map-url-template) setting. @@ -136,7 +156,7 @@ All main business objects in AyaNova are reviewable. #### History -History menu option opens the [History form](ay-history.md) to display a log of events related for this object being edited such as when it was created and each edit made to it etc. +History menu option opens the [History form](ay-history.md) to display a log of events for this object such as when it was created and each edit made to it etc. All main business objects in AyaNova are tracked in the history event log. @@ -146,7 +166,9 @@ If the logged in User has sufficient rights they will see a Customize menu optio #### Search -The search menu item links to the search form and automatically causes the search form to only show results for the type of object that was being viewed in the edit form before clicking search. For example if you are viewing a Customer edit form then clicking on search will automatically select Customer as the only type of result to search for. +The search menu item links to the search form and automatically causes the search form to only show results for the type of object that was being viewed in the edit form before clicking search. + +For example if you are viewing a Customer edit form then clicking on search will automatically select Customer as the only type of result to search for. #### Help @@ -154,4 +176,4 @@ Help menu option opens the specific help documentation for that form. ### Common edit form controls -Controls used in AyaNova are documented on the [Common form controls](ay-start-common-controls.md) documentation page. +Controls used in AyaNova are documented on the [Common form controls](ay-start-common-controls.md) documentation page with usage instructions and time saving tips and features that might not be noticed at first glance.