Component types are the configuration elements of a vault. MDL allows you to access these elements and execute scripts to automate complex or repetitive configuration changes in your vault. This page contains details for the component types available in Vault.
Some component types are visible through the Vault REST API, but are not included in this reference. These component types can only be used by internal Veeva developers.
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. For example, Object.country__v |
object_lifecycle | Type : Objectlifecycle Required | The Objectlifecycle the security applies to. For example, Objectlifecycle.general_lifecycle__c |
state | Type : Objectlifecyclestate Required | The Objectlifecyclestate of the Objectlifecycle the security applies to. For example, 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. For example, Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles. |
type | Type : Enum Required Allowed values :
| The type of 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. For example, Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles. |
type | Type : Enum Required Allowed values :
| The type of 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. |
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. For example, Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles. |
type | Type : Enum Required Allowed values :
| The type of permission to apply. |
workflow_actions | Type : Enum Allows multiple values Allowed values :
| The workflow action to apply. |
workflow_task_actions | Type : Enum Allows multiple values Allowed values :
| The workflow task action to apply. |
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. For example, Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles. |
type | Type : Enum Required Allowed values :
| The type of permission to apply. |
document_fields | Type : Docfield Allows multiple values | Lists the object fields corresponding to the object-to-document inbound relationship on the specified object. |
object_fields | Type : Field Allows multiple values | Lists the object fields corresponding to the object-to-object relationship on the specified object. |
Checklists are a data entry method that allows a user to enter data in question and answer format.
Learn about Designing Checklists in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
target_object | Type : Object Required | The object the checklist applies to. |
target_object_type | Type : Objecttype Required | The target object’s Objecttype . |
version_controlled | Type : Boolean | Indicates whether the checklist type is version controlled. Learn more about checklist versioning in Vault Help. |
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
target_matching_field | Type : Subcomponent | The field on the target object. This is used to match a value from the target object record with the corresponding matching field value on the Checklist Design object. |
target_object | Type : Object Required | The object the checklist applies to. |
checklist_design_matching_field | Type : Subcomponent Required | The field on the checklist design object. This is used to match a value from the Checklist Design object record with the corresponding matching field value on the target object. |
checklist_design_object | Type : Object Required | The object the checklist design applies 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. |
Atomic security for documents provides more granular control, based on lifecycle state and role, over who can perform specific lifecycle user actions like changing document state and starting a workflow. For example, the Editor role may be able to start the Review workflow, but not the Expedited Approval workflow.
Learn more about Atomic Security for Documents 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 field is active. |
document_lifecycle | Type : Doclifecycle Required | Indicates the lifecycle that atomic security applies to. |
state | Type : String Required Maximum length : 1500 | Indicates the lifecycle state that atomic security applies to. |
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in Vault’s base language. |
active | Type : Boolean | Indicates whether the field is active. |
role | Type : String Required Maximum length : 1500 | Indicates the role override that the permission applies to. |
type | Type : Enum Required Allowed values :
| Indicates the permission type. |
workflow_actions | Type : Enum Allows multiple values Ordered : True Allowed values :
| Indicates the active workflow action that the permission applies to. |
workflow_task_actions | Type : Enum Allows multiple values Ordered : True Allowed values :
| Indicates the active workflow task action that the permission applies to. |
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in Vault’s base language. |
active | Type : Boolean | Indicates whether the field is active. |
role | Type : String Required Maximum length : 1500 | Indicates the role override that the permission applies to. |
type | Type : Enum Required Allowed values :
| Indicates the permission type. |
lifecycle_actions | Type : String Allows multiple values Maximum length : 1500 Ordered : True | Indicates the user action that the permission applies to. |
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. For example, 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. |
secure_relationship | Type : Boolean | Enables relationship security on a referenced object. |
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, For example, Object.product__v |
relationship_type | Type : String Maximum length : 1500 | Can only return “reference” at this time. |
no_copy | Type : Boolean | When true a value will not be set in a copied document. Cannot be true when required is true . |
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_value | Type : Number | (Number fields only) If the value is greater than 500 on Objectreference type fields where multi_value is set to true , VQL queries return an unordered list. |
min_value | Type : Number | Applicable to fields of type number only. |
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. |
can_change_disabled | Type : Boolean | For internal Veeva use only. |
can_change_multiple | Type : Boolean | For internal Veeva use only. |
can_change_required | Type : Boolean | For internal Veeva use only. |
can_change_section | Type : Boolean | For internal Veeva use only. |
can_change_no_copy | Type : Boolean | For internal Veeva use only. |
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_multi_value | Type : String Allows multiple values | Specifies the field value or values that trigger the action. |
docfield_value | Type : String | Specifies the field value that triggers the the action. This attribute cannot support individual values containing a comma, for example, “Tanzania, United Republic of”. This attribute is deprecated as of 19R2.3. |
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_multi_values | Type : String Allows multiple values | The value(s) available when deprule_docfield_action is picklist . |
deprule_docfield_values | Type : String | The value(s) available when deprule_docfield_action is picklist . This attribute cannot support individual values containing a comma, for example, “Tanzania, United Republic of”. This attribute is deprecated as of 19R2.3. |
lifecycle | Type : String | The Doclifecycle the dependency rule applies to. |
state | Type : String | The Doclifecycle state the dependency rule applies to. |
role | Type : String | The Doclifecycle role the dependency 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. |
show_in_edit_mode | Type : Boolean | For internal Veeva use only. |
allow_field_assignment | Type : Boolean | For internal Veeva use only. |
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. |
overlays | Type : XMLString Maximum length : 32000 | The overlay template applied to a speciifc lifecycle. |
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 relative order in which the action displays. For example, order 1 will display before order 2 . |
cancel_state | Type : Doclifecyclestate | Indicates the state documents enter when their document workflow is cancelled. |
skip_cancel_state | Type : Boolean | If set to true , documents stay in their current state when their workflow is cancelled. If set to false or omitted, documents enter the state defined by cancel_state when the workflow is cancelled. |
entry_criteria | Type : XMLString Maximum length : 128000 | 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 : 128000 | 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 : 128000 | 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. |
Attribute | Description | |
---|---|---|
active | Type : Boolean Required | Indicates whether the component is active. |
event | Type : String Required Maximum length : 1500 | The type of event action. |
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. For example, order 1 will display before order 2 . |
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. |
Workflow participant rules control which document fields will force the selected role to be required or hidden in the workflow start dialog.
Learn about Workflow Participant Rules in Vault Help.
Attribute | Description | |
---|---|---|
lifecycle | Type : Doclifecycle Required | The document lifecycle the rule applies to. |
role | Type : Doclifecyclerole Required | The lifecycle role the rule applies to. |
active | Type : Boolean Required | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | A general description of the rule. |
label | Type : String Required Maximum length : 60 | UI-friendly string in Vault’s base language. |
Attribute | Description | |
---|---|---|
object_field | Type : Field Required | The field of the object the rule is defined on. |
data_field | Type : Docfield Required | The field on the document the rule is defined on. |
object | Type : Object Required | The Object the participant rule is defined on. This can only be workflow_role_setup__v . |
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. |
binder_unbound_document_display_option | Type : Enum Allowed values :
| Select display options for unbound documents. |
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 | Use a document from within the binder as the binder thumbnail instead of the standard Vault binder icon. |
enable_suggested_links_source | Type : Boolean | Each document type, subtype, and classification can be enabled or disabled for the Suggest Links action. Available in PromoMats vaults only. |
enable_suggested_links_target | Type : Boolean | Each document type, subtype, and classification can be enabled as eligible or not eligible for Suggested Links references. Available in PromoMats vaults only. |
binder_unbound_document_display_option | Type : Enum Allowed values :
| Select display options for unbound documents. |
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 |
inherit_doctype_groups | Type : Boolean | Indicates whether the doctype_group values are inherited from the parent Doctype . |
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 | Vault Clinical Docs Hierarchy Item id. Available in eTMF vaults only. |
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 | The type of milestone. |
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. |
global_content_type | Type : String Maximum length : 1500 | The default global_content_type for the document type. Available in PromoMats vaults only. |
milestone_types | Type : String Allows multiple values Maximum length : 1500 | The type of milestone. |
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. |
Documents can have custom actions that perform specific instructions. You can use a custom action to automate certain business processes.
Learn about Record Role Triggers 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. |
lifecycle | Type : Doclifecycle | The lifecycle where this document action is available. |
user_input_object_type | Type : Objecttype | If your action takes user input, identifies the user input object type. |
checksum | Type : String Maximum length : 1500 | Used to check data for errors. |
user_input_object | Type : Object | If your action takes user input, identifies the user input object. |
usages | Type : String Allows multiple values Maximum length : 1500 | Specifies where in Vault this action is available for configuration and execution. For example, User Action or Entry Action. UNSPECIFIED means the action is available everywhere document actions are supported. |
source_code | Type : SdkCode Maximum length : 1048576 | The source of this document action. For example, Custom means this is a custom action developed with the Vault Java SDK. |
Lifecycle Stages allow organizations to group document and object lifecycle states into ordered collections of “stages”.
Learn about Lifecycle Stages.
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. |
document_lifecycle | Type : Doclifecycle Required | A component reference to Doclifecycle . |
description | Type : String Maximum length : 255 | A general description of the lifecycle stage group. A general description for this document stage. |
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. |
document_lifecycle_states_ref | Type : String Allows multiple values Maximum length : 1500 | A component reference to Doclifecyclestate . |
description | Type : String Maximum length : 255 | A general description of the lifecycle stage group. A general description for this document stage. |
order | Type : Number Required Minimum value : 1 | A number automatically assigned to a stage after it’s created and represents the order of stages in a stage group. |
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. |
Spark Integration Rules provide platform configuration and SDK services for developers building Vault to Vault integration features that require data mapping.
Learn about Integration Rules in the SDK Documentation.
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. |
integration_point | Type : String Maximum length : 40 | Reference to Integration Point by API Name to allow for defining and retrieving of specific Integration Rules related to the Connection and Integration Point. |
primary_query_object | Type : String Maximum length : 1500 | Constrains this integration rule to a particular object or document and allows access to the relationships on that object or document. If omitted, field rules are not constrained and cannot access relationships. |
connection | Type : String Required Maximum length : 40 | Reference to the connection record by api_name__sys . |
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. |
query_object | Type : String Required Maximum length : 1500 | Name of the mapped query object object_name__c . Must be specified as returned in VQL response. |
filter_clause | Type : Expression Maximum length : 4000 | A Criteria VQL expression containing the logic for this query object rule. |
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. |
reference_lookup_type | Type : Enum Allowed values :
| The type of the reference_lookup . lifecyclestate is deprecated as of 19R2.2. Use either objectlifecyclestate or documentlifecyclestate . |
target_object_field | Type : Subcomponent | Subcomponent reference to the Object field. This is required of the target_object is set. |
query_field | Type : String Maximum length : 100 | Name of the mapped query field (field_name__c ). For example, name__v or doc_number__v . |
target_object | Type : Object | References the Object if the target is an Object . |
target_docfield | Type : Docfield | References the Docfield of the target is a Document. |
query_object | Type : String Maximum length : 100 | Name of the mapped query object object_name__c . Must be specified as returned in VQL response. |
field_default | Type : String Maximum length : 1500 | Mapping to a static default. |
reference_lookup | Type : String Maximum length : 45 | Set field based on a reference lookup from the reference_lookup__sys object. |
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. |
active | Type : Boolean Required | Indicates whether the component is active. |
trigger_date | Type : Expression Maximum length : 4000 | The special date Vault evaluates for documents as of the job’s run date, each time 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. |
hourly_interval | Type : Number Maximum value : 12 Minimum value : 1 | For jobs where schedule is set to hourly , the number of hours to wait before repeating the job. |
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 |
active_after_clone | Type : Boolean | Determines if the job will be set to an active state when the cloned vault is created. If no value is specified, the default value is ‘false’. |
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. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
related_doc_conditions | Type : String Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any related documents. |
relationship_types | Type : String Allows multiple values Maximum length : 1500 | Defines which document relationship type to run the primary action on. |
notify_on_status_condition | Type : Boolean | Always set to true . |
trigger_date_target | Type : String Maximum length : 1500 | Defines the date field to be evaluated against the trigger date. |
conditions | Type : String Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any records. |
recipients | Type : String Allows multiple values Maximum length : 1500 | Defines the notification recipients based on a list of roles on the affected records. |
template | Type : String Maximum length : 1500 | Defines the notification template to be used when sending a notification as a result of the job. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
conditions | Type : String Required Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any records. |
object | Type : String Required Maximum length : 1500 | Defines the Vault Object the job will run on. Only records in this Object can be affected. |
recipients | Type : String Allows multiple values Maximum length : 1500 | Defines the notification recipients based on a list of roles on the affected records. |
template | Type : String Maximum length : 1500 | Defines the notification template to be used when sending a notification as a result of the job. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
related_doc_conditions | Type : String Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any related documents. |
notify_on_status_condition | Type : Boolean | Always set to true . |
trigger_date_target | Type : String Maximum length : 1500 | Defines the date field to be evaluated against the trigger date. |
relationship_types | Type : String Allows multiple values Maximum length : 1500 | Defines which document relationship type to run the primary action on. |
conditions | Type : String Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any records. |
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. |
document_version | Type : Enum Allowed values :
| Determines which document version the job will run on. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
conditions | Type : String Required Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any records. |
object | Type : String Required Maximum length : 1500 | Defines the Vault Object the job will run on. Only records in this Object can be affected. |
terminate_existing_workflows | Type : Boolean Required | Indicates whether to cancel existing workflows to perform action. |
destination_state | Type : String Required Maximum length : 1500 | Defines the lifecycle state to set. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
related_doc_conditions | Type : String Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any related documents. |
relationship_types | Type : String Allows multiple values Maximum length : 1500 | Defines which document relationship type to run the primary action on. |
notify_on_status_condition | Type : Boolean | Always set to true . |
trigger_date_target | Type : String Maximum length : 1500 | Defines the date field to be evaluated against the trigger date. |
conditions | Type : String Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any records. |
recipients | Type : String Allows multiple values Maximum length : 1500 | Defines the notification recipients based on a list of roles on the affected records. |
template | Type : String Maximum length : 1500 | Defines the notification template to be used when sending a notification as a result of the job. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
conditions | Type : String Required Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any records. |
object | Type : String Required Maximum length : 1500 | Defines the Vault Object the job will run on. Only records in this Object can be affected. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
run_as_user | Type : String Maximum length : 1500 | Defines the user account the vault uses to complete an extenral URL call job. |
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. |
session_granted_by | Type : String Maximum length : 1500 | Defines which user to “Run as”. |
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. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
job_metadata | Type : String Required Maximum length : 1500 | Reference to the Jobmetadata component of the job to be run. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
conditions | Type : String Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any records. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
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. |
collapse_groups | Type : Boolean | If true , a flash report will expose only group level information in emails. |
include_report_in_email | Type : Boolean | Indicates whether to include a copy of the report in the notification. |
enable_flash_refresh | Type : Boolean | If true , a flash report may be refreshed by users. |
report_name | Type : String Maximum length : 1500 | Defines the name of the report. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
edcAsyncPayload | Type : JSONString Maximum length : 32000 | For internal Veeva use only. |
The Jobmetadata
component is used to define the metadata of an SDK Job. Because SDK Jobs are invoked through their Jobmetadata
, every class implemented using the Job
interface must be associated to a Jobmetadata
component. Note: You may see Vault-supplied SDK jobs which work to deliver various features.
Learn about Administering SDK Job Metadata 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 field is active. |
chunk_size | Type : Number Maximum value : 500 Minimum value : 1 | Defines the number of Job items to be processed in each task. |
single_instance_states | Type : Enum Allows multiple values Allowed values :
| Defines a state or states as single instance. Only one instance of a job is allowed to be in a single instance state at any given time. |
description | Type : String Maximum length : 1500 | Description of the job which displays in the UI. |
job_code | Type : ComponentReference Required | References the fully qualified path name of the job class. |
queue | Type : ComponentReference | The queue the job will place messages into. Custom jobs cannot reference standard queues. |
Layout rules streamline the data entry process by dynamically hiding irrelevant fields and sections on an object record detail page based on business needs.
Learn about Configuring Layout Rules in Vault Help.
Attribute | Description | |
---|---|---|
hide_controls | Type : String Allows multiple values Maximum length : 1500 | Indicates the custom control to hide in the layout rule. |
hide_sections | Type : String Allows multiple values Maximum length : 1500 | Indicates the sections to hide in the layout rule. |
hide_fields | Type : String Allows multiple values Maximum length : 1500 | Indicates the fields to hide in the layout rule. |
active | Type : Boolean Required | Indicates whether the component is active. |
label | Type : String Required Maximum length : 40 | UI-friendly string in the vault’s base language. |
expression | Type : String Required Maximum length : 3900 | A valid expression. |
order | Type : Number | The relative order of the layout rules on the Layout Rules list page. |
description | Type : String Maximum length : 255 | A general description of the Layout Rule. |
Lifecycle state types are groups of lifecycle states across lifecycles that share common behaviors.
Learn more about Object Lifecycle State 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. |
document_lifecycle | Type : Doclifecycle | The document lifecycle the state type belongs to. Not currently supported. |
label_message_key | Type : String Maximum length : 255 | |
description | Type : String Maximum length : 255 | Text description of the state type and how it is used. |
state_required | Type : Boolean Required | Indicates whether a lifecycle must have a lifecycle state associated with the state type. |
lifecycle_scope | Type : Enum Required Allowed values :
| Determines whether the state type applies to all lifecycles, is available to all lifecycles (but not required for all lifecycles), or is relevant to only a specific lifecycle. |
object_lifecycle | Type : Objectlifecycle | The object lifecycle the state type belongs to. |
lifecycle_type | Type : Enum Required Allowed values :
| Indicates whether the state type is supporting document or object lifecycles. Only object lifecycles are currently supported. |
Lifecycle state type associations join a state and a lifecycle state type record.
Learn more about Object Lifecycle State 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. |
document_lifecycle | Type : Doclifecycle | The document lifecycle the state type belongs to. Not currently supported. |
state_type | Type : ComponentReference Required | The state type that is joined to the object lifecycle state. |
description | Type : String Maximum length : 255 | Text description of the state type and lifecycle state association. It is not exposed in the user interface. |
object_lifecycle_state | Type : Subcomponent | The object lifecycle state that is joined to the state type. |
document_lifecycle_state | Type : String Maximum length : 1500 | Describes the document lifecycle state being joined to the state type. Not currently supported. |
object_lifecycle | Type : Objectlifecycle | The object lifecycle that the state type and object lifecycle state belong to. |
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. |
Spark message delivery event handlers provide a way to handle undelivered Spark messages. For example, implement MessageDeliveryEventHandler
in your custom code and add it to an Outbound Queue. When an undeliverable message is encountered, Vault executes the logic coded in the handler.
Learn about Spark Message Delivery Event Handlers.
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. |
checksum | Type : String Maximum length : 1500 | Used to check data for errors. |
source_code | Type : SdkCode Maximum length : 1048576 | The source of this Spark message delivery event handler and code used to create and edit metadata. Custom means this handler was developed with the Vault Java SDK. |
To provide a localized experience, Vault Java SDK developers can create translations for messages displayed to the end user in Vault. To do this, they create the message groups and messages with MDL or use the Message Catalog in the Vault UI. Learn more about creating message groups and messages in Vault Help.
Developers retrieve the messages using TranslationService
. Learn more in the Javadocs.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in Vault’s base language. |
active | Type : Boolean | Indicates whether the field is active. |
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in Vault’s base language. |
active | Type : Boolean | Indicates whether the field is active. |
default_value | Type : String Required Maximum length : 1500 | The default translation value for this message. |
system_managed | Type : Boolean | Indicates whether users can overwrite translation values for this message. |
Spark message processors provide logic to handle Spark messages. For example, all inbound queues must include a Spark message processor to provide the operations to perform on the received messages. You create Spark message processors with the MessageProcessor
interface in the Vault Java SDK.
Learn about Spark Message Processors.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in Vault’s base language. |
active | Type : Boolean | Indicates whether the field is active. |
checksum | Type : String Maximum length : 1500 | Used to check data for errors. |
source_code | Type : SdkCode Maximum length : 1048576 | The source code of this Spark message processor. Custom means this was developed with the Vault Java SDK. |
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 | Indicates 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 the 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. |
data_store | Type : Enum Allowed values :
| Indicates the data store for this object, either standard or high_volume . Once set, this attribute cannot change. |
allow_types | Type : Boolean | Indicates whether the object supports Objecttype . |
user_role_setup_object | Type : Object | Indicates the user role setup object when sharing settings are enabled. Specified as Object.object_name__c . |
default_obj_type | Type : Objecttype | The default Objecttype |
secure_audit_trail | Type : Boolean | If set to true , enables the Secure Audit Trail action for the object. |
secure_sharing_settings | Type : Boolean | Enables ability to control user access to sharing settings. |
secure_attachments | Type : Boolean | If set to true , enables Secure Object Record Attachments for object records of this type. Cannot be set to true if allow_attachments is set to false . |
prevent_record_overwrite | Type : Boolean | If set totrue , enables record-level locking on object records of this type. This prevents users from editing the same record simultaneously and saving over each other’s updates. |
multi_select | Type : Boolean | Indicates whether a complex join related section is multi-select or not. The default value if not specified is false. |
Attribute | Description | |
---|---|---|
show_as_icon | Type : Boolean | If true , show_in_header settings are applied. Can only be used on formula fields with a return type of text. |
related_corporate_currency_field | Type : String Maximum length : 1500 | Contains the name of the related corporate currency field. |
related_local_currency_field | Type : String Maximum length : 1500 | Contains the name of the local currency code field, e.g., local_currency_type (local_currency__sys ). |
controlling_picklist | Type : String Maximum length : 50 | The name of the controlling picklist, if any. |
show_in_header | Type : Enum Allowed values :
| If set to left or right , the field is shown as an icon in the left or right of the header. Can only be used on formula fields with a return type of text. |
secure_relationship | Type : Boolean | Enables relationship security on a referenced object. |
picklist_dependencies | Type : String Maximum length : 32000 | Contains comma-delimited list of all dependencies for the controlling picklist. For example, ’{ "english__c" : [“united_kindom__c ”, “united_states__c ”]}’ |
encrypted | Type : Boolean | Indicates whether the field is encrypted. Learn more about encryption in Vault Help. |
subtype | Type : Enum Allowed values :
| Determines that the field is of the Currency or Link type. |
label | Type : String Required Maximum length : 40 | UI-friendly string in the vault’s base language. |
type | Type : Enum Required Allowed values :
| Defines the field’s data type. |
active | Type : Boolean Required | Indicates whether the object is active. |
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 the 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 : 500 | 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 | The name of the related document reference field. For example, study_document__c . Indicates that this field is an Unbound Document Field. |
no_copy | Type : Boolean | When true a value will not be set in a copied record. Cannot be true when required is true . |
create_object_inline | Type : Boolean | (Object fields only) If set to true , users can create a new reference record within an object reference field. |
sequential_naming | Type : Boolean | Indicates the system controls the name be sequential. |
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. |
For use with objects where data_store
is high_volume
. While Vault indexes standard
objects for search and filtering automatically, Vault indexes high_volume
object metadata using a combination of automatic and up to five (5) custom index definitions. You define custom Indexes
to meet filtering needs.
Learn more about high volume objects in Vault Help.
Attribute | Description | |
---|---|---|
description | Type : String Maximum length : 1500 | A description of this index. |
label | Type : String Required Maximum length : 1500 | UI-friendly string in the vault’s base language. |
fields | Type : String Required Allows multiple values Maximum length : 1500 | The list of fields for this index. Note that Vault cannot index LongText fields, or Text fields longer than 255 characters. |
Object user actions are configurable instances of a Vault Action that you can define for an object and object types.
Learn about Object Actions 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 | General description of the object action. |
parameters | Type : XMLString Maximum length : 32000 | Values for any parameters the Action requires. |
action | Type : Recordaction Required | The Action code to run. |
available_all_states | Type : Boolean | Indiciates if the Action is available for all lifecycle states. |
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. Deprecated - replaced by Lifecyclestatetypeassociation . |
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 . Deprecated - replaced by Lifecyclestatetypeassociation . |
starting_state | Type : Objectlifecyclestate | The name of the starting state of an object lifecycle. |
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. |
order | Type : Number | The relative order in which the action displays. For example, order 1 will display before order 2 . |
Attribute | Description | |
---|---|---|
rule | Type : XMLString Required Maximum length : 32000 | The defined rules and conditions for entry criteria, entry actions, or user actions. |
order | Type : Number | The relative order in which the action displays. For example, order 1 will display before order 2 . |
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. For example, order 1 will display before order 2 . |
Attribute | Description | |
---|---|---|
rule | Type : XMLString Required Maximum length : 32000 | The defined rules and conditions for entry criteria, entry actions, or user actions. |
event | Type : String Required Maximum length : 1500 | |
order | Type : Number Required | The relative order in which the action displays. For example, order 1 will display before order 2 . |
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. |
Lifecycle Stages allow organizations to group document and object lifecycle states into ordered collections of “stages”.
Learn about Lifecycle Stages.
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. |
object_type | Type : Objecttype Required | The Objecttype of the Lifecycle Stage Group. If an object type is not enabled, the object type will be BASE by default. |
description | Type : String Maximum length : 255 | General description for this object lifecycle stage group. General description for this object stage. |
object_lifecycle | Type : Objectlifecycle Required | Reference to Objectlifecycle component type. Validation ensures that only one Objectstagegroup exists per Objectlifecycle.Objecttype . |
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. |
object_lifecycle_states_ref | Type : String Allows multiple values Maximum length : 1500 | Reference to the Objectlifecyclestate . Validation ensures that a Objectlifecyclestate only exists in one object stage. |
description | Type : String Maximum length : 255 | General description for this object lifecycle stage group. General description for this object stage. |
order | Type : Number Required Minimum value : 1 | A number automatically assigned to a stage after it’s created and represents the order of stages in a stage group. |
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. |
label_plural | Type : String Required Maximum length : 40 | Plural of the label in the vault’s base language. |
active | Type : Boolean Required | Indicates whether the object is active. |
additional_type_validations | Type : String Allows multiple values Maximum length : 1500 | Contains a list of all validation rules for the specified object type. |
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 ) |
default_value | Type : String Maximum length : 1500 | The type specific default expression for the field. |
Attribute | Description | |
---|---|---|
action | Type : String Required Maximum length : 1500 | The Objectaction allowed. |
Validation rules enhance data quality by comparing user-entered data with Admin-defined rules for an object record.
Learn about Record Validation Rules 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 validation is active. |
expression | Type : String Required Maximum length : 3900 | A valid expression. |
description | Type : String Maximum length : 255 | Describes the details of the validation rule. |
error_message | Type : String Required Maximum length : 255 | Describes the error that displays if the rule fails. |
error_location | Type : String Required Allows multiple values Maximum length : 255 | Select fields for the error location. |
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. The Objectlifecycle must be associated with an Object . |
document_content_lifecycle | Type : Doclifecycle | The Doclifecycle to which this workflow belongs. |
description | Type : String Maximum length : 255 | Description of the workflow. |
auto_start | Type : Boolean | |
envelope_name_format | Type : String Maximum length : 128 | The format used to auto-number envelope workflows in vaults where auto-numbering is configured. |
workflow_variables | Type : XMLString Maximum length : 32000 | Admin-defined variables which workflow initiators can select at the start of a 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. |
tags | Type : String Allows multiple values Maximum length : 40 | |
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 |
header_01 | Type : String Maximum length : 1500 | Header row 1 |
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. |
page | Type : Page | For internal Veeva use only. |
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 configuration 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. |
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. |
This component is specific to Quality family vaults and supports the External Audit Collaboration features of the QMS application. Use Qmsautomationusertemplate to automatically create External User accounts for existing Person records.
Learn about QMS 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. If the component or subcomponent is inactive, no one in the vault can edit team membership using this team or Team Role. |
description | Type : String Maximum length : 500 | UI-friendly description of the intended use of this automation template for Vault Admins. |
username_pattern | Type : String Required Maximum length : 1500 | Tokenized pattern used to generate a username from the attributes of a Person & their Organization. |
security_profile | Type : Securityprofile Required | Defines the Security Profile to use when creating a user with this template. |
Admins can create and configure Quality Teams and Quality Team Roles to suit their needs. Quality Teams allow users to make individual work assignments to individual Change Controls, Audits, CAPAs, or other Quality Event-related processes.
Learn about Quality Teams 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. If the component or subcomponent is inactive, no one in the vault can edit team membership using this team or Team Role. |
destination_state | Type : Subcomponent | If change state on team completion is selected, this is the state the team enabled record will change into. Note: This is required on change state when team completion is selected. |
initial_state | Type : Subcomponent | If change state on team completion is selected, it will only occur while team complete happens if the team enabled record is in this state. Note: Required change state when team completion is selected. |
process_relationships | Type : String Allows multiple values Maximum length : 1500 | No function at this time. |
locked_in_states | Type : String Allows multiple values Maximum length : 1500 | While the record is any one of these states, no user in the vault may change team member assignments for any role. This supersedes all security configurations. Note: When using cascade of team member updates between records, records in this state will not reflect team membership changes, but will also not cause an error. |
objecttype | Type : Objecttype | If left blank, team will apply to all records of this object that do not have a team defined for this type. |
object | Type : Object Required | The object the Qualityteam applies to. The object the Qualityteamrole applies to. |
objectlifecycle | Type : Objectlifecycle Required | Must be the lifecycle for the selected object or type. |
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. If the component or subcomponent is inactive, no one in the vault can edit team membership using this team or Team Role. |
maximum_user_in_role | Type : Number Required Maximum value : 20 Minimum value : 1 | Maximum number of users selected for a Team Role per record. Maximum must be greater than minimum. |
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. |
linked_application_role | Type : String Required Maximum length : 1500 | The role into which Team Role assignments for a team enabled record are inserted. This role defines the permissions and sharing settings role that team members will be granted. |
cascade_from_relationship | Type : Subcomponent | Required if cascade behavior is set to anything other than NOT_APPLICABLE . Defines the field which indicates the record from which team assignments should be inherited. |
display_order | Type : Number Required Maximum value : 25 | The order in which this Team Role will display to viewers and editors of the team enabled record. |
cascade_behavior | Type : Enum Required Allowed values :
| Indicates if the membership of this role can be governed by the membership of a related records Team Role. Enums:
|
constraining_role | Type : String Maximum length : 1500 | Limits selection of users when editing this team role’s membership to the current membership of the specified application role on the team enabled record. |
locked_in_states | Type : String Allows multiple values Maximum length : 1500 | While the record is any one of these states, no user in the vault may change team member assignments for any role. This supersedes all security configurations. Note: When using cascade of team member updates between records, records in this state will not reflect team membership changes, but will also not cause an error. |
minimum_user_in_role | Type : Number Required Maximum value : 20 | Minimum number of users selected for a Team Role per record. Value of zero means the role is purely optional. Population of the role will not effect team completeness record behaviors. |
object | Type : Object Required | The object the Qualityteam applies to. The object the Qualityteamrole applies to. |
objectlifecycle | Type : Objectlifecycle Required | Must be the lifecycle for the selected object or type. |
Spark messaging is a message notification system that allows for loosely coupled, asynchronous, near real-time integration between vaults or external applications. Messages are processed by a queuing system to provide reliable delivery. Outbound messages are placed in an outbound queue, and delivered messages enter an inbound queue.
Learn about Creating & Managing Queues 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 field is active. |
message_delivery_event_handler | Type : ComponentReference | Specifies the optional Spark message delivery event handler to use for outbound queues. References the Messagedeliveryeventhandler component. |
sequential | Type : Boolean | Indicates if the messages intended for this queue must be processed sequentially, meaning one after another in the order they are received. |
description | Type : String Maximum length : 500 | The description of the queue. |
type | Type : Enum Required Allowed values :
| Specifies whether the queue is Outbound (sends messages), or Inbound (receives messages). |
message_processor_user | Type : String Maximum length : 1500 | Indicates the user who will process messages delivered to an Inbound queue. |
rollback_on_error | Type : Boolean | Indicates whether this queue will continue the transaction when a message fails to enter the queue. |
message_processor | Type : ComponentReference | References the Messageprocessor component. |
message_delivery_event_handler_user | Type : String Maximum length : 1500 | Indicate the user who will process Spark message delivery event handler actions for the outbound queue. Applicable only when message_delivery_event_handler is configured. |
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in Vault’s base language. |
active | Type : Boolean | Indicates whether the field is active. |
connection_type | Type : Enum Required Allowed values :
| The type of queue connection. |
connection_name | Type : String Required Maximum length : 40 | The name of the connection. |
deliver_to_queue | Type : String Maximum length : 1500 |
Custom actions for records, called record actions, are invoked by a user on a specific record from the UI or API.
Learn about Defining User Actions for Objects.
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. |
user_input_object_type | Type : Objecttype | If your action takes user input, identifies the user input object type. |
user_input_object | Type : Object | If your action takes user input, identifies the user input object. |
type | Type : String Maximum length : 1500 | The type of record action, for example, Object . |
checksum | Type : String Maximum length : 1500 | Used to check data for errors. |
usages | Type : String Allows multiple values Maximum length : 1500 | If specified, the action is available for configuring in the specified usages only. For example, USER_ACTION . If omitted, the action is available across all supported usages. |
source_code | Type : SdkCode Maximum length : 1048576 | The source of this record action code used to create and edit metadata. For example, Custom means this is a custom action developed with the Vault Java SDK. |
object | Type : Object | The object this record action is associated to, for example, product__v . |
Record role triggers execute custom code whenever roles are directly (manually) added or removed from an object record.
Learn about Record Role Triggers 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. |
checksum | Type : String Maximum length : 1500 | Used to check data for errors. |
source_code | Type : SdkCode Maximum length : 1048576 | The source of this record role trigger and code used to create and edit metadata. Custom means this record role trigger was developed with the Vault Java SDK. |
event_segment | Type : Enum Allowed values :
| For internal Veeva use only. This Enum is used for a variety of features in Vault. Contains valid values for specifying eventSegment . |
events | Type : Enum Allows multiple values Allowed values :
| The Events specifying when this record role trigger executes. For example, BEFORE means the trigger executes right before the record role assignment. |
order | Type : Enum Allowed values :
| If multiple triggers exist on the same object, this specifies the order this record role trigger will execute. Order 1 executes first and Order 10 executes last. UNSPECIFIED means this trigger will always execute last. |
object | Type : Object Required | The object this record role trigger is associated to, for example, product__v . |
Record triggers execute custom code when a record Event occurs.
Learn about Record Triggers 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. |
checksum | Type : String Maximum length : 1500 | Used to check data for errors. |
source_code | Type : SdkCode Maximum length : 1048576 | The source of this record trigger and code used to create and edit metadata. Custom means this record trigger was developed with the Vault Java SDK. |
event_segment | Type : Enum Allowed values :
| For internal Veeva use only. This Enum is used for a variety of features in Vault. Contains valid values for specifying eventSegment . |
events | Type : Enum Allows multiple values Allowed values :
| The Events specifying when this record trigger executes. For example, BEFORE_UPDATE means the trigger executes right before the record updates. |
order | Type : Enum Allowed values :
| If multiple triggers exist on the same object, this specifies the order this record role trigger will execute. Order 1 executes first and Order 10 executes last. UNSPECIFIED means this trigger will always execute last. |
object | Type : Object Required | The object this record trigger is associated to, for example,product__v . |
Record workflow actions execute custom code during object workflow events.
Learn more about Record Workflow Actions
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. |
checksum | Type : String Maximum length : 1500 | Used to check data for errors. |
source_code | Type : SdkCode Maximum length : 1048576 | The source of this workflow action. For example, Custom means this is a custom action developed with the Vault Java SDK. |
step_types | Type : Enum Allows multiple values Allowed values :
| Indicates the step types where this record workflow action is allowed to execute. |
object | Type : Object | Indicates the object the record workflow action supports. This action is only available for workflows on this supported object. The default value is "" , indicating all objects are supported. |
Rendition profiles allow you to choose rendition settings that differ from the Vault-wide rendition settings.
Learn about Rendition Profiles 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. |
bookmark_expansion_level | Type : Enum Required Allowed values :
| Determines how many level deep are expanded in the bookmark panel. |
generate_toc_lofs_bookmarks | Type : Boolean Required | Generates bookmakrs based on the Table of Content and List of Figures. |
render_ppt_speaker_notes | Type : Boolean Required | Viewable Renditions for PowerPoint documents will be rendered with Speakrer Notes. |
generate_bookmarks_for_title_style | Type : Boolean Required | Generates bookmarks for Title Style. |
set_link_text_to_blue | Type : Boolean Required | Sets link text to blue. |
generate_caption_bookmarks_tree | Type : Boolean Required | Auto-generates bookmarks for captions. |
embed_fonts | Type : Enum Required Allowed values :
| Indicates the type of font embedding. Learn more about font embedding in Vault Help. |
no_mark_up | Type : Boolean Required | Does not show Markup in the viewable rendition. |
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. |
automated_image | Type : Boolean | Indicates that the rendition is an Automated Image Rendition |
density | Type : String Maximum length : 1800 | Specifies the density of the Automated Image Rendition. The value must be numeric. You can also populate this field with a height and width value such as 300x200. You can use the following expected values -
|
format | Type : Enum Allowed values :
| Specifies the format of an Automated Image Rendition |
colorspace | Type : Enum Allowed values :
| Specifies the color space of an Automated Image Rendition |
quality | Type : String | Specifies the the quality of an Automated Image Rendition. The value must be numeric. |
resize | Type : Number | Specifies the size and dimensions of an Automated Image Rendition. The value must be numeric. |
resample | Type : Boolean |
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. |
editors | Type : String Allows multiple values Maximum length : 1500 | Users with the Editor permission required to edit reports. |
viewers | Type : String Allows multiple values Maximum length : 1500 | Users with the Viewer permission required to view reports. |
class | Type : Enum Allowed values :
| Indicates whether the report is Standard or Multi-Pass. |
excel_template | Type : Reportexceltemplate | Indicates which, if any, Excel template is associated with the report. |
fit_pdf_to_page | Type : Boolean | Indicates whether all columns should fit on a single page in the exported PDF. |
tags | Type : String Allows multiple values Maximum length : 1500 Ordered : True | Any tags assigned to the report. |
With Excel Report Templates, users can create report templates in Microsoft Excel, upload the templates to Vault, and export report data into those templates. The Reportexceltemplate component type stores these templates.
Learn more about Excel Report Templates 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. |
filename | Type : String Required Maximum length : 1500 | The name of the uploaded Excel template. |
template_file | Type : File Required | A reference to the Excel template file within Vault’s filesystem. |
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. |
class | Type : Enum Allowed values :
| Indicates whether the report is Standard or Multi-Pass. |
Saved or custom views users to save or “bookmark” current searches, fileters, and other view settings.
Learn about Saved Views 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 saved view. |
tab | Type : Tab Required | The tab where the saved view appears. |
created_by | Type : String Maximum length : 1500 | The username of the user who created the saved view. |
icon | Type : String Maximum length : 1500 | The icon that appears next to the saved view. |
search_criteria | Type : String Required Maximum length : 32000 | The filters that the saved view applies. |
view_layout | Type : String Maximum length : 1500 | The columns displayed for REPORTING (Tabular in UI) type layouts, including order and width information. Learn more about layout types in Vault Help. |
mandatory | Type : Boolean | Determines if the view is displayed in the Views section of the tab. |
view_layout_type | Type : Enum Required Allowed values :
| The layout type of the saved view. |
Job processors provide logic to process jobs in bulk. You cannot create these with the Vault Java SDK. You may see Vault-supplied Jobs here which work to deliver various features.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
idempotent | Type : Boolean | If true , Vault automatically restarts the job if interrupted by a system failure. |
visible | Type : Boolean | If true , the job appears in the Scheduled, Running, and History tables in the Job Admin UI. |
admin_configurable | Type : Boolean | If true , the job processor is available to be called with custom SDK code or by configuration by an Admin as a Job Definition in the Vault UI. |
checksum | Type : String Maximum length : 1500 | Used to check data for errors. |
source_code | Type : SdkCode Maximum length : 1048576 | The source code of this SDK job. Standard indicates a Vault-supplied, read-only job. |
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 : 50 | UI-friendly string in All view |
my_view_label | Type : String Maximum length : 50 | UI-friendly string in My view |
recent_view_label | Type : String Maximum length : 50 | UI-friendly string in Recent view |
object_type | Type : Objecttype | The Objecttype (if an object type Tab) |
active | Type : Boolean | Indicates whether the component is active. |
filter_criteria | Type : String Maximum length : 32000 | Contains the set of fields, operators, and values to be applied as filters for the search results in the tab. |
prevent_create | Type : Boolean | Indicates whether record creation is allowed in an object tab. |
modal_create_record | Type : Boolean | Determines if a new record should be created in a pop-up modal. |
related_object_ids | Type : String Maximum length : 1500 | Contains a list of object API keys to be used as related object filters in the tab. |
page | Type : Page | For internal Veeva use only. |
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 : 50 | UI-friendly string in All view |
my_view_label | Type : String Maximum length : 50 | UI-friendly string in My view |
recent_view_label | Type : String Maximum length : 50 | UI-friendly string in Recent view |
object_type | Type : Objecttype | The Objecttype (if an object type Tab) |
active | Type : Boolean | Indicates whether the component is active. |
filter_criteria | Type : String Maximum length : 32000 | Contains the set of fields, operators, and values to be applied as filters for the search results in the tab. |
prevent_create | Type : Boolean | Indicates whether record creation is allowed in an object tab. |
modal_create_record | Type : Boolean | Determines if a new record should be created in a pop-up modal. |
related_object_ids | Type : String Maximum length : 1500 | Contains a list of object API keys to be used as related object filters in the tab. |
page | Type : Page | For internal Veeva use only. |
Admins can create tags to label any document with a topic, category, or any other type of identification. Users can easily find tagged documents by searching or filtering on the tag name.
Learn about Configuring Document Tags.
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. |
phrases | Type : String Allows multiple values Maximum length : 50 | Text used to automatically tag document versions when an exact match is found. |
auto_tag | Type : Boolean | Determines if automatic document tagging is turned on. |
include_archive | Type : Boolean | Determines if archived documents should be analyzed for tagging. |
Allow users to apply custom business logic on objects when a record is created, updated, or deleted.
Learn more about User-defined Classes.
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. |
checksum | Type : String Maximum length : 1500 | Used to check data for errors. |
source_code | Type : SdkCode Maximum length : 1048576 | The source of this User-Defined Class and code used to create and edit metadata. Custom means this UDC was developed with the Vault Java SDK. |
Allow users to wrap reusable logic into a service that can be used by other Vault Java SDK code, such as triggers, actions, or user-defined classes.
Learn more about User-defined Services.
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. |
checksum | Type : String Maximum length : 1500 | Used to check data for errors. |
interface | Type : String Maximum length : 1500 | The name of the user-defined service extension interface that a user-defined service class implements, or blank if the user-defined service is an extension interface. |
source_code | Type : SdkCode Maximum length : 1048576 | The source of this user defined service and code used to create and edit metadata. Custom means this user defined service was developed with the Vault Java SDK. |
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. |