OPUS Actions

The OPUS Actions app enables automation across OPUS apps by running custom JavaScript in response to supported OPUS events. Actions can automate tasks, add or edit data, and invoke Agents. Users can bind Actions at the Solution, Process Network, or Agent level. OPUS Action includes an event, binding configuration, environment variables, JavaScript code, an integration principal, and an activation state. Only active OPUS Actions execute when their configured event occurs.

  1. Select the Main Menu icon.

  2. Select OPUS Actions.

  3. Select Available in the side menu.

  4. Select OPUS Actions in the side menu.

    The Search OPUS Action screen appears.

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

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

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

    3. Select any app from the Application drop-down.
    4. Enter the event name in the Event field.

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

    6. Select true or false from the Active drop-down.

  7. Select Apply.

    The filtered results display in the table.

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

    • Name field – The name of the OPUS Action.
    • Description field – A description of the OPUS Action and its purpose.
    • Application field – The app associated with the OPUS Action.
    • Event field – The OPUS event that triggers the OPUS Action. Only active OPUS Actions execute when their configured event occurs. OPUS Actions support the following Event types:

      • POST_OPERATION – Runs the OPUS Action after an object operation completes successfully (e.g. after a Purchase Order is created). Because the business operation completes before the action runs, an action failure does not undo the completed business operation.

      • POST_TRANSITION – Runs the OPUS Action after a workflow transition completes successfully (e.g. after an Invoice completes a specified workflow transition). Use this event type for downstream automation that should occur after a workflow successfully reaches the required status.

    • Integration Principal User field – The integration principal associated with the OPUS Action. The integration principal provides the permissions required by the action to perform operations such as downstream API calls.

    • Binding Level field – The context in which the OPUS Action applies. The available binding levels are Solution, Process Network, and Agent.

    • Solution Keys – The solutions to which the OPUS Action is bound.

    • Process Network Names – The Process Networks to which the OPUS Action is bound when the binding level is Process Network.

    • Agent Keys – The agents to which the OPUS Action is bound when the binding level is Agent. An Agent binding does not automatically invoke the Agent. The action JavaScript must explicitly call the Agent API.

    • Active switch – Indicates whether the OPUS Action is active:

      • true – The OPUS Action is active and can execute when its configured Event occurs.

      • false – The OPUS Action is inactive and does not execute.

    • Source Action Definition field – The source OPUS Catalog Action Definition associated with the OPUS Action, if applicable. An OPUS Action created from a Catalog Action Definition is an independent local copy and is not automatically updated when the Catalog definition changes.

    • Target Action Definition field – The target Action Definition associated with the OPUS Action.

    • Environment Variables field – The environment variables configured for the OPUS Action. Environment variables provide environment-specific configuration to the OPUS Action and can be accessed by the JavaScript through the execution context. Select an environment variable to view its name and value.

      • Name field – The name of the selected environment variable.

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

    • Code Language field – The programming language used for the OPUS Action. OPUS Actions use JavaScript business logic that runs in response to the configured OPUS event.
    • Code field – The JavaScript that executes when the configured OPUS event occurs. The JavaScript can use the execution context to access the event payload, environment variables, logging functions, binding context, and supported APIs.

    9. Tips

    • Select the Edit button to update OPUS Action Details. In the Login Information section, all fields are read-only.

    • Select Save to Catalog to save the OPUS Action to the Catalog for reuse.

    • On the Search OPUS Actions screen, select the Activate or Deactivate button to activate or deactivate the OPUS Action. The Active switch displays the current activation status.

Create an OPUS Action

Before creating an OPUS Action, identify the OPUS event that triggers the action and determine where the action applies. The Action Builder role is required to create an OPUS Action.

  1. Select the Main Menu icon.

  2. Select OPUS Actions.

  3. Select Available in the side menu.

  4. Select OPUS Actions in the side menu.

    The Search OPUS Action screen appears.

  5. Select the New button.
    The New OPUS Action screen displays the expandable Basic Information and Code sections.

  6. Expand the Basic Information section and fill in the following fields:

    1. Name field – The name for the OPUS Action.

    2. Description field – The description of the OPUS Action.

    3. Application drop-down – The app associated with the OPUS Action.

    4. Event drop-down – The OPUS event that triggers the OPUS Action.

    5. Integration Principal User field – The Integration Principal with the permissions required to perform the operations used by the OPUS Action.

    6. Binding Level drop-down – Select the applicable binding level:

      • Solution – The OPUS Action applies to the selected Solution or Solutions.

      • Process Network – The OPUS Action applies only to the selected Process Network or Process Networks.

      • Agent – The OPUS Action applies based on the configured Agent criteria.

    7. Using the Add icon, add the applicable Solution Keys, Process Network Names, or Agent Keys based on the selected binding level.

  7. Expand the Code section and fill in the following fields:

    1. In the Environment Variables section, select the Add icon. In the Environment Variables side panel that opens, fill in the following fields:

      • Name field – The environment variable name.

      • Value field – The environment variable value.

    2. From the Code Language drop-down list, select JavaScript.

    3. In Code, enter the JavaScript logic that executes when the configured OPUS event occurs.

      A basic action follows this pattern:

      Copy 
      function execute(ctx) {
          ctx.log.info('Processing Action');

          return {
              success: true,
              response: '',
              errorString: ''
          };
      }
      execute

  8. Select one of the following:

    • Save – Adds the OPUS Action and displays the OPUS Action Details screen for the newly added OPUS Action.

    • Save and New – Adds the OPUS Action and displays a the New OPUS Action screen to add another OPUS Action.

    The OPUS Action is added and available for activation and testing.

Tips

  • Design each OPUS Action to perform a clear business responsibility. Smaller actions are easier to test, troubleshoot, and reuse.

  • Use environment variables instead of hardcoding environment-specific configuration (e.g. Process Network names or other identifiers).

  • Choose the appropriate binding level. Use:

    • Solution – For Solution-specific automation.

    • Process Network – For collaboration-specific automation.

    • Agent – When Agent participation determines whether the OPUS Action applies. An Agent binding does not automatically invoke an Agent. The action JavaScript must explicitly invoke the Agent.

After adding an OPUS Action, activate it when it is ready to execute in response to its configured event. Deactivate the OPUS Action when you no longer want it to execute. Only active OPUS Actions execute when their configured event occurs.

  1. Select the Main Menu icon.

  2. Select OPUS Actions.

  3. Select Available in the side menu.

  4. Select OPUS Actions in the side menu.

    The Search OPUS Action screen appears.

  5. Select the added OPUS Action.

  6. Select the Activate button.

  7. In the Activate side panel, select Apply to activate an OPUS Action.
    The Active column displays true when the OPUS Action is active.

    8. Tips

    • Select Deactivate to deactivate the OPUS Action and prevent it from executing when its configured event occurs. Once deactivated, the Active column displays false.

    • On the OPUS Actions Details screen, view the Active switch to see the current activation status.

Test an OPUS Action before using it in a production environment. Testing helps validate the configured event, bindings, environment variables, Integration Principal permissions, event payload, downstream API calls, and Agent invocation, if applicable.

Use logging during testing to understand the event payload and execution context, and complete the following steps:

  1. Trigger the event configured for the OPUS Action. For example, create a Purchase Order in MINT for an OPUS Action configured for the MINT Purchase Order creation event.

  2. Verify that the OPUS Action produces the expected result. For example, if the OPUS Action is configured to add an object in POET when a MINT Purchase Order is created, verify that the expected POET object is added.

Tip

  • Use logging during testing to confirm that the OPUS Action executed, inspect the event payload, verify the binding context, and troubleshoot action failures.

Use Save to Catalog to make tested OPUS Action logic reusable. When you save an OPUS Action to the Catalog, OPUS adds a reusable OPUS Catalog Action Definition.

  1. Select the Main Menu icon.

  2. Select OPUS Actions.

  3. Select Available in the side menu.

  4. Select OPUS Actions in the side menu.

    The Search OPUS Action screen appears.

  5. Select the OPUS Action hyperlink from the Search OPUS Actions table.

  6. Select the Save to Catalog button.

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

    • Name field – The name of the OPUS Catalog Action Definition.

    • Description field – A description of the OPUS Catalog Action Definition.

    • Catalog Scope drop-down – The scope of the OPUS Catalog Action Definition:

      • Marketplace – Creates a globally scoped OPUS Catalog Action Definition.

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

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

Tip

  • After saving the OPUS Action to the Catalog, view the saved OPUS Catalog Action Definition under Catalog > OPUS Action Definitions.