This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# Select list templates
|
||||
# Autocomplete list templates
|
||||
|
||||
This form is used to set which fields of an AyaNova object are displayed and [searchable](ay-start-form-autocomplete.md#filtering-searching) in [select lists](ay-start-form-autocomplete.md) on [forms](ay-start-form-overview.md).
|
||||
This form is used to set which fields of an AyaNova object are displayed and [searchable](ay-start-form-autocomplete.md#searching) in [autocomplete lists](ay-start-form-autocomplete.md) on [forms](ay-start-form-overview.md).
|
||||
|
||||
In most cases when users of AyaNova need to select from a list of AyaNova objects on a form they will be looking at the "Name" field however in many cases there are other fields that are equally important. For example when looking for a particular [part](inv-parts.md) to select on a [work order](svc-workorders.md) it may be helpful to be able to find the part by not only the part name but also by the part manufacturer or supplier number or other fields.
|
||||
|
||||
@@ -18,36 +18,36 @@ Read only access
|
||||
|
||||
- Business administration - restricted
|
||||
|
||||
## How to access Select list templates
|
||||
## How to access autocomplete list templates
|
||||
|
||||
From the `Administration` navigation pane [Global settings form](adm-global-settings.md) in the `User interface` section of the form click on the `Select list templates` button.
|
||||
From the `Administration` navigation pane [Global settings form](adm-global-settings.md) in the `User interface` section of the form click on the `Autocomplete list templates` button.
|
||||
|
||||
In the select list template form at the top is a list of AyaNova objects that have select lists that can be templated and selecting an object will open it's template for editing.
|
||||
In the autocomplete list template form at the top is a list of AyaNova objects that have autocomplete lists that can be templated and selecting an object will open it's template for editing.
|
||||
|
||||
## How select list templates work
|
||||
## How autocomplete list templates work
|
||||
|
||||
### templates are shared by all users
|
||||
|
||||
Select list templates are a global setting that affects all users, there is no way to specify a unique template per user.
|
||||
Autocomplete list templates are a global setting that affects all users, there is no way to specify a unique template per user.
|
||||
|
||||
### templates do not control _display_
|
||||
|
||||
Select lists templates are used for **selection** purposes only, not general display purposes. In other words when you need to select a part you will likely require more fields to help make the selection than you typically want to see when viewing an object with that part selected.
|
||||
Autocomplete lists templates are used for **selection** purposes only, not general display purposes. In other words when you need to select a part you will likely require more fields to help make the selection than you typically want to see when viewing an object with that part selected.
|
||||
|
||||
For most objects, the `Name` field will be the **primary identifier** used to display an object as it's required to be unique and it's the value that is displayed most often in the user interface and on reports.
|
||||
|
||||
### example
|
||||
|
||||
Let's use the [part](inv-parts.md) object as an example. By default the part select list template will have (in order left to right) the `Name`, `Manufacturer` and `Tags` fields of a part selected to include in a part select list:
|
||||
Let's use the [part](inv-parts.md) object as an example. By default the part select list template will have (in order left to right) the `Name`, `Manufacturer` and `Tags` fields of a part selected to include in a part autocomplete list:
|
||||
|
||||
|
||||
|
||||
|
||||
In the image above you can see the selected fields as well as other fields available. The order displayed can be changed by using the ordering arrow controls under each field to move it to the desired location.
|
||||
|
||||
In this example the `Name` field is mandatory and will always be checked as it's the primary identifier for this object, however you can move it to any location desired.
|
||||
|
||||
When the user needs to select a part the default list will look similar to this:
|
||||
|
||||
|
||||
|
||||
In the image above the selected part's name is on the far left "397389", the manufacturer "Yellow cedar consulting" is displayed in the center and the tags set on that part "violet, zone5, zone7, zone8, zone9" are displayed to the right.
|
||||
|
||||
@@ -79,21 +79,21 @@ It is not mandatory they be those sizes or formats, it's what is used in testing
|
||||
|
||||
The small logo is the most commonly used on reports and the small and medium are most commonly used for the login form logo depending upon the size of the device's screen in use. The large logo is not currently used for any stock report templates however it's available to any report template if required or can be used as an alternative logo for reports if required.
|
||||
|
||||
### Select list templates
|
||||
### Autocomplete list templates
|
||||
|
||||
Searchable [select lists](ay-start-form-autocomplete.md) are used throughout AyaNova for areas where you need to select another AyaNova object on a form, for example selecting a Customer on a Work order or a Part on a Purchase Order.
|
||||
Searchable [autocomplete lists](ay-start-form-autocomplete.md) are used throughout AyaNova for areas where you need to select another AyaNova object on a form, for example selecting a Customer on a Work order or a Part on a Purchase Order.
|
||||
|
||||
The `SELECT LIST TEMPLATES` button will take you to the [select list templates form](adm-global-select-templates.md) where you can configure what information is displayed in select lists for each object type depending upon your specific requirements.
|
||||
The `AUTOCOMPLETE LIST TEMPLATES` button will take you to the [autocomplete list templates form](adm-global-autocomplete-templates.md) where you can configure what information is displayed in autocomplete lists for each object type depending upon your specific requirements.
|
||||
|
||||
These templates allow you to control which fields from the source object are displayed and searched in that type of objects selection lists.
|
||||
These templates allow you to control which fields from the source object are displayed and searched in that type of objects autocomplete lists.
|
||||
|
||||
Note that this setting affects select lists only for searching and identification purposes, not how names of objects are displayed generally in AyaNova forms or on reports. These templates are for the Users to help them more quickly select objects.
|
||||
Note that this setting affects autocomplete lists only for searching and identification purposes, not how names of objects are displayed generally in AyaNova forms or on reports. These templates are for the Users to help them more quickly select objects.
|
||||
|
||||
[Select list templates](adm-global-select-templates.md) are Global and apply to _all_ users of AyaNova.
|
||||
[Autocomplete list templates](adm-global-autocomplete-templates.md) are Global and apply to _all_ users of AyaNova.
|
||||
|
||||
In the template form you can select the sources of information that are displayed in each select list and the order in which they are displayed. You can also turn on or off [Tags](ay-start-form-tags.md) for each object.
|
||||
In the template form you can select the sources of information that are displayed in each autocomplete list and the order in which they are displayed. You can also turn on or off [Tags](ay-start-form-tags.md) for each object.
|
||||
|
||||
The fields you select will be the ones **searched** when typing characters into a selection list to limit the list to the desired selection so the choice of which fields to show serves multiple purposes.
|
||||
The fields you select will be the ones **searched** when typing characters into a autocomplete list to limit the list to the desired selection so the choice of which fields to show serves multiple purposes.
|
||||
|
||||
### Customer signature
|
||||
|
||||
|
||||
@@ -1,78 +1,78 @@
|
||||
# Select lists
|
||||
#b4beta (change filter to search below and check if that breaks links, searching makes more sense in this case and is easier to understand)
|
||||
# Autocomplete lists
|
||||
|
||||
## Overview
|
||||
|
||||
Select lists are used to select and / or filter for a value on forms. For example a Part on a Workorder form.
|
||||
Select lists can be [customized](adm-global-select-templates.md) for each object type so that they will display one or multiple fields from that object type.
|
||||
Autocomplete lists are used to select and / or search for a value on forms. For example a Part on a Workorder form.
|
||||
Autocomplete lists can be [customized](adm-global-autocomplete-templates.md) for each object type so that they will display one or multiple fields from that object type.
|
||||
|
||||
By default the Name of an object will _always_ be present in that object type's select list template in addition to any other fields selected for that object type's select list template.
|
||||
By default the Name of an object will _always_ be present in that object type's autocomplete list template in addition to any other fields selected for that object type's autocomplete list template.
|
||||
|
||||
They are also used to open the record selected in them or a new record if no selection has been made.
|
||||
|
||||
## Selecting
|
||||
|
||||
A maximum of 100 items are returned by the server for any select list and clicking on a select list will cause it to drop down and by default fetch the first 100 records found for that type of object in the AyaNova database. For objects that there are less than 100 of this is often all that is required to select the item you need. However for larger lists searching by entering a few characters that match the item desired will be necessary.
|
||||
A maximum of 100 items are returned by the server for any autocomplete list and clicking on a autocomplete list will cause it to drop down and by default fetch the first 100 records found for that type of object in the AyaNova database. For objects that there are less than 100 of this is often all that is required to select the item you need. However for larger lists searching by entering a few characters that match the item desired will be necessary.
|
||||
|
||||
### No selection item
|
||||
|
||||
Select lists have a special item represented by a single dash character `-` which indicates that no selection has been made for that item.
|
||||
Autocomplete lists have a special item represented by a single dash character `-` which indicates that no selection has been made for that item.
|
||||
|
||||
## Searching
|
||||
|
||||
The fastest way to select an item when there are a large number of choices is by filtering.
|
||||
The fastest way to select an item when there are a large number of choices is by searching.
|
||||
|
||||
The choices in the select list can be filtered by entering text into the control.
|
||||
A valid filter consists of a single text filter a single [Tag](ay-start-form-tags.md) filter or both separated by a space.
|
||||
The choices in the autocomplete list can be searched by entering text into the control.
|
||||
A valid search consists of a single text search a single [Tag](ay-start-form-tags.md) search or both separated by a space.
|
||||
|
||||
If a filter is invalid the control will show an error message with a help link to this page of documentation.
|
||||
If a search is invalid the control will show an error message with a help link to this page of documentation.
|
||||
|
||||
By default the Name field is always present and filterable but other fields can be added for selection and filtering via template.
|
||||
Tags will only display if added to the template but you can always filter for them.
|
||||
By default the Name field is always present and searchable but other fields can be added for selection and searching via template.
|
||||
Tags will only display if added to the template but you can always search for them.
|
||||
|
||||
### Case sensitivity
|
||||
|
||||
By default AyaNova filters are case **in**-sensitive. This can be changed in the Adminstration -> Global settings form `Filtering is case sensitive` checkbox. Setting this to checkmarked (true) means that all filters will be treated as case sensitive so for example filtering a list for "group" will NOT match to "Group".
|
||||
By default AyaNova searches are case **in**-sensitive. This can be changed in the Adminstration -> Global settings form `Filtering is case sensitive` checkbox. Setting this to checkmarked (true) means that all searches will be treated as case sensitive so for example seaarching a list for "group" will NOT match to "Group".
|
||||
|
||||
### Filter by text
|
||||
### Search by text
|
||||
|
||||
A single string of text with no spaces can be entered into the control to bring back results that _contain_ anywhere in their name or templated fields that text entered.
|
||||
Multiple separate text queries are _not_ supported, so for example this filter `paul pero` is not valid.
|
||||
Multiple separate text queries are _not_ supported, so for example this search `paul pero` is not valid.
|
||||
|
||||
The server will filter all the fields that are specified in the select list template for that type of object.
|
||||
By default filters are _not_ case sensitive however that can be adjusted via [Global settings](adm-global-settings.md) if required.
|
||||
The server will search all the fields that are specified in the autocomplete list template for that type of object.
|
||||
By default searches are _not_ case sensitive however that can be adjusted via [Global settings](adm-global-settings.md) if required.
|
||||
|
||||
Filtering, sort order and case sensitivity are affected by your [Server locale setting](ops-server-locale.md)
|
||||
Searching, sort order and case sensitivity are affected by your [Server locale setting](ops-server-locale.md)
|
||||
|
||||
For example if you want to quickly select a Customer named "Paul's Perogies" you could type `pau` and up to 100 of the Customers with "pau" anywhere in their select list template would be returned for selection. You could also type `per` which would also match to "Paul's Perogies" and any other Customers with "per" anywhere in their template.
|
||||
For example if you want to quickly select a Customer named "Paul's Perogies" you could type `pau` and up to 100 of the Customers with "pau" anywhere in their autocomplete list template would be returned for selection. You could also type `per` which would also match to "Paul's Perogies" and any other Customers with "per" anywhere in their template.
|
||||
|
||||
### Filter by tag
|
||||
### Search by tag
|
||||
|
||||
A tag query is a string of text with no spaces that starts with two consecutive periods, i.e. `..north` will filter for all objects tagged with tags that contain the text "north".
|
||||
A tag query is a string of text with no spaces that starts with two consecutive periods, i.e. `..north` will search for all objects tagged with tags that contain the text "north".
|
||||
|
||||
You can always filter for an object by [Tag](ay-start-form-tags.md) even if it's not set to display in the select list template for that object type. If the select list template has had tags added to it they will display in the selection list as a comma separated list of all tags e.g. "Paul's Perogies zone1,north,etc" but even if they are not added to the template they will still be filtered when a tag query is entered.
|
||||
You can always search for an object by [Tag](ay-start-form-tags.md) even if it's not set to display in the autocomplete list template for that object type. If the autocomplete list template has had tags added to it they will display in the autocomplete list as a comma separated list of all tags e.g. "Paul's Perogies zone1,north,etc" but even if they are not added to the template they will still be searched when a tag query is entered.
|
||||
|
||||
Just like text filters, tag filters will match to any position in the tag name, so for example if you were filtering for an object tagged with "outside-service" you could enter `..side` and it would match all tags that contain those letters.
|
||||
Just like text searches, tag searches will match to any position in the tag name, so for example if you were searching for an object tagged with "outside-service" you could enter `..side` and it would match all tags that contain those letters.
|
||||
|
||||
### Combined filters
|
||||
### Combined search
|
||||
|
||||
You can also filter by tag and by text combined, for example entering `aul ..side` indicates you want to filter all text for the letters "aul" and all tags for the letters "side" which is useful to narrow down the filter quickly to very specific records.
|
||||
You can also search by tag and by text combined, for example entering `aul ..side` indicates you want to search all text for the letters "aul" and all tags for the letters "side" which is useful to narrow down the search quickly to very specific records.
|
||||
|
||||
### Item not appearing in results?
|
||||
|
||||
Inactive records are not valid for selection in many forms so if you are filtering for an item that is set to Active=false it likely will not appear in your results on most forms by default.
|
||||
Inactive records are not valid for selection in many forms so if you are searching for an item that is set to Active=false it likely will not appear in your results on most forms by default.
|
||||
|
||||
### Opening selected record
|
||||
|
||||
|
||||
|
||||
|
||||
If the selection list is displaying objects that you are able to open for editing, an edit icon will appear beside the control and clicking on that icon will directly open the edit form for that record or a new empty record if the special "-" no selection item has been selected.
|
||||
If the autocomplete list is displaying objects that you are able to open for editing, an edit icon will appear beside the control and clicking on that icon will directly open the edit form for that record or a new empty record if the special "-" no selection item has been selected.
|
||||
|
||||
This is a quick way to get to the object from another object's edit form. You will be prompted to save changes first before the new form opens if you have any unsaved changes.
|
||||
|
||||
### Clear button
|
||||
|
||||
The select list has a clear button that can be used to quickly erase the contents of the select list to save a step when you want to enter a new filter.
|
||||
The autocomplete list has a clear button that can be used to quickly erase the contents of the autocomplete list to save a step when you want to enter a new search.
|
||||
|
||||
## Customizing pick list template
|
||||
|
||||
The choice of fields displayed and filterable in the select list can be [customized](adm-global-select-templates.md).
|
||||
The choice of fields displayed and searchable in the autocomplete list can be [customized](adm-global-autocomplete-templates.md).
|
||||
|
||||
|
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 58 KiB |
|
Before Width: | Height: | Size: 407 B After Width: | Height: | Size: 407 B |
|
Before Width: | Height: | Size: 55 KiB After Width: | Height: | Size: 55 KiB |
@@ -118,7 +118,7 @@ nav:
|
||||
- Business administration and Customization:
|
||||
- 'Start here': 'ay-biz-admin-intro.md'
|
||||
- 'Authorization roles': 'ay-biz-admin-roles.md'
|
||||
- 'Select list templates': 'adm-global-select-templates.md'
|
||||
- 'Select list templates': 'adm-global-autocomplete-templates.md'
|
||||
- 'Business logos': 'adm-global-logo.md'
|
||||
- 'Migrating from v7': 'ay-biz-admin-migrate-v7.md'
|
||||
- Trying out AyaNova:
|
||||
|
||||
@@ -1789,7 +1789,7 @@
|
||||
"ErrorNoMatch": "Values don't match",
|
||||
"ErrorPickListQueryInvalid": "Query not valid - click help icon to learn more",
|
||||
"UserInterfaceSettings": "User interface",
|
||||
"PickListTemplates": "Select list templates",
|
||||
"PickListTemplates": "Autocomplete list templates",
|
||||
"ResetToDefault": "Reset to default",
|
||||
"ServerState": "Server state",
|
||||
"ServerStateOpen": "Open",
|
||||
@@ -1817,7 +1817,7 @@
|
||||
"NoType": "No type",
|
||||
"License": "License",
|
||||
"LogFile": "Log file",
|
||||
"PickListTemplate": "Select list template",
|
||||
"PickListTemplate": "Autocomplete list template",
|
||||
"ServerJob": "Server job",
|
||||
"AyaNova7Import": "AyaNova 7 import",
|
||||
"TrialSeeder": "Trial seed data",
|
||||
|
||||
Reference in New Issue
Block a user