Explore Data Mapper Types

Learning Objectives

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

• List the different types of Data Mappers available in Omnistudio.
  
• Describe the primary function of each Data Mapper type.
  

Explore Data Mapper Types

You now know that Data Mappers can get, transform, and write data to Salesforce objects. But not all Data Mappers can do all of these tasks.

There are four types of Data Mappers, each with a role to play.

In this unit, you explore each of them in depth. But, first, here’s an overview of each type and what they do.

Let’s get started exploring each type of Data Mapper!

Data Mapper Turbo Extract

Data Mapper Turbo Extracts ‌get data from a single Salesforce object and fields from that object’s related objects.

This is the simplest type of Data Mapper. And you can set it up quickly for simple single-object data pulls with better performance than more complicated Data Mapper Extracts. But Turbo Extracts don’t support formulas, custom JSON, default values, or complex transformations directly.

So Data Mapper Turbo Extracts are the best choice for simple data calls. For example, if you only want to return data from one object—like address fields from the Account object—a Data Mapper Turbo Extract works well. Here’s an example.

There’s a single configuration tab for a Data Mapper Turbo Extract, where you set the filters and select the fields you want to include.

Data Mapper Turbo Extracts can be called from other Omnistudio components like Omniscripts, Integration Procedures, and Flexcards. They can also be called from Apex classes and REST APIs.

Data Mapper Extract

Data Mapper Extracts get data from one or more Salesforce objects and their related objects. You explored one in the designer in the previous unit.

Unlike Turbo Extracts, Extracts can read Salesforce data from multiple objects and return the results, supporting various output formats, including JSON, XML, and custom types. They can also filter retrieved data and use formulas.

Data Mapper Extracts can apply default values and translations to the data during extraction. You can structure the output data, substitute values using key-value pairs, and map formula results to the output structure. Extracts support caching to speed up frequently-used data. Field-level security is supported, too.

For all of these reasons, use Data Mapper Extracts to get data that’s more complicated than the simple, single-object calls where you ‌use a Turbo Extract.

For example, imagine you want to return data about an account, all of its related opportunities, and all of its previously purchased products. You also want to return the total value of all of the account’s open and closed opportunities. A Data Mapper Extract is the best choice. It isn’t possible to get a list of child records with the simpler Turbo Extract.

Data Mapper Extracts can be called from other Omnistudio components like Omniscripts, Integration Procedures, and Flexcards. They can also be called from Apex classes and REST APIs.

Data Mapper Transform

Omnistudio Data Mapper Transforms don’t extract data, but instead manipulate any data from inside or outside Salesforce. This data is passed to Data Mapper Transforms by other Data Mappers or Integration Procedures. They can perform intermediate data transformations without reading from or writing to Salesforce objects.

Data Mapper Transforms take the data they receive and change the structure, content, and format. For example, they can:

• Rename fields by mapping input paths to define output paths.
  
• Substitute values using key-value pairs, such as converting Y to True.
  
• Apply formulas to add new calculated values.
  
• Convert data to different outputs, such as JSON, XML, or a custom format.
  

Data Mapper Transforms only have two tabs in the designer: Formula and Transforms.

The Formula tab is where you define formulas to add and manipulate your data, such as formatting a date in the screenshot here. The Transforms tab is where you map data from the input to the output. You set how the data is mapped and organized. This includes changing data to the formats needed to fill documents like PDF, DocuSign, or other Document Templates.

When can you use these capabilities? Imagine you designed an Omniscript that collects information from the customer for an agreement they must sign as part of a transaction. After the customer or service rep enters all of the data in the Omniscript, you use a Data Mapper Transform to format the data into the specific JSON format to populate the PDF or DocuSign template. A Data Mapper Transform is the perfect tool because it manipulates input data without reading from or writing to Salesforce objects during the transformation process.

Data Mapper Transforms can be called from Omnistudio Integration Procedures and Omniscripts, or Apex code.

Data Mapper Load

Data Mapper Loads save data to one or more Salesforce objects. They can take data from various sources and write it directly to Salesforce by updating or creating records.

They’re flexible in what data they accept, and can process inputs in JSON, XML, or custom formats. Before writing data to Salesforce, Data Mapper Loads can also modify the data, using formulas to calculate values, substitute values, and change the output data type. This way, you perform manipulations within a Load without having to use a Transform.

To configure a Data Mapper Load, you specify the target objects and then define mappings to link the field in your input data to the field on the Salesforce object. Data Mapper Loads also support Upsert Keys, which intelligently determine whether to update an existing record or create a new one.

In the designer, there are three tabs in a Data Mapper Load: Objects, Formula, and Mapping.

The Objects tab is where you specify the objects to which data should be saved. In the screenshot here there’s a single object, but you can add others by clicking . The Formula tab is where you manipulate the data, as in other types of Data Mappers. Finally, the Mapping tab is where you map the data to the fields of its target objects.

Data Mapper Loads are often used within other Omnistudio components like Omniscripts or Integration Procedures to write data to Salesforce.

For example, imagine you have an Omniscript that helps service reps update customers’ account mailing addresses and primary contacts. As the service rep enters information, data is temporarily held within the Omniscript Data JSON. When the service rep finishes, you use a Data Mapper Load to take that information and update and create account and contact records.

Warning

As you start to experiment with Data Mappers, be aware that when you test a Data Mapper Load in preview mode, the changes are saved permanently to Salesforce.

Knowledge Check

Ready to review what you’ve learned? This knowledge check isn’t scored—it’s just an easy way to quiz yourself. To get started, drag the Data Mapper type in the left column next to the matching use case on the right. When you finish matching all the items, click Submit to check your work. To start over, click Reset.

OK, you now know about the four types of Data Mappers. In the next unit, learn about the Data Mapper development process and some tips and best practices for creating your own Data Mappers.

Resources

• Salesforce Help: Omnistudio Data Mapper Turbo Extract
• Salesforce Help: Omnistudio Data Mapper Extract
• Salesforce Help: Omnistudio Data Mapper Transform Overview
• Salesforce Help: Omnistudio Data Mapper Load