OPUS Catalog Action Definitions

An OPUS Catalog Action Definition contains reusable, versioned logic for adding OPUS Actions. It can be available at the Marketplace or Company scope. Marketplace-scoped OPUS Catalog Action Definitions are provided by TraceLink and Marketplace Providers and are available to customers. Company-scoped OPUS Catalog Action Definitions are created by a company and are available within that company.

When an OPUS Action is saved to the Catalog, OPUS copies its reusable content to an OPUS Catalog Action Definition. Environment-specific configuration, including Solution, Process Network, or Agent bindings and environment-variable values, is excluded. Environment-variable keys are retained. The OPUS Catalog Action Definition is referenced as the Target on the local OPUS Action.

When an OPUS Action is created from an OPUS Catalog Action Definition, OPUS creates an independent local copy. Environment-specific configuration is provided for the new Action. The source OPUS Catalog Action Definition is referenced as the Source on the local OPUS Action.

Changes to the source definition do not automatically update the local OPUS Action. Changes to the local OPUS Action do not modify the source definition. An OPUS Catalog Action Definition is versioned. When a newer version becomes available, existing OPUS Actions created from an earlier version remain unchanged.

  1. Select the Main Menu icon.

  2. Select OPUS Actions.

  3. Select Catalog in the side menu.

  4. Select OPUS Action Definitions in the side menu.

    The Search OPUS Catalog Action Definition screen appears.

  5. Select the Filter button.
  6. In the Filters side panel, use any of the following filters to view OPUS Catalog Action Definition:

    1. Enter the OPUS Action Definition name in the Name field.

    2. To search for the exact name, select the Enable exact keyword search checkbox.

    3. Enter the provider name in the Provider field.

    4. To search for the exact name, select the Enable exact keyword search checkbox.

    5. Enter the event name in the Event field.

    6. To search for the exact name, select the Enable exact keyword search checkbox.

  7. Select Apply.

    The filtered results display in the table.

  8. Select the OPUS Catalog Action Definition hyperlink in the results table and and see the information that displays in the OPUS Catalog Action Definition Details screen.

    • Name field – The name of the OPUS Catalog Action Definition.
    • Description field – A description of the OPUS Catalog Action Definition.
    • Provider field – The provider of the OPUS Catalog Action Definition.
    • Scope field – The scope of the OPUS Catalog Action Definition:

      • Marketplace – A globally scoped OPUS Catalog Action Definition.

      • Company – A company-scoped OPUS Catalog Action Definition for reuse within the permitted company scope.

    • Event field – The OPUS event associated with the OPUS Catalog Action Definition.

    • Binding Level field – The binding level associated with the OPUS Catalog Action Definition.

    • Version Number field – The version number of the OPUS Catalog Action Definition.

    • Approval Status field – The approval status of the OPUS Catalog Action Definition.

    • Created By User field – The user who created the OPUS Catalog Action Definition.

    • Creation Date/Time field – The date and time the OPUS Catalog Action Definition was created.

    • Last Updated By User field – The user who last modified the OPUS Catalog Action Definition.

    • Last Updated Date/Time field – The date and time the OPUS Catalog Action Definition was last modified.

    • Environment Variables field – The environment-variable names included in the OPUS Catalog Action Definition. Environment-variable values are excluded when an OPUS Action is saved to the Catalog.

      • Value field – The value assigned to the selected environment variable.

    • Code Language field – The programming language used for the OPUS Catalog Action Definition.
    • Code field – The reusable JavaScript logic included in the OPUS Catalog Action Definition.

    9. Tips

    • Select Save As to create a local OPUS Action from the OPUS Catalog Action Definition. The resulting OPUS Action is an independent local copy.

Use Save As to create a local OPUS Action from an OPUS Catalog Action Definition. OPUS copies the reusable content from the selected definition to the new local OPUS Action.

  1. Select the Main Menu icon.

  2. Select OPUS Actions.

  3. Select Catalog in the side menu.

  4. Select OPUS Action Definitions in the side menu.

    The Search OPUS Catalog Action Definition screen appears.

  5. Select the required OPUS Catalog Action Definition hyperlink from the Search OPUS Catalog Action Definitions table.
    The OPUS Catalog Action Definition Details screen appears.

  6. Select Save As to add a local OPUS Action from the Catalog Definition.

  7. In the Save As side panel, fill in the following required fields:

    1. Name field – The name of the new local OPUS Action.

    2. Description field – A description of the new local OPUS Action.

  8. Select Apply.
    The local OPUS Action is created and is available under Available > OPUS Actions.

Tips

  • Select Available > OPUS Actions in the side menu.
    The Search OPUS Action screen appears.

  • Select the newly added OPUS Action hyperlink from the Search OPUS Actions table.
    The OPUS Action Details screen appears.

  • Configure the local bindings, environment-variable values, and Integration Principal. See Configure a new OPUS Action.

  • Review and edit the copied JavaScript as required. See Configure a new OPUS Action.

  • Activate the OPUS Action. See Activate and deactivate an OPUS Action.

  • Test the OPUS Action. See Test an OPUS Action.

  • An OPUS Action Definition is versioned. When a newer version becomes available, existing OPUS Actions created from an earlier version remain unchanged.

OPUS Catalog Action Definitions are versioned. Each version represents reusable OPUS Action logic available at a specific point in time.

When an OPUS Action is created from an OPUS Catalog Action Definition, OPUS creates an independent local copy. Publishing a newer version does not automatically change OPUS Actions created from an earlier version. This preserves local configuration and modifications.

For example:

OPUS Catalog Action Definition v1 → Save As → Local OPUS Action

If OPUS Catalog Action Definition v2 is published later, the existing local OPUS Action remains unchanged.

Review newer versions to determine whether to use the updated reusable logic. Existing OPUS Actions continue to use their local configuration and logic until explicitly changed.