You are here:
Create an Integration Procedure (Managed Package)
For the managed package runtime, to create an Integration Procedure, you must name it, configure it, define its logic, and preview how it runs. You can also view debugging information and set options that apply only to previews.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
For step-by-step details of how to build Integration Procedure examples, see the block and action topics under Group Integration Procedure Steps Using Blocks (Managed Package) and Integration Procedure Actions (Managed Package).
- Go to the Vlocity Integration Procedures tab.
- Click New. The New Integration Procedure screen is displayed.
-
In the Procedure Configuration section, specify the following settings:
-
Integration Procedure Name — The name displayed on the Integration Procedures tab when you expand the Type/SubType node. Make the Name unique.
-
Type and SubType — The top-level node on the Integration Procedures tab under which you want the Integration Procedure listed. The Type can be a category. Make the SubType unique.
After providing a Name, Type, and SubType, you must click Save. You only have to save this one time.
-
Description — A general description of the Integration Procedure.
-
Tracking Custom Data — Key/value pairs to be recorded when the Integration Procedure is executed, if tracking is enabled.
-
Include All Actions in Response — Write the results of each action to the root level of the Data JSON. By default, results are written to the Data JSON under a node with the same name as the action.
-
Rollback on Error — If an error occurs, roll back data manipulation language (DML) statements.
-
Required Permission — If specified, this setting limits who can run this Integration Procedure. Specify a comma-separated list of custom permission names.
-
Chainable and Queueable Chainable Limits — These settings control how long-running procedures are executed when there’s a risk of hitting Salesforce governor limits. For details, see Settings for Long-Running Integration Procedures (Managed Package).
-
Cache Configuration — These settings control caching of Integration Procedure metadata and JSON data. See Cache for Omnistudio Data Mappers (Managed Package).
-
-
To define the logic for the Integration Procedure, drag blocks and actions from the palette to the Structure panel in the Properties pane. For details about blocks, see Group Integration Procedure Steps Using Blocks (Managed Package). For details about actions, see Integration Procedure Actions (Managed Package).
When a step executes, its results are written to the Data JSON under a node with the same name as the step. Subsequent steps can access the data that was written to the Data JSON by preceding steps.
- To test the Integration Procedure, click Preview. In the Input Parameter pane, specify any parameters that must be provided by callers, then click Execute. Verify that the JSON results are composed correctly according to the requirements of the caller.
- To correct a component, click it in the Structure panel and edit its properties.
-
To view debugging information in Preview mode, display the Error/Debug Output pane on the right side of the Integration Procedure Designer. This pane contains the following subpanes:
-
Debug Log — Output from the execution of each step in the procedure.
-
Errors — Any errors that occurred during execution.
-
Options — JSON containing Boolean flags that you can set to enable or disable run-time options for debugging. These options are for debugging only, and by default aren’t in effect when the Integration Procedure is called from an Omniscript.
-
isDebug — Enable or disable display of debugging information.
-
chainable — Enable or disable chaining during execution, to prevent a long-running procedure from exceeding Salesforce governor limits. For details about chaining, see Settings for Long-Running Integration Procedures (Managed Package).
-
resetCache and ignoreCache — Enable or disable caching features. For details about caching, see Cache for Omnistudio Data Mappers (Managed Package).
-
-
-
To create a new version of an Integration Procedure, click Create
Version.
To clone an Integration Procedure instead, change the Integration Procedure Name and SubType, then click Save. Changing the Type is optional.
-
To activate an Integration Procedure so other Omnistudio components can call it,
click Activate Version.
Only one version can be active at a time. You can't edit the active version.
