Add Integration Configuration Objects

Integration Configuration Objects (ICO), JSON based configuration entity, managed in Integration Catalog, that a Transform can read at runtime (via JavaScript) to get customer, partner, or environment‑specific settings instead of hardcoding them.

  • A company-scoped ICO can be used with both Company and Marketplace transforms.

  • ICOs can be used in JavaScript steps or transform steps that include child JavaScript steps that consume configuration values.

  • If a transform uses ICOs and the required configuration is not available, the transform returns an error unless fallback logic (e.g., hard-coded values) is implemented.

  • An ICO version in a Released state can be implemented in the transforms in either Edit or Released state.

Add and update Integration Configuration Objects

  1. Select the Main Menu icon.

  2. Select Integration Catalog.

  3. Select Integration Configuration Objects in the side menu.

  4. Select the Add button. The New Integration Configuration Object page displays.

  5. In the General section, fill in the following information:

    • Name field – Required. The unique name of the Integration Configuration Object.
    • Used With drop-down – Indicates whether the Integration Configuration Object is used with a Transform.

      Future releases will also support Link Actions.

    • Used by drop-down – The name of the Transform used by the ICO.

      The selected transform binds the ICO exclusively to that transform. All subsequent versions of the ICO must continue to use the same transform and cannot be associated with a different one.

    • Description field – Required. A brief description explaining what the Integration Configuration Object contains.
  6. Select the Save button.

    The screen is directed to the Integration Configuration Object Details page with the ICO in the Edit state and with the required sections populated.

  7. In the General section, the following fields can be edited when the Transform is in Edit status:

    • Name field – Required. The unique name of the Integration Configuration Object.
    • Description field – Required. A description explaining what the Integration Configuration Object contains.
    • Used With drop-down – Indicates whether the Integration Configuration Object is used with a Transform.

      Future releases will also support Link Actions.

    • Used by drop-down – The name of the Transform used by the ICO.

      The selected transform binds the ICO exclusively to that transform. All subsequent versions of the ICO must continue to use the same transform and cannot be associated with a different one.

    • Created By User drop-down – The name of the user who created the ICO. This field is auto-populated and cannot be edited.

    • Version Description drop-down – A brief description for the version.

    • Version field – The current version of the ICO. This field is auto populated and read-only.

  8. In the Configuration JSON section, upload the JSON-based Integration Configuration Object.

  9. Select the Move To button at the top of the screen to release the Integration Configuration Object to make it available in all other environments i.e. Prod, Val, and OLL.

    By default, the ICO is set to Edit Status unless it is manually changed to Released Status.

    The submit status indicator circle is filled in with green to indicate the ICO is in Released status.

  10. Select the Save button.

    The Integration Configuration Object is created with Version as 1.

  1. Select the Main Menu icon.

  2. Select Integration Catalog.

  3. Select Integration Configuration Objects in the side menu.

  4. On the Search Integration Configuration Objects screen, select the row of a ICO and select New version.

  5. On the New Version side panel, select Apply.

    An incremented version of Integration Configuration Object with the same ICO name is created.

Tips

  • An ICO in Released status cannot be updated. To upgrade an ICO, create a new version.
  • A new version can be created for ICOs in Edit and Released status.

Search and view all Integration Configuration Objects

  1. Select the Main Menu icon.

  2. Select Integration Catalog.

  3. Select Integration Configuration Objects.

  4. Select the Filter button.

    In the Filters panel, fill in one or more of the following fields to filter the results:

    • Name field – The unique name of the Integration Configuration Object.
    • Status drop-down – The status of the ICO.
      • Select All – Displays ICOs in Released and Edit state.
      • Edit – Displays ICOs in Edit state.

      • Released – Displays ICOs in Released state.

    • Used With drop-down – Indicates whether the Integration Configuration Object is used with a Transform.

    • Used by drop-down – The name of the Transform used by the ICO.

  5. Select Apply.

    The results will be displayed in a table based on the filter results.

  6. Select the link on the ICO name from the results table.

    • The General section displays the following information:
      • Name field – Required. The unique name of the Integration Configuration Object.
      • Description field – Required. A description explaining what the Integration Configuration Object contains.
      • Used With drop-down – Indicates whether the Integration Configuration Object is used with a Transform.

        Future releases will also support Link Actions.

      • Used by drop-down – The name of the Transform used by the ICO.

        The selected transform binds the ICO exclusively to that transform. All subsequent versions of the ICO must continue to use the same transform and cannot be associated with a different one.

      • Created By User drop-down – The name of the user who created the ICO.

      • Version Description field – A brief description for the version.

      • Version field – The current version of the ICO. This field is auto populated and read-only.

      • The uploaded JSON based ICO in the Configuration JSON section.