Edit the Code List for an Element

In addition to properties, you can also edit code lists for element constructs while customizing standard B2B schemas.

Some EDI X12 elements are restricted to a set of enumerated values. A code list displays the allowed values for an element. Typically, elements of the type ID (identifier) have a code list associated with them; however, any element can have a code list.

To view an element's code list, hover over the element row and click View Details View Details icon. The Details panel appears on the right, displaying the Properties tab. Click Code List Code List. If there is a code list defined, all code values are displayed in the table. Hover over a row and use the buttons that appear to edit or delete the row or to add a new row. While editing, you can add a description and a note to each code. While deleting, a row is first marked for deletion (which can be reversed with an Undo) and is actually deleted upon clicking Save.

Note:

While adding a new row, you can insert it at any position. The validation of an element's data against the code list happens regardless of the order. After a Save action, the code list is sorted alphabetically.

If you want to edit several rows in a code list, use the Export CSV action under Code List Actions to export the list to a comma-separated values file for editing in an external tool, such as a spreadsheet editor. The CSV file has a header row identical to the code list table. After the editing is complete, you can import it back using the Import CSV action. This overwrites the existing code list completely with the codes defined in the CSV file.

Multiple Code Lists for an Element

Occasionally, you may find elements with multiple code lists. One such example is the element TD101 (Packaging Code) for the document type EDI X12 850 (any version). This element has two code lists defined as follows:

Description of multiple_code_lists.png follows
Description of the illustration multiple_code_lists.png

The element's data value is a concatenation of one code from each of the code lists. For example, a value of AMM01 is a valid data value because it uses AMM from Code List 1 and 01 from Code List 2.

Customizing a Code List

An element is considered customized (with respect to code lists) if any of its associated code lists have codes that are different from the standard X12 codes. However, only changing the description or adding notes is not considered a customization because it does not affect the element's allowed data values or the validation.