You are here:
Configure an Omnistudio Data Mapper Load
Configure a Data Mapper Load by specifying the object type and filters. To enhance the performance of the Data Mapper Load, you can define formulas, add fields to write data to, and configure additional properties.
- From the App Launcher, find and select Data Mappers.
- Select the Data Mapper Load that you want to configure.
-
Click Objects, and add a Data Mapper Load Object:
- To add an object, click +. If you’re using the designer on a managed package, click Add Object.
- From the Load Object list, search, and select an object.
-
Click Formula, add a formula, and define it for the Data Mapper
Load. See Use Formulas in Omnistudio Data Mappers.
- To add a Formula block, click +. If you’re using the designer on a managed package, click Add Formula.
- In the Formula field, enter the desired logic.
- In the Formula Result Path field, specify a JSON node in which you want to store the formula result.
-
If you’re using this Data Mapper for testing purposes, disable the formula. Click
, and
then click Disable. If you’re using the designer on a managed package,
select the Disabled checkbox.
-
Click Mapping, and then click Create Mapping.
If you’re using the designer on a managed package, click Fields and then
click +.
You can also use the Quick Match option to quickly match an input field to an output object field. You can match fields either manually using the Pair option or automatically using the Auto Match option.
-
Configure these settings for mapping:
- Input JSON Path: The key of the JSON node containing the data you want to write to Salesforce.
- Domain Object: The Salesforce object that you want to map to.
- Domain Object Field: The field in the Salesforce object that you
want to update. In fields that contain JSON data, you can't map JSON nodes individually.
Stringify all JSON nodes that have values to ensure that no JSON data is lost. For example:
"JsonField": "{\"JsonNode1\":\"Text\", \"JsonNode2\":100, \"JsonNode3\":true}"If you’re updating multiple Salesforce objects, the designer displays a separate tab for the mappings of each target object. See Multiple Related Object Loads (Link Mappings).
- Add Key-Value Pair: These mapping settings copy the value to a top-level JSON node specified as a key.
-
To control how the mapping is performed, you can configure these optional settings. If
you’re using the designer on a managed package, click All, and
configure these settings:
- Output Data Type: Must be compatible with the data type of the target field. The Output Data Type setting must be compatible with the target field in Salesforce. If you configure incompatible types, the load operation can fail. For a list of valid output types, see Omnistudio Data Mapper Output Data Types.
- Default Value: Value to be loaded if the field in the Data Mapper output JSON is null. To specify an empty string for string fields that are null, enter a pair of double quotes (""). Omit if Required for Upsert is enabled.
- Disabled: Prevents the field from being loaded.
- Upsert Key: Specifies that the field is a key for the Salesforce object being loaded. The Data Mapper uses the value to determine whether it updates an existing record or inserts a new one. If the Upsert property is enabled for multiple field mappings, the result is a multi-field upsert key. The Data Mapper uses this key to check the object for unique values to determine whether to create or update an object. Don’t use an ID as the upsert key. If the input contains an ID, the Data Mapper updates the record. If the input doesn’t contain an ID, Data Mapper creates a record.
- Required for Upsert: If this field is null, it prevents an object record from being updated.
- Lookup: Uses the field value to query for the specified Salesforce data, and writes the result to the output field.
- Save your changes. If you want to add more mappings, click Save & New. If you’re using the designer on a managed package, click +.
-
Configure these settings for mapping:
-
To configure additional properties, click Options and configure
these properties:
- Ignore Errors: Execute the Data Mapper even if errors occur, skipping only the steps that are having errors. This option is useful when you know a record will fail with limited data and future steps don't rely on previous steps.
- Rollback on Error: Don't create or update the sObjects if errors occur. For more information, see Apex Transactions and Transaction Control.
- Use Assignment Rules: Use assignment rules for sObjects such as Cases that have user assignment fields. For more information, see Set Up Assignment Rules. Unauthenticated guest users can’t trigger assignment rules. If emails are configured in Case assignment rules, checking this option automatically sends emails to users when Cases are assigned.
- Overwrite Target For All Null Inputs: If an input doesn't have a value, set the corresponding output value to NULL.
- Delete on Success: When the input type is sObject, use this option to automatically delete bulk records after successfully bulk-loading data.
- Is Default for Interface: When the input type is sObject, specify this Data Mapper as the default bundle for the specified interface object.
- Create Interface Objects for a Data Mapper Load
Provide external data, such as a CSV file, as an input to a Data Mapper Load. The external data can be imported into an interface object, which is a custom Salesforce object using a data import tool. Then, map the fields from the custom object to the target Salesforce records using a Data Mapper Load. When you load data to a Salesforce custom object, it fires an Apex trigger that calls a Data Mapper Load. The Data Mapper takes data from the interface object and writes the resulting data to other Salesforce record objects. - Multiple Related Object Loads (Link Mappings)
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.

