diff --git a/docs/8.0/ayanova/docs/home-reminders.md b/docs/8.0/ayanova/docs/home-reminders.md index ccec26ef..d8ae769a 100644 --- a/docs/8.0/ayanova/docs/home-reminders.md +++ b/docs/8.0/ayanova/docs/home-reminders.md @@ -31,7 +31,7 @@ The Reminders [data table](ay-start-form-data-tables.md) lists all the reminders ## Reminder edit form -The Reminder edit form contains the [standard edit form](ay-start-edit-forms.md) functionality and contains the following fields: +The Reminder edit form has the [standard edit form](ay-start-edit-forms.md) functionality and the following fields: #### Name diff --git a/docs/8.0/ayanova/docs/home-reviews.md b/docs/8.0/ayanova/docs/home-reviews.md index 8bebd959..d43e8cab 100644 --- a/docs/8.0/ayanova/docs/home-reviews.md +++ b/docs/8.0/ayanova/docs/home-reviews.md @@ -54,7 +54,7 @@ If the current user has a [Supervisory role](#authorization-roles-required) they ## Review edit form -The Review edit form contains the [standard edit form](ay-start-edit-forms.md) functionality and contains the following fields: +The Review edit form has the [standard edit form](ay-start-edit-forms.md) functionality and the following fields: #### Assigned to @@ -70,12 +70,10 @@ The required "Title" of the review, this field is displayed in the schedule form #### Review date -This is the required date and time the review must take place. A review displays in the personal schedule of the assigned user at the date and time. Reviews always display as a 15 minute long event as there is stop date and so no time period duration for a review. +This is the required date and time the review must take place. A review displays in the personal schedule of the assigned user at the date and time. Reviews always display as a 15 minute long event as there is only one date and time for a review. The Review date is also used for review [notifications](home-notify-subscriptions.md). -(Once a review is set to completed date and saved it will cancel any impending notifications for it that haven't been sent yet) - #### Notes Notes is an optional field for entering more details about the review. Notes do _not_ display in the schedule form, only the Name field so the review needs to be opened to view Notes. @@ -84,6 +82,8 @@ Notes is an optional field for entering more details about the review. Notes do Date and time a review has been completed. +Once a review has it's completed date set and saved it will cancel any impending overdue notifications for it that haven't been sent yet. + #### Completion notes Optional notes regarding the status of the follow up review. diff --git a/docs/8.0/ayanova/docs/home-schedule.md b/docs/8.0/ayanova/docs/home-schedule.md index 807c99ca..5106ae61 100644 --- a/docs/8.0/ayanova/docs/home-schedule.md +++ b/docs/8.0/ayanova/docs/home-schedule.md @@ -1,6 +1,6 @@ # Schedule -The personal schedule displays events connected to the currently logged in User and can also be used to create new items or modify existing ones. +The home personal schedule displays events connected to the currently logged in User and can also be used to create new items or modify existing ones. The events potentially displayed are [Work order](svc-workorders.md) item scheduled User records, [Review](home-reviews.md) and [Reminder](home-reminders.md) records. @@ -12,7 +12,7 @@ The personal schedule menu provides quick access to the currently logged in User ![Settings](img/home-schedule-settings.png) -The settings dialog (access by clicking on gear icon at top) controls what is displayed in the schedule. Schedule settings are device independent and saved to the server so that any device used will take these same settings. +The settings dialog (access by clicking on gear icon at top) controls what is displayed in the schedule. Schedule settings are device independent and saved to the server as a personal User setting so that any device used by this same User account will use these same settings. ### First time in day view @@ -34,7 +34,7 @@ The schedule shows dated items only, any Work order item scheduled user records ## Review events -A Review object does not have a duration of it's event associated with it as it only has a single Review Date field. For this reason all Review items will display at their Review Date in the schedule display as a 15 minute interval. +A Review object does not have a time period associated with it as it only has a single *Review Date* field. For this reason all Review items will display in the schedule starting at their Review Date as a 15 minute interval. ## Moving around @@ -43,7 +43,7 @@ A Review object does not have a duration of it's event associated with it as it - Month Year button - This button displays the current month and year and can be clicked on to switch to month view if in any other view - Settings (Gear / Cog icon) opens the settings form - View drop down at top right is used to switch the view between the available options -- Date (Day) number - Clicking on a date in the Calendar (i.e. clicking on the "23" for the 23rd of the month) will switch to the day view for that date if in any view other than day view +- Date (Day) number - Clicking on a date in the Calendar (i.e. clicking on the "23" for the 23rd of the month) will switch the current view to the Day view for that date. ## Create / modify / view events @@ -53,8 +53,7 @@ A Review object does not have a duration of it's event associated with it as it - Extend the duration of an event: hover the mouse over the bottom, a "grip" will appear, click and drag up or down to modify the time range - Events with a lock symbol on them are not modifiable - Click and drag in an empty space in any Day view to create a new object in that time frame selected -- Click an event to open a quick More information display with a summary of that item -- Open the object the event represents for editing by clicking on Open or the icon at the top of the More information dialog +- Click an event to open a More information display with a summary of that item and an Open button to open the source record ### Non mouse devices diff --git a/docs/8.0/ayanova/docs/home-search.md b/docs/8.0/ayanova/docs/home-search.md index 2fa97032..5ddb881f 100644 --- a/docs/8.0/ayanova/docs/home-search.md +++ b/docs/8.0/ayanova/docs/home-search.md @@ -15,11 +15,13 @@ This form is available to all user however results will be limited to objects th ### Indexing -When a business object is saved the AyaNova server indexes text and other unique fields into the search system. Indexing is the process of breaking out all the unique words in a business object and recording them in a central "dictionary" with a key that indicates the record type and id of the business object that those words were entered on so that they can be searched for and the exact business object they were entered in retrieved. +When a business object is saved the AyaNova server indexes text and other unique fields into the search system. Indexing is the process of breaking out all the unique words in a business object and recording them in a central "dictionary" with a key that indicates the record type and id of the business object that those words were entered on so that they can be searched for later. -In order for a word to be indexed for searching it must be 2 to 255 characters long and not be a "Stop word". +In order for a word to be indexed for searching it must be 2 to 255 characters long and not be a [Stop word](#stop-words). -All text in the business object is indexed including Addresses, phone numbers, email and web addresses, Tags, Wiki and custom fields. The _contents_ of file Attachments are _not_ indexed for searching and can not be searched for, however the name and notes are indexed for searching. (Attachments can also be viewed in a central list of all attachments in the [administration attachments](adm-attachments.md)) +All text in the business object is indexed including Addresses, phone numbers, email and web addresses, Tags, Wiki and custom fields. + +The _contents_ of file Attachments are _not_ indexed for searching and can not be searched for, however the name and notes are indexed for searching. (Attachments can also be viewed in a central list of all attachments in the [administration attachments](adm-attachments.md)) #### Numbers @@ -31,15 +33,15 @@ Stop words are words that are so common in each language that there is little po AyaNova keeps a list of the most common stop words for each provided [Translation](adm-translations.md) under the translation key names of "StopWords1" to "StopWords7" to break them into smaller chunks for processing. Not all languages require all stopword keys to be used, for example Spanish uses all 7 stopword slots but German requires 3. -While we do not recommend it except in specific exceptional circumstances, it is possible to view the list of stop words and even add your own or remove any that need to be indexed for your business by examining and editing the "StopWords\*" keys in the translation form for the translations in use by your users. +While we do not recommend it, except in specific exceptional circumstances, it is possible to view the list of stop words and even add your own or remove any that need to be indexed for your business by examining and editing the "StopWords\*" keys in the translation form for the translations in use by your users. ### Searching #### Seach terms -To search for a word or phrase enter one or more search terms into the `Search` text input control. +To search for a word or phrase enter one or more search terms into the *Search* text input control. -Search terms are one or more words separated by spaces. Each search term word must be 2 to 255 characters in length. Shorter or longer words will be ignored. +Search terms are one or more words, each separated by a single space character. Each search term word must be 2 to 255 characters in length. Shorter or longer words will be ignored. A search phrase can be entire words to match exactly or wildcard terms. @@ -48,7 +50,9 @@ A search phrase can be entire words to match exactly or wildcard terms. The `*` asterisk wildcard character can be used in a search term to search for words that begin with, end with or contain a portion of a word. Begins with searches look like this `mon*` which would match "monday", "Montana", "mongoose" etc. + Ends with searches look like this `*ay` which would match with "sunday", "tray", "spray" etc. + Contains searches look like this `*oul*` which would match with "would", "boulder", "outlook", "soul" etc. (Note that contains can match starts and ends as well as contained within words) You can use multiple wildcard terms and mix and match with non-wildcard terms so, for example this is a valid search phrase: `*att* rain blue *spa ors*`. @@ -71,7 +75,7 @@ When indexing and searching _all_ fields are searched at the same time so, for e The `Object` select list can be used to only search for an exact type of object. When you come to the Search form via the Search menu option in a specific AyaNova object, the `Object` select list is automatically set to the type of object you came from. -You can change this to any type of object by selecting the `-` or no selection option. +You can change this to any type of object by selecting the `-` no selection option. ### Results list