Omnistudio Data Mappers (Managed Package)

For the managed package runtime, a Data Mapper is a mapping tool that enables you to read, transform, and write Salesforce data. There are four types of Data Mapper: Turbo Extract, Extract, Transform, and Load.

This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

• Turbo Extract: Read data from a single Salesforce object type, with support for fields from related objects. Then select the fields to include. Formulas and complex field mappings aren’t supported. See Omnistudio Data Mapper Turbo Extract Overview (Managed Package).

• Extract: Read data from Salesforce objects and output JSON or XML with complex field mappings. Formulas are supported. See Omnistudio Data Mapper Extract Overview (Managed Package).

• Transform: Perform intermediate data transformations without reading from or writing to Salesforce. Formulas are supported. See Omnistudio Data Mapper Transform Overview (Managed Package).

• Load: Update Salesforce data from JSON or XML input. Formulas are supported. See Omnistudio Data Mapper Load Overview (Managed Package).

Data Mappers typically supply data to Omniscripts, Integration Procedures, and Cards, and write updates from Omniscripts, Integration Procedures, and Cards to Salesforce. A typical data flow is as follows:

1. Omniscript calls Data Mapper Extract to read data from Salesforce.

2. Omniscript interacts with user to capture changed and new data.

3. Omniscript calls Data Mapper Load to write data back to Salesforce.

Both Extract and Load Data Mappers can handle custom data formats. Data Mappers can access external objects and custom metadata as well as sObjects. No special syntax or additional configuration is required.

• Set Omnistudio Data Mappers to Use Managed Package Runtime and Objects (Managed Package)
  For the managed package runtime, when the Managed Package Runtime setting and Omnistudio permission set licenses are enabled, Data Mappers use processes on the Salesforce platform. To have them use the Apex processes in the managed package runtime and custom objects, set RollbackDRChanges to true. Each setting applies to all instances of the Data Mapper component.
• Omnistudio Data Mapper Turbo Extract Overview (Managed Package)
  For the managed package runtime, a Data Mapper Turbo Extract retrieves data from a single Salesforce object type, with support for fields from related objects. You can filter the data and select the fields to return. Unlike a standard Data Mapper Extract, a Data Mapper Turbo Extract doesn't support formulas. There’s no Output tab, so you can't use mappings to structure the output. Custom JSON, default values, attributes, and translations aren't supported.
• Omnistudio Data Mapper Extract Overview (Managed Package)
  For the managed package runtime, Data Mapper Extracts read Salesforce data and return results in JSON, XML, or custom formats. You can filter the data and select the fields to return. Formulas, attributes, default values, and translations are supported. Extracts typically provide Omniscripts, Integration Procedures, and Cards with the data they require.
• Omnistudio Data Mapper Transform Overview (Managed Package)
  For the managed package runtime, Data Mapper Transforms let you perform intermediate data transformations without reading from or writing to Salesforce. Formulas are supported.
• Omnistudio Data Mapper Load Overview (Managed Package)
  For the managed package runtime, Data Mapper Loads accept data in JSON, XML, or custom input formats and write the data to Salesforce objects. Formulas and attributes are supported.
• Omnistudio Data Mapper Best Practices (Managed Package)
  For the managed package runtime, to maximize the benefits of Data Mappers, follow the best practices whenever possible.
• List Input for Omnistudio Data Mappers (Managed Package)
  For the managed package runtime, Data Mappers can perform list transformations. For mapping input to output, Data Mappers require a list input in which every value is paired with a key.
• Use Formulas in Omnistudio Data Mappers (Managed Package)
  For the managed package runtime, to add data to the output of a Data Mapper, define formulas. Several types of Data Mapper (Extract, Transform, and Load) support formulas. When you define a formula, you map its output to the output JSON (for extracts and transforms) or Salesforce object field (for loads).
• Omnistudio Data Mapper Output Data Types (Managed Package)
  For the managed package runtime, many data types can be assigned to data in the Output JSON, including boolean, currency, string, various number and list types, and date formats.
• Omnistudio Data Mapper Developer Features (Managed Package)
  For the managed package runtime, you can call Data Mappers using Apex or a REST API. You can also use custom input and output and environment variables in Data Mappers.
• Omnistudio Data Mapper Administration (Managed Package)
  For the managed package runtime, Data Mappers have additional caching, security, batch, and debug settings. You can also export and deploy Data Mappers.
• Cache for Omnistudio Data Mappers (Managed Package)
  For the managed package runtime, Omnistudio offers multiple caching options to improve performance and minimize unnecessary data processing in Data Mappers. The two primary user-configurable caching types are Org Cache and Session Cache, which are available in the Data Mapper designer. These caching mechanisms are part of the Salesforce Platform Cache and are implemented through Vlocity Cache in Omnistudio with managed package runtime. Each serves a distinct purpose and comes with specific configuration considerations.
• Security for Omnistudio Data Mappers and Integration Procedures (Managed Package)
  For the managed package runtime, you can control access to Data Mappers and Integration Procedures using settings that reference Sharing Settings and Sharing Sets or Profiles and Permission Sets.