OmniDataTransform

Represents the header configuration of a DataRaptor.

Parent Type

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

File Suffix and Directory Location

OmniDataTransform components have the suffix .omniDataTransform and are stored in the OmniDataTransforms folder.

Version

OmniDataTransform components are available in API version 54.0 and later.

Special Access Rules

To use this metadata type, you must have an Omnistudio license and the Discovery Framework feature enabled in your Salesforce org.

Fields

active

Field Type: boolean
Description: Indicates whether the omni data transformation is active (true) or not (false).
Default value: false

assignmentRulesUsed

Field Type: boolean
Description: Indicates whether Salesforce Assignment Rules must be used (true) or not (false).
Default value: false

deletedOnSuccess

Field Type: boolean
Description: Indicates whether bulk records must be deleted after successfully processed on bulk loading (true) or not (false).

description

Field Type: string
Description: The comment added in the Omni Data Transformation.

errorIgnored

Field Type: boolean
Description: Indicates whether the Omni Data Transformation must continue processing if there are errors (true) or not (false).

expectedInputJson

Field Type: string
Description: The expected JSON input payload format to assist in the Omni Data Transformation configuration.

expectedInputOtherData

Field Type: string
Description: The expected custom input payload format to assist in the Omni Data Transformation configuration.

expectedInputXml

Field Type: string
Description: The expected XML input payload format to assist in the Omni Data Transformation configuration.

expectedOutputJson

Field Type: string
Description: The expected JSON output payload format to assist in the Omni Data Transformation configuration.

expectedOutputOtherData

Field Type: string
Description: The expected custom output payload format to assist in the Omni Data Transformation configuration.

expectedOutputXml

Field Type: string
Description: The expected XML output payload format to assist in the Omni Data Transformation configuration.

fieldLevelSecurityEnabled

Field Type: boolean
Description: Indicates whether the Omni Data Transformation must check the user field-level access (true) or not (false).

inputParsingClass

Field Type: string
Description: Custom class that’s used to deserialize input to support any serialization format.

inputType

Field Type: OmniDataTransformInputType (enumeration of type string)
Description: The data format in the input. Values are:
- Custom
- JSON
- SObject
- XML

isManagedUsingStdDesigner

Field Type: boolean
Description: Indicates whether the Omni Data Transformation is managed using standard designer (true) or not (false).

name

Field Type: string
Description: Required.

The name that uniquely identifies a Omni Data Transformation.

namespace

Field Type: string
Description: The namespace associated with the omni data transformation record.

nullInputsIncludedInOutput

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).

omniDataTransformItem

Field Type: OmniDataTransformItem[]
Description: The configuration of a component inside a DataRaptor.

outputParsingClass

Field Type: string
Description: Custom class that’s used to serialize output to support any serialization format.

outputType

Field Type: string
Description: The data format or object that’s used in the output (JSON, XML, SObejct, PDF, Document).

overrideKey

Field Type: string
Description: Reserved for future use.

preprocessorClassName

Field Type: string
Description: The Apex class name to be executed before the Omni Data Transformation (acting as a before insert trigger/process).

previewJsonData

Field Type: string
Description: The preview of input JSON.

previewOtherData

Field Type: string
Description: The preview of input other data.

previewSourceObjectData

Field Type: string
Description: The preview of input source object records.

previewXmlData

Field Type: string
Description: The preview of input XML.

processSuperBulk

Field Type: boolean
Description: Indicates whether the load Omni Data Transformation process the record upsert spread over multiple Salesforce Apex batch jobs (true) or not (false).

requiredPermission

Field Type: string
Description: The list of custom permissions required to execute the Omni Data Transformation.

responseCacheTtlMinutes

Field Type: double
Description: The number of minutes the Omni Data Transformation response must stay in the platform cache.

responseCacheType

Field Type: string
Description: The platform cache used to store the Omni Data Transformation response, either org cache or session cache.

rollbackOnError

Field Type: boolean
Description: Indicates whether the Omni Data Transformation must not commit if there is an error (true) or commit what has been executed (false).

sourceObject

Field Type: string
Description: The SObject that’s used as input in a Load Omni Data Transformation.

sourceObjectDefault

Field Type: boolean
Description: Indicates whether it’s the default Omni Data Transformation setting for the specified interface object (true) or not (false).

synchronousProcessThreshold

Field Type: double
Description: The number of input records that can be processed synchronously in a Load Omni Data Transformation. If it’s more than this number, then it uses a batch job.

targetOutputDocumentIdentifier

Field Type: string
Description: The envelope ID of the document template.

targetOutputFileName

Field Type: string
Description: The document name that receives the output of the Omni Data Transformation.

type

Field Type: string
Description: Required.

The definition of what the Omni Data Transformation performs: extract (SOQL), transform, or load (DML).

uniqueName

Field Type: string
Description: The unique name for the Omni Data Transformation.

versionNumber

Field Type: double
Description: A numeric version that’s used with subtype, type, and language to create a unique identifier for Omni Data Transformation.

xmlDeclarationRemoved

Field Type: boolean
Description: Indicates whether the XML declaration (e.g. <?xml version=“1.0” encoding=“UTF-8”?>) must be removed (true) or not (false).

xmlOutputTagsOrder

Field Type: string
Description: The XML tag sequence to be used in the output.

OmniDataTransformItem

Represents the configuration of a component inside a DataRaptor.

defaultValue

Field Type: string
Description: The default value that’s used in output map.

disabled

Field Type: boolean
Description: Indicates whether the output must not be generated (true) or is active and must be generated (false).

filterDataType

Field Type: ODTItemFilterDataType (enumeration of type string)
Description: The field data type that’s used in a Turbo Omni Data Transformation. Values are:
- ADDRESS
- ANYTYPE
- BASE64
- BOOLEAN
- COMBOBOX
- CURRENCY
- DATACATEGORY
- DATE
- DATETIME
- DOUBLE
- EMAIL
- ENCRYPTEDSTRING
- GROUPREFERENCE
- ID
- INTEGER
- LONG
- MULTIPICKLIST
- PERCENT
- PHONE
- PICKLIST
- REFERENCE
- STRING
- TEXTAREA
- TIME
- URL

filterGroup

Field Type: double
Description: The grouping of WHERE clauses in the SOQL.

filterOperator

Field Type: string
Description: The operator in the WHERE clause of the SOQL.

filterValue

Field Type: string
Description: The field in the WHERE clause of the SOQL.

formulaConverted

Field Type: string
Description: The reverse polish notation of the formula.

formulaExpression

Field Type: string
Description: The formula that the user typed in.

formulaResultPath

Field Type: string
Description: The variable name where the formula output is stored.

formulaSequence

Field Type: double
Description: The sequence of execution of the formulas.

globalKey

Field Type: string
Description: The globally unique identifier of the Omni Data Transformation Item that’s used to identify the product across Salesforce orgs.

inputFieldName

Field Type: string
Description: The field or variable path that’s used in the configuration of the inputs.

inputObjectName

Field Type: string
Description: The object that’s used in the configuration of the inputs.

inputObjectQuerySequence

Field Type: double
Description: The execution sequence of the inputs.

linkedFieldName

Field Type: string
Description: The field name that’s used to look up another object in a Load Omni Data Transformation.

linkedObjectSequence

Field Type: double
Description: The UI number (sequence number) associated with the object that’s used in the lookup in a Load Omni Data Transformation.

lookupByFieldName

Field Type: string
Description: The field name that’s used to look up a record in a Load Omni Data Transformation output.

lookupObjectName

Field Type: string
Description: The object name that’s used to look up a record in a Load Omni Data Transformation output.

lookupReturnedFieldName

Field Type: string
Description: The field name that must be returned and used in the lookup in a Load Omni Data Transformation output.

migrationAttribute

Field Type: string
Description: Field that’s used for DataPacks.

migrationCategory

Field Type: string
Description: Field that’s used for DataPacks.

migrationGroup

Field Type: string
Description: Field that’s used for DataPacks.

migrationKey

Field Type: string
Description: Field that’s used for DataPacks.

migrationPattern

Field Type: string
Description: Field that’s used for DataPacks.

migrationProcess

Field Type: string
Description: Field that’s used for DataPacks.

migrationType

Field Type: string
Description: Field that’s used for DataPacks.

migrationValue

Field Type: string
Description: Field that’s used for DataPacks.

name

Field Type: string
Description: Required.

The Omni Data Transformation name where this configuration belongs to.

omniDataTransformation

Field Type: string
Description: Omni Data Transformation associated with the item configuration

omniDataTransformationId

Field Type: string
Description: The ID of the Omni Data Transformation associated with this item configuration.

outputCreationSequence

Field Type: double
Description: The sequence of the output path items.

outputFieldFormat

Field Type: string
Description: The data type of the field, node, or tag in the output path.

outputFieldName

Field Type: string
Description: The field, node, or tag in the object that’s used in the output path.

outputObjectName

Field Type: string
Description: The name of the object that’s used in the output path.

requiredForUpsert

Field Type: boolean
Description: Indicates whether the field is mandatory for the upsert (true) or not (false).

transformValuesMappings

Field Type: string
Description: The key-value pair JSON list that’s used to convert output values into another value.

upsertKey

Field Type: boolean
Description: Indicates whether the field is the key to find the records to upsert in the object (true) or is a value that’s to be used during the upsert (false).

Declarative Metadata Sample Definition

The following is an example of an OmniDataTransform component.

1<?xml version="1.0" encoding="UTF-8"?>
2<OmniDataTransform xmlns="http://soap.sforce.com/2006/04/metadata">
3    <active>false</active>
4    <assignmentRulesUsed>false</assignmentRulesUsed>
5    <deletedOnSuccess>false</deletedOnSuccess>
6    <errorIgnored>false</errorIgnored>
7    <fieldLevelSecurityEnabled>true</fieldLevelSecurityEnabled>
8    <inputType>JSON</inputType>
9    <isManagedUsingStdDesigner>false</isManagedUsingStdDesigner>
10    <name>COODMtest</name>
11    <nullInputsIncludedInOutput>false</nullInputsIncludedInOutput>
12    <omniDataTransformItem>
13        <disabled>false</disabled>
14        <filterGroup>0.0</filterGroup>
15        <globalKey>c7622d95-6995-4b57-8102-716e034e15e4</globalKey>
16        <inputFieldName>Account:Type</inputFieldName>
17        <inputObjectQuerySequence>0.0</inputObjectQuerySequence>
18        <linkedObjectSequence>0.0</linkedObjectSequence>
19        <name>COODMtest</name>
20        <outputCreationSequence>1.0</outputCreationSequence>
21        <outputFieldName>Type</outputFieldName>
22        <outputObjectName>json</outputObjectName>
23        <requiredForUpsert>false</requiredForUpsert>
24        <transformValuesMappings>{ }</transformValuesMappings>
25        <upsertKey>false</upsertKey>
26    </omniDataTransformItem>
27    <omniDataTransformItem>
28        <disabled>false</disabled>
29        <filterGroup>0.0</filterGroup>
30        <filterOperator>&lt;&gt;</filterOperator>
31        <filterValue>&apos;&apos;</filterValue>
32        <globalKey>fffd4cd6-7ad8-4e90-adaa-d534a8f75dde</globalKey>
33        <inputFieldName>Id</inputFieldName>
34        <inputObjectName>Account</inputObjectName>
35        <inputObjectQuerySequence>1.0</inputObjectQuerySequence>
36        <linkedObjectSequence>0.0</linkedObjectSequence>
37        <name>COODMtest</name>
38        <outputCreationSequence>0.0</outputCreationSequence>
39        <outputFieldName>Account</outputFieldName>
40        <outputObjectName>json</outputObjectName>
41        <requiredForUpsert>false</requiredForUpsert>
42        <upsertKey>false</upsertKey>
43    </omniDataTransformItem>
44    <omniDataTransformItem>
45        <disabled>false</disabled>
46        <filterGroup>0.0</filterGroup>
47        <globalKey>34b482a6-b64e-4d7f-9610-ef1c4f613b44</globalKey>
48        <inputFieldName>Account:Id</inputFieldName>
49        <inputObjectQuerySequence>0.0</inputObjectQuerySequence>
50        <linkedObjectSequence>0.0</linkedObjectSequence>
51        <name>COODMtest</name>
52        <outputCreationSequence>1.0</outputCreationSequence>
53        <outputFieldName>Id</outputFieldName>
54        <outputObjectName>json</outputObjectName>
55        <requiredForUpsert>false</requiredForUpsert>
56        <transformValuesMappings>{ }</transformValuesMappings>
57        <upsertKey>false</upsertKey>
58    </omniDataTransformItem>
59    <omniDataTransformItem>
60        <disabled>false</disabled>
61        <filterGroup>0.0</filterGroup>
62        <globalKey>5e7ae38a-0cb1-4383-aab9-43e4d88caff2</globalKey>
63        <inputFieldName>Account:Name</inputFieldName>
64        <inputObjectQuerySequence>0.0</inputObjectQuerySequence>
65        <linkedObjectSequence>0.0</linkedObjectSequence>
66        <name>COODMtest</name>
67        <outputCreationSequence>1.0</outputCreationSequence>
68        <outputFieldName>Name</outputFieldName>
69        <outputObjectName>json</outputObjectName>
70        <requiredForUpsert>false</requiredForUpsert>
71        <transformValuesMappings>{ }</transformValuesMappings>
72        <upsertKey>false</upsertKey>
73    </omniDataTransformItem>
74    <omniDataTransformItem>
75        <disabled>false</disabled>
76        <filterGroup>0.0</filterGroup>
77        <globalKey>1a6f7464-1157-4ec3-b62f-f795c5caceb2</globalKey>
78        <inputFieldName>Account:BillingStreet</inputFieldName>
79        <inputObjectQuerySequence>0.0</inputObjectQuerySequence>
80        <linkedObjectSequence>0.0</linkedObjectSequence>
81        <name>COODMtest</name>
82        <outputCreationSequence>1.0</outputCreationSequence>
83        <outputFieldName>BS</outputFieldName>
84        <outputObjectName>json</outputObjectName>
85        <requiredForUpsert>false</requiredForUpsert>
86        <transformValuesMappings>{ }</transformValuesMappings>
87        <upsertKey>false</upsertKey>
88    </omniDataTransformItem>
89    <outputType>JSON</outputType>
90    <processSuperBulk>false</processSuperBulk>
91    <responseCacheTtlMinutes>0.0</responseCacheTtlMinutes>
92    <rollbackOnError>false</rollbackOnError>
93    <sourceObjectDefault>false</sourceObjectDefault>
94    <synchronousProcessThreshold>0.0</synchronousProcessThreshold>
95    <type>Extract</type>
96    <uniqueName>COODMtest_1</uniqueName>
97    <versionNumber>1.0</versionNumber>
98    <xmlDeclarationRemoved>false</xmlDeclarationRemoved>
99</OmniDataTransform>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>OmniDataTransform</name>
6    </types>
7    <version>68.0</version>
8</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.