Integration Procedure Action Properties (Managed Package)

For the managed package runtime, this page contains information on Integration Procedure Action Properties.

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

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.

Property

Description

Integration Procedure

Specifies the Integration Procedure to be run in the format Type_Subtype.

Remote Options

Specifies additional properties for the Integration Procedure as key/value pairs.

Send Only Extra Payload

Enables the action to send Extra Payload's Key/Value pairs without including the Omniscript's data JSON.

Use Future

Specifies that the Integration Procedure runs asynchronously, as a Salesforce future method, which can return no data to the calling Omniscript.

Is Chainable

Enables the Chainable settings of the subordinate Integration Procedure.

Use Continuation

Enables a subordinate Integration Procedure that calls long-running actions to use Apex continuations.

Use Queueable

Enables chainable steps in the subordinate Integration Procedure to start queueable jobs.

Is Queueable Chainable

Enables the Queueable Chainable settings of the Integration Procedure.

Invoke Mode

Configures the response behavior of the action:

  • Default — Blocks the UI with a loading spinner.

  • Non-Blocking — Runs asynchronously, and the response is applied to the UI. Pre and Post Omnistudio Data Mapper transforms and large attachments are not supported. When Invoke Mode is set to non-blocking, elements using default values will not receive the response because the element loads before the response returns. To map the response to an element, you must set Response JSON Node to VlocityNoRootNode and Response JSON Path to the name of the element.

  • Fire and Forget — Runs asynchronously with no callback to the UI. Pre and Post Data Mapper transforms and large attachments are not supported. A response will still appear in the debug console but will not be applied to the Data JSON.

Extra Payload

Sends additional Key/Value pairs. Supports merge field syntax.

Show Toast On Completion

Displays a message when the subordinate Integration Procedure completes.