Integration Procedure Action (Managed Package)

For the managed package runtime, invoke an Integration Procedure to retrieve Salesforce data and external data.

Managed Package app icon This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

Before You Begin

Create an Integration Procedure to handle Omniscript data.

  1. Drag the Integration Procedure Action into the Omniscript's structure panel.
  2. To select the Integration Procedure to be called, click in the Integration Procedure field, and select from the list. You can type in the field to filter the list.
  3. Use the Response Transformations properties to specify the input and to trim or rename the output JSON.
    • Send JSON Path — Specifies the JSON node that contains the input for the Integration Procedure. This is typically the name of a previous element in the Omniscript.

    • Send JSON Node — Renames the JSON node that contains the input for the Integration Procedure. This is typically the name of one of the Integration Procedure's input parameters.

    • Response JSON Path — Specifies the JSON node that contains the output to return to the Omniscript. By default, all Integration Procedure data is returned.

    • Response JSON Node — Renames the JSON node that contains the output to return to the Omniscript. This is typically the name of a subsequent element in the Omniscript.

    See Manipulate JSON with the Send/Response Transformations Properties (Managed Package).

  4. (Optional) Use the Extra Payload property to send additional key/value pairs to the Integration Procedure as input data.
  5. Specify any additional Integration Procedure Action properties you need.
  6. (Optional) Enable the Integration Procedure's Queueable Chainable settings by taking these steps:
    1. Click the Is Queueable Chainable? checkbox to enable the settings.

    2. In Remote Options, add this Key-Value pair:

      Key

      Value

      useQueueableApexRemoting

      true

  7. (Optional) When Invoke Mode is set to non-blocking, elements using default values don’t receive the response because the element loads before the response returns. You must configure these properties to map the response to an element:

    Property

    Value

    Response JSON Node

    VlocityNoRootNode

    Response JSON Path

    The name of the Omniscript Element receiving the value.

    See Manipulate JSON with the Send/Response Transformations Properties (Managed Package).

Note
Note When an Omniscript invokes an Integration Procedure asynchronously, the Integration Procedure continues running if the user goes to the next step, but not if the user navigates away from the Omniscript.
Note
Note When RollbackIPChanges is enabled in Omni Interaction Configuration and an Integration Procedure fails with an exception, the response JSON nests the error at result.error instead of at the root level. Because the root-level error node is absent, the Omniscript doesn't detect the failure and continues executing subsequent steps. To handle errors in this scenario, use one of these workarounds:
  • Add a Response Action to catch the error from the nested result.error path.
  • Add a try-catch block inside the Integration Procedure to handle the exception before it propagates.