Reference Lists

Menu > Logic Settings > Reference Lists

Use the Reference Lists page to manage reference lists and values associated with the currently-selected company. From this page you can add, modify, delete and export reference lists.

Reference lists allow you to maintain lists of related items and organize conditions to reduce the number of rule qualifiers and TransEditors that you need. By including values in a reference that share a common characteristic that you want to configure, you can trigger a specified rate or set an exemption, for example.

Each reference list has values that can be evaluated to determine whether a specific TransEditor Conditions or Rule Qualifiers is applied to a transaction. For example, a reference list called Refineries could include a list of refinery locations. An inbound transaction can specify the refinery in a Custom Attributes (user element), and TransEditor conditions or rule qualifiers can test to see if the value of that user element is either in, or not in, the list of values.

Using the Reference Lists Page

This page has the following areas and their associated tasks:

• Reference Lists List: View and select from a list of configured reference lists owned by this company.
• Selected Reference List Tasks : Manage the selected reference list or add a new list.
• Reference Values List: View and select from a list of configured reference values belonging to the selected reference list.
• Selected Value Tasks: Manage the selected reference value or add a new value.

Reference Lists List

The Reference Lists List is the complete list of reference lists associated with this company.

If you select a reference list from the list, the Selected Reference List section is populated with data related to that list.

For detailed information about the fields in the list, see the table at the end of the following section.

Selected Reference List Tasks

You can create a new reference list or modify or delete the selected list. Only reference lists owned by your company can be modified or deleted.

Add a new reference list

1. Select Add from the Actions menu.
2. Enter data using the field reference below.
3. Click Submit to save your changes.

Modify a reference list

1. Select the item from the Reference Lists list.
2. Modify data using the field reference below.
3. Click Submit to save your changes.

Delete a reference list

1. Select the reference list from the Reference Lists list.
2. Select Delete from the Actions menu.
3. Click OK to confirm the deletion.

Export a reference list

You can export the selected reference list, or all reference lists which reference the same company and authority.

1. Select Properties from the Actions menu.
2. Click one of the following.
   • This Reference List to export only the selected reference list.
   • This Reference List and All Siblings to export all reference lists owned by this company.
   • In either case, the values associated with the exported list(s) are also exported.
3. Click Save.
4. Browse to or enter a filename to save to and click Save.

Once you save the file, you can re-import it. See the Importing Data page.

Reference Lists Field Reference
Field	Req?	Description
Name	Y	The list's name. Reference List names are case-sensitive.
Description	Opt.	A description of the list.
Start Date	Y	The date (MM/DD/YYYY) on which the reference list becomes active.
End Date	Opt.	The date (MM/DD/YYYY) on which the reference list terminates. If blank, the reference list will remain effective indefinitely.

Reference Values List

The Reference Values List is the complete list of values currently associated with the selected list.

If you select a reference list from the list, the Selected Reference Value section is populated with the data related to that value.

For detailed information about the fields in the list, see the Selected Reference Value Field table at the end of the following section.

If you prefer, you can import reference values using a CSV format file. For more information, see Reference Value CSV Format

Selected Value Tasks

Use these procedures to create a new value to include in the selected reference list or modify or delete the selected value.

Add a new reference value

1. Select Add from the Actions menu.
2. Enter data using the field reference below.
3. Click Submit to save your changes.

Modify a reference value

1. Select the item from the Reference Values list.
2. Modify data using the field reference below.

Delete a reference value

1. Select the item from the Reference Values list.
2. Select Delete from the Actions menu.
3. Click OK to confirm the deletion.

Selected Reference Value Field Reference
Field	Req?	Description
Value	Y	The value to include on the selected list. This value is case-sensitive. If you want to use dates in this field, use the following format: YYYY-MM-DD.
Start Date	Y	The date (MM/DD/YYYY) on which the value is included on the reference list. This date should fall in the effective date range for the list or the value will not be used.
End Date	Opt.	The date (MM/DD/YYYY) on which the value terminates membership in the selected list. If blank, the value will remain effective indefinitely.