Class DatapackDeployer

Private Readonly connectionProvider

Private Readonly container

Private Readonly logger

Private Readonly objectLookupService

Private Readonly schemaService

Private Readonly specRegistry

Private afterDeployRecord

• afterDeployRecord(deployment, datapackRecords): Promise<void>

• Performs additional tasks after the deployment of a datapack record. If triggers are disabled in the deployment options, it sets the Vlocity trigger state to true. Verifies the deployed field data for specific fields. Runs the 'afterDeployRecord' spec function with the provided arguments.

  Parameters

  • deployment: DatapackDeployment

    The DatapackDeployment object representing the deployment.

  • datapackRecords: Iterable<DatapackDeploymentRecord>

    An iterable of DatapackDeploymentRecord objects representing the deployed records.

  Returns Promise<void>

  A Promise that resolves when all the tasks are completed.

Private afterDeployRecordGroup

• afterDeployRecordGroup(deployment, datapackGroups): Promise<void>

• Event handler running after the deployment

  Parameters

  • deployment: DatapackDeployment

  • datapackGroups: Iterable<DatapackDeploymentRecordGroup>

  Returns Promise<void>

Private beforeDeployRecord

• beforeDeployRecord(deployment, datapackRecords): Promise<void>

• Executes the necessary actions before deploying a record. If the disableTriggers option is set in the deployment, it will disable triggers. If the deployment is cancelled, the method will return early. It then runs the beforeDeployRecord spec function with the provided arguments.

  Parameters

  • deployment: DatapackDeployment

    The DatapackDeployment object.

  • datapackRecords: Iterable<DatapackDeploymentRecord>

    An iterable of DatapackDeploymentRecord objects.

  Returns Promise<void>

  A Promise that resolves when the actions are completed.

Private beforeDeployRecordGroup

• beforeDeployRecordGroup(deployment, datapackGroups): Promise<void>

• Event handler running before the deployment

  Parameters

  • deployment: DatapackDeployment

  • datapackGroups: Iterable<DatapackDeploymentRecordGroup>

  Returns Promise<void>

Private beforeRetryRecord

• beforeRetryRecord(deployment, datapackRecords): Promise<void>

• Executes the necessary actions before retrying a record deployment.

  Parameters

  • deployment: DatapackDeployment

    The DatapackDeployment object.

  • datapackRecords: Iterable<DatapackDeploymentRecord>

    An iterable of DatapackDeploymentRecord objects.

  Returns Promise<void>

Private evalFilter

• evalFilter(filter, arg): boolean

• Parameters

  • filter: DatapackFilter

  • arg: string | VlocityDatapack | DatapackDeploymentRecord | DatapackDeploymentRecordGroup

  Returns boolean

Private filterApplicableRecords

• filterApplicableRecords(filter, arg): DatapackDeploymentRecord[]

• Parameters

  • filter: DatapackFilter

  • arg: readonly DatapackDeploymentRecord[]

  Returns DatapackDeploymentRecord[]

• filterApplicableRecords(filter, arg): DatapackDeploymentRecordGroup

• Parameters

  • filter: DatapackFilter

  • arg: DatapackDeploymentRecordGroup

  Returns DatapackDeploymentRecordGroup

Private getAffectedRecords

• getAffectedRecords(parameters): DatapackDeploymentRecord[]

• Parameters

  • parameters: unknown[]

  Returns DatapackDeploymentRecord[]

Private handleSpecFunctionError

• handleSpecFunctionError(eventType, err, options): void

• Parameters

  • eventType: string

  • err: unknown

  • options: DeploymentSpecExecuteOptions<unknown[]>

  Returns void

Private runSpecFunction

• runSpecFunction<T, E>(eventType, options): Promise<void>

• Run a datapack spec function and await the result

  Type Parameters

  • T extends keyof DatapackDeploymentSpec

  • E extends ((datapack) => any) | ((records) => any) | ((records) => any) | ((event) => any) | ((event) => any) | ((event) => any) | ((event) => any) | ((event) => any)

  Parameters

  • eventType: T

    Event/function type to run

  • options: DeploymentSpecExecuteOptions<Parameters<E>>

  Returns Promise<void>

Private setVlocityTriggerState

• setVlocityTriggerState(newTriggerState): Promise<void>

• Disable or enable all Vlocity triggers

  Parameters

  • newTriggerState: boolean

    true to enable all Vlocity Triggers; false to disabled all Vlocity triggers

  Returns Promise<void>

Private verifyDeployedFieldData

• verifyDeployedFieldData(records, fieldNames): Promise<void>

• Verifies the data deployed to the org matched the local data for the specified list of fields. This is especially useful for GlobalKey fields that are updated by a Vlocity before update/insert trigger making it impossible to update the global key when Vlocity triggers are enabled.

  Parameters

  • records: Iterable<DatapackDeploymentRecord>

    records

  • fieldNames: string[]

    Array of field names to compare

  Returns Promise<void>