Mapping Field Definitions
The mapping file consists of the following constructs in the JSON file:
Mapping Field Name | Required | Default Value | Description |
---|---|---|---|
description |
false | none | Mapping description |
isActive |
false | true | Status of mapping |
reltioObjectType |
true | none | Reltio entity type URI |
sobject|sobject{type, recordTypeId, startField, endField} |
true | none | Object with next attributes:
Note: The
startField and endField details are required for objects of the relation type only.Example:
|
sfdcSource |
false | none | Salesforce crosswalk type |
relation |
false | true for relation types | Specifies that this mapping entry is a custom object relation. This must be set to true for relation types. |
startObjectType |
For relation types only | none | Reltio entity type for the start object of the relation. |
endObjectType |
For relation types only | none | Reltio entity type for the end object of the relation |
to_salesforce |
false | none | Mapping of field for replication from Reltio to Salesforce |
to_salesforce/filter |
false | none | Salesforce to Reltio filter for entire entity. For example: [equals(attributes.SyncFlag, True)] |
to_salesforce/attributeMapping |
true | none | List of one to one attribute mappings |
/attributeMapping/sfdcAttrName |
true | none | Salesforce field Name |
/attributeMapping/value |
true | none | Value that must be propagated to the Salesforce object. Possible values are:
|
to_salesforce/relatedObjects |
false | none | List of the Salesforce object related to the root Salesforce object |
/relatedObjects/sobject|sobject{type,recordTypeId} |
true | none | Related object with attributes:
|
/relatedObjects/filter |
false | none | Filter criteria for relation objects while replicating data from Reltio to
Salesforce. For example:
[equals(configuration/entityTypes/Org/attributes/Address/attributes/Rank,1)]
|
/relatedObjects/relationshipName |
false | none | Relationship names of the related object. Example:
Address_vod__r By default, must get first relationship in Salesforce |
/relatedObjects/rootUri |
false | none | Reltio attribute URI |
/relatedObjects/recordTypeId |
false | none | |
/relatedObjects/attributeMapping |
true | none | List of one to one mapping for the related object. |
/relatedObjects/attributeMapping/sfdcAttrName |
true | none |
Salesforce object attribute name Salesforce object fields that are External ID fields cannot be mapped. |
/relatedObjects/attributeMapping/value |
true | none | Value that must be propagated to the Salesforce object. Possible values are:
|
/deleteRelatedObjects |
false | none | Custom Salesforce objects mapped to a nested entity attribute will be removed if the entire nested attribute is removed in Reltio platform. |
/relations |
false | none | List of objects. Multiple relation types are supported for entity types applicable only for Salesforce lookup relations. It must be configured for a child Salesforce object that has a special field with a reference ID to the parent object. |
/relations/relationType |
true | none | This is the Relation type defined in Reltio metadata. The
startObject type defined in relation metadata should be present in
the mapping and match the parent Reltio object type defined in the mapping (type
inheritance is not supported). The endObject type defined in relation
metadata should match the Reltio object type defined in mapping where relation is
configured (type inheritance is not supported). For example:
configuration/relationTypes/Affiliation . |
/relations/sfdcAttrName |
true | none | This is the Salesforce object field name that contains a reference to the parent object (Salesforce lookup relation). The Parent object type is determined by Salesforce metadata and should match to the Salesforce object type defined in parent object mapping. |
to_reltio |
false | none | Defines mapping of fields to be replicated from Salesforce to Reltio |
to_reltio/filter |
false | none | Filter criteria for the object to be replicated to Reltio. For example
[equals(attributes.Name, Main Street)] . Same structure as other
Reltio filters. |
to_reltio/attributeMapping |
true | none | List of one to one attribute mapping |
/attributeMapping/uri |
true | none | Reltio entity URI |
/attributeMapping/value |
true | none | Value that must be propagated to the Salesforce object. Possible values are:
|
/attributeMapping/sobject |
false | none | Can be string (recordTypeId is Master Record Type) or object with next
attributes:
|
/attributeMapping/filter |
false | none | Filter criteria for the entire entity. For example -
[equals(attributes.Name, Main Street)] Same structure as other Reltio filters. |
/attributeMapping/compoundFieldName |
false | none | Must be filled with compoundFieldName for embedded Address.
Example: ShippingAddress |
/attributeMapping/forceRefEntityMerge |
false | true | forceRefEntityMerge allows you to create new values for reference attributes
instead of updating the existing operational values (OV). For example, when a user
changes address in Salesforce, the connector creates a new location attribute
instead of updating the existing location with new values that become OVs. Match
rule is used to merge the values.
If the If the If the |
/relations |
false | none | Array of objects. Multiple relation types are supported for Sobject . |
/relations/relationType |
true | none | This is the Relation type defined in Reltio metadata. For
example: configuration/relationTypes/Contact . |
/relations/sfdcAttrName |
true | none | This is the Sobject field name that contains a reference to the parent. |