Private_Private Readonly_Private Readonly_Private Optional_Private Optional_Private_Private Optional_Private Readonly_Private Readonly_ReadonlydatapackReadonlydatapackReadonlynormalizedNumber of times the record has been retried for deployment. This is used to determine if the record should be skipped after a certain number of retries.
True if looking up existing records to update is skipped causing the deployment to always create a new object using insert
ReadonlysobjectReadonlysourceReadonlyvaluesGets the error associated with the deployment record.
The error object or undefined if there is no error.
Gets the error message associated with the deployment record.
The error message, or undefined if there is no error.
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.
True if the deployment record represents a cascade failure, false otherwise.
Gets a value indicating whether the deployment is pending or in retry status.
True if the deployment is pending or in retry status, otherwise false.
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.
When the record is not deployed this property contains the last reported state detail.
Add a lookup dependency to this record based on only a source key string.
Dependencies source key in the following format: <sobject>/<values...>
Add a lookup dependency to this record based on a SObject type and the source key string.
SObject type of the record on which this record is dependent. Replace vlocity namespace with the namespace placeholder.
String that describes the records source key; should be prefixed with the record sobject type otherwise it is automatically prepended
Add a lookup dependency to this record is based on a SObject type and the matching key values of the record.
SObject type of the record on which this record is dependent. Replace vlocity namespace with the namespace placeholder.
Object describing the matching key values that are concatenated into the source key
so the source key matches the following format: <sobject>/<values...>
Get all dependencies on which this record depends; returns resolved and unresolved dependencies
Array with all dependencies
PrivategetGet dependencies that are resolved through a lookup and not provided as part of the datapack. These dependencies of datapack type VlocityLookupMatchingKey
Array with dependencies
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.
Array with dependencies
Retrieves the unresolved dependencies of the datapack deployment record.
An array of unresolved dependencies.
Retrieves the unresolved dependencies of the datapack deployment record.
The type of dependencies to retrieve. Can be 'lookup', 'matching', or 'all'. Default is 'all'.
An array of unresolved dependencies.
Retrieves the unresolved dependencies of the datapack deployment record.
An array of unresolved dependencies.
Retrieves the unresolved dependencies of the datapack deployment record.
An array of unresolved dependencies.
Checks if the specified record is a dependency for this record and returns the dependency data and lookup field on this record
Record to check
The dependency info and lookup field as defined for this record
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.
SObjectType as string or RegEx
true if the record SObject type matches the filter otherwise false
Check if a field that is dependent on another record is resolved.
name of the field
Namespace and case normalized check to determine if the current datapack is of the specified type.
SObject type with or without namespace prefix
Resolves the dependencies of the datapack deployment record. Rethrows any error that occurs during dependency resolution from the resolver.
The datapack dependency resolver.
A promise that resolves to a boolean indicating whether all dependencies have been resolved.
OptionalupdateId: stringOptionaldetail: string | Error | RecordErrorPrivatevalidateValidate dependency integrity by checking if mandator fields are set
Dependency to check
Get a value in the underlying record data
field name
value of the field
Set the value in the underlying record data. To remove a field from the record pass the value as undefined
field name
value to set or undefined to remove the field
true if set or false if not set
StaticfromOptionaloptions: { recordKey?: string; upsertFields?: string[] }
Namespace normalized SObjectName; contains the SObjectType without the namespace prefix.