Class DatapackDeploymentRecord

constructor

• new DatapackDeploymentRecord(datapackType, sobjectType, sourceKey, datapackKey, upsertFields?, values?): DatapackDeploymentRecord

• Parameters

  • datapackType: string

  • sobjectType: string

  • sourceKey: string

  • datapackKey: string

  • upsertFields: undefined | string[] = undefined

  • values: object = {}

  Returns DatapackDeploymentRecord

Readonly datapackKey

Readonly datapackType

Readonly normalizedSObjectType

skipLookup

Readonly sobjectType

Readonly sourceKey

upsertFields

Readonly values

action

• get action(): DeploymentAction

• Returns DeploymentAction

deployTime

• get deployTime(): number

• Returns number

error

• get error(): undefined | Error | RecordError

• Gets the error associated with the deployment record.

  Returns undefined | Error | RecordError

  The error object or undefined if there is no error.

errorCode

• get errorCode(): undefined | string

• Returns undefined | string

errorMessage

• get errorMessage(): undefined | string

• Gets the error message associated with the deployment record.

  Returns undefined | string

  The error message, or undefined if there is no error.

hasUnresolvedDependencies

• get hasUnresolvedDependencies(): boolean

• Returns boolean

hasWarnings

• get hasWarnings(): boolean

• Returns boolean

isCascadeFailure

• get isCascadeFailure(): boolean

• Checks if the deployment record failed due to a cascade failure. A cascade failure occurs when a record cannot be deployed because it is dependent on another record that failed to deploy.

  Returns boolean

  True if the deployment record represents a cascade failure, false otherwise.

isDeployed

• get isDeployed(): boolean

• Returns boolean

isFailed

• get isFailed(): boolean

• Returns boolean

isInsert

• get isInsert(): boolean

• Returns boolean

isPending

• get isPending(): boolean

• Gets a value indicating whether the deployment is pending or in retry status.

  Returns boolean

  True if the deployment is pending or in retry status, otherwise false.

isPendingRetry

• get isPendingRetry(): boolean

• Returns boolean

isSkipped

• get isSkipped(): boolean

• Returns boolean

isStarted

• get isStarted(): boolean

• Returns boolean

isUpdate

• get isUpdate(): boolean

• Returns boolean

recordId

• get recordId(): undefined | string

• Gets the record ID of the deployed record if the record is deployed. Otherwise the ID of the record that will be updated. For new records this will be undefined.

  To change the record ID of a record use the setAction method with the DeploymentAction.Update action.

  Returns undefined | string

retryCount

• get retryCount(): number

• Returns number

status

• get status(): DeploymentStatus

• Returns DeploymentStatus

statusMessage

• get statusMessage(): undefined | string

• When the record is not deployed this property contains the last reported state detail.

  Returns undefined | string

warnings

• get warnings(): readonly string[]

• Returns readonly string[]

addDependency

• addDependency(dependency): any

• Parameters

  • dependency: VlocityDatapackReference | DatapackDeploymentRecord

  Returns any

addLookup

• addLookup(field, dependency): void

• Parameters

  • field: string

  • dependency: VlocityDatapackReference

  Returns void

addLookupDependency

• addLookupDependency(sourceKey): void

• Add a lookup dependency to this record based on only a source key string.

  Parameters

  • sourceKey: string

    Dependencies source key in the following format: <sobject>/<values...>

  Returns void
• addLookupDependency(sobjectType, sourceKey): void

• Add a lookup dependency to this record based on a SObject type and the source key string.

  Parameters

  • sobjectType: string

    SObject type of the record on which this record is dependent. Replace vlocity namespace with the namespace placeholder.

  • sourceKey: string

    String that describes the records source key; should be prefixed with the record sobject type otherwise it is automatically prepended

  Returns void
• addLookupDependency(sobjectType, matchingKeyValues): void

• Add a lookup dependency to this record is based on a SObject type and the matching key values of the record.

  Parameters

  • sobjectType: string

    SObject type of the record on which this record is dependent. Replace vlocity namespace with the namespace placeholder.

  • matchingKeyValues: Record<string, undefined | null | string | number | boolean>

    Object describing the matching key values that are concatenated into the source key so the source key matches the following format: <sobject>/<values...>

  Returns void

addWarning

• addWarning(message): void

• Parameters

  • message: string

  Returns void

getDependencies

• getDependencies(): VlocityDatapackReference[]

• Get all dependencies on which this record depends; returns resolved and unresolved dependencies

  Returns VlocityDatapackReference[]

  Array with all dependencies

getDependencySourceKeys

• getDependencySourceKeys(): Iterable<string>

• Returns Iterable<string>

getGlobalKey

• getGlobalKey(): any

• Returns any

getLookup

• getLookup(field): undefined | VlocityDatapackLookupReference

• Parameters

  • field: string

  Returns undefined | VlocityDatapackLookupReference

getLookupDependencies

• getLookupDependencies(): {
      dependency: VlocityDatapackReference;
      field: string;
  }[]

• Get dependencies that are resolved through a lookup and not provided as part of the datapack. These dependencies of datapack type VlocityLookupMatchingKey

  Returns {
      dependency: VlocityDatapackReference;
      field: string;
  }[]

  Array with dependencies

getMatchingDependencies

• getMatchingDependencies(): {
      dependency: VlocityDatapackReference;
      field: string;
  }[]

• Get embedded dependencies that are not resolved through lookup but instead are provided as part of the datapack. These dependencies of datapack type VlocityMatchingKeyObject. Does not included dependencies that are added through the addDependency function as these are not linked through a field.

  Returns {
      dependency: VlocityDatapackReference;
      field: string;
  }[]

  Array with dependencies

getUnresolvedDependencies

• getUnresolvedDependencies(): {
      dependency: VlocityDatapackReference;
      field: string;
  }[]

• Retrieves the unresolved dependencies of the datapack deployment record.

  Returns {
      dependency: VlocityDatapackReference;
      field: string;
  }[]

  An array of unresolved dependencies.
• getUnresolvedDependencies(type): {
      dependency: VlocityDatapackReference;
      field: string;
  }[]

• Parameters

  • type: "all"

  Returns {
      dependency: VlocityDatapackReference;
      field: string;
  }[]

• getUnresolvedDependencies(type): {
      dependency: VlocityDatapackLookupReference;
      field: string;
  }[]

• Parameters

  • type: "lookup"

  Returns {
      dependency: VlocityDatapackLookupReference;
      field: string;
  }[]

• getUnresolvedDependencies(type): {
      dependency: VlocityDatapackMatchingReference;
      field: string;
  }[]

• Parameters

  • type: "matching"

  Returns {
      dependency: VlocityDatapackMatchingReference;
      field: string;
  }[]

hasGlobalKey

• hasGlobalKey(): boolean

• Returns boolean

isDependentOn

• isDependentOn(record): undefined | {
      dependency: VlocityDatapackReference;
      field: string;
  }

• Checks if the specified record is a dependency for this record and returns the dependency data and lookup field on this record

  Parameters

  • record: DatapackDeploymentRecord

    Record to check

  Returns undefined | {
      dependency: VlocityDatapackReference;
      field: string;
  }

  The dependency info and lookup field as defined for this record

isMatch

• isMatch(filter): boolean

• Check if this record type matches the specified SObject type filter. Matches are always case insensitive and will be matched against the full and normalized SObject (without namespace prefix) type. Matching will first be done against the normal sobject type and only after that against the normalized sobject type.

  Parameters

  • filter: string | RegExp

    SObjectType as string or RegEx

  Returns boolean

  true if the record SObject type matches the filter otherwise false

isResolved

• isResolved(field): boolean

• Check if a field that is dependent on another record is resolved.

  Parameters

  • field: string

    name of the field

  Returns boolean

isSObjectOfType

• isSObjectOfType(sobjectType): boolean

• Namespace and case normalized check to determine if the current datapack is of the specified type.

  Parameters

  • sobjectType: string

    SObject type with or without namespace prefix

  Returns boolean

resolveDependencies

• resolveDependencies(resolver): Promise<boolean>

• Resolves the dependencies of the datapack deployment record. Rethrows any error that occurs during dependency resolution from the resolver.

  Parameters

  • resolver: DatapackDependencyResolver

    The datapack dependency resolver.

  Returns Promise<boolean>

  A promise that resolves to a boolean indicating whether all dependencies have been resolved.

setAction

• setAction(action): void

• Parameters

  • action: DeploymentAction

  Returns void

• setAction(action, updateId): void

• Parameters

  • action: Update

  • updateId: string

  Returns void

• setAction(action, updateId?): void

• Parameters

  • action: Skip

  • Optional updateId: string

  Returns void

setError

• setError(error): void

• Parameters

  • error: string | Error | RecordError

  Returns void

setFailed

• setFailed(error): void

• Parameters

  • error: string | Error | RecordError

  Returns void

updateStatus

• updateStatus(status, detail?): void

• Parameters

  • status: DeploymentStatus

  • Optional detail: string | Error | RecordError

  Returns void

value

• value(field): any

• Get a value in the underlying record data

  Parameters

  • field: string

    field name

  Returns any

  value of the field
• value(field, value): boolean

• Set the value in the underlying record data. To remove a field from the record pass the value as undefined

  Parameters

  • field: string

    field name

  • value: unknown

    value to set or undefined to remove the field

  Returns boolean

  true if set or false if not set

Static fromValues

• fromValues(sobjectType, values, options?): DatapackDeploymentRecord

• Parameters

  • sobjectType: string

  • values: object

  • Optional options: {
        recordKey?: string;
        upsertFields?: string[];
    }

    • Optional recordKey?: string

    • Optional upsertFields?: string[]

  Returns DatapackDeploymentRecord