You are here:
Overriding Data Pack Settings (Managed Package)
For the managed package runtime, you can change the settings that are used to define the behavior of each data pack that is imported, deployed, and written to the files.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
Add settings overrides inside the job file definition with this syntax, also found in lib/datapacksexpandeddefinition.yaml.
OverrideSettings:
DataPacks:
Product2:
SupportParallel: false
SObjects:
Product2:
FilterFields:
- vlocity_namespace__AttributeMetadata__c
- vlocity_namespace__ImageId__c
- vlocity_namespace__JSONAttribute__c
FolderName:
- vlocity_namespace__GlobalKey__c
JsonFields:
- vlocity_namespace__CategoryData__c
SourceKeyDefinition:
- vlocity_namespace__GlobalKey__c
UnhashableFields:
- vlocity_namespace__JSONAttribute__c
- vlocity_namespace__CategoryData__c
- vlocity_namespace__IsConfigurable__c
vlocity_namespace__DRMapItem__c:
FilterFields:
- vlocity_namespace__UpsertKey__c
The settings for Product2 include: SupportParallel: false meaning that Product2 data packs don’t support being uploaded in parallel due to record locking issues on the Standard Pricebook Entry.
FilterFields:
- AttributeMetadata__c
- ImageId__c
- JSONAttribute__c
Filter Fields describes fields that are removed from the JSON before writing to the file system. The fields might be filtered if they contain Salesforce Ids that can’t be replaced during export and are not version control friendly.
FolderName:
- GlobalKey__c
Folder Name is the field that contains the name of the folder where the Product2 is written. This folder name is different from the file name because the folder must be unique, but the file should be readable.
JsonFields:
- CategoryData__c
JsonFields is a list of fields on the SObject which should be written as formatted JSON as opposed to a String when writing to a file.
This table lists the supported settings.
| Setting | Type | Default | Description |
|---|---|---|---|
| SortFields | Array | "Hash" | The fields used to sort lists of SObjects to make the sort as consistent as possible. Valid Values: Fields on the SObject (For example, Name, Type__c) |
| DoNotExpand | Boolean | false | Skip expanding the data pack into Multiple Files. |
| FilterFields | Array | none | Fields to remove before writing to files. Valid Values: Fields on SObject |
| SourceKeyFields | Array | Name | Fields used to create the File Names for an SObject. Valid Values: Fields on SObject or "_String" to add a Literal |
| SourceKeyGenerationFields | Array | none | Fields used to Generate a new Source Key when addSourceKeys: true Valid Values: Fields on SObject |
| MatchingSourceKeyDefinition | Array | none | Fields used to build the readable key for a single SObject when it is a Matching Key node. Valid Values: Fields on SObject or "_String" to add a Literal |
| FolderName | Array | Name | Fields used to create the Folder Name for an SObject. Valid Values: Fields on SObject or "_String" to add a Literal |
| FileType | String | json | Field or String used to determine the file type when creating a file. Valid Values: Fields on SObject or a string for a literal |
| JsonFields | String | none | JsonFields is a list of fields on the SObject which should be written as formatted JSON as opposed to a String when writing to a file. Valid Values: Fields on SObject |
| ReplacementFields | Object | none | Fields that should be replaced with values from other fields. Valid Values: Key is Target Field - Value is Field to Replace with or "_String" for literals |
| NonUnique | Boolean | false | Declares that an SObject's data is always newly created during deployment, is never referenced by other objects, and therefore doesn't need to keep extra metadata. |
| PaginationSize | Integer | 1000 | Declares that an SObject should paginate during deployment. |
| RemoveNullValues | Boolean | false | Delete all null values from JSON. Similar to NonUnique, it is newly created, but can be referenced by other objects. |
| UnhashableFields | Array | none | Identifies fields that shouldn’t be used for checking diffs because they’re informational. Valid Values: Fields on SObject. |
| SupportParallel | Boolean | true | Turn on or off parallel processing when deploying the data pack type. Necessary when Master-Detail Parent might be shared with other data packs. |
| MaxDeploy | Integer | 50 | Specify the maximum number of data packs which should be uploaded in a single transaction. |
| HeadersOnly | Boolean | false | Support uploading only the top level SObject in the data pack. Good for potentially fixing circular reference issues |
| ExportGroupSize | Integer | 5 | Specify the maximum number of data packs which should be Exported in a single transaction. Potentially large data packs like Matrix or Attachments could be set to 1 if necessary. |
