You are here:
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.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
-
Input JSON Path — The key of the JSON node containing the data you want to write to Salesforce.
-
Domain Object Field — The field in the sObject 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) (Managed Package).
Mapping Options
To control how the update is performed, you can configure the following optional settings:
-
Is 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. 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.
-
Is Required for Upsert — Prevents an object record from being updated if this field is null.
-
Is Lookup — Uses the field value to query for the specified Salesforce data, and writes the result to the output field.
-
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 (Managed Package).
-
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 Is Required for Upsert is enabled.
Attribute Data Loads
To change the value of an object attribute using a Data Mapper Load, specify the attribute using its code (not its name) preceded by @. (An attribute is assigned a GUID value when created, but you can edit the code to specify a human-readable value. Outside of Data Mapper Designer, Salesforce displays the GUID, regardless of whether you override it.) To add a profile attribute to an object, enable Upsert Key for the object Id.Overview of Attributes
In Spring '20 and later releases, in the Domain Object Field, type-ahead is supported for up to 500 attributes. For example, you can type @C to display attributes beginning with the letter C and select from the dropdown list instead of typing the entire attribute name manually.
For example, to assign Gold Star Status to an account, set the corresponding attribute
to on as follows:
Mappings:
Input JSON Path |
Domain Object Field |
Upsert Key |
|---|---|---|
GoldStarAccount |
@GoldStarAccount |
(unchecked) |
Id |
Id |
(checked) |
Input JSON:
{
"Id": "0016100001Ey84K",
"GoldStarAccount": "on"
}
When assigning values to attributes, specify values that are data-type-compatible as follows:
-
On-Off: To apply the attribute to the object, specify
"On",true, or"true". To remove the attribute from the object, specify"Off",false, or"false". -
Three-state: Specify a negative value, a positive value, or 0.
-
1 to 5: Specify a value from 1 to 5. Values less than 1 are treated as 1, and values greater than 5 are treated as 5.
-
TextComment: String data
Product attributes can’t be added to or modified for the Product object using Data Mapper Loads. You can modify product attributes for the following objects:
-
Asset
-
CompiledAttributeOverride__c
-
ContractLineItem__c
-
FulfilmentRequestLine__c
-
InventoryItem__c
-
OpportunityLineItem
-
OrderItem
-
ProgramEnrollment__c
-
QuoteLineItem
A Data Mapper Load can’t create a Product Attribute for a Line Item. It can only modify existing Product Attributes for existing Line Items.
