Vlocity Facts #49 ||Using Integration Procedure as Rest API

In Salesforce OmniStudio, we can fetch the data, create records or perform update operations by exposing an Integration Procedure to third-party applications. Instead of relying on Apex classes or methods, the Integration Procedure handles the data processing and record creation, allowing us to seamlessly create, fetch, update records in Salesforce from external systems.
In this post will show how to create, update a Account, Case and user records by using Integration Procedure as REST API.

Follow these Steps to implement the use case.
To create records we need to get all the required the fields. In Integration procedure by using set values we can identify whether we got all required fields to create, update the records.

For this example I'm going to use below mentioned json.

{
    "accountDetails": {
        "FirstName": "Community",
        "LastName": "User6",
        "Email": ".com",
        "DateOfBirth": "1999-12-12",
        "Premium": "Yes",
        "Partner": "Gold"
    },
    "caseDetails": {
        "Subject": "Performance Issue",
        "Description": "While I'm playing game it is getting over heated",
        "Type": "Laptop",
        "Priority": "High",
        "Mobile Number": "999999999",
        "SIDN": "9999",
        "CaseReason": "Performance"
    }
}

Start by creating Integration Procedure.

Error Handling Scenario
Set Values: By using set values I will get to know whether required fields I have received or not.

Response Action: Based on the Boolean value true, false I will conditionally execute the response action. If required fields are missing I will send "Required fields are missing to create case." by using response action.

Happy Path: Account, Case and User record creation.
  • Create a load data raptor - Select the ‘Interface Type’ as ‘Load’ and ‘Output Type’ as ‘SObject’ and click Save, select ‘Account’, 'Case' in the Objects tab.
  • I'm Using "Upsert" option on Email, Last Name, First Name field to update the existing account details.

  • Add the Input JSON Path and Domain Object Field or paste the json in "Input Json" and use Quick match to map the JSON path and Domain Object.
Use Data Mapper Extract to extract the Account and case details for creating the user record.
To get the existing User Details I have added User object to get the Id for upsert options in next step. 
I'm using one more IP to create User record. Due to salesforce limitation which we cannot perform the creation at a time on Setup and Non-setup objects. 
In remote options I have added one parameter "useFuture" as true.
Child Integration Procedure:
And Data Mapper Post to create/update User records.

Using "Email Action" to send email after case creation.

To test the above Integration Procedure as rest API
To test the integration, you can use tools like Workbench, Postman, or others. In this example, we will use Workbench. First, log in to Workbench, navigate to the 'Utilities' tab, and select 'REST Explorer.' Then, choose the 'POST' method instead of 'GET,' and prepare the URL as outlined in the next step.

/services/apexrest/{namespace}/v1/integrationprocedure/{Type}_{SubType}/

I have replaced the {namespace} in the URL with the correct namespace for my organization (e.g., OmniStudio), and substituted {Type}_{SubType} with the appropriate type and subtype of the Integration Procedure created earlier. The final URL would look like this

/services/apexrest/omnistudio/v1/integrationprocedure/Salesforce_Hackathon/

Response of the Integration Procedure

In conclusion: Instead of utilizing Apex code for the REST API, we leveraged OmniStudio Integration Procedures and DataRaptors to expose Salesforce to third-party applications, successfully creating records in Salesforce. By implementing this OmniStudio feature, we provide a seamless and efficient method for performing REST-based web services without the need for custom code.

OutPut:













Comments

Post a Comment

Popular posts from this blog

Vlocity Facts #01 | OmniStudio DataRaptors

DataRaptor is a mapping tool that  you can use to read, transform, and write Salesforce data. For Example. In each interaction with a digital customer  or business process, the system needs to extract the data in order to display it. If the user modifies this data or enters new data, they also need to be saved. This is where we use OmniStudio DataRaptors.  Where to use DataRaptors? Retrieving Data:   OmniScript calls  DataRaptor Extract (via the integration procedure) to read the data from Salesforce. For example, OmniScript editing an account should display data such as account name, phone number, website, and so on. Manipulating data: OmniScript captures modified and new data based on user input. For example, an agent changes the  phone number of an account. Save Data:   OmniScript calls DataRaptor Load (via the integration procedure) to write the data back to Salesforce. For example, the updated account phone number is saved back to the Account rec...
Read more

Vlocity Facts #44 || Communication between Omniscript and Flexcard [Pub/Sub]

Image
Flexcards have the ability to trigger and listen to two kinds of events: Custom and Pubsub events . Custom Events: Facilitate the transmission of information between a child and its parent. This can occur between a child Flexcard and its parent Flexcard, or between an element and the Flexcard to which it belongs. Pubsub Events: Allows communication between two separate components. This could occur between two separate Flexcards on the same Lightning page, known as sibling Flexcards, or between a Flexcard and an Omniscript.  In this post I will discuss about Pub/Sub event. Consider we have omniscript and flexcard individually on home page when an update happens we need to show those details in flexcard. To achieve this we can use pub/sub event. Step 1: Create a omniscript according to your requirement. I'm trying to create Contact record by using Step element and data raptor post action. Now to trigger the flexcard we need to configure the messaging frame work when an update happen...
Read more

Vlocity Facts #45 || Pop-Up Screen and Navigating to the Next Step in Omniscript by using LWC

Image
Consider one scenario where we need to show confirmation screen when user proceeding to next steps after updating details.  To achieve this, you'll need to use a custom button: when a user clicks it, a pop-up screen will appear, which can be implemented using LWC. Create LWC component  1. HTML code 2. JS code import { LightningElement , track } from 'lwc' ; import { OmniscriptBaseMixin } from "omnistudio/omniscriptBaseMixin" ; export default class ConfirmationScreenLWC extends OmniscriptBaseMixin ( LightningElement ) { @ track isOpen = false ;   handleShowPopUp() {         this .isOpen = true ;     }     handleOk() {         this .omniNextStep();     }    handleClose() {         this .isOpen = false ;     } } Enable a custom Lightning web component to interact with OmniScript by extending the OmniScriptBaseMixin component. The OmniScriptBaseMixin include...
Read more