Screen flows

• Submit—Validate and save the changes.
• Refresh—Reload the original data. Any changes made since the last submit are lost.
• New—Create a new item related to the application.
• Save As—Create a new item based on the information provided by an existing item.
• Delete—Confirm and delete the current item.
• Open—Display a dialog box to enter an existing item to display its detail.
• New Search—Return to the Search screen and clear the search results and the search criteria.

Header

• Scope

  The scope at which the application preference is applied:

  • INSTANCE ONLY—Where there is no lower level application preference than this INSTANCE application preference, or the preference's Is Lowest Level Lock is selected, when a user logs into a laboratory, then the INSTANCE scope application preference applies.

  • ORGANISATION ONLY—Where there is no lower level application preference than this ORGANISATION application preference, or the preference's Is Lowest Level Lock is selected, when the user logs into a laboratory associated with the preference's organisation, then the ORGANISATION scope application preference applies.

  • LABORATORY ONLY—Where there is no lower level application preference than the LABORATORY application preference, or the preference's Is Lowest Level Lock is selected, when the user logs into the laboratory associated with the preference's laboratory, then the LABORATORY scope application preference applies.

  • ROLE ONLY—Where there is no lower level application preference than the ROLE application preference, or the preference's Is Lowest Level Lock is selected, when the user logs into a laboratory, then the ROLE scope application preference applies.

  • USER ONLY—Where there is no lower level application preference than the USER preference, or the preference's Is Lowest Level Lock is selected, when the user logs into a laboratory, then the USER scope application preference applies.

  • USER ROLE ONLY—When the current user logs into a laboratory, and the user's first role (sorted ascending alpha-numerically) matches the preference's Role Name, then the USER-ROLE scope application preference applies.

  Note: When the selected Scope is LABORATORY, ROLE, USER, or USER ROLE, preferences apply only to the current logged in laboratory. This means that the same preference needs to be created for each of the user's log in laboratories.

• Preference Name

  The name of the application preference. Maximum 40 characters.

• Description

  The description of the application preference. Maximum length of 400 characters.

• Setting Type

  The type of data contained within the application preference:

  • Boolean—Setting Value is displayed as a check box.

  • Year

  • Date

  • Time

  • Date Time

  • Numeric

  • String

  • List

  • Colour

  • Folder

  • File—Used to import a script file if the preference is being used to set up a workbook command or right-click menu.

  • Font.

• Format

  The text outlining the format of the Setting Value. For example, "Code of a Workbook Script".

• Setting Value

  The value of the preference setting. For example, the value contains the directory path specifying where a generated report is stored, such that, the preference can be used in the report filename syntax's script.

  Notes:

  • There is no immediate validation of the values of the preference setting.

  • If Setting Type is Boolean, then Setting Value displays as a check box. On submission, Setting Value for the preference is set to true or false, according to the checked or cleared status of Setting Value.

• Preference Type

  The type of preference:

  • SECURITY—Indicates that the preference is tied to secured functionality

  • PREFERENCE—Indicates that the preference is tied to a choice of pathways.

  Note: There is no core purpose to setting this, and is only used to sub-categorise the preferences,

• Preference Category

  A category assigned to the preference. Selected from categories with a Category Type of PREFERENCES.

  Note: A category cannot be assigned to a preference that has a Scope of INSTANCE ONLY.

• Is Active

  Indicates whether the entity is available in drop-down lists when selecting a category for an entity. An inactive entity cannot be selected for use.

• Is System

  Indicates that the preference is system-owned. The preference cannot be updated, deleted or copied where Is System is selected.

• Is Lowest Level Lock

  The preference is at its lowest level. If a lower level preference is defined, it is not applied. This allows organisation or laboratory level preferences to be preferentially used, even where the preference exists and is active at a lower level.