Global ID and link fields allow you to keep track of object records and documents when implementing external and/or Vault-to-Vault integrations.
Global ID Fields
Global ID fields are universal identifiers that allow you to keep track of and reference object records, documents, and document versions in external and Vault-to-Vault integrations. This can be useful when copying documents and object records from one Vault to another or maintaining a single identifier for a document or object record between Vault and an external system.
Global ID Fields
|
Field |
Description |
Entity |
|
global_id__sys |
Combination of the Vault ID and the Document ID. Read-only. |
Document |
|
global_version_id__sys |
Combination of the Vault ID and the document version's Global ID. Read-only. |
Document |
|
global_id__sys |
Combination of the Vault ID and the object record's ID. Read-only. |
Object Record |
Link Fields
Link fields allow you to track the source of object records or documents that are brought into your Vault whether from an external source or a Vault-to-Vault integration.
Link Fields
|
Field |
Description |
Entity |
|
link__sys |
Default value is null. Used to store a value that identifies a document's content. For example, the document's global_id__sys field value. |
Document |
|
version_link__sys |
Default value is null. Used to store a value that identifies a document version's content. For example, the document version's global_version_id__sys field value. |
Document |
|
link__sys |
Default value is null. Used to store a value that identifies an object record across Vaults. For example, an object record's global_id__sys field value. |
Object Record |
All global ID and link fields are retrievable via VQL and Vault API queries.