Vlocity Facts #54 || How to Invoke a DataMapper from LWC in Omnistudio (Vlocity)

Instead of writing custom Apex classes and their associated test classes, developers can use DataMappers within LWCs to handle data operations in a more efficient, declarative way. DataMappers are designed to read, transform, and write Salesforce data without the need for extensive Apex logic. They provide a low-code approach to data integration, which simplifies development and reduces dependency on custom code.

To call a DataMapper from a custom Lightning Web Component (LWC), we use the getDataHandler method provided by Omnistudio’s. This method handles communication with backend services like DataRaptors, Integration Procedures.

import { LightningElement } from "lwc";
import { OmniscriptBaseMixin } from "omnistudio/omniscriptBaseMixin"; 
//replace omnistudio with vlocity_ins/vlocity_cmt or with your installed package namespace
import util from "omnistudio/utility";

We need to create the request data and input parameters and pass it to getDataHandler method.

// Method to call the DataRaptor
    callDataRaptor() {

        // Step 1: Prepare the request object for DataRaptor
        let drRequest = {
            type: "DataRaptor",
            value: {
                bundleName: "AccountDetailsDR",  // Replace with your actual DataRaptor bundle name
                inputMap: "{}",                  // Input parameters (to be filled below)
                optionsMap: "{}"                 // Optional parameters
            },
        };

        // Step 2: Add dynamic input parameters to the inputMap
        drRequest.value.inputMap = JSON.stringify({
            accountId: this.omniJsonData?.accountId,
            region: this.omniJsonData?.region
        });

Note: Use the format "this.omniJsonData?.accountId" where accountId is the data we want to pass it from omniscript to lwc. We can pass other details as well not only from omniscript.
We have to stringify the input which we are going to pass into the callDataRaptor() function.

Full code:

import { LightningElement } from "lwc";
import { OmniscriptBaseMixin } from "omnistudio/omniscriptBaseMixin"; 
//replace omnistudio with vlocity_ins/vlocity_cmt or with your installed package namespace
import util from "omnistudio/utility"; 

export default class DataraptorCallerLwc extends OmniscriptBaseMixin(LightningElement) {

    // Method to call the DataRaptor
    callDataRaptor() {

        // Step 1: Prepare the request object for DataRaptor
        let drRequest = {
            type: "DataRaptor",
            value: {
                bundleName: "AccountDetailsDR",  // Replace with your actual DataRaptor bundle name
                inputMap: "{}",                  // Input parameters (to be filled below)
                optionsMap: "{}" 
            }                
        };

        // Step 2: Add dynamic input parameters to the inputMap
        drRequest.value.inputMap = JSON.stringify({
            accountId: this.omniJsonData?.accountId,
            region: this.omniJsonData?.region
        });

        // Step 3: Call the DataRaptor using util.getDataHandler
        util.getDataHandler(JSON.stringify(drRequest))
            .then((response) => {
                const parsedResponse = JSON.parse(response);
                console.log("DataRaptor Response:", parsedResponse);

                // Step 4: Optionally load the response data into Omniscript using omniApplyCallResp
                this.omniApplyCallResp({ accountDetails: parsedResponse });

            })
            .catch((error) => {
                console.error("DataRaptor Call Error:", error);
            });
    }
}

In this way we can call DataRaptor from LWC.

Connect with me on LinkedIn for more updates/scenarios related to Omnistudio.

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 #39 || DataMapper - Functions and Formulas

Image
In Data Mapper we can use functions and formulas to manipulate our data or we can change the out come of the values according to our requirement. In this post we will go through some of the formulas which we used in daily requirements. 1. Consider the following example: we have a list of products and need to filter them depending on their color or name. By using FILTER() function we can separate the list which has Green products. FILTER(LIST(Products),'Color == "Green"') Result: 2. We are getting list of contacts or cases and we need to display those records by sorting with DSC or ASC. By using   SORTBY() we can sort the list by using this formula.   SORTBY ( LIST ( Nephews ),  ' Name ',' [ : DSC ] ' ) Result:  Note: we can use [:DSC] only in Data Mapper Transform. 3. We can use SUM(), AVG(), MIN(), MAX() functions to return the Sum/Avg/Min/Max of the list or individual values. Result:  4. We can executes a SOQL query to produce a JSON list of values. ...
Read more