Class DatapackDeployer

Private ReadonlyconnectionProvider

Private Readonlycontainer

Private Readonlylogger

Private ReadonlyobjectLookupService

Private ReadonlyschemaService

Private ReadonlyspecRegistry

PrivateafterDeployRecord

• afterDeployRecord(
      deployment: DatapackDeployment,
      datapackRecords: Iterable<DatapackDeploymentRecord>,
  ): 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.

PrivateafterDeployRecordGroup

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

  Event handler running after the deployment

  Parameters

  • deployment: DatapackDeployment
  • datapackGroups: Iterable<DatapackDeploymentRecordGroup>

    Datapacks that have been deployed

  Returns Promise<void>

PrivatebeforeDeployRecord

• beforeDeployRecord(
      deployment: DatapackDeployment,
      datapackRecords: Iterable<DatapackDeploymentRecord>,
  ): 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.

PrivatebeforeDeployRecordGroup

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

  Event handler running before the deployment

  Parameters

  • deployment: DatapackDeployment
  • datapackGroups: Iterable<DatapackDeploymentRecordGroup>

    Datapacks being deployed

  Returns Promise<void>

PrivatebeforeRetryRecord

• beforeRetryRecord(
      deployment: DatapackDeployment,
      datapackRecords: Iterable<DatapackDeploymentRecord>,
  ): 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>

PrivateevalFilter

• evalFilter(
      filter: DatapackFilter,
      arg:
          | string
          | VlocityDatapack
          | DatapackDeploymentRecord
          | DatapackDeploymentRecordGroup,
  ): boolean

  Parameters

  • filter: DatapackFilter
  • arg:
        | string
        | VlocityDatapack
        | DatapackDeploymentRecord
        | DatapackDeploymentRecordGroup

  Returns boolean

PrivatefilterApplicableRecords

• filterApplicableRecords(
      filter: DatapackFilter,
      arg: readonly DatapackDeploymentRecord[],
  ): DatapackDeploymentRecord[]

  Parameters

  • filter: DatapackFilter
  • arg: readonly DatapackDeploymentRecord[]

  Returns DatapackDeploymentRecord[]

• filterApplicableRecords(
      filter: DatapackFilter,
      arg: DatapackDeploymentRecordGroup,
  ): DatapackDeploymentRecordGroup

  Parameters

  • filter: DatapackFilter
  • arg: DatapackDeploymentRecordGroup

  Returns DatapackDeploymentRecordGroup

PrivategetAffectedRecords

• getAffectedRecords(parameters: unknown[]): DatapackDeploymentRecord[]

  Parameters

  • parameters: unknown[]

  Returns DatapackDeploymentRecord[]

PrivatehandleSpecFunctionError

• handleSpecFunctionError(
      eventType: string,
      err: unknown,
      options: DeploymentSpecExecuteOptions,
  ): void

  Parameters

  • eventType: string
  • err: unknown
  • options: DeploymentSpecExecuteOptions

  Returns void

PrivateonRecordError

• onRecordError(
      deployment: DatapackDeployment,
      datapackRecord: DatapackDeploymentRecord,
  ): Promise<void>

  Handles errors encountered during the deployment of a specific datapack record. If the deployment has been cancelled, this method will return immediately without performing any actions. Otherwise, it invokes a specified function (onRecordError) to handle the error, passing the problematic datapack record as an argument.

  Parameters

  • deployment: DatapackDeployment

    The current datapack deployment instance.

  • datapackRecord: DatapackDeploymentRecord

    The specific datapack record that encountered an error during deployment.

  Returns Promise<void>

  A promise that resolves when the error handling process is complete.

PrivaterunSpecFunction

• runSpecFunction<
      T extends keyof DatapackDeploymentSpec,
      E extends
      
              | ((datapack: VlocityDatapack) => unknown)
              | ((records: readonly DatapackDeploymentRecord[]) => unknown)
              | ((records: readonly DatapackDeploymentRecord[]) => unknown)
              | ((event: DatapackDeploymentEvent) => unknown)
              | ((event: DatapackDeploymentEvent) => unknown)
              | ((event: readonly DatapackDeploymentRecord[]) => unknown)
              | ((event: readonly DatapackDeploymentRecord[]) => unknown)
              | ((event: readonly DatapackDeploymentRecord[]) => unknown)
              | ((event: readonly DatapackDeploymentRecord[]) => unknown),
  >(
      eventType: T,
      options: DeploymentSpecExecuteOptions<Parameters<E>>,
  ): Promise<void>

  Run a datapack spec function and await the result

  Type Parameters

  • T extends keyof DatapackDeploymentSpec
  • E extends
        | ((datapack: VlocityDatapack) => unknown)
        | ((records: readonly DatapackDeploymentRecord[]) => unknown)
        | ((records: readonly DatapackDeploymentRecord[]) => unknown)
        | ((event: DatapackDeploymentEvent) => unknown)
        | ((event: DatapackDeploymentEvent) => unknown)
        | ((event: readonly DatapackDeploymentRecord[]) => unknown)
        | ((event: readonly DatapackDeploymentRecord[]) => unknown)
        | ((event: readonly DatapackDeploymentRecord[]) => unknown)
        | ((event: readonly DatapackDeploymentRecord[]) => unknown)

  Parameters

  • eventType: T

    Event/function type to run

  • options: DeploymentSpecExecuteOptions<Parameters<E>>

    Options for executing the spec (args, ignoreErrors, errorSeverity)

  Returns Promise<void>

PrivatesetVlocityTriggerState

• setVlocityTriggerState(newTriggerState: boolean): 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>

PrivateverifyDeployedFieldData

• verifyDeployedFieldData(
      records: Iterable<DatapackDeploymentRecord>,
      fieldNames: string[],
  ): 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>