diff --git a/docs/8.0/ayanova/docs/ay-about.md b/docs/8.0/ayanova/docs/ay-about.md index 80c27f32..0b40c7f0 100644 --- a/docs/8.0/ayanova/docs/ay-about.md +++ b/docs/8.0/ayanova/docs/ay-about.md @@ -95,7 +95,7 @@ This menu option will copy to clipboard all the information displayed on the Abo #### 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. +The log menu option will display the current contents of the local AyaNova [web app error log](ay-log.md). You can easily copy the log contents to clipboard by using the [copy support information](#copy-support-information) menu option. diff --git a/docs/8.0/ayanova/docs/ay-extensions.md b/docs/8.0/ayanova/docs/ay-extensions.md index f1fc89d5..9eceb9c7 100644 --- a/docs/8.0/ayanova/docs/ay-extensions.md +++ b/docs/8.0/ayanova/docs/ay-extensions.md @@ -26,7 +26,7 @@ If no rows are indivdidually selected then all rows available to be viewed in th When no rows are selected the current filtering and sorting choices are sent to the server **not** the actual record id's. This means the server must 're-hydrate' the same view you are seeing in the web app based on the filtering and sorting choices which means it's possible new records which meet the filter condition were added in the time between the data table being fetched and the server re-hydrating the list to process an extension. -For this reason it's a good idea to refresh the data table and confirm it's the records you intend to process before running the extension on all rows in the data table view or select individual records only depending on what is most appropriate. +For this reason it's a good idea to refresh the data table and confirm it contains the desired records before running the extension on all rows in the data table view or select individual records only depending on what is most appropriate. [Selecting](ay-start-form-data-tables.md#selecting-records) individual records limits the extension operation to only the selected rows. Individual records can be selected for processing by checking the checkboxes in the leftmost column when available in which case only the records selected will be processed. diff --git a/docs/8.0/ayanova/docs/ay-history.md b/docs/8.0/ayanova/docs/ay-history.md index a62061db..e8a115a9 100644 --- a/docs/8.0/ayanova/docs/ay-history.md +++ b/docs/8.0/ayanova/docs/ay-history.md @@ -1,3 +1,62 @@ -# MISC-RECORD HISTORY Placeholder -#b4beta -[UNDER CONSTRUCTION] +# History + +The History form shows a timeline of the current User's history of events that are tracked in AyaNova. +There is also an administrator's [Global history](adm-history.md) form showing the event log for _all_ users. + +Personal history is particularly useful when you want to open a record you were working with recently as the history form doubles as a most recently used list. + +## Authorization Roles required + +This form is available to each User. + +## How to access personal history + +From the `Home` navigation pane select `History` navigation item. + +## How personal history works + +When an important event takes place in AyaNova, the server logs it to the database. This includes any modifications to business objects tracked in AyaNova as well as some other key events. + +### business object events + +Most events are related to changes to **"business objects"** in AyaNova, that is objects that are related to the business like a Customer or Work order, not the internal workings of AyaNova such as a select list or form template. + +### Interface + +The personal history event log is displayed as a time line view with the most recent events at the top and oldest at the bottom. + +![personal history](img/personal-history.png) + +#### Title + +The Title is displayed at the top left of the time line display and shows the object for which the history is being displayed, in the example above this is the history of the AyaNova SuperUser account. + +Each business object has it's own history and if this were a Customer (for example) then the title would display the name of the customer who's history is being displayed. + +#### Timeline 'spine' + +In a wide screen display history is shown with a central "spine" or line running down the center with alternating left side and right side boxes for each event. In a narrow screen display the timeline runs down the left side only and all events will display in their boxes to the right of the timeline. + +The spine shows an icon representing each event type such a saving a record (disk icon) or deleting a record (trash can icon). + +#### Events + +Each box on the time line shows an event that took place for this object's history. The title of each box is at the top in bold and indicates the name or a description of the object which experienced or caused the event. + +When viewing a User's history the title will show the object affected by the event, when viewing an Object's history the title will show the User who triggered the event. + +Below the title is the date and time the event took place and a description of the event type itself such as "created" or "deleted". + +Below the date and time is an icon and name representing the _type_ of object that was involved so you can quickly see at a glance that it involves a customer (for example) or a work order. + +Finally at the bottom are the `History`, `Activity` and `Open` buttons. + +The `History` button will open this same history form but it will display history for that object. So, for example if you click on `History` for a Customer you will see that customer's event log showing all events that affected that customer record. + +If the event box is displaying a User then the `Activity` button will show which is a shortcut to the event log for that particular User. + +The `Open` button will be shown if you have rights to open that object and clicking on it will open the object in it's edit form. + +#### More button + +By default 200 event log history items are displayed at a time. Clicking on the "More" button will retrieve the next 200. diff --git a/docs/8.0/ayanova/docs/ay-log.md b/docs/8.0/ayanova/docs/ay-log.md index 9e58ec54..59a6ab65 100644 --- a/docs/8.0/ayanova/docs/ay-log.md +++ b/docs/8.0/ayanova/docs/ay-log.md @@ -1,4 +1,27 @@ -# CLIENT LOG FORM HELP Placeholder +# Web app diagnostic log -[UNDER CONSTRUCTION] -#b4beta (what is this, where does it link from? Do we need it?) \ No newline at end of file +The web app diagnostic log shows events such as errors that occur during use of the AyaNova web app. + +This log can be useful for troubleshooting purposes. + +## Authorization Roles required + +This form is available to each User. + +## How to access the log + +The log is reached from the [About form's](ay-about.md) `Log` menu item. + +## How the log works + +AyaNova keeps a 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. + +AyaNova mostly logs error messages but it also can contain other diagnostic information of use to technical support for troubleshooting purposes. + +When you see an error displayed in AyaNova chances are it was also logged here so it's a useful way to go back and look at an error message again if necessary. + +## Gathering information for technical support + +The log display is intended for reading only, if you need to send the log or save it for later, the [About form's](ay-about.md) "Copy support information" menu option will automatically copy the log contents as well as some diagnostic information about the current browser in use and other information potentially useful when requesting support. + +Because the log only retains the most recent 100 items, it is sometimes necessary to recreate an error before copying the log to send to technical support as the error could have dropped off the log if many other items were logged since the error first appeared. diff --git a/docs/8.0/ayanova/docs/ay-notification.md b/docs/8.0/ayanova/docs/ay-notification.md deleted file mode 100644 index a393eb70..00000000 --- a/docs/8.0/ayanova/docs/ay-notification.md +++ /dev/null @@ -1,5 +0,0 @@ -# NOTIFICATION Placeholder - -[UNDER CONSTRUCTION] - -#b4beta (what is this and do we need it and wehre does it link from) \ No newline at end of file diff --git a/docs/8.0/ayanova/docs/home-user-settings.md b/docs/8.0/ayanova/docs/home-user-settings.md index 7454cb07..231260e8 100644 --- a/docs/8.0/ayanova/docs/home-user-settings.md +++ b/docs/8.0/ayanova/docs/home-user-settings.md @@ -14,7 +14,7 @@ If you change the language setting here you must logout and back in for the chan ## User email address -This is the email address used to send AyaNova related information to the user by the AyaNova [Notification system](ay-notification.md). +This is the email address used to send AyaNova related information to the user by the AyaNova [Notification system](home-notify-subscriptions.md). This setting is not required (except for notifications if used) and the default value for this setting is empty. diff --git a/docs/8.0/ayanova/docs/img/personal-history.png b/docs/8.0/ayanova/docs/img/personal-history.png new file mode 100644 index 00000000..246ad83c Binary files /dev/null and b/docs/8.0/ayanova/docs/img/personal-history.png differ diff --git a/docs/8.0/ayanova/mkdocs.yml b/docs/8.0/ayanova/mkdocs.yml index 0b15ad39..f45edfc8 100644 --- a/docs/8.0/ayanova/mkdocs.yml +++ b/docs/8.0/ayanova/mkdocs.yml @@ -47,7 +47,8 @@ nav: - 'Set password': 'home-password.md' - 'Two factor authentication': 'home-tfa.md' - 'Notification subscriptions': 'home-notify-subscriptions.md' - - 'Notifications list': 'home-notifications.md' + - 'Notifications list': 'home-notifications.md' + - 'History': 'ay-history.md' - Customers: - 'Customers': 'customers.md' - 'Customer contacts': 'cust-contacts.md' @@ -101,9 +102,8 @@ nav: - 'About': 'ay-about.md' - 'Report': 'ay-report.md' - 'Review': 'ay-review.md' - - 'History': 'ay-history.md' - 'Customize': 'ay-customize.md' - - 'Log': 'ay-log.md' + - 'Web app diagnostic log': 'ay-log.md' - 'Report editor': 'ay-report-edit.md' - 'Report timeout warning': 'ay-report-timeout.md' - Extensions: @@ -116,7 +116,6 @@ nav: - 'Customer service requests': 'customer-csr.md' - Features: - 'Translation': 'ay-translation.md' - - 'Notification': 'ay-notification.md' - Business administration and Customization: - 'Start here': 'ay-biz-admin-intro.md' - 'Authorization roles': 'ay-biz-admin-roles.md'