Retrieve Data with an Integration Procedure in an Omniscript

From an Omniscript, call an Integration Procedure to retrieve Salesforce data and external data. You can run multiple actions as a headless service (lacking a UI) through JavaScript or Apex Service.

Before you begin, create an Integration Procedure to handle Omniscript data.

Note When you add the same Integration Procedure action to two or more Omniscripts that have a parent-child relationship, set the values in the parent Omniscript, even if the value is intended for use in the child Omniscript.

1. After adding an Integration Procedure element, in the remote properties, enable the Integration Procedure's Queueable Chainable settings:

   Property	Value
   Future Method Use Future (in the designer for a managed package)	Specifies that the Integration Procedure runs asynchronously, as a Salesforce future method, which can return no data to the calling Omniscript.
   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.
   Queueable	Enables chainable steps in the subordinate Integration Procedure to start queueable jobs.
   Queueable Chainable	Enables the Queueable Chainable settings of the Integration Procedure.

2. In Remote Options, add this key-value pair:

   Key	Value
   useQueueableApexRemoting	true

3. Use the Extra Payload property to send additional key-value pairs to the Integration Procedure as input data.
4. Specify any additional Integration Procedure Action properties you need.
5. Use the Send/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.

6. Select the response behavior of the action by selecting an Invoke Mode.

   • 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 aren’t supported. When Invoke Mode is set to non-blocking, elements using default values won’t 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 aren’t supported. A response will still appear in the debug console but won’t be applied to the Data JSON.

7. 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.

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.