The sharedo system uses lists of values called option sets. An option set is a list of values.
When you set up your list you can specify the following attributes:
| Attribute | Description |
|---|---|
| Name | The name of the list. |
| System Name |
This is the unique system name for the list. When using an option set in formbuilder, execution engine plans etc this is the name by which the list is referred |
| Description | A useful description of the list which will help administrators understand how it is used in your implementation |
| Active | Can be used to set a list that is no longer used to inactive. This prevents the list being used to create new data but can still be used to refer to old links. |
| Is System | If set to On this indicates that the list is used internally within the system and should only be changed by a technical resource |
| Allow Hierarchy | Allows the values in the list to be hierarchical |
Each option set contain one or more values. Each value can have the following attributes.
| Attribute | Description |
|---|---|
| Name | The value that will be shown in the UI |
| ID |
A unique id for the value. This value should be used when referring to the value in execution engine plans or formbuilder |
| Short Name | A short name for the value |
| Meaning Code | Give an underlying condition or meaning for the value. So for example a status of New, In Progress called all be given a meaning code of open. |
| Icon | The icon shown in the application where appropriate for the list item |
| Colour | The colour the list item will be shown in |
| Migration Code | The code that is used by an interface or data migration to link to the item |
| Active | Indicates whether the value is active or not. |
Striping Option Set Values
The concept of striping allows you to display data in the application depending on context. Striping can be applied to list view values. For example: You may only wish certain values to appear in a list if a certain user persona is viewing the list