The Code Lists interface will provide the ability to maintain the relevant application code lists. A code list is a set of items that have at least two pieces of information: a description and a database "code" that is associated with the description. The purpose of a code list is to present users with a descriptive text instead of the short database code that is stored in the database table. Code List Maintenance provides the ability to edit code names and values so that the change is reflected throughout the system with one modification.
This tool can be accessed by clicking on the Administration icon on the Utility Bar. Only users with the System Administrator security role will have this option available.
When "Code Lists" is selected in the picklist, its interface will appear on the screen. The image below shows the Code Lists interface after a row is selected in the table. When the user first enters this interface, only the left side (table) will be populated.
On the left side, the user can view a table listing each code list in the system. The three radio buttons above the table allow the user to easily filter the table. The user can choose to see All, Maintained (Editable), or Read-Only code lists. These columns appear on the table, regardless of the displayed code lists:
| Column | Description |
|---|---|
| Name | This field defines the user-friendly display name for the code list. |
| Status | This field showcases whether the User is Maintained (editable) or read-only within the application. |
| System List | This field showcases whether the code list is a system list (checkmark) or a custom list (no checkmark). |
To view and edit the code values in the code list, the user can click on its row in the table. Then, the Detail window on the righthand side will be filled with its information. This area will include the code list name, a delete icon (), and an "Edit Code List" button in the header, and these fields below:
| Field | Description |
| This icon will appear beside each row in the table to allow the user to click, drag, and drop the entry into a different position. This alters the Display Order in which each code appears in all dropdown lists. | |
|
This checkbox will appear beside each row in the table to allow the user to select a code in the code list and delete or edit the item.
|
|
| Order | This is the Display Order in which each code appears in all dropdown lists. |
| Name | This is a user-friendly display name for the code. |
| Status | This showcases whether the code is Active (checkmark) or Inactive (no checkmark) within the application. Inactive codes will not be selectable from any picklist within the system. However, if an Inactive code is currently assigned in the system, the code will be displayed but read-only. |
Edit Code
To edit a code entry, the user can click the checkmark on its row, then select "Edit Code" above the Codes table. This will trigger the appearance of a pop-up. An editable "Phase Tag Name" field will appear in this pop-up, filled with the current values, and the user can type in a new value in the desired textbox if desired. A code's status (active/inactive) can also be altered in this space by the toggle (). When any change is made, the user can solidify it by clicking "Save". Alternatively, the user can revert the changes to their original values through the available "Discard" button.
Add Code
The "Add Code" button allows the user to add a new code to a code list. When this button is selected, a pop-up will appear for the user to define the new code. The user must enter an Item Name here, and more fields may appear in this space if there are additional requirements for the code list. For example, the "Asset Class" code list has the "Parent Element" field in the "Add New Item" pop-up when creating a new code. Once all fields are filled, the user can select "Add Item".
Add List
The "Add List" button, located above the Code List table (lefthand side), allows the user to create custom code lists. Once selected, a pop-up will appear for a "Code List Name" to be specified. Upon "Save", the Detail window (righthand side) will be cleared, so the user can add new code values to the list through the "Add Item" button.
Comments
0 comments
Please sign in to leave a comment.