Working with code lists

You can create, edit, view details of, import, and export code lists, and add columns and items to a code list.

You can also perform common UI functions such as deleting and filtering code lists, and working with versions.

Table 1. Working with code lists
Task Procedure
Create a code list

  1. Click Document Envelopes > Code lists and click Create.

    The Create Code List page opens.

  2. Enter or select the code list basic properties, including the mandatory properties List Name and Tenant Id.

  3. Enter any optional properties (Sender Id, Receiver Id, and Comments), and click Save.
Import or update code lists by using the Resource Manager
  1. Click Resource Manager > Import.
  2. Choose an option:
    • Import all resources
    • Migrate Sterling B2B Integrator import file.

      This option identifies a Sterling B2B Integrator file as the source of the resources that are being imported.

    • Update existing resources. Select to keep your current default version as the default.
  3. Click Browse to upload the resource file.

    Available resources for importing are shown in the Available section. They are presented separately by resource type.

  4. Highlight one or more items, move them to the Selected section, and click Next.
  5. Review your selections and click Next.
  6. Click and view the report.
  7. Click Finish.
Convert a code list file to XML format when importing See Converting a resource file during import.
Edit a code list
  1. Click a map on the Code Lists page. The Basic Properties page opens.
  2. You can edit the fields for an existing form, or add items to the code list.
    • To edit a form, click Edit and edit fields.
    • To add items, click the Items bar to expand and click Create. Populate the new form.
A new version is created for the list or the form, as appropriate. Version information includes comments and date and time.
View Basic properties for a code list From the Code Lists page, click a code list. The Basic Properties detailed view is displayed, showing code list details.
Export code lists
  1. Click Resource Manager > Export.
  2. Under Types to Export, select Code Lists, and click Next.

    The selection of available code lists is displayed.

    Exported version: Only the default version is exported.
  3. Select one or more code lists, move them to the Selected dialog box, and click Next.
  4. Review your selections and click Next.

    The Export File name, Export Report file name, and their sizes are listed. The default file location is \user\AppData\Local\Temp\SPE1.

  5. Click the Export File name or the Export Report file name to open it for viewing or to save the file to a different location. Click Finish to return to the export choices
Add a column to a code list
  1. Click Document Envelopes > Code lists.
  2. Select a code list.

  3. Click the Columns bar to expand and click Create Code List Column.

    The Add Column page opens.

  4. Complete the properties according to your criteria for the new column, including the text strings for column names.
  5. Optionally, you can include a Description for the column name.
  6. Click Save Code List Column to return to the detailed view page for the selected code list.

After you create code list columns, you can assign one or more of those columns to a particular code item.
Add an item to a code list
  1. Click Document Envelopes > Code lists.
  2. Select a code list.

  3. Click the Items bar to expand and click Create Code List Item.

    The Add Item page opens.

  4. Complete the properties according to your criteria for the new item, including the Sender Code, Receiver Code, Start Date, End Date, and Description.
  5. Click Save Code List Item to return to the detailed view page for the selected code list.