This page contains details for the component types available in Vault.
View and edit messages that Vault sends to users as both emails and in-application notifications.
Learn about Email and Message Administration in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
email_body | Type : LongString Required Maximum length : 1500 | The body of the email sent to the notification recipient. |
subject | Type : String Required Maximum length : 255 | Subject of the email sent to the notification recipient. |
default_lang | Type : String Maximum length : 255 | The default language for the email. |
Atomic security provides an additional layer of control by allowing you to configure security at the lifecycle state and/or assigned role level.
Learn about Atomic Security in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in the vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
object | Type : Object Required | The Object the security applies to. e.g. Object.country__v |
object_lifecycle | Type : Objectlifecycle Required | The Objectlifecycle the security applies to. e.g. Objectlifecycle.general_lifecycle__c |
state | Type : Objectlifecyclestate Required | The Objectlifecyclestate of the Objectlifecycle the security applies to. e.g. Objectlifecyclestate.active_state__c |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in the vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
role | Type : Objectlifecyclerole Required | The Objectlifecyclerole of the Objectlifecycle the security applies to. e.g. Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles. |
type | Type : Enum Required Allowed values :
| The permission to apply. |
fields | Type : Field Required Allows multiple values | The fields to apply this permission to. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in the vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
role | Type : Objectlifecyclerole Required | The Objectlifecyclerole of the Objectlifecycle the security applies to. e.g. Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles. |
type | Type : Enum Required Allowed values :
| The permission to apply. |
object_actions | Type : Objectaction Allows multiple values | The Object level action(s) to apply this permission to. |
lifecycle_actions | Type : Objectlifecyclestateuseraction Allows multiple values | The Lifecycle level action(s) to apply this permission to. |
Dashboards provide an at-a-glance understanding of key metrics.
Learn about Dashboards in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | A general description of the dashboard. |
editors | Type : String Allows multiple values Maximum length : 300 | Users with the Editor permission required to edit dashboards. |
viewers | Type : String Allows multiple values Maximum length : 300 | Users with the Viewer permission required to view dashboards. |
dashboard_markup | Type : XMLString Required Maximum length : 32000 | Describes the layout of the dashboard. |
Attribute of a document associated to one or more document types.
Learn about Document Fields in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in Vault’s base language. |
active | Type : Boolean Required | Indicates whether the field is active. |
used_in | Type : String Allows multiple values Maximum length : 1500 | The Doc Type(s) this field is used in (shared fields only). e.g. Doctype.my_doc_type__c |
blank_fields | Type : String Maximum length : 1500 | options:
|
display_section | Type : String Required Maximum length : 1500 | Name of the display section e.g Docfieldlayout.general_properties__v |
security_override_editable | Type : String Allows multiple values Maximum length : 1500 | To specify users: User.user@domain.com . To specify groups: Group.public_key__v . |
security_override_readonly | Type : String Allows multiple values Maximum length : 1500 | To specify users: User.user@domain.com . To specify groups: Group.public_key__v . |
security_override_hidden | Type : String Allows multiple values Maximum length : 1500 | To specify users: User.user@domain.com .To specify groups: Group.public_key__v . |
default_security | Type : String Maximum length : 1500 | options:
|
set_on_create_only | Type : Boolean | Can only set if the user has a proper MDL admin permission. |
queryable | Type : Boolean | Whether the field is queryable in through VQL |
lookupObjectFieldKey | Type : String Maximum length : 1500 | Reference to Doc field component. Used for the Lookup field type. |
lookupObjectId | Type : String Maximum length : 1500 | Reference to Object component. Used for the Lookup field type. |
lookupFieldId | Type : String Maximum length : 1500 | Reference to Object field component. Used for the Lookup field type. |
shared | Type : Boolean Required | Indicates whether the field is shared or local. |
formula | Type : Expression Maximum length : 4000 | An expression surrounded in [ ] character combination. |
multi_value | Type : Boolean | Indicates whether the field accepts multiple values. |
relationship_criteria | Type : String Allows multiple values Maximum length : 1500 | The VQL used to constrain records in the referenced Object |
relationship_name | Type : String Maximum length : 1500 | Auto-generated name based on the field name and the vault object. |
editable | Type : Boolean | Whether the field is editable by the user. The value here is specific to the user and depends on security_overrides. |
defined_in | Type : String Maximum length : 1500 | The Doc Type this field belongs to (local fields only). e.g. Doctype.my_doc_type__c |
hidden | Type : Boolean | Indicates wether the field is hidden in the UI. The value here is specific to the user and depends on security_overrides. |
help_content | Type : String Maximum length : 500 | UI-friendly help string |
picklist | Type : String Maximum length : 1500 | Reference to Picklist component. Used for the Picklist field type. |
controlling_field | Type : String Maximum length : 1500 | Name of an object e.g. Object.product__v |
relationship_type | Type : String Maximum length : 1500 | Can only return “reference” at this time. |
max_value | Type : Number | Applicable to fields of type number only. |
min_value | Type : Number | Applicable to fields of type number only. |
scale | Type : Number Maximum value : 9 | Applicable to fields of type number only. |
scope | Type : String Maximum length : 1500 | options:
Regular users can create Document scoped fields only Creating DocumentVersion scoped fields requires special security permissions |
required | Type : Boolean Required | Indicates whether the field is required. |
max_length | Type : Number Maximum value : 1500 Minimum value : 1 | Applicable to fields of type string only. |
object | Type : String Maximum length : 1500 | Possible values supported are names of VOF objects, User, Group, and Lifecycle. |
type | Type : String Required Maximum length : 1500 | options:
|
default_value | Type : String Allows multiple values Maximum length : 1500 | The default value used when the field is not set. |
Dependent fields allows you to configure a relationship between a controlling field and one or more controlled or dependent fields.
Learn about Dependent Fields in Vault Help.
Attribute | Description | |
---|---|---|
doctype | Type : Doctype Required | The Doctype the field dependency applies to. |
docfield | Type : Docfield | The Docfield the field dependency applies to. |
docfield_value | Type : String | Specifies the field value that triggers the the action. |
deprule_docfield | Type : Docfield Required | Specifies the Docfield the dependency rule applies to. |
deprule_docfield_action | Type : Enum Required Allowed values :
| The action applied. Specifies the actions to take on the field values. |
deprule_docfield_values | Type : String | The value(s) available when deprule_docfield_action is picklist . |
lifecycle | Type : String | The Doclifecycle the rule applies to. |
The field layout for document fields.
Learn about Document Field Layouts.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in Vault’s base language. |
active | Type : Boolean Required | Whether the layout is active. |
icon | Type : Enum Allowed values :
| The icon to display in the section header. |
order | Type : Number | The order of the section relatve to other sections. |
fields | Type : Docfield Allows multiple values Ordered : True | The Docfield ’s listed in order they should appear in the section. |
Document lifecycles are the sequences of states (Draft, In Review, etc.) a document goes through during its life.
Learn about Document Lifecycles in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in Vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | General description for this lifecycle. |
state_labels | Type : String Required Allows multiple values Maximum length : 1500 Ordered : True | Lists lifecycle state labels (by name) defined for this lifecycle. The order defined here must correspond to the order in labeled_states . |
labeled_states | Type : Doclifecyclestate Required Allows multiple values Ordered : True | Lists “special states” (by name). The order of the state in this list dictates which state from state_labels is assigned to the specific special state. |
expiration | Type : XMLString Maximum length : 32000 | Expiration rules. |
signature_pages | Type : XMLString Maximum length : 32000 | Signature page rules. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in Vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | General description for this lifecycle. |
application_role | Type : String Required Maximum length : 255 | The name__v field value of the application_role__v record this role corresponds to. |
note_color | Type : Enum Allowed values :
| Annotations made by users in this role will use this color by default. |
security_options | Type : XMLString Maximum length : 32000 | The default security rules. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 128 | UI-friendly string in Vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | General description for this lifecycle. |
order | Type : Number Required | The order this state appears in the list. |
cancel_state | Type : Doclifecyclestate | deprecated - replaced by state_labels and labeled_states |
overlay | Type : String Allows multiple values Maximum length : 255 | The overlay template used for this state. |
entry_criteria | Type : XMLString Maximum length : 32000 | The criteria, and the conditions under which they are enforced, which must be satisfied for a document to enter this state. |
entry_action | Type : XMLString Maximum length : 32000 | The actions, and the conditions under which they are executed, which are performed when a document enters this state. |
user_action | Type : XMLString Maximum length : 64000 | The actions, and the conditions under which they are available, which a user can execute when a document is in this state. |
security_settings | Type : XMLString Maximum length : 32000 | The actions a user, in each role, can perform when a document is in this state. |
Dynamic Access Control (DAC) is an access control model for documents, which automates the assignment of users to document roles.
Learn about Dynamic Access Control for Documents in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in Vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
lifecycle | Type : Doclifecycle Required | The lifecycle this rule applies to. |
role | Type : Doclifecyclerole Required | The role this rule applies to. |
description | Type : String Maximum length : 255 | General description for this rule. |
Attribute | Description | |
---|---|---|
object_field | Type : Field Required | The field of the object to match on. |
data_field | Type : Docfield Required | The field on the document to match on. |
object | Type : Object Required | The Object the matching rule is defined on. |
Attribute | Description | |
---|---|---|
lifecycle | Type : Doclifecycle Required | |
role | Type : Doclifecyclerole Required | |
active | Type : Boolean Required | |
description | Type : String Maximum length : 255 | |
label | Type : String Required Maximum length : 60 |
Attribute | Description | |
---|---|---|
object_field | Type : Field Required | |
data_field | Type : Docfield Required | |
object | Type : Object Required |
Document relationship types define the type on relationship between two documents.
Learn about Document Relationships in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in the vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
single_use | Type : Boolean | True when only one relationship of this type can be created for the source document. |
target_doctype | Type : String Maximum length : 1500 | The Doctype of the related document. |
source_version_specific | Type : Boolean | Whether the relationship is bound to the current version of the source document. |
carry_forward_source_specific | Type : Boolean | Whether the relationship will be brought forward when the source document is versioned. |
target_version_specific | Type : Boolean | Whether the relationship is bound to the current version of the target document. |
carry_forward_target_specific | Type : Boolean | Whether the relationship will be brought forward when the target document is versioned. |
relationship_filter | Type : XMLString Maximum length : 32000 | A criteria which restricts the documents that can be related using this type. |
Document types refer to a hierarchical taxonomy to differentiate the various types of documents stored in Vault.
Learn about Document Types in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 200 | UI-friendly string |
active | Type : Boolean Required | Indicates whether the field is active |
allow_attachments | Type : Boolean | Whether documents of this type can have attachments. |
document_number_format | Type : String Maximum length : 512 | The document numbering pattern. If none are specified, the default value is inherited from parent or base |
document_name_format | Type : String Maximum length : 512 | The document numbering pattern. If none are specified the default value is inherited from parent or base If not specified at root, the default is: {FileName} |
etmf_department | Type : String Maximum length : 1500 | The department name from the etmf_departmnet picklist Available in eTMF Vaults only. |
enable_binder_thumbnail | Type : Boolean | |
create_document_permissions | Type : String Allows multiple values Maximum length : 1500 | The list of group or user IDs in the form of user:username or Group.name__v |
create_binder_permissions | Type : String Allows multiple values Maximum length : 1500 | The list of group or user IDs in the form of user:username or Group.name__v |
role_defaulting_editors | Type : String Allows multiple values Maximum length : 1500 | The list of group or user IDs in the form of user:username or Group.name__v |
role_defaulting_viewers | Type : String Allows multiple values Maximum length : 1500 | The list of group or user IDs in the form of user:username or Group.name__v |
role_defaulting_consumers | Type : String Allows multiple values Maximum length : 1500 | The list of group or user IDs in the form of user:username or Group.name__v |
processes | Type : String Allows multiple values Maximum length : 1500 | The list of process names. These come from processes picklists |
doctype_group | Type : String Allows multiple values Maximum length : 1500 | List of Document Group (doc_type_group__v ) linked to this Doctype |
regen_doc_name_on_save | Type : Boolean | Whether auto-generated names should be refreshed when saving the document. |
etmf_rm_v2 | Type : String Maximum length : 1500 | eTMF Reference Model V2 Hierarchy Item external id, (e.g.,tmf_rm_v2_04.02 ) Available in eTMF Vaults only. |
etmf_rm_v3 | Type : String Maximum length : 1500 | eTMF Reference Model V3 Hierarchy Item external id, (e.g., tmf_rm_v3_04.02 ) Available in eTMF Vaults only. |
clinical_docs_rm | Type : String Maximum length : 1500 | |
relationship_types | Type : String Allows multiple values Maximum length : 1500 | The list of Docrelationshiptype names supported. |
default_workflows | Type : String Allows multiple values Maximum length : 1500 | The list consists of Doclifecycle /Workflow combinations separated by a colon (:) (e.g., promotional_field__c:start_mld_review__c ) |
milestone_types | Type : String Allows multiple values Maximum length : 1500 | |
available_lifecycles | Type : String Allows multiple values Maximum length : 1500 | The list of Doclifecycle names. If none are specified, the default value is inherited from parent or base |
rendition_types | Type : String Allows multiple values Maximum length : 1500 | The list of Renditiontype names supported. |
description | Type : String Maximum length : 350 | |
filters | Type : String Allows multiple values Maximum length : 1500 | Names of fields for document fields using MDL notation (e.g., Docfield.field__v ) Additional special filters:
|
fields | Type : String Allows multiple values Maximum length : 1500 | The list of Docfield components linked to this Doctype |
Formatted output templates allow quick transfer of complete object record data into a customized template file.
Learn about Formatted Output in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
root_object_type | Type : Objecttype Required | Root Object for the formatted output if the object has object types. |
root_object | Type : Object Required | Root Object for the formatted output, for example, Application. |
template_file | Type : File Required | A template XFA PDF file to upload and attach. |
Vault’s job scheduler provides a simpler, streamlined way for Admins to create a batch operation and schedule it to repeatedly execute.
Learn about Jobs in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
trigger_date | Type : Expression Maximum length : 4000 | Tthe special date Vault evaluates for documents as of the job’s run date, each tie the job runs |
month_repeat_type | Type : Enum Allowed values :
| Day of the month or week for a scheduled job. |
week_day | Type : Enum Allowed values :
| Day of the week |
repeat_on_days | Type : Enum Allows multiple values Allowed values :
| The number of the day to repeat the job on. |
timezone | Type : String Maximum length : 1500 | Timezone as used in the TZ variable. Example: America/Los_Angeles |
schedule | Type : String Maximum length : 1500 | The frequency of a scheuled job. options:
|
owner | Type : String Maximum length : 1500 | The group or user that owns the report job. |
time | Type : String Maximum length : 1500 | The scheduled time of the report job.
|
day_of_month | Type : Number Maximum value : 31 | Specify the day of the month for a monthly report. |
week_number | Type : Number Maximum value : 5 | Week number for a monthly report that runs on a “day of the week” |
priority | Type : String Maximum length : 1500 | e.g. normal |
type | Type : String Maximum length : 1500 | Indicates job type. Example:
|
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . Always set to true . Always set to true . Always set to true . The primary operation that the job completes. |
notify_on_status_condition | Type : Boolean | Always set to true . Always set to true . Always set to true . |
conditions | Type : String Allows multiple values Maximum length : 1500 | Defines the query that finds and selects qualified documents for a document operation job. Defines the query that finds and selects qualified documents for a document operation job. Defines the query that finds and selects qualified documents for a document operation job. Defines the query that finds and selects qualified documents for a document operation job. |
destination_state | Type : String Maximum length : 1500 | Defines the lifecycle state to set. |
terminate_existing_workflows | Type : Boolean | Indicates whether to cancel existing workflows to perform action. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . Always set to true . Always set to true . Always set to true . The primary operation that the job completes. |
conditions | Type : String Allows multiple values Maximum length : 1500 | Defines the query that finds and selects qualified documents for a document operation job. Defines the query that finds and selects qualified documents for a document operation job. Defines the query that finds and selects qualified documents for a document operation job. Defines the query that finds and selects qualified documents for a document operation job. |
notify_on_status_condition | Type : Boolean | Always set to true . Always set to true . Always set to true . |
recipients | Type : String Allows multiple values Maximum length : 1500 | Defines the roles that will receive the notification. Defines the roles that will receive the notification. |
template | Type : String Maximum length : 1500 | Defines the text that is sent as the notification. Defines the text that is sent as the notification. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . Always set to true . Always set to true . Always set to true . The primary operation that the job completes. |
run_as_user | Type : String Maximum length : 1500 | Defines the user account the vault uses to complete an extenral URL call job. |
session_granted_by | Type : String Maximum length : 1500 | Defines which user to “Run as”. |
external_url | Type : String Maximum length : 1500 | Defines (as a link) what URL is accessed then the job executs the External URL Call job action. |
post_session_creds | Type : Boolean | Indicates whether to post session credentials via form data with key “Session.id”. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . Always set to true . Always set to true . Always set to true . The primary operation that the job completes. |
conditions | Type : String Allows multiple values Maximum length : 1500 | Defines the query that finds and selects qualified documents for a document operation job. Defines the query that finds and selects qualified documents for a document operation job. Defines the query that finds and selects qualified documents for a document operation job. Defines the query that finds and selects qualified documents for a document operation job. |
notify_on_status_condition | Type : Boolean | Always set to true . Always set to true . Always set to true . |
recipients | Type : String Allows multiple values Maximum length : 1500 | Defines the roles that will receive the notification. Defines the roles that will receive the notification. |
template | Type : String Maximum length : 1500 | Defines the text that is sent as the notification. Defines the text that is sent as the notification. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . Always set to true . Always set to true . Always set to true . The primary operation that the job completes. |
conditions | Type : String Allows multiple values Maximum length : 1500 | Defines the query that finds and selects qualified documents for a document operation job. Defines the query that finds and selects qualified documents for a document operation job. Defines the query that finds and selects qualified documents for a document operation job. Defines the query that finds and selects qualified documents for a document operation job. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . Always set to true . Always set to true . Always set to true . The primary operation that the job completes. |
send_notifications_on_completion | Type : Boolean | Always set to true . |
only_send_notifications_if_result | Type : Boolean | Indicates whether to send a notification when no results are returned. |
include_report_in_email | Type : Boolean | Indicates whether to include a copy of the report in the notification. |
report_name | Type : String Maximum length : 1500 | Defines the name of the report. |
Defines a Web Action.
Learn about Web Actions in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in Vault’s base language. |
send_session_via_post_message | Type : Boolean | Specifies the option to send post session credentials via post message instead of through the URL. |
url | Type : String Required Maximum length : 2083 | Defines the URL link for the web action. |
component | Type : Enum Required Allowed values :
| Specifies whether the action applies to documents or objects records. |
target | Type : Enum Required Allowed values :
| Controls where the target URL displays when a user executes the web action. |
Matching Sharing Rules are part of Dynamic Access Control for objects. These rules allow assignment of users to Auto Managed groups and dynamic assignment of those groups to roles on specific object records.
Learn about Configuring Matching Sharing Rules for Objects in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 100 | UI-friendly string in Vault’s base language. |
active | Type : Boolean Required | Indicates whether the field is active. |
description | Type : String Maximum length : 255 | General description of the matching rule. |
object | Type : Object Required | The object the rule applies to. |
role | Type : String Required Maximum length : 60 | The role the rule applies to. |
user_role_fields | Type : String Required Allows multiple values Maximum length : 56 Ordered : True | A list of User Role Object Fields used to identify matching rows. |
data_fields | Type : String Required Allows multiple values Maximum length : 56 Ordered : True | A list of Object or Document Fields used to identify matching rows. |
Defines a template for email and notification messages sent by Vault.
Notification templates use special pieces of text called tokens. When sending a notification, Vaule replaces the token with the values it represents. Learn about Notification Messages in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in Vault’s base language. |
active | Type : Boolean Required | Whether the component is active. |
description | Type : String Maximum length : 255 | Additional description of the notification template. |
subject | Type : String Required Maximum length : 255 | Subject of the email sent to the receipient. |
notification | Type : String Required Maximum length : 1023 | The message that appears in vault’s notification page for the recipient. |
email_body | Type : String Required | Body of the email sent to the notification recipient. |
entity_type | Type : Enum Required Allowed values :
| Indiciates whether the message is intended for documents or objects. |
referenced_component | Type : Object | The specific Object (when entity_type is object ). |
Objects define the data model for the vault.
Learn about Vault Objects in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in the vault’s base language. |
active | Type : Boolean Required | Indicates whether the object is active. |
label_plural | Type : String Required Maximum length : 40 | Plural of the label in the vault’s base language. |
description | Type : String Maximum length : 255 | Description of the object in the vault’s base language. |
help_content | Type : String Maximum length : 255 | Hover text to display for the (?) icon in the Business Admin for this object. Custom help text that appears in the UI when users hover over the field. |
in_menu | Type : Boolean Required | Indicates whether the object appears in the Business Admin menu. |
enable_esignatures | Type : Boolean | Indicates whether eSignatures are enabled on the object. |
allow_attachments | Type : Boolean | Indicates whether the object allows file attachments. |
audit | Type : Boolean Required | Indicates whether Vault tracks object record changes in the audit logs. |
order | Type : Number | Order for the object to display in the Business Admin sidebar. The order in which the fields appears in List Layout. |
dynamic_security | Type : Boolean | Enables Custom Sharing Rules for the object. |
system_managed | Type : Boolean | Indicates that records are managed by the system. |
available_lifecycles | Type : Objectlifecycle | Defines the lifecycle (by name) that manages the object, e.g., Objectlifecycle.general_lifecycle__v . |
object_class | Type : Enum Allowed values :
| Classification of the object. |
allow_types | Type : Boolean | Indicates whether the object supports Objecttype . |
user_role_setup_object | Type : Object | |
default_obj_type | Type : Objecttype | The default Objecttype |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in the vault’s base language. |
active | Type : Boolean Required | Indicates whether the object is active. |
type | Type : Enum Required Allowed values :
| Defines the field’s data type. |
required | Type : Boolean Required | Indicates whether the user must always enter a value |
unique | Type : Boolean | Indicates whether the field’s value must be unique. |
max_length | Type : Number Maximum value : 32000 Minimum value : 1 | (Text fields only) Defines the maximum number of characters for the field value. |
max_value | Type : Number | (Number fields only) Defines the maximum numeric value for the field value. |
min_value | Type : Number | (Number fields only) Defines the minimum numeric value for the field value. |
scale | Type : Number Maximum value : 9 | (Number fields only) Defines the maximum number of decimal places for the field value. |
help_content | Type : String Maximum length : 255 | Hover text to display for the (?) icon in the Business Admin for this object. Custom help text that appears in the UI when users hover over the field. |
list_column | Type : Boolean Required | Indicates if the field should display in default object record lists, hovercards, etc. |
order | Type : Number | Order for the object to display in the Business Admin sidebar. The order in which the fields appears in List Layout. |
multi_value | Type : Boolean | (Picklist fields only) Indicates if the field is multi-select. |
object | Type : String Maximum length : 50 | (Object fields only) Defines the related object (by name), e.g., country__v . |
relationship_type | Type : Enum Allowed values :
| (Object fields only) Indicates the relationship type. |
relationship_outbound_name | Type : String Maximum length : 50 | (Object fields only) Indicates the Outbound Relationship Name, e.g., edl__vr on EDL Item. |
relationship_inbound_name | Type : String Maximum length : 50 | (Object fields only) Indicates the Inbound Relationship Name, e.g., edl_item__vr on EDL. |
relationship_inbound_label | Type : String Maximum length : 40 | (Object fields only) Indicates the Outbound Relationship Label, e.g., EDL on EDL Item. |
controlling_field | Type : String Maximum length : 50 | Controlling field name, if any. |
relationship_deletion | Type : Enum Allowed values :
| (Object fields only) Defines the Deletion Rules that apply to when users try to delete the referenced or parent object record. |
relationship_criteria | Type : Expression Maximum length : 4000 | (Object fields only) VQL WHERE clause expression which specifies the criteria that an object record must meet for the relationship. |
system_managed_name | Type : Boolean | Indicates if the [name] value is automatically generated by the system. When true , the field becomes read-only. |
start_number | Type : Number Minimum value : 1 | First sequence number for the system-managed name value. |
value_format | Type : String Maximum length : 128 | Format for the system-managed name value, e.g., VV-{###} . |
component | Type : String Maximum length : 40 | (Component fields only) The Component Type values can refer to. |
relationship_deep_copy | Type : Boolean | (Object fields only) Indicates if the child records associated via this field are available for hierarchical copy. |
picklist | Type : String | (Picklist fields only) |
lookup_relationship_name | Type : String Maximum length : 50 | (Lookup fields only) Defines the relationship (by [name]) that a Lookup field uses. |
lookup_source_field | Type : String Maximum length : 50 | (Lookup fields only) Defines the field on the referenced object that should appear as a Lookup field on the current object. |
document_version_reference | Type : String Maximum length : 40 | Either specific or latest |
related_document_reference_field | Type : String Maximum length : 128 | |
no_copy | Type : Boolean | When true a value will no be set in a copied record. Cannot be true when required is true . |
create_object_inline | Type : Boolean | |
sequential_naming | Type : Boolean | Indicates the system controls the name be seqential. |
default_value | Type : String Maximum length : 1500 | The default value of the field. |
checkbox | Type : Boolean | Indicates whether “Yes/No” field will display as a checkbox. |
formula | Type : String Maximum length : 1500 | An expression surrounded in [ ] character combination. |
multi_part_field | Type : Enum Allowed values :
| Indicates whether the prefix and suffix of multi-part field is editable. |
multi_part_readonly | Type : String Maximum length : 1500 | The read-only text of a multi-part field. |
show_as_icon | Type : Boolean | |
show_in_header | Type : Enum Allowed values :
|
Definition of the lifecycle of an Object
.
Object lifecycles are sequences of states (In Review, Approved, etc.) that an object record can go through during its life. Learn about Object Lifecycles.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in Vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
labeled_states | Type : Objectlifecyclestate Allows multiple values Ordered : True | Lists “special states” (by name). The order of the state in this list dictates which state from state_labels is assigned to the specific special state. |
state_labels | Type : String Allows multiple values Maximum length : 255 Ordered : True | Lists lifecycle state labels (by name) defined for this lifecycle. The order defined here must correspond to the order in labeled_states . |
starting_state | Type : Objectlifecyclestate | deprecated - replaced by state_labels and labeled_states |
description | Type : String Maximum length : 255 | Additional information to describe the lifecycle. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in Vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
record_status | Type : Enum Allowed values :
| Indicates the status of a record while in this state. |
record_inactive | Type : Boolean | deprecated - replaced by record_status |
description | Type : String Maximum length : 255 | Additional information to describe the lifecycle. |
Attribute | Description | |
---|---|---|
rule | Type : XMLString Required Maximum length : 32000 | The defined rules and conditions for entry criteria, entry actions, or user actions. |
Attribute | Description | |
---|---|---|
rule | Type : XMLString Required Maximum length : 32000 | The defined rules and conditions for entry criteria, entry actions, or user actions. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in Vault’s base language. |
rule | Type : XMLString Required Maximum length : 32000 | The defined rules and conditions for entry criteria, entry actions, or user actions. |
order | Type : Number Required | The relative order in which the action displays. |
Attribute | Description | |
---|---|---|
active | Type : Boolean Required | Indicates whether the component is active. |
application_role | Type : String Required Maximum length : 60 | The name__v field value of the application_role__v record this role corresponds to. (Prefixed with Applicationrole. ) |
permissions | Type : Enum Allows multiple values Allowed values :
| List of permissions assigned to the object role. Note that
|
Attribute | Description | |
---|---|---|
states | Type : Objectlifecyclestate Required Allows multiple values Ordered : True | Lists the object lifecycle states in which the permission applies. |
role | Type : Objectlifecyclerole Required | The role to which this permission applies. |
permission | Type : Enum Required Allowed values :
| The permission to apply. |
An object type is a collection of fields that are grouped to capture similar but not identical data within a single object.
Not all objects use object types. Learn about Object Types in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in the vault’s base language. |
active | Type : Boolean Required | Indicates whether the object is active. |
label_plural | Type : String Required Maximum length : 40 | Plural of the label in the vault’s base language. |
Attribute | Description | |
---|---|---|
source | Type : Enum Required Allowed values :
| The owner of the type. e.g. standard indicates owned by vault. |
required | Type : Boolean | Indicates whether the user must always enter a value |
relationship_criteria | Type : Expression Maximum length : 4000 | The VQL used to constrain records in the referenced Object . |
pickentries | Type : String Allows multiple values Maximum length : 1500 | The picklist values allowed for this field when the record is of this type. (Only valid for Fields of type Picklist ) |
Attribute | Description | |
---|---|---|
action | Type : String Required Maximum length : 1500 | The Objectaction allowed |
Object workflows apply to a single object lifecycle and a single object.
Learn about Object Workflows in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in Vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
object_lifecycles | Type : Objectlifecycle Required Allows multiple values | The Objectlifecycle to which this workflow belongs. |
description | Type : String Maximum length : 255 | Description of the workflow. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in Vault’s base language. |
type | Type : Enum Required Allowed values :
| The type of step. |
next_steps | Type : Objectworkflowstep Allows multiple values | The Objectworkflowstep to move to once this step is complete. |
step_detail | Type : XMLString Maximum length : 32000 | Details of the step configuration. |
description | Type : String Maximum length : 255 | Description of the workflow. |
Overlays allow you to apply information to a vieable rendition when users download it from Vault.
Learn about Managing Overlays in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. Indicates whether the component is active. |
watermark | Type : String Maximum length : 1500 | Diagnal watermark that appears across the center of the downloaded rendition. |
footer_01 | Type : String Maximum length : 1500 | Footer row 1 |
footer_02 | Type : String Maximum length : 1500 | Footer row 2 |
active | Type : Boolean | Indicates whether the component is active. Indicates whether the component is active. |
header_01 | Type : String Maximum length : 1500 | Header row 1 |
label | Type : String Maximum length : 60 | UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. |
header_02 | Type : String Maximum length : 1500 | Header row 2 |
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. Indicates whether the component is active. |
file | Type : File Required | Reference to the file |
The layout of an object detail page.
Learn about Page Layouts in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 100 | UI-friendly string in Vault’s base language. |
page_markup | Type : XMLString Required Maximum length : 32000 | Defines page layout using HTML markup. |
Represents a page link that navigates users to custom page destinations.
Learn about Page Links in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in Vault’s base language. |
description | Type : String Maximum length : 255 | A general description of the page link. |
url | Type : String Required Maximum length : 1500 | Defines the URL link for the page link. |
mode | Type : Enum Required Allowed values :
| Determines which action redirects the user to a custom page. |
page_type | Type : Enum Required Allowed values :
| Specifies the type of page link. Object is the only allowed value at this time. |
object | Type : Object | Sepcifies the object that the page link will override behavior for. |
Permission sets are a way to group permissions together. Security profiles then use the permission sets to grant or restrict users’ access to certain features.
Note that the configruation of this component varies by vault. Learn about Permission sets in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | A general description of the permission. |
Picklists allow users to select a value for a field from a range of predefined options.
Learn about Picklists in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in the vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
Attribute | Description | |
---|---|---|
active | Type : Boolean Required | Indicates whether the component is active. |
value | Type : String Required Maximum length : 128 | UI-friendly string for the value of the entry (in the vault’s base language). |
order | Type : Number Required | Defines the ordinal position of the entry in the picklist. |
Renditions are files that users can add to documents. Rendition types describe the kind or purpose of the rendition.
Learn about Rendition Types in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
Represents a Vault report.
Learn about Reporting in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in Vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | A general description about the report. |
format | Type : Enum Required Allowed values :
| The output format of the report. For example, a Tabular or Matrix report. |
definition | Type : XMLString Required Maximum length : 32000 | The query to use to pull the data. |
layout | Type : XMLString Required Maximum length : 32000 | The layout of the data. |
content_type | Type : Enum Required Allowed values :
| Specifies the type of data the report refers to. |
report_type | Type : Reporttype | The Reporttype this instance of the report was created from. |
Report Type determines the “reporting objects” for Vault reports. Vault report types allow you to build the foundation for users to create and customize reports.
Learn about Report Types in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in Vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | A general description about the report type. |
primary_object | Type : String Required Maximum length : 255 | Primary entity or Object for the report type, for example, Document. |
configuration | Type : XMLString Required Maximum length : 32000 | Details of the report type. |
Definition of a searchable object Field.
Learn about Searchable Object Fields in Vault Help.
Attribute | Description | |
---|---|---|
field | Type : Object.Field | Defines the object field (by [name]) of the searchable field, e.g., abbreviation__v. |
active | Type : Boolean | Indicates whether the component is active. |
label | Type : String Maximum length : 60 | UI-friendly string in Vault’s base language. |
required | Type : Boolean | Whether this component must exist (every Object must have at least one). |
object | Type : Object | Defines the object (by [name]) that the searchable field belongs to, e.g., country__v . |
Security profiles are how Vault applies permissions sets to individual users.
Learn about Security Profiles in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in Vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | Description of the security profile. |
permission_sets | Type : Permissionset Allows multiple values Required | List of permiission sets contained within the profile. |
Vault uses Sharing Rules to manage users’ roles on specific object records by matching rule criteria to specific user assignments.
Note that the configruation of this component varies by vault. Learn about Custom Sharing Rules in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | A general description of the rule. |
object | Type : Object Required | The type of object the rule applies to. |
criteria | Type : Expression Maximum length : 4000 | A VQL statement where clause that returns a list of records of the specified object type. |
Attribute | Description | |
---|---|---|
members | Type : String Allows multiple values Maximum length : 300 | A list of the groups and/or users that will be given the associated permission. To specify users: User.user@domain.com . To specify groups: Group.public_key__v . |
Signature pages display the manifested signatures for a Vault document.
Learn about Signature Pages in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
signature_block_02 | Type : String Maximum length : 1500 | Signature block 2 |
signature_block_01 | Type : String Maximum length : 1500 | Signataure block 1 |
file | Type : File | Reference to the file |
footer_01 | Type : String Maximum length : 1500 | Footer row 1 |
footer_02 | Type : String Maximum length : 1500 | Footer row 2 |
header_01 | Type : String Maximum length : 1500 | Header row 1 |
location | Type : Enum Allowed values :
| Specifies whether the signature page appears at the beginning or end of the document. |
header_02 | Type : String Maximum length : 1500 | Header row 2 |
A Tab within the UI of Vault.
Learn about Tabs in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in Vault’s base language. |
order | Type : Number Required | The relative order of the tabs within Vault’s navigation bar. |
object | Type : String Maximum length : 50 | (Object tabs) The Object to display records for e.g. product__v . |
doctype | Type : String Maximum length : 50 | (Document type tab) The Doctype to display documents for e.g., promotional_piece__c . |
subtype | Type : String Maximum length : 100 | (Document type tab) The Doctype subtype to display documents for e.g. promotional_piece__c.advertising__c . |
classification | Type : String Maximum length : 150 | (Document type tab) The Doctype classification to display documents for e.g. promotional_piece__c.advertising__c.print__c . |
url | Type : LongString Maximum length : 2048 | The target URL (if a web Tab). |
send_session_via_post_message | Type : Boolean | Whether to send the user’s current session token (if a web Tab) |
parent | Type : String Maximum length : 43 | Name of the parent Tab . |
all_view_label | Type : String Maximum length : 40 | UI-friendly string in All view |
my_view_label | Type : String Maximum length : 40 | UI-friendly string in My view |
recent_view_label | Type : String Maximum length : 40 | UI-friendly string in Recent view |
vault_target | Type : String Maximum length : 50 | |
object_type | Type : Objecttype | The Objecttype (if an object type Tab) |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in Vault’s base language. |
order | Type : Number Required | The relative order of the tabs within Vault’s navigation bar. |
object | Type : String Maximum length : 50 | (Object tabs) The Object to display records for e.g. product__v . |
doctype | Type : String Maximum length : 50 | (Document type tab) The Doctype to display documents for e.g., promotional_piece__c . |
subtype | Type : String Maximum length : 100 | (Document type tab) The Doctype subtype to display documents for e.g. promotional_piece__c.advertising__c . |
classification | Type : String Maximum length : 150 | (Document type tab) The Doctype classification to display documents for e.g. promotional_piece__c.advertising__c.print__c . |
url | Type : LongString Maximum length : 2048 | The target URL (if a web Tab). |
send_session_via_post_message | Type : Boolean | Whether to send the user’s current session token (if a web Tab) |
parent | Type : String Maximum length : 43 | Name of the parent Tab . |
all_view_label | Type : String Maximum length : 40 | UI-friendly string in All view |
my_view_label | Type : String Maximum length : 40 | UI-friendly string in My view |
recent_view_label | Type : String Maximum length : 40 | UI-friendly string in Recent view |
vault_target | Type : String Maximum length : 50 | |
object_type | Type : Objecttype | The Objecttype (if an object type Tab) |
A workflow is a series of steps configured in Vault to align with a specific business purpose.
Learn about Document Workflows in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 40 | UI-friendly string in Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
lifecycle | Type : Docifecycle Required Allows multiple values | The Doclifecycle to which this workflow belongs. |
description | Type : String Maximum length : 255 | Description of the workflow. Description of the workflow. |
workflow_type | Type : String Allows multiple values Maximum length : 1500 | The type of workflow. |
bulk_email_message | Type : LongString Required Maximum length : 1500 | When the workflow is started through bulk actions, this message template will be used to inform users. |
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 40 | UI-friendly string in Vault’s base language. |
status | Type : Boolean | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | Description of the workflow. Description of the workflow. |
flow_type | Type : Enum Required Allowed values :
| The type of worflow step. |
next_steps | Type : Docworkflowstep Allows multiple values | The Docworkflowstep to move to once this step is complete. |