Lookups Details

Overview

The Lookup Details screen provides detailed information about the selected Lookup table.

Access

To access the Lookup Details screen, click the desired item from the Lookups screen.

Navigation links are provided near the top of the Lookup Details screen:

Settings

The basic properties for the Lookup table are displayed at the top of the screen in the Header section. The features available within this section are described below.

 View or Edit Lookup Table Properties

Click hereClick here

To edit the properties of the selected Lookup table:

  1. In the top section of the Lookup Details screen, click the Edit icon. The "Edit Lookup" pop-up window is displayed.

  2. Make any necessary changes to the Lookup table properties. 

  3. Click save.

 

 Delete a Lookup Table

Click hereClick here

To delete a Lookup table:

  1. In the top section of the Lookup Details screen, click the Edit icon. The "Edit Lookup " pop-up window is displayed. 

  2. Click delete. A confirmation dialog box is displayed.

  3. Click confirm

Parameters

A Parameter in a Lookup table represents the information that you know, and that's used to lookup additional details (which are called Values). A Lookup table can have one or more Parameters. 

 Define Lookup Table Parameters

Click hereClick here

To define a Lookup table Parameter:

  1. Within the "Parameters" section, enter the name of the Parameter in the "Enter Label" field.

  2. Click create. The "Edit Lookup Parameter" pop-up window is displayed. 

  3. The "Display Name" field is populated with the value you entered above; optionally edit this value.

  4. The "Internal Name" is automatically populated based on the "Display Name" value. This field is disabled by default. To edit the Internal Name, check edit internal name. A confirmation dialog box is displayed; click ok. Edit the Internal Name value.

  5. Optionally, enter a description in the "Description" field.

  6. Click save

  7. Repeat the above steps as necessary to define additional Parameters. 

 

 View or Edit Parameter Properties

Click hereClick here

To edit the properties of a Lookup table Parameter:

  1. In the Actions column of the desired Parameter, click the Edit icon. The "Edit Lookup Parameter" pop-up window is displayed.

  2. Make any necessary changes to the Parameter properties. 

  3. Click save.

 

 Delete a Parameter

Click hereClick here

To delete a Parameter:

  1. In the Actions column of the desired Parameter, click the Edit icon. The "Edit Lookup Parameter" pop-up window is displayed.

  2. Click delete. A confirmation dialog box is displayed.

  3. Click confirm

Values

A Value in a Lookup table represents the information that you want to look up and return, based on the information provided (the Parameter). A Lookup table can have one or more Values. 

 Define Lookup Table Values

Click hereClick here

To define a Lookup table Value:

  1. Within the "Value" section, enter the name of the Value in the "Enter Label" field.

  2. Click create. The "Edit Lookup Value" pop-up window is displayed. 

  3. The "Display Name" field is populated with the value you entered above; optionally edit this value.

  4. The "Internal Name" is automatically populated based on the "Display Name" value. This field is disabled by default. To edit the Internal Name, check edit internal name. A confirmation dialog box is displayed; click ok. Edit the Internal Name value.

  5. Optionally, enter a default value in the "Default Value" field. 

  6. Optionally, enter a description in the "Description" field.

  7. Click save

  8. Repeat the above steps as necessary to define additional Values. 

 

 View or Edit Value Properties

Click hereClick here

To edit the properties of a Lookup table Value:

  1. In the Actions column of the desired Value, click the Edit icon. The "Edit Lookup Value" pop-up window is displayed.

  2. Make any necessary changes to the Value properties. 

  3. Click save.

 

 Delete a Value

 Click hereClick here

To delete a Value:

  1. In the Actions column of the desired Value, click the Edit icon. The "Edit Lookup Value" pop-up window is displayed.

  2. Click delete. A confirmation dialog box is displayed.

  3. Click confirm

Populate Lookup Table

To populate the Lookup table, you must upload a file stored locally on your PC. The file should contain a column for each Parameter and for each Value that you defined above. Each distinct value for a Parameter should have its own row. 

 Upload a File

 Click hereClick here

To upload a file to populate the Lookup table:

  1. In the "File" section, click upload.  

  2. Browse to and select the desired file. 

  3. Click attach. The platform uploads the file, and displays a sample (first 100 records) in the "Content" section (you may need to refresh your browser to get the "Content" section to appear). 

 

 Remove a File

 Click hereClick here

To remove the upload file and delete the contents of the Lookup table:

  1. In the "File" section, the name of the upload file is displayed beneath the attach button. Next to this filename, click the Delete icon. A confirmation dialog box is displayed.

  2. Click confirm

 

Back to Lookups