Hierarchy

Properties

allowUnresolvedDependencies?: boolean

When enabled the deployment will not fail when a dependency cannot be resolved. If a record has a dependency that cannot be resolved the record will normally be skipped as deploying the record would fail or cause a corrupted state in the org.

When this option is enabled records the deployment will try to deploy the record wihtout resolving the dependency. Only enable this if you are sure that all records can be deployed without all dependencies resolved.

Default

false;
bulkApiThreshold?: number = 500
chunkSize?: number = 100

Max chunk size when using the collections API only; if using bulk API once

continueOnError?: boolean

Continue the deployment when a fatal error occurs, note that continuing the deployment on fatal errors will result in an incomplete deployment. This setting affects fatal errors such as unable to convert a datapack to valid Salesforce records and should not be enabled on production deployments.

Default

false;
deltaCheck?: boolean

When enabled teh deployment wil check for changes between the datapack source and the source org and only deploy

Default

false;
disableTriggers?: boolean

Disable all Vlocity Triggers before starting the deployment; triggers are automatically re-enabled after the deployment completes.

Default

false
lookupFailedDependencies?: boolean

Attempt to lookup dependencies that are part of the deployment but failed to deploy. By setting this to true when part of a datapack fails to deploy the deployment will attempt to lookup an existing record that also matches the lookup requirements. This can help resolve deployment issues whe deploying datapacks from which the parent record cannot be updated, but it does introduce a risk of incorrectly linking records.

Default

false
maxRetries?: number

Number of times to retry the update or insert operation when it fails; defaults to 1 when not set

Default

1
purgeLookupOptimization?: boolean

When

See

DatapackDeploymentOptions.purgeMatchingDependencies is enabled this setting controls how embedded datapacks are deleted from the target org when enabled purging of existing records happens in bulk, this is more efficient but in this mode it is not possible to related errors while deleting records to a particular datapack.

Default

true
purgeMatchingDependencies?: boolean

Purge dependent records after deploying any record. This setting controls whether or not the deployment will delete direct dependencies linked through a matching (not lookup) dependency. This is especially useful to delete for example PCI records and ensure that old relationships are deleted.

Default

false
remoteScriptActivation?: boolean

When enabled the deployment will activate OmniScripts in the target org using Anonyms Apex.

Default

false;
retryChunkSize?: number

Chunk size for retrying failed records; defaults to 5

Default

5
skipLwcActivation?: boolean

When enabled LWC enabled OmniScripts will not get compiled into native LWC components and be deployed to the target org during deployment.

Use this if you want to manually compile OmniScripts into LWC or have a batch process ot activate OmniScript LWCs in bulk.

Default

false;
strictOrder?: boolean

When strict order is enabled the deployment will wait for all records in a datapack to complete before proceeding with deploying any dependent datapacks. By default Vlocode determines deployment order based on record level dependencies this allows for optimal chunking improving the overall speed of the deployment. By setting strictOrder to true Vlocode also enforces that any datapack that is dependent on another datapack is deployed after the datapack it depends on.

Enabling this reduces deployment performance as the deployment will be split in smaller chunks increasing the number of API calls to Salesforce.

Default

false;
useBulkApi?: boolean = false

Allow the use of the bulk API when the record count is larger then the bulk API threshold (chunkSize)

useMetadataApi?: boolean

When true LWC components are deployed using the metadata API instead of the tooling API. The tooling API is usually faster and thus the preferred way to compiled deploy LWC components.

Disable this if you need to use the metadata API to deploy LWC components.

Default

false;