Integration Procedure Basics

In this session/post we will learn about Integration Procedure Basics and learn about declarative server side processing in OmniStudio.

What is Integration Procedures?

Declarative, server-side processes that execute multiple actions in a single server call. Merge the output to multiple APIs and orchestrate multi-step calculations. Integration procedures can be used as a data source for an OmniScript, FlexCard, API, or Apex.

  1. Declarative object-to-object maps
  2. Declarative JSON/Object mapping
  3. Hierarchical REST interfaces
  4. JSON and XML-based transactions
  5. Declarative cache configurations
  6. Declarative data source management in
  7. Salesforce Industries Process Libraries
  8. Bulk transaction support

Omnistudio Integration Procedures build integrations 10x faster… with no code!

Integration Procedure Basics

Integration Procedures Overview

Integration procedures provide drag and drop designer build using same technology as OmniScript. It provide different action to run on Salesforce Servers to reducing round trips to client.

Integration Procedures Overview

When to use Integration Procedures?

Now question is when we should use Integration procedures in OmniStudio? Following are some reason where we can use Integration Procedures.

  1. You need to access and transform data from third-party sources.
  2. No user interaction is required.
  3. Moving the workload from client to server is preferable.

Integration Procedure – Data Input

IP can be used to to get data from Salesforce object using DataRaptor Extract, Or we can get data from external system using API and we can get data from Apex class as well using Remote Action.

Integration Procedure

Integration Procedure – Designer

In OmniStudio ntegration procedure designer divided into three following part:

  1. Available Components Panel
  2. Structure Panel
  3. Preview Pane
Integration Procedure - Designer

Common Mistakes in Integration Procedure

  1. When a partition has no allocation, cache operations are not invoked. By default VlocityMetadata and VlocityAPIResponse Partition cache have zero space allocation
  2. Send and Return more data than needed
  3. IP is not used for all data calls
  4. OmniStudio Integration Procedure is not used to performed some SOAP and Rest API callout
  5. Integration Procedure is not used to be exposed as Rest API

Best Practices of Integration Procedure

  1. Use Integration Procedures for all data calls to Salesforce.
  2. Use a Response Action for Integration Procedures to trim the data and only return what is needed. For specific trimming strategies, see Manipulate JSON with the Send/Response Transformations Properties.
  3. Use multiple Response Actions with different Execution Conditional Formulas to allow an Integration Procedure to exit early under appropriate conditions.
  4. Use caching to store frequently accessed, infrequently updated data.
  5. To run data operations asynchronously, call Integration Procedures using these settings:
    1. Use Future — Use when the calling OmniScript or Integration Procedure doesn’t need a response and completion time is not critical.
    2. Invoke Mode: Fire and Forget — Use instead of Use Future when the calling OmniScript must invoke the Integration Procedure immediately.
    3. Invoke Mode: Non-Blocking — Use to run the Integration Procedure immediately while continuing the user interaction of the calling OmniScript. A response is returned when the Integration Procedure is complete.

Integration Procedure Basics Video

YouTube video


OmniStudio Integration Procedures are declarative, server-side processes that execute multiple actions in a single server call. Check our our complete Salesforce OmniStudio Training.

Amit Chaudhary
Amit Chaudhary

Amit Chaudhary is Salesforce Application & System Architect and working on Salesforce Platform since 2010. He is Salesforce MVP since 2017 and have 17 Salesforce Certificates.

He is a active blogger and founder of Apex Hours.

Articles: 461


Leave a Reply

Your email address will not be published. Required fields are marked *