DataMapperDefinition

Represents a Data Mapper's header configurations, such as its name and type. Data Mappers transfer and transform data between Salesforce and Omnistudio components. They act as data sources in Flexcards and as actions in Omniscripts.

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

DataMapperDefinition components have the suffix .dataMapperDefinition and are stored in the dataMapperDefinitions folder.

Version

DataMapperDefinition components are available in API version 67.0 and later.

Special Access Rules

Fields

Field Name	Description
batchSize	Field Type double Description The number of items to process in a batch action. You can add any value up to 2000.
cleanResponseCacheType	Field Type CleanResponseCacheType Description Specifies the cache type used to store response data for this definition.
dataMapperDefinitionItem	Field Type DataMapperDefinitionItem Description The configuration of a component inside a Data Mapper.
description	Field Type string Description The description added to the Data Mapper.
expectedInputJson	Field Type string Description The sample input JSON format to assist the user with Data Mapper configuration, such as providing auto complete options.
expectedInputOtherData	Field Type string Description The expected custom input payload format to assist in the Data Mapper configuration when data must be transformed.
expectedInputXml	Field Type string Description The expected XML format of the input.
expectedOutputJson	Field Type string Description The sample output JSON format to assist the user with Data Mapper configuration in various ways, such as by providing auto complete options.
expectedOutputOtherData	Field Type string Description The sample output in a custom format to assist the user with Data Mapper configuration in various ways, such as by providing auto complete options.
expectedOutputXml	Field Type string Description The sample output XML format to assist the user with Data Mapper configuration in various ways, such as by providing auto complete options.
globalKey	Field Type string Description The globally unique identifier of the Data Mapper definition. Use this identifier to identify the component across Salesforce orgs.
inputParsingClassName	Field Type string Description The custom Apex class used to deserialize input to support any serialization format.
inputType	Field Type DataMapperInputType (enumeration of type string) Description The format of the input data, such as JSON, XML, SObject, and so on. Values Values are: `JSON` `XML` `SObject` `Custom`
isActive	Field Type boolean Description Indicates whether this Data Mapper is currently active (`true`) or not (`false`).
isAssignmentRulesUsed	Field Type boolean Description Indicates whether Salesforce Assignment Rules must used (`true`) or not (`false`).
isDeletedOnSuccess	Field Type boolean Description Indicates whether bulk records must be deleted after being successfully processed on bulk-loading (`true`) or not (`false`).
isErrorIgnored	Field Type boolean Description Indicates whether the Data Mapper definition must continue processing if there are errors (`true`) or not (`false`).
isFldLevelSecurityEnabled	Field Type boolean Description Indicates whether the Data Mapper definition must check the user's field-level access (`true`) or not (`false`).
isManagedUsingStdDesigner	Field Type boolean Description Indicates whether the Data Mapper is created or updated using the Omnistudio standard designer.
isNullInpIncludedInOput	Field Type boolean Description Indicates whether fields missing in the input (or null) must nullify the values in the record (`true`) or ignore the missing input and only update the fields that were provided in the input (`false`).
isProcessSuperBulk	Field Type boolean Description Indicates whether the Load Data Mapper processes the record upsert spread over multiple Salesforce Apex batch jobs (`true`) or not (`false`). Process Super Bulk is a Data Mapper property available if the Input Type is sObject. It helps process large jobs spread over multiple Salesforce Apex batch jobs without exceeding Salesforce governor limits.
isRollbackOnError	Field Type boolean Description Indicates whether the Data Mapper definition must continue executing if there's an error (`false`) or not (`true`). Control whether the current transaction is rolled back and any records created up until the point of error are removed.
isSourceObjectDefault	Field Type boolean Description Indicates whether it is the default Data Mapper definition setting for the specified Interface Object (`true`) or not (`false`).
isXmlDeclarationRemoved	Field Type boolean Description Indicates whether the XML header declaration must be removed (`true`) or not (`false`).
masterLabel	Field Type string Description The user-defined label of the component.
outputParsingClassName	Field Type string Description The unique identifier of the custom Apex class that's used to deserialize the output to support any serialization format.
outputType	Field Type DataMapperOutputType (enumeration of type string) Description The data format or object used in the output, such as JSON, XML, SObejct, PDF, or Document. Values Values are: `JSON` `XML` `SObject` `PDF` `Custom` `DocuSign`
overrideKey	Field Type string Description The unique identifier of the Data Mapper that's being overriden.
preprocessorClassName	Field Type string Description The custom Apex class name to be executed before the Data Mapper definition is triggered.
previewJsonData	Field Type string Description The preview of the Data Mapper's JSON with the existing input data.
previewOtherData	Field Type string Description The custom content in the Data Mapper's preview, when an input is added while previewing.
previewSourceObjectData	Field Type string Description The source object record in the Data Mapper's preview when an input is added while previewing.
previewXmlData	Field Type string Description The XML content in the Data Mapper's preview, when an input is added while previewing.
references	Field Type string Description The list of referenced components used by this definition.
requiredPermission	Field Type string Description The list of custom permissions that allow a user to execute the Data Mapper definition.
responseCacheTtlMinutes	Field Type double Description The number of minutes the Data Mapper Definition response must stay in the cache.
sourceObject	Field Type string Description The sObject used as an input in a Load Data Mapper.
synchronousProcessThreshold	Field Type double Description The foreign key to the Apex class the Data Mapper Definition references.
targetOutputDocIdentifier	Field Type string Description The envelope ID of a document template when using DocuSign.
targetOutputFileName	Field Type string Description The document name that receives the output of the Data Mapper Definition.
type	Field Type DataMapperType (enumeration of type string) Description Specifies the category or type of this component. Values Values are: `Extract` `Load` `Transform`
xmlOutputTagsOrder	Field Type string Description The XML tag sequence to be used in the output.