1. Orchestrator Guide
  2. Defining Data Structure

Defining Data Structure

In the Data Dictionary tab, you can add data dictionary items, Boolean, and arrays to the data structure.

  1. Access the Data Dictionary tab in the Logic Extensions page. This tab is displayed by default when you start creating a new logic extension.

  2. To add a data dictionary item:

    1. Click the + Data Dictionary button.
    2. In the Data Dictionary window, enter the required data dictionary alias in the Alias field and then click the + icon. You can also use the Search, Type, and Size fields to filter and find the required data dictionary item.
    3. The Name field is editable. Change the value in the Name field if required.
    4. The Required option for all the data dictionary items is disabled by default. Enable this option if required.
    5. Select the value from the IO type drop-down list. If you select the IO type as Output Only or Both, you can enter an output variable name.
  3. To add a Boolean:
    1. Click the +Boolean button.
    2. The Name field is editable. Change the value in the Name field if required.
  4. (Release 9.2.7) To add an array:
    1. Click the +Array button.
      Note: When you add an array as a data dictionary item, the system adds an array variable in the <Arrayname><id>.length format in the Variables tab. These <Arrayname><id>.length variables are not editable but you can reorder them.
    2. The Name field is editable. Change the value in the Name field if required.
    3. The Required option is disabled by default. Enable this option if required.
    4. Select the value from the IO type drop-down list. If you select the IO type as Output Only or Both, you can enter an output variable name.
  5. Click Save.

    The system enables you to add members to the newly added array. When you add a data structure after adding an array, an option to add the data dictionary item to the array is displayed in the Data Dictionary window.

    For example, see the following screenshot. When you add an AN8 data dictionary item after adding Array1 and Array2 in the Data Dictionary tab, you can see the Add to Array drop-down menu and you can choose to add AN8 to Array1 or Array2. To do so, select the required array and then click the Add "+" icon.

    This image is described in following text.

    When you click the +Boolean button after adding an array, the system displays the Add to Array window. You can either choose the array name from the Array field to add the Boolean to an array or leave this field blank.

    The values in the Required field and the IO type field for all the data dictionary items added to the array is inherited from the parent array. For example, if you define an array as Input Only and enabled the Required option, all the data dictionary items added to that array will have the IO type as Input Only and Required option enabled.

  6. (Release 9.2.7.3) To add a control:
    1. Click the +Add Control button.
    2. The Name field is editable. Change the value in the Name field if required.
    3. The Required option is disabled by default. Enable this option if required.
    4. In the Data Type drop-down list, Form Control is selected by default. To select an array of form controls, click the Data Type drop-down list and select Form Control List.
  7. Click Save.
To delete a data dictionary item, click the X icon at the end of a row.
Note: The system deletes all the data dictionary items with in an array when you delete an array type data dictionary item.

Duplicating a Data Dictionary Item

To duplicate a data dictionary item, you can click the drop-down menu next to the Name field and select either Duplicate as Data Structure, Duplicate as Variable, or Duplicate into Array (Release 9.2.7). The system automatically generates a unique ID with a value in the Name field and the Output Variable(if applicable) for the duplicated item. The Name and Output Variable fields are editable.
Note:
  • You have to manually change the name for the new duplicated data structure to avoid the duplicated name validation error.
  • You cannot duplicate an array into an array. When you click the drop-down menu next to an array Name field, you will see the Duplicate as Data Structure and Duplicate as Variable options. The Duplicate into Array option is disabled.