Interface DatapackDeploymentSpec

This hook is called after all records of a datapack are deployed and will only be called once for every datapack in the deployment. Use this hook to execute datapack activation logic. It is comparable to post-step in Vlocity tools and should also execute any activation logic if required.

Use the DatapackDeploymentEvent.getDeployedRecords function to get a list of deployed records for a specific SObject type. This excludes any records that didn't get deployed.

The type argument passed to DatapackDeploymentEvent.getRecords should not be prefixed with a namespace even if the object you try to access has a namespace; see also beforeDeploy.

Executes after a group of records is deployed, at this stage it is not possible to change any field value anymore. The hook point can be used to run post-deployment validations or post-deployment activation processes.

Note: this runs on record level and use afterDeploy to run datapack activation processes.

This hook is almost identical to the DatapackDeploymentSpec.preprocess hook except that executes after a datapack is converted into 1 or more Salesforce records.

The list of records past into this hook contains all the records generated for a single datapack; it is not possible to remove/drop any record but individual records can be manipulated,

Note At this point dependencies are not yet resolved

This hook is called before deploying the first record in a datapack, and is only called once very datapack in the deployment.

• Use this hook to execute and pre-deployment actions. This action is comparable with the pre-step job from the Vlocity tools library.
• Use the DatapackDeploymentEvent.getRecords function to get a list of records for a specific SObject type.

The type argument passed to DatapackDeploymentEvent.getRecords should not be prefixed with a namespace. I.e; to get a list of OmniScript__c records in the deployment use:

DatapackDeploymentEvent.getRecords('OmniScript__c')
Copy

instead of

DatapackDeploymentEvent.getRecords('vlocity_cmt__OmniScript__c')
Copy

The event object also exposes DatapackDeploymentEvent.getDeployedRecords; in the beforeDeploy this will always return an empty array.

Executed just before the records are being deployed; the event contains a readonly array of records. At this stage values for the records can still be manipulated. This hook point should only be used to run logic that depends on all dependencies on individual record level are resolved.

Note: this runs on record level and use beforeDeploy to run datapack activation processes.

Executed before a record is retried; this hook point can be used to run any logic that should be executed before a record is retried such as updating the record values ot changing the upsert fields.

This hook point is called before dependency resolution.

Executed when a record fails to deploy; this hook point can be used to run any logic that should be executed when a record fails to deploy such as updating the record values or changing the upsert fields.

This function executes before a datapack is converted into a set of DatapackDeploymentRecord's and allow changing the datapack data, correct faulty field values that would otherwise cause errors during record conversion or remove certain fields that should not be deployed.

This hook can also be used to override certain fields with autogenerated values; i.e. setting the element order and level field of OmniScript elements