Building an IP starts in OmniStudio, drag actions in sequence, configure each action''s input and output mappings, save, activate, test.
- Open the Integration Procedure designer
OmniStudio app, Integration Procedures tab, click New. Name the IP and pick the procedure type.
- Add DataRaptor Extract Actions
Drag DataRaptor Extract actions onto the canvas. Each one queries a Salesforce object and returns the result into the IP''s shared state.
- Add transformation steps
Use Set Values, Conditional Block, or Format Date actions to shape the data for the consumer.
- Build the response
Configure the Response Block at the end. Pick the fields and structure to return; the consumer sees only what the response includes.
- Save and activate
Save the IP. Activate the new version. The active version is what consumers call.
- Test via the Debug pane
Open the Debug pane, provide test inputs, run the IP, inspect the response JSON. Iterate until the output matches expectations.
User-facing identifier referenced by OmniScripts and external callers.
The ordered list of operations the IP performs.
The final block that shapes the output JSON.
Only one version can be active at a time.
- IPs run as the calling user, respecting their FLS and sharing. A DataRaptor inside the IP that returns no rows when called by a restricted user is usually a security setting, not a bug.
- Caching is per-IP and per-input-hash. Cached IPs that depend on the calling user may return wrong data for another user; design cache keys carefully.
- Errors inside an IP propagate to the caller unless wrapped in a Try/Catch. Without explicit error handling, a single DataRaptor failure can break an entire OmniScript.
- OmniStudio is licensed separately. Confirm the org has the OmniStudio package installed before designing IPs.