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.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
For example, when a user running a case-handling Omniscript finishes entering data and clicks Save, the script calls a Data Mapper Load to record the data entered.
A Data Mapper Load can obtain its input data in the following ways:
-
Omniscript or Integration Procedure: During execution, an Omniscript or Integration Procedure builds a Data JSON that is populated with the data required for the business use case. When the script invokes the Data Mapper Load, the Data JSON is sent as input.
-
Interface object: Create a custom object and populate it with data for the Data Mapper Load. Use Salesforce Bulk Loader or other load tools to insert data into the object. If you must modify the data before it’s inserted into the object, define a preprocessor class. This approach lets you load data from flat files, for example. (See Interface Objects for External Data Loads (Managed Package).)
Omnistudio doesn't support interface objects, but Omnistudio for Managed Packages does.
-
Data Mapper API REST call: If the Data Mapper is invoked using a POST action, the Data JSON can be included in the payload of the call.
-
Apex code: Specify the Data JSON as a parameter in the call to the Data Mapper Load.
Custom objects must have unique names and shouldn't use API names that already exist for custom objects in a managed package. Custom objects are accessed in the managed package namespace and not as an object without a namespace. For example, in the vlocity_ins__ namespace, a custom object named Policy__c is the same as the existing vlocity_ins__Policy__c.
To modify the input data, you can define formulas, transform values, and change the output data type. (See Use Formulas in Omnistudio Data Mappers (Managed Package).) To specify how the resulting data is to be written to Salesforce objects, you map fields from the output JSON to fields in Salesforce objects. (See Object Field Mapping (Managed Package).) When invoked, the Data Mapper Load applies its mappings and formulas to the input data to create the output data. Then it loads the output data into Salesforce objects according to the mappings.
- Create an Omnistudio Data Mapper Load (Managed Package)
For the managed package runtime, to create a Data Mapper Load, specify its name, input and output types, permissions, and options. - Object Field Mapping (Managed Package)
For the managed package runtime, on the Fields tab, you map data from the Omnistudio Data Mapper Load input JSON to the target Salesforce object and field. You can also handle data types, attributes, and default values. - Multiple Related Object Loads (Link Mappings) (Managed Package)
For the managed package runtime, when loading data into a sequence of objects, you can propagate data directly from one object to another related object. For example, you can use an Omnistudio Data Mapper Load to support an Omniscript that creates an Account and a Contact for the Account. - Interface Objects for External Data Loads (Managed Package)
For the managed package runtime, to provide data from an external source (for example, a CSV file) to an Omnistudio Data Mapper, create an interface object and optionally a preprocessor class. Interface objects are custom Salesforce objects. - Test an Omnistudio Data Mapper Load (Managed Package)
For the managed package runtime, you can test the results of a Data Mapper Load on the Preview tab. - Omnistudio Data Mapper Load Examples (Managed Package)
For the managed package runtime, Data Mapper Load examples demonstrate formulas and object relationships, and working with attributes.