Salesforce OmniStudio Integration Procedures are advanced tools designed to help organizations streamline and automate their business processes by integrating with various external systems. This guide provides an in-depth understanding of Integration Procedures, covering their key features, building elements, and best practices.
Salesforce OmniStudio Integration Procedures are server-side processes that facilitate complex data transformations and seamless integration with external systems. These procedures enable businesses to orchestrate multiple actions within a single transaction, ensuring data consistency and improving operational efficiency.
Key Features of Omnistudio Integration Procedures
- Declarative Configuration: Build integration processes using a user-friendly interface without extensive coding knowledge.
- Reusability: Create reusable integration procedures that can be applied across multiple applications and business processes.
Source: Trailhead Integration Procedures serve as data sources for multiple technologies
- Performance Optimization: Execute complex data transformations and integrations efficiently, reducing API callouts and processing time.
- Error Handling: Robust error handling mechanisms to manage exceptions and ensure data integrity.
- Security: Leverage the Salesforce security model to ensure data protection and compliance with industry standards.
How to Create an Integration Procedures
-
Sign up for Omnistudio/ Vlocity Developer org:
Here’s how to request one if this is your first time reading an OmniStudio content: Sign up for a special Developer org.
- Navigate to Vlocity /OmniStudio Integration Procedures:
- Go to the OmniStudio application in Salesforce.
Select “Integration Procedures” from the available options or search in App launcher.
Integration Procedure
- Create a New Integration Procedure: Click on the “New” button to create a new Integration Procedure. Provide a name and description for the Integration Procedure.
- Add Elements to the Procedure: Use the drag-and-drop interface to add Data Raptors/Mapper, HTTP Actions, Remote Actions, Loop Blocks, and Conditional Blocks. Configure each element with the necessary parameters and logic to meet your business requirements.
- Define the Response Structure: Add a Response Action to specify the data returned by the Integration Procedures. Map the output fields to ensure the correct data is being sent to the calling service.
- Test and Activate: Test the Integration Procedure to ensure that it works as expected.
Activate the Integration Procedure to make it available for use in OmniScripts or flexcards.
Build Elements
- DataRaptor (DataMapper): A tool to extract, transform, and load the data within Integration Procedures.
- HTTP Action: Perform HTTP callouts to external systems, enabling real-time data synchronization.
- Remote Action: Call the Apex classes or other Salesforce services to perform complicated logic or data manipulation.
Integration Procedures Configuration
- Loop Block: Iterate over a collection of records to perform actions on each record individually.
- Conditional Block: Execute actions based on specific conditions, providing flexibility in the processing logic.
- Response Action: Define the response structure returned by the Integration Procedure, ensuring that the right data is delivered to the calling service.
Source: Trailhead
Configure Response Action 1 to tell the Integration Procedure what data to send back. To trim the data and return only what you need, enter the previous element name in the Send JSON Path 2 field.
Source: Trailhead
On the Preview tab, enter a Key-Value pair in the Input Parameters panel 1, such as AccountId(ContextId) for the Key and an Account RecordId for the Value.
Click Execute 2 to run the Integration Procedure. The Response window 3 returns results to confirm it is extracting data correctly.
In the Errors/Debug Output Debug Log 1, which helps to work through and identify any problem with the output and input for each element in the Integration Procedures. To ensure the Dataraptor is connected to the Integration Procedures, select the debug log you want 2 and confirm the Account info displays.
Best Practices
- Modular Design: Break down complex processes into smaller, reusable Integration Procedures to simplify maintenance and enhance reusability.
- Error Handling: Implement robust error handling to manage exceptions gracefully and maintain data integrity.
- Performance Optimization: Use efficient data transformation and integration techniques to reduce API callouts and minimize processing time.
- Documentation: Document each Integration Procedure thoroughly to provide clarity on its functionality and usages.
- Security: Ensure that your Integration Procedures adhere to Salesforce’s security best practices, protecting sensitive data and complying with industry regulations.
Benefits
- Use Integration Procedures as data source whenever possible due to the streamlined structure of IP, efficiency, and consistency.
- IP provides optimal flexibility, makes implementation easier, and greatly improves the performance of FlexCards and OmniScripts.
- Replacing Apex classes with Integration Procedures offers several advantages, including easier maintenance and updates and significantly reduced development time.
Conclusion
OmniStudio Integration Procedures are essential tools for automating and optimizing business processes through seamless data integration and transformation. By understanding their key features, elements, and best practices, you can create efficient and reliable integration solutions that enhance your organization’s operational efficiency and data consistency.
Mastering Integration Procedures empowers you to deliver robust and scalable integration solutions, driving business success in today’s competitive landscape.
