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 8c6f4271..92e1547e 100644 --- a/docs/8.0/ayanova/docs/ay-start-edit-forms.md +++ b/docs/8.0/ayanova/docs/ay-start-edit-forms.md @@ -1,6 +1,6 @@ # Edit forms -AyaNova business objects are created and edited in edit forms. Here we detail the common features of edit forms. Some forms will not have these features if they don't apply, for example there won't be a "View on map" menu item if there is no address for the object being edited. +AyaNova business objects are created and edited in edit forms. Here we detail the common features of edit forms. Some forms will not have these features if they don't apply, for example there won't be a "View on map" menu item if there is no address for the object being edited. ### Top Application bar @@ -12,7 +12,7 @@ This app bar is green indicating the User has the ability to edit the current re ![narrow edit form appbar gray image](img/edit-form-appbar-gray-narrow.png) -This app bar 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. +This app bar 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. #### App bar controls @@ -24,7 +24,7 @@ The nav icon or "hamburger" button slides open the navigation pane to move to di ##### Object type icon -The object type icon is a visual reminder of what type of object is being edited. All business objects in AyaNova have their own icon to represent them. +The object type icon is a visual reminder of what type of object is being edited. All business objects in AyaNova have their own icon to represent them. ##### Object name @@ -36,19 +36,19 @@ The notification bell icon is always visible in AyaNova and indicates when there ##### Surfaced menu items -When there is enough width to fit, AyaNova will "surface" commonly used menu icons to save a click. Generally this is the "Save" button on most forms. +When there is enough width to fit, AyaNova will "surface" commonly used menu icons to save a click. Generally this is the "Save" button on most forms. #### 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 #### Responsive display -AyaNova uses a grid system to automatically lay out the contents of the edit form appropriate to the width of the browser window. +AyaNova uses a grid system to automatically lay out the contents of the edit form appropriate to the width of the browser window. -In narrow view devices such as smart phones and small tablets AyaNova will display a single vertical column of all form fields. This expands up to 4 columns wide on the widest browser windows on wide screen devices such as a typical PC monitor. +In narrow view devices such as smart phones and small tablets AyaNova will display a single vertical column of all form fields. This expands up to 4 columns wide on the widest browser windows on wide screen devices such as a typical PC monitor. #### Error and alerts @@ -62,25 +62,30 @@ Validation and server errors will appear as a red alert box with a triangular /! ##### Alert notes -Alert notes will display as an orange alert box with a triangular /!\ exclamation mark icon. Some objects, in this example the Customer, provide for an alert to be displayed when they are selected on a form. This example is displaying alert notes that were entered previously into the Customer's [alert notes](customers.md#alert-notes) field. +Alert notes will display as an orange alert box with a triangular /!\ exclamation mark icon. Some objects, in this example the Customer, provide for an alert to be displayed when they are selected on a form. This example is displaying alert notes that were entered previously into the Customer's [alert notes](customers.md#alert-notes) field. The alert notes display on multiple different objects in AyaNova where an alertable object can be selected. ##### Service tech notes -Service tech notes will display as a dark blue alert box with an (i) info icon. Service tech notes are specific notes that display on work orders, quotes and preventive maintenance orders only and are intended as a message to the service technician whenever they deal with this customer. +Service tech notes will display as a dark blue alert box with an (i) info icon. Service tech notes are specific notes that display on work orders, quotes and preventive maintenance orders only and are intended as a message to the service technician whenever they deal with this customer. This example is displaying Service tech notes that were entered previously into the Customer's [service tech notes](customers.md#service-tech-notes) field. - ### Common edit form menu options #### Save -The Save +The Save button submits to the AyaNova server any 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. #### Delete +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 a record is deleted but 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. + #### Report This menu option opens a [list of reports](ay-report.md) available to be rendered for this object type. @@ -91,14 +96,28 @@ This menu item shows the name of the last report rendered in this form to save t #### New +New is used to create a new object. + #### Duplicate +Duplicate creates a *local* duplicate copy of the object. This copy is 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. + #### View on map -(sometimes) +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. + +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. + +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. #### Review +Review menu option opens the [Review form](home-reviews.md). A review is a way to schedule a time to re-visit a business object in future, for example a reminder to call a Customer on a certain date or check their billing status. + +All main business objects in AyaNova are reviewable. + #### History #### Customize