Adding Objects and Fields to Data Dictionaries

New objects can only be added in specific data dictionaries. To add a new object to a data dictionary:

  1. In the sidebar, select Data Dictionary and select any of the following dictionaries:
    • Gateway
    • File
    • Unifier
      • Notes:
      • For a checklist of all the features supported in each data dictionary, refer to the Features of Provider Data Dictionaries.
      • XML file format is not supported for objects added manually within the Gateway user interface. To ensure these objects and fields are included by Gateway during a data transfer you must set up a business flow and synchronization where the File provider is set as the destination provider, and select CSV, XLS, or XLSX file formats to ensure these objects will be available in the destination output.
  2. Select Add... to add a new provider object to a data dictionary

    The Object and Fields wizard displays.

  3. In the General step describe the object:
    1. Enter an Object Name for the new business object.
    2. Select a Category for the business object. Choices include: No Category (for Gateway only), BP, DynamicBP, DynamicUDR, and SOAP.
    3. Enter a Description of the business object.

      Note: Select Next on each screen to advance to the next step.

  4. In the Fields step to add one or more fields supported by the business object:
    1. Enter a Field Name for the new field.
    2. In the Field Type field, select the data type of the field. Choices include: Boolean, DateTime, Double, ForeignKey, Integer, and String.
    3. If you add a ForeignKey field, then select the Join to Object to join the new field with an existing object in that provider's dictionary.
    4. Select Read Only Field to indicate the field value cannot be modified.
    5. Select any of the following actions:
      • Select Add to add the field to the field table.
      • Select Delete to delete a field from the field table.
    6. Repeat the above sequence to add multiple fields to the business object.
  5. In the Flow Control step to indicate the combination of flow type and flow direction to be associated with the business object:
    1. In the Flow Type field, indicate if the business object will be available in a Master Data or Project Data flow, or both.
    2. In the Flow Type Direction field, indicate if the business object will be available in the Source or Destination provider, or both.
    3. Select any of the following actions:
      • Select Add to add the flow control combination to the flow table.
      • Select Delete to delete a flow control combination from the flow table.
    4. Repeat the above sequence to add multiple flow control combinations to the business object.
  6. In the Cross reference step setup the cross-reference key field to be associated with the Gateway object.
    1. In the Key Field field, select the field within the object that is to be used as the cross-reference key by the Gateway object.
    2. In the Gateway Objects field, select the Gateway business object from the drop-down to map the cross-reference key of the provider object.

      Note: You can also map the provider object to a new Gateway object that has already been added using this procedure. For more details, see Changing Cross-Reference Keys of Data Dictionary Objects.

    3. Select Add to add the cross-reference key and Gateway object combination to the Key table.
    4. Select Delete to delete a cross-reference and business object combination from the Key table.
  7. In the Summary step review a summary of all the selections made in the previous steps:
    1. Expand each tab title to review the selections made in that tab.
    2. Select any of the following actions:
      • Select Back to navigate to a specific tab and make changes.
      • Select Save to add a new provider object or update an existing object in the data dictionary.

Legal Notices | Your Privacy Rights
Copyright © 2016, 2021

Last Published Tuesday, October 12, 2021