The Code Lists interface will provide the ability to maintain the relevant application code lists. This tool can be accessed by clicking on the Administration Menu icon on the Utility Bar. Only users with the System Administrator security role, TIP Coordinator security role, or users assigned a role that includes the Create Code Lists and/or the Manage Code List Values permissions will have this option available.
When "Code Lists" is selected in the picklist, its interface will appear on the screen.
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 |
| List ID | This is the system generated unique ID for the code list. |
| List Display Name | This is a user-friendly display name for the code list. |
| Custom | This showcases whether the code list is Custom (checkmark) or not (empty). |
| Maintained | This showcases whether the code list is Maintained (checkmark) and editable, or Read-Only (empty). |
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 and a delete icon () in the header, the Codes table, and an "Add Code" button. The Codes table includes these values:
| 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. | |
| ID | This is a read-only field that defines the unique code associated with a code list entry. This field is automatically populated by the system when a new code is saved. |
| Name | This is a user-friendly display name for the code. |
| Active | 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. |
| Delete | This column has an icon ( |
Edit Code
To edit a code entry, the user can click on its row in the Codes table. Then, the editable fields will appear below the table, filled with the current values. The user can type in a new value in the desired textbox. 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 Code". Alternatively, the user can revert the changes to their original values through the available "Cancel" button.
Add Code
The "Add Code" button allows the user with the System Administrator role, TIP Coordinator role, or the Manage Code List Values permission to add a new code to a code list. When this button is selected, blank fields will appear below the Codes table (righthand side) for the user to define the new code. At minimum, the Code Name field will appear here, and more fields may appear in this space if there are additional requirements for the code list. For example, the "Color" code list requires that the ColorHex field also be filled when creating a new code. Once all fields are filled, the user can select "Save Code".
Add List
The "Add Code List" button, located above the Code List table (lefthand side), allows the user with the System Administrator role, TIP Coordinator role, or the Create Code Lists permission to create custom code lists. Once selected, the Detail window (righthand side) will be cleared, so the user can enter information about the new code list. The user must first enter a unique Code List Name, then click "Save". Once the code list is saved in the system, the user can add new code values to the list through the "Add Code" button.
Comments
0 comments
Please sign in to leave a comment.