Build an Integration Procedure with Conditional Data Mapper Loads

Learning Objectives

After completing this unit, you’ll be able to:

• Build an Integration Procedure with branching capabilities.
  
• Add Data Mapper Loads to an Integration Procedure.
  

Build an Integration Procedure with Branching Capabilities

The Update Account Primary Contact OmniScript branches three different ways. Does that mean you need to build three different Integration Procedures to handle the data updates? While that's an option, there’s another solution—build a single Integration Procedure with branching capabilities. 

To match the OmniScript’s branching logic, this Integration Procedure has three ways of updating the records. It uses conditional actions to determine which of the Data Mapper Loads to execute. 

While it’s possible to add three different integration procedures or Data Mapper Loads directly to an OmniScript, doing so makes the OmniScript more complex. Extra logic in an OmniScript takes longer to execute, so it is generally best practice to do this type of work in an Integration Procedure.

The Integration Procedure’s Structure panel includes a Data Mapper Post Action (1) for each of the three Data Mapper Loads (2). The Action names describe their purpose: Update, change, or create a primary contact.

In the OmniScript’s StepContacts element, the option selected for RadioPriContact defines when a particular Data Mapper runs. In the Integration Procedure, set a condition in each Data Mapper Post Action that matches the option in the StepContacts element. 

The action properties include an Execution Conditional Formula field, which determines when the action executes. In this example, the DRUpdatePriContact Action (1) is set to execute the teamUpdatePriContact Data Mapper (2) when its Execution Conditional Formula (3) is RadioPriContact=="Update".

Here are the formulas for the Data Mapper Post Actions. 

Create Data Mapper Loads and Add Them to an Integration Procedure

To create each Data Mapper Load, you only need a portion of the JSON you pasted into the Integration Procedure Preview: the particular node of the array and the AccountId. Here are the different Send/Response Transformation and Additional Input properties for the Data Mapper Post Actions. 

When you create a Data Mapper Load, use the following tabs in the Data Mapper Designer to specify what you want the Data Mapper Load to do.

• Objects tab
  
• Fields tab
  
• Preview tab
  

Each Data Mapper Load has a different purpose, so let’s examine how you use the different tabs. 

The Objects Tab

Use the Objects tab to specify the Salesforce objects you want to update. 

1. In the Update Primary Contact Data Mapper, select Contact as the object because you want to save the updated primary contact data back to the Contact object.

2. In the other Data Mappers, select Account as the second object. This allows you to save the account’s new primary contact back to the Account object.

3. Link the Account object to the Contact object. Click +Add Link (1), select the primary contact custom field in the Domain Object Field (2), and select 1 - Contact and Id in the two Linked Object dropdowns (3).

This is a good example of the power of Data Mappers. You want to use the RecordId of the newly created or changed Contact to update the value of the Primary Contact field in the Account. The Data Mapper first creates the Contact and then uses data from that newly created record to populate other records linked to it (in this example, the Account).

The Fields Tab

Use the Fields tab to map the input data to the Salesforce object fields you want to update. 

The Input JSON Path (1) specifies the key of the JSON node containing the data you want to write to the Salesforce object. The Domain Object Field (2) specifies the field in the Salesforce object you want to update. Paste JSON into the Input JSON panel (3) to create input mappings, then use the Quick Match button (4) to match the input mappings to the object fields.

This process is the same for each of the Data Mapper Loads. The difference is in the JSON you paste into the Input JSON panel—this determines the mappings you need to match. 

A Data Mapper Load saves updates to records in Salesforce by overwriting existing data or creating new records if that data doesn’t yet exist. Two settings control this “Upsert” process. 

When you select the Upsert Key checkbox (1) for a field, this means it is required to match a unique record in Salesforce. Because you want to update an existing Account record, adding an Upsert Key is required.

There are two requirements when configuring a Data Mapper Load to create a new contact record.

• Do not create a new contact when one already exists. Select fields such as the Contact’s first name and last name to confirm a contact does not already exist.
  
• Include all of the required fields for that record type in your Data Mapper. In Salesforce, Last Name is the only required field in the Contact record. Select the Is Required for Upsert checkbox (2) to make sure data is present in that field. Otherwise, the Data Mapper will not upsert the record.
  

The Preview Tab

Use the Preview tab to test the Data Mapper’s output. 

1. Paste the JSON from the Integration Procedure into the Input panel (1).
   
2. Click the Execute button (2).
   
3. The Objects Created panel (3) lists the resulting objects, which are saved permanently.
   

You now understand how to build an Integration Procedure with conditional Data Mapper Loads.

We hope you’re starting to see how powerful OmniStudio tools can be when you use them together. In the next unit, you learn how OmniStudio tools work with another component in OmniStudio’s UI layer: FlexCards.