A deployment spec contains Datapack specific logic and allows hooking into the deployment process to manipulate what get's deployed and execute post-deployment activation logic.

Implementers can implement any of the specified functions in this interface, all functions are optional and only the implemented functions are executed.

For many standard datapacks spec logic is implemented under the ./deploymentSpecs folder.

Hierarchy

  • DocumentTemplate

Implements

Constructors

Properties

lookupService: ContentVersionLookup

Methods

  • 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 __type to run datapack activation processes.

    Parameters

    Returns Promise<void[]>