For the managed package runtime, the job file additionally supports some build-based options and the options available to the data packs API.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
Most options can also be passed in as command line options with -optionName <value> or --optionName for boolean values.
Job Options
Pass job options through the job file.
| Job Option | Description | Type | Default |
|---|---|---|---|
| activate | Activate everything after it’s imported / deployed. | Boolean | true |
| addSourceKeys | Generate Global / Unique Keys for Records that are missing this data. Improves the ability to import exported data. | Boolean | false |
| autoFixPicklists | Automatically propagates metadata changes across orgs for managed package fields and eliminates errors due to missing metadata. Doesn’t work for Managed Global Value Sets - Like CurrencyCode field. | Boolean | true |
| autoRetryErrors | Retry after a deployment. This option checks whether any errors that are due to incorrectly resolved references can be fixed. | Boolean | false |
| autoUpdateSettings | Automatically run packUpdateSettings before deployment. | Boolean | true |
| buildFile | The target output file from packBuildFile. | String | AllDataPacks.json |
| defaultMaxParallel | The number of parallel processes to use for export. | Integer | 1 |
| compileOnBuild | Compiled files aren’t generated as part of this export. This option applies primarily to SASS files. | Boolean | true |
| continueAfterError | Don't end the job on error. | Boolean | false |
| delete | Delete the VlocityDataPack__c file on finish. | Boolean | true |
| exportPacksMaxSize | Split data pack export after it reaches this threshold. | Integer | null |
| expansionPath | Secondary path after projectPath to expand the data for the job. | String | |
| gitCheck | Use Git hashes to determine changes and greatly speed up deployment. | Boolean | false |
| gitCheckKey | Enable checking what the latest git hash was before deploying to the target org. | String | null |
| ignoreAllErrors | Ignore errors while running a job. Not recommended. | Boolean | false |
| manifestOnly | If true, an export job saves only items specifically listed in the manifest. | Boolean | false |
| maxDepth | The max distance of parent or children relationships from initial data being exported. | Integer | -1 (All) |
| maximumDeployCount | The maximum number of items in a single deployment. Setting value to 1 and using preStepApex can allow deployments for a single data pack at a time. | Integer | 1000 |
| processMultiple | When false, each export or import runs individually. | Boolean | true |
| reactivateOmniScriptsWhenEmbeddedTemplateFound | Run activate for ALL Omniscripts. This option requires that you’re logged in via SFDX authentication. | Boolean | false |
| supportForceDeploy | Attempt to deploy data packs which have not had all their parents successfully deployed. | Boolean | false |
| supportHeadersOnly | Attempt to deploy a subset of data for certain data pack types to prevent blocking due to Parent failures. | Boolean | true |
| useAllRelationships | Determines whether or not to store the _AllRelations.json file which may not generate consistently enough for version control. Salesforce recommends setting to false. | Boolean | true |
| useVlocityTriggers | Turn on / off Vlocity's AllTriggers custom setting during the deployment. | Boolean | true |
| disableVlocityTriggers | Turn off Vlocity's AllTriggers custom setting during the deployment. | Boolean | false |
| ignoreLWCActivationOS | Don’t compile and deploy LWC Omniscripts. | Boolean | false |
| ignoreLWCActivationCards | Don’t compile and deploy LWC Cards. | Boolean | false |
| lwcCompilerNamespace | Overrides the namespace of the installed managed package. Useful when using a developer org. Options: vlocity-cme, vlocity-ins, vlocity-ps. | String | |
| lwcCompilerVersion | Overrides the version of the installed managed package. Useful when using a developer org. Example: 900.469 | String | |
| npmRepository | Overrides the npm repository where the LWC compiler is hosted. | String | |
| npmAuthKey | Your customer NPM auth key used to install the LWC compiler package. | String |
Build Options
Pass build options at the command line.
| Build Option | Description | Type | Default |
|---|---|---|---|
| apex | Apex Class to run with the runApex command. | String | none |
| folder | Path to folder containing Apex Files when using the runApex command. | String | none |
| javascript | Path to javascript file to run when using the runJavaScript command. | String | none |
| json | Output the result of the Job as JSON only. Used in CLI API applications. | Boolean | false |
| json-pretty | Output the result of the Job as more readable JSON Only. Used in CLI API applications. | Boolean | false |
| job | Path to job file. | String | none |
| key | Data pack key to export or deploy. | String | none |
| manifest | JSON of VlocityDataPackKeys to be processed. | JSON | none |
| simpleLogging | Remove the colors from console output. Good for Automation servers. | Boolean | false |
| nojob | Run the command without specifying a job file. Default settings are used. | Boolean | false |
| propertyfile | Path to property file that can also contain any valid options. | String | build.properties |
| query | SOQL Query used for packExportSingle
command. |
String | none |
| queryAll | Query all default types. Overrides any project settings. | Boolean | false |
| quiet | Don't log any output. | Boolean | false |
| sandbox | Set sf.loginUrl to https://test.salesforce.com. | Boolean | false |
| sfdx.username | Use Salesforce DX Authorized Username. | String | none |
| sf.accessToken | Salesforce Access Token when using OAuth info. | String | none |
| sf.instanceUrl | Salesforce Instance URL when using OAuth info. | String | none |
| sf.loginUrl | Salesforce Login URL when sf.username + sf.password. |
String | |
| sf.password | Salesforce password + security token when using sf.username. |
String | none |
| sf.sessionId | Salesforce Session Id when using OAuth info. | String | none |
| sf.username | Salesforce username when using sf.password. |
String | none |
| type | Data pack type used for packExportSingle
command. |
String | none |
| verbose | Show additional logging statements. | Boolean | false |