Component Types

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.

About Internal Component Types

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.

Accountmessage

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.

Atomicsecurity

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

Fieldsecurity

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 :
  • read__v
  • hide__v
  • edit__v
 The type of permission to apply.
fields Type : Field
Required
Allows multiple values		 The fields to apply this permission to.

Objectcontrolsecurity

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 :
  • hide__v
  • view__v
 The type of permission to apply.
object_controls Type : Objectcontrol
Required
Allows multiple values		 The object control permissions to apply. Learn more about Object Control Permissions in Vault Help.

Actionsecurity

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 :
  • hide__v
  • view__v
  • execute__v
 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.

Workflowactionsecurity

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 :
  • hide__v
  • execute__v
 The type of permission to apply.
workflow_task_actions Type : Enum
Allows multiple values
Allowed values :
  • cancel
  • reassign
  • updateduedate
 The workflow task action to apply.
workflow_actions Type : Enum
Allows multiple values
Allowed values :
  • addparticipants
  • cancel
  • emailparticipants
 The workflow action to apply.

Relationshipsecurity

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 :
  • read__v
  • edit__v
 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.

Checklisttype

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.

Checklistmatchingfield

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.

Dashboard

Dashboards provide an at-a-glance understanding of key metrics.

Learn about Dashboards in Vault Help.

Attribute Description
active Type : Boolean Indicates whether the component is active.
label Type : String
Required
Maximum length : 60		 UI-friendly string in Vault’s base language.
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.

Docatomicsecurity

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.

Docworkflowactionsecurity

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 :
  • hide__v
  • view__v
  • execute__v
 Indicates the permission type.
workflow_actions Type : Enum
Allows multiple values
Ordered : True
Allowed values :
  • cancel
  • addparticipants
  • removecontent
  • emailparticipants
 Indicates the active workflow action that the permission applies to.
workflow_task_actions Type : Enum
Allows multiple values
Ordered : True
Allowed values :
  • cancel
  • reassign
  • updateduedate
 Indicates the active workflow task action that the permission applies to.

Docactionsecurity

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 :
  • hide__v
  • view__v
  • execute__v
 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.

Docfield

Attribute of a document associated to one or more document types.

Learn about Document Fields in Vault Help.

Attribute Description
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.
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.
lookupFieldId Type : String
Maximum length : 1500		 Reference to Object field component. Used for the Lookup field type.
formula Type : Expression
Maximum length : 4000		 An expression surrounded in [ ] character combination.
display_section Type : String
Required
Maximum length : 1500		 Name of the display section. For example, Docfieldlayout.general_properties__v
blank_fields Type : String
Maximum length : 1500		 options:
  • zeros
  • blanks
default_security Type : String
Maximum length : 1500		 options:
  • editable
  • readonly
  • hidden
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.
picklist Type : String
Maximum length : 1500		 Reference to Picklist component.
Used for the Picklist field type.
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.
set_on_create_only Type : Boolean Can only set if the user has a proper MDL admin permission.
controlling_field Type : String
Maximum length : 1500		 Name of an object, For example, Object.product__v
defined_in Type : String
Maximum length : 1500		 The Doc Type this field belongs to (local fields only). e.g. Doctype.my_doc_type__c
shared Type : Boolean
Required		 Indicates whether the field is shared or local.
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
no_copy Type : Boolean When true a value will not be set in a copied document. Cannot be true when required is true.
secure_relationship Type : Boolean Enables relationship security on a referenced object.
relationship_criteria Type : String
Allows multiple values
Maximum length : 1500		 The VQL used to constrain records in the referenced Object
relationship_type Type : String
Maximum length : 1500		 Can only return “reference” at this time.
help_content Type : String
Maximum length : 500		 UI-friendly help string
queryable Type : Boolean Whether the field is queryable in through VQL
hidden Type : Boolean Indicates whether the field is hidden in the UI.
The value here is specific to the user and depends on security_overrides.
multi_value Type : Boolean Indicates whether the field accepts multiple values.
scale Type : Number
Maximum value : 9		 Applicable to fields of type number only.
active Type : Boolean
Required		 Indicates whether the field is active.
label Type : String
Required
Maximum length : 1500		 UI-friendly string in Vault’s base language.
max_length Type : Number
Maximum value : 1500
Minimum value : 1		 Applicable to fields of type string only.
min_value Type : Number Applicable to fields of type number only.
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.
scope Type : String
Maximum length : 1500		 options:
  • Document
  • DocumentVersion

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.
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:
  • String
  • Number
  • Boolean
  • Picklist
  • Date
  • URL
  • Formula
  • ObjectReference
  • Lookup
default_value Type : String
Allows multiple values
Maximum length : 1500		 The default value used when the field is not set.

Docfielddependency

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 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 :
  • isHidden
  • isReadOnly
  • isVisible
  • isRequired
  • picklist
 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.

Docfieldlayout

The field layout for document fields.

Learn about Document Field Layouts.

Attribute Description
show_in_edit_mode Type : Boolean For internal Veeva use only.
allow_field_assignment Type : Boolean For internal Veeva use only.
panel Type : String
Maximum length : 1500		 For internal Veeva use only.
active Type : Boolean
Required		 Whether the layout is active.
icon Type : Enum
Allowed values :
  • UNDEFINED
  • AUSTRALIA
  • AUSTRIA
  • BELGIUM
  • CANADA
  • CHINA
  • EUROPEAN_UNION
  • FRANCE
  • GERMANY
  • GLOBAL
  • IRELAND
  • ITALY
  • JAPAN
  • NETHERLANDS
  • SPAIN
  • SWEDEN
  • SWITZERLAND
  • UNITED_KINGDOM
  • UNITED_STATES
  • VEEVA
 The icon to display in the section header.
label Type : String
Required
Maximum length : 60		 UI-friendly string in Vault’s base language.
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.

Doclifecycle

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.

Doclifecyclerole

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 :
  • Dark Orange
  • Orange
  • Dark Yellow
  • Yellow
  • Lime
  • Green
  • Aqua
  • Royal
  • Purple
  • Lilac
  • Pink
  • Salmon
 Annotations made by users in this role will use this color by default.
security_options Type : XMLString
Maximum length : 32000		 The default security rules.

Doclifecyclestate

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.

Doclifecycleevent

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.

Docmatchingrule

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
lifecycle Type : Doclifecycle
Required		 The lifecycle this rule applies to.
role Type : Doclifecyclerole
Required		 The role this rule applies to.
active Type : Boolean
Required		 Indicates whether the component is active.
description Type : String
Maximum length : 255		 General description for this rule.
label Type : String
Required
Maximum length : 60		 UI-friendly string in Vault’s base language.

Docmatchingcriterion

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.

Docparticipantrule

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.

Docparticipantcriterion

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.

Docrelationshiptype

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.

Doctype

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
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)
relationship_types Type : String
Allows multiple values
Maximum length : 1500		 The list of Docrelationshiptype names supported.
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
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.
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.
allow_attachments Type : Boolean Whether documents of this type can have attachments.
enable_binder_thumbnail Type : Boolean Use a document from within the binder as the binder thumbnail instead of the standard Vault binder icon.
binder_unbound_document_display_option Type : Enum
Allowed values :
  • latest_version
  • latest_viewable_version
  • latest_steady_state_version
 Select display options for unbound documents.
rendition_types Type : String
Allows multiple values
Maximum length : 1500		 The list of Renditiontype names supported.
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
milestone_types Type : String
Allows multiple values
Maximum length : 1500		 The type of milestone.
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.
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:
  • date_search
  • user_search
  • version_search
  • file_format_search
active Type : Boolean
Required		 Indicates whether the field is active
label Type : String
Required
Maximum length : 200		 UI-friendly string
description Type : String
Maximum length : 500		 A general description of the Doctype.
fields Type : String
Allows multiple values
Maximum length : 1500		 The list of Docfield components linked to this Doctype.
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.
global_content_type Type : String
Maximum length : 1500		 The default global_content_type for the document type.
Available in PromoMats vaults only.

Documentaction

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.
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.
icon Type : String
Maximum length : 1500		 Specifies the icon to display for your action in the Vault UI Actions menu. If omitted, no icon is displayed and the action is not eligible to appear in the the most frequently used section of the Action Bar. See the Vault Java SDK Documentation for a list of allowed values.
lifecycle Type : Doclifecycle The lifecycle where this document action is available.
checksum Type : String
Maximum length : 1500		 Used to check data for errors.
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.

Documentstagegroup

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.

Documentstage

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.

Emailprocessor

When creating Inbound Email Addresses in the Vault Admin UI, Admins select an Email Processor, which defines how Vault automatically creates documents, records, and attachments from emails sent to the address. In addition to those provided by the System, you can create custom Email Processors with the Vault Java SDK.

Learn more about Email to Vault 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 email processor. For example, Custom means this is a custom email processor developed with the Vault Java SDK.
allowed_senders Type : Enum
Required
Allows multiple values
Allowed values :
  • VAULT_USERS_AND_PERSONS
  • VAULT_USERS
  • VAULT_GROUPS
 Indicates the type of senders from whom this email processor can receive emails.

Formattedoutput

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.

Inboundemailaddress

When configuring Email to Vault, Admins use Inbound Email Addresses to create and manage Vault-owned email addresses and define the Email Processor with which to create documents, attachments, or object records from the email.

Learn more about Email to Vault 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.
authenticate_sender Type : Boolean If true, Vault checks the sender’s authenticity via Sender Policy Framework (SPF) and DomainKeys Identified Mail (DKIM). Can only be set to false for certain Veeva-provided email processors. Use caution when setting to false as unauthenticated emails may come from spoofed addresses. Must always be set to true if allowed_senders = VAULT_USERS or VAULT_GROUPS.
email_username Type : String
Required
Maximum length : 64		 The username of the inbound email address, for example, inquiries in inquiries@verteopharma.veevavault.com.
email_processor_user Type : String
Maximum length : 255		 The default originating user when the sender’s email address does not belong to a user in this vault.
description Type : String
Maximum length : 1500		 A general description of the inbound email address.
email_processor Type : ComponentReference
Required		 The email processor to run when an email is sent to this address.
allowed_sender_groups Type : String
Allows multiple values
Maximum length : 1500		 If allowed_senders = VAULT_Groups, stores the groups whose users are allowed to send emails to this address. There is a maximum of five groups.
allowed_senders Type : Enum
Required
Allowed values :
  • VAULT_USERS_AND_PERSONS
  • VAULT_USERS
  • VAULT_GROUPS
  • UNSPECIFIED
 Indicates the type of senders from whom this inbound email address can receive emails.

Integrationrule

Spark Integration Rules provide platform configuration and SDK services for developers building Vault to Vault integration features that require data mapping. Note that deleting an Integrationrule record with the DROP command also deletes any child Queryobjectrule and Fieldrule subcomponent records. Similarly, inactivating an Integrationrule record by changing its active attribute value to false also inactivates any associated subcomponent records. Learn more in the MDL Documentation.

Learn about Integration Rules in the SDK Documentation.

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.
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.

Queryobjectrule

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.
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.

Fieldrule

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.
query_field_type Type : Enum
Allowed values :
  • document_boolean__sys
  • document_component__sys
  • document_date__sys
  • document_datetime__sys
  • document_formula__sys
  • document_lookup__sys
  • document_number__sys
  • document_object_reference__sys
  • document_picklist__sys
  • document_text__sys
  • document_url__sys
  • vobject_boolean__sys
  • vobject_component__sys
  • vobject_currency__sys
  • vobject_date__sys
  • vobject_datetime__sys
  • vobject_document_reference__sys
  • vobject_formula__sys
  • vobject_id__sys
  • vobject_longtext__sys
  • vobject_lookup__sys
  • vobject_number__sys
  • vobject_object_reference__sys
  • vobject_parent_object_reference__sys
  • vobject_picklist__sys
  • vobject_richtext__sys
  • vobject_text__sys
 The type (object or document) and data type of the query field.
query_object Type : String
Maximum length : 100		 Name of the mapped query object object_name__c. Must be specified as returned in VQL response.
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_object_field Type : Subcomponent Subcomponent reference to the Object field. This is required of the target_object is set.
target_docfield Type : Docfield References the Docfield of the target is a Document.
reference_lookup_type Type : Enum
Allowed values :
  • picklist
  • object
  • objectlifecyclestate
  • documentlifecyclestate
  • documenttype
  • generic
  • lifecyclestate
 The type of the reference_lookup. lifecyclestate is deprecated as of 19R2.2. Use either objectlifecyclestate or documentlifecyclestate.
reference_lookup Type : String
Maximum length : 45		 Set field based on a reference lookup from the reference_lookup__sys object.
field_default Type : String
Maximum length : 1500		 Mapping to a static default.

Job

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.
repeat_on_days Type : Enum
Allows multiple values
Allowed values :
  • Sun
  • Mon
  • Tue
  • Wed
  • Thu
  • Fri
  • Sat
 The number of the day to repeat the job on.
week_day Type : Enum
Allowed values :
  • Sun
  • Mon
  • Tue
  • Wed
  • Thu
  • Fri
  • Sat
 Day of the week.
month_repeat_type Type : Enum
Allowed values :
  • dayOfTheMonth
  • dayOfTheWeek
 Day of the month or week for a scheduled job.
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. Allowed values are 1, 2, 3, 4, 6, 12.
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’.
timezone Type : String
Maximum length : 1500		 Timezone as used in the TZ variable. Example: America/Los_Angeles
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.
schedule Type : String
Maximum length : 1500		 The frequency of a scheduled job. Options:
  • Manual
  • Once
  • Hourly
  • Daily
  • Weekly
  • Monthly
active Type : Boolean
Required		 Indicates whether the component is active.
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.
  • Format:hour:min
  • Hour: 24 hour clock
  • min: 00-60
    • For example, 22:30.
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:
  • Task Reminder Notification
  • Date Based Document Operation

Changestatejobaction

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.
trigger_date_target Type : String
Maximum length : 1500		 Defines the date field to be evaluated against the trigger date.
notify_on_status_condition Type : Boolean Always set to true.
relationship_types Type : String
Allows multiple values
Maximum length : 1500		 Defines which document relationship type to run the primary action on.
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.
document_version Type : Enum
Allowed values :
  • absolute_latest
  • latest_steady_state
 Determines which document version the job will run on.
terminate_existing_workflows Type : Boolean Indicates whether to cancel existing workflows to perform action.
destination_state Type : String
Maximum length : 1500		 Defines the lifecycle state to set.

Sendnotificationjobaction

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.
trigger_date_target Type : String
Maximum length : 1500		 Defines the date field to be evaluated against the trigger date.
notify_on_status_condition Type : Boolean Always set to true.
relationship_types Type : String
Allows multiple values
Maximum length : 1500		 Defines which document relationship type to run the primary action on.
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.
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.

Sendobjectnotificationjobaction

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.

Changeobjectstatejobaction

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.

Noopjobaction

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.
trigger_date_target Type : String
Maximum length : 1500		 Defines the date field to be evaluated against the trigger date.
notify_on_status_condition Type : Boolean Always set to true.
relationship_types Type : String
Allows multiple values
Maximum length : 1500		 Defines which document relationship type to run the primary action on.
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.
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.

Objectnoopjobaction

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.

Httppostjobaction

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.
external_url Type : String
Maximum length : 1500		 Defines (as a link) what URL is accessed when the job executes the External URL Call job action.
session_granted_by Type : String
Maximum length : 1500		 Defines which user to “Run as”.
run_as_user Type : String
Maximum length : 1500		 Defines the user account the vault uses to complete an external URL call job.
post_session_creds Type : Boolean Indicates whether to post session credentials via form data with key “Session.id”.

Sdkbatchjobaction

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.

Edlmatchjobaction

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.

Flashreportjobaction

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.
report_name Type : String
Maximum length : 1500		 Defines the name of the report.
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.
enable_flash_refresh Type : Boolean If true, a flash report may be refreshed by users.
include_report_in_email Type : Boolean Indicates whether to include a copy of the report in the notification.
collapse_groups Type : Boolean If true, a flash report will expose only group level information in emails.

Scheduleddataexportjobaction

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.
selected_entities Type : LongString
Required
Maximum length : 32000		 A comma-separated list of all selected entities to export.
data_storage_option Type : Enum
Required
Allowed values :
  • VAULT_FILE_STAGING
  • CUSTOM_S3_BUCKET
 If set to VAULT_FILE_STAGING, the email or in-app notification when the job is complete includes a link to download exported files from the staging server. If set to CUSTOM_S3_BUCKET, Vault sends the exported files to an external storage service.
enable_full_data_export Type : Boolean
Required		 If set to true, enables full data export option and the job exports all data for the selected entities. You can only enable the full data export option once every 30 days. After executing as true, the system sets this parameter back to false. The default value is false.

Documentperiodicreviewjobaction

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.

Schedulededcjobaction

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.

Jobmetadata

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 :
  • scheduled
  • queued
  • running
 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 class name of an Sdkjob component.
queue Type : ComponentReference The queue the job will place messages into. Custom jobs cannot reference standard queues.

Layoutrule

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_fields Type : String
Allows multiple values
Maximum length : 1500		 Indicates the fields 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_controls Type : String
Allows multiple values
Maximum length : 1500		 Indicates the custom control to hide in the layout rule.
active Type : Boolean
Required		 Indicates whether the component is active.
expression Type : String
Required
Maximum length : 3900		 A valid expression.
label Type : String
Required
Maximum length : 40		 UI-friendly string in the vault’s base language.
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.

Lifecyclestatetype

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 :
  • AppliesToAll
  • AvailableToAll
  • Specific
 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 :
  • Document
  • Object
 Indicates whether the state type is supporting document or object lifecycles. Only object lifecycles are currently supported.

Lifecyclestatetypeassociation

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.

Link

Defines a Web Action.

Learn about Web Actions in Vault Help.

Attribute Description
component Type : Enum
Required
Allowed values :
  • Document
  • Object
 Specifies whether the action applies to documents or objects records.
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.
label Type : String
Required
Maximum length : 40		 UI-friendly string in Vault’s base language.
target Type : Enum
Required
Allowed values :
  • self
  • blank
 Controls where the target URL displays when a user executes the web action.

Matchingrule

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.

Messagedeliveryeventhandler

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.

Messagegroup

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.

Message

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.

Messageprocessor

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.

Mobileshareactionconfig

The Vault Mobile application allows users to share files on their smartphone to Vault using a Sharing Action. When configuring a Sharing Action in the Vault Admin UI, Admins select a Mobile Sharing Action, which provides the logic Vault executes on the files when a user selects the action.

This component type represents a Sharing Action and provides configuration options including a reference to a Mobile Sharing Action. Learn more about Share to Vault 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.
mobile_share_action Type : ComponentReference
Required		 The Mobile Sharing Action to which this configuration applies.
allowed_for Type : Enum
Required
Allowed values :
  • ANYONE
  • SPECIFIC_GROUPS
 Defines which users can use this mobile share action.
description Type : String
Maximum length : 1500		 A description of the mobile share action in the Vault’s base language.
allowed_for_groups Type : String
Allows multiple values
Maximum length : 1500		 If allowed_for is set to SPECIFIC_GROUPS, the groups allowed to use this mobile share action.

Notificationtemplate

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 :
  • document
  • object
  • custom
 Indiciates whether the message is intended for documents or objects.
referenced_component Type : Object The specific Object (when entity_type is object).

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.
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.
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 :
  • base
  • component
  • userrolesetup
  • legalhold
  • usertask
  • esignature
  • checklist
  • section
  • response
  • responsedoc
  • availableanswer
  • dependency
  • subchecklist
  • qualityteammember
  • lifecyclestagesobject
  • publicaccesslink
  • qualityoneteammember
 Classification of the object.
data_store Type : Enum
Allowed values :
  • standard
  • high_volume
 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.

Field

Attribute Description
show_in_header Type : Enum
Allowed values :
  • left
  • right
 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”]}’
controlling_picklist Type : String
Maximum length : 50		 The name of the controlling picklist, if any.
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).
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.
encrypted Type : Boolean Indicates whether the field is encrypted. Learn more about encryption in Vault Help.
subtype Type : Enum
Allowed values :
  • Currency
  • Link
 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 :
  • String
  • Number
  • Boolean
  • Date
  • DateTime
  • Object
  • Picklist
  • ID
  • users
  • Component
  • documents
  • LongText
  • RichText
  • Binary
  • ObjectReference
  • ObjectParent
 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 :
  • parent
  • reference
  • child
  • reference_inbound
  • reference_outbound
 (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 :
  • block
  • cascade
  • setnull
 (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 and document fields only) VQL WHERE clause expression which specifies the criteria that a document or 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.
picklist Type : String (Picklist fields only)
relationship_deep_copy Type : Boolean (Object fields only) Indicates if the child records associated via this field are available for hierarchical copy.
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 : 3900		 The default value of the field.
checkbox Type : Boolean Indicates whether “Yes/No” field will display as a checkbox.
formula Type : String
Maximum length : 3900		 An expression surrounded in [ ] character combination.
multi_part_field Type : Enum
Allowed values :
  • suffix
  • prefix
 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.
add_to_layout Type : Boolean If set to false, Vault hides the field on object record pages. This attribute cannot be set to false if required is true. If omitted, the default value is true and the field appears on object record pages. This attribute is only available when creating fields with a CREATE, RECREATE, or ALTER ADD command and is not included when retrieving Object metadata through the Vault REST API.

Index

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
label Type : String
Required
Maximum length : 1500		 UI-friendly string in the vault’s base language.
description Type : String
Maximum length : 1500		 Description of the object 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.

Objectaction

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.
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.
active Type : Boolean
Required		 Indicates whether the component is active.

Objectlifecycle

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
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.
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.
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.
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.

Objectlifecyclestate

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_inactive Type : Boolean deprecated - replaced by record_status
record_status Type : Enum
Allowed values :
  • active__v
  • inactive__v
  • in_migration__v
  • archived__v
 Indicates the status of a record while in this state.
description Type : String
Maximum length : 255		 Additional information to describe the lifecycle.

Objectlifecyclestateentrycriterion

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.

Objectlifecyclestateentryaction

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.

Objectlifecyclestateuseraction

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.

Objectlifecycleevent

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.

Objectlifecyclerole

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 :
  • Read
  • Edit
  • Delete
 List of permissions assigned to the object role. Note that:
  • Read is always present
  • Edit is always present if Delete is present

Objectlifecyclepermission

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 :
  • Read
  • Edit
  • Delete
 The permission to apply.

Objectlifecyclestagegroup

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.

Objectlifecyclestage

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.

Objecttype

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.

Typefield

Attribute Description
source Type : Enum
Required
Allowed values :
  • standard
  • sample
  • custom
  • application
  • system
 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 : 3900		 The type specific default expression for the field.

Typeaction

Attribute Description
action Type : String
Required
Maximum length : 1500		 The Objectaction allowed.

Objectvalidation

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.

Objectworkflow

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 For document workflows only, the Doclifecycle to which this workflow belongs. Must be empty for all other workflow types.
record_content_lifecycle Type : Objectlifecycle For object workflows only, the Objectlifecycle to which this workflow belongs. Must be empty for all other workflow types.
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.
cancellation_comment Type : Boolean
workflow_variables Type : XMLString
Maximum length : 32000		 Admin-defined variables which workflow initiators can select at the start of a workflow.
workflow_content_type Type : Enum
Allowed values :
  • Document
  • Object
 Indicates the type, objects or documents, of the workflow’s contents.
class Type : Enum
Allowed values :
  • ReadAndUnderstood
 Indicates the classification of the workflow.
cardinality Type : Enum
Allowed values :
  • One
  • OneOrMany
 Indicates how many contents can be included in a workflow.
show_fields Type : Boolean For ReadAndUnderstood workflows created in v21.2+, if set to false, document fields are hidden and cannot be updated while the workflow is in progress. If the value is true or null, document fields are shown as usual. For workflows created in v21.1 and lower, or if class is not ReadAndUnderstood, this must be blank.
bound_create_draft Type : Boolean For document workflows only, if set to true, the Create Draft action increments the document’s minor version while the active workflow remains on the previous major document version. The default value for document workflows is false. Must be empty or null for object and R&U workflows.

Objectworkflowstep

Attribute Description
label Type : String
Required
Maximum length : 40		 UI-friendly string in Vault’s base language.
type Type : Enum
Required
Allowed values :
  • start
  • end
  • usertask
  • contenttask
  • notification
  • placeholder
  • changestate
  • decision
  • join
  • action
  • updaterecordfield
  • updatesharingsettings
  • updatedocumentsharingsettings
  • updaterelatedrecordfield
  • contentaction
 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 : 128000		 Details of the step configuration.
description Type : String
Maximum length : 255		 Description of the workflow.

WorkflowCancelationAction

Attribute Description
rule Type : XMLString
Required
Maximum length : 32000		 An XML String describing the workflow cancellation action rule.
order Type : Number
Required		 The order in which the cancellation action is executed.

Overlaytemplate

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.
active Type : Boolean Indicates whether the component is active.
watermark Type : String
Maximum length : 1500		 Diagnal watermark that appears across the center of the downloaded rendition.
allow_download_without_overlay Type : Boolean If set to true, identifies an overlay template as optional and allows users to download a viewable rendition if Vault fails to apply an overlay.
overlay_override_page_match Type : Boolean If set to true, Vault applies overlays to documents within 0.5” of the specified height or width of the overlay. If no matching overlay template overrides within the 0.5” page tolerance are found, Vault applies the standard overlay template.
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

Overlayoverride

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.
file Type : File
Required		 Reference to the file

Pagelayout

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 : 64000		 Defines page layout using XML.

Pagelink

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 :
  • Create
  • Edit
  • Copy
  • View
 Determines which action redirects the user to a custom page.
page_type Type : Enum
Required
Allowed values :
  • Object
 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.

Permissionset

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. Permissionset metadata is not available through the Retrieve Component Type Metadata endpoint in the Vault REST API. 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.

Picklist

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.

Picklistentry

Picklistentry does not support the DROP command.

Attribute Description
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.
active Type : Boolean
Required		 Indicates whether the component is active.

Qmsautomationusertemplate

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.

Qualityobjectrelationshipconfig

This component defines how records of a configured object type will be duplicated and inverted in order to automatically support bidirectional relationships between two objects. Administrators must configure which object type exhibits this bidirectional automation, what relationship fields that will be used by the join object to describe the two related records, and what picklist will be used to describe the way in which the two records are related. The Qualitypicklistmap subcomponent describes base/inverse pairings of entries in the relationship natures picklist, so Vault can accurately identify and display the nature of how two records are related.

Learn about Bidirectional Object Relationships.

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.
right_field Type : Subcomponent
Required		 The target field. Must be a Parent Object reference.
target_object_type Type : Objecttype The object type of the target object.
left_field Type : Subcomponent
Required		 The source field. Must be a Related Object reference.
target_object Type : Object
Required		 The object which will be the data store for the bidirectional link.
relationship_picklist Type : Subcomponent
Required		 The Picklistentry field on the selected object which Vault will set when establishing the bidirectional link. The Picklist component to be mapped.

Qualitypicklistvaluemap

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.
inverse_picklist_value Type : Subcomponent
Required		 The mapped Picklistentry value on the linked object.
relationship_picklist Type : Picklist
Required		 The Picklistentry field on the selected object which Vault will set when establishing the bidirectional link. The Picklist component to be mapped.
picklist_value Type : Subcomponent
Required		 The mapped Picklistentry value on the current object.

Qualityrecordcheck

This component defines the configuration for a Quality Record Check. You can create Quality Record Check configurations for each scenario in which users will need to check for recurrences. For example, if your quality system requires that a newly completed Deviation be checked against older Deviations for recurrence for either six months or one year, depending on the affected process, you can create two Quality Record Check configurations appropriately, both available to users as a separate user action.

Learn more about Quality Record Checks 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.
search_fields Type : Subcomponent
Allows multiple values		 The text fields on which to run the recurrence check.
target_object Type : Object
Required		 The object on which the Quality Record Check is configured.
description Type : String
Maximum length : 1500		 A description of the Quality Record Check.
check_type Type : Subcomponent
Required		 The type of check to be executed.
relationship_type_entries Type : Subcomponent
Allows multiple values		 The picklist values to be displayed to the end user. Possible values are based on the picklist specified in the relationship_type_picklist.
simple_match_fields Type : Subcomponent
Required
Allows multiple values		 The fields on the target_object that must match.
date_field Type : Subcomponent
Required		 The date field from the target_object from which to base your timeframe.
date_unit_picklist Type : Picklist
Required		 References the picklist from which users choose the date_unit_entry.
object_lifecycle_states Type : Subcomponent
Allows multiple values		 The lifecycle states from the object_lifecycle to include in the recurrence check.
date_unit_entry Type : Subcomponent
Required		 The unit of measurement for the date, for example, days__v or years__v.
target_object_type Type : Objecttype
Required		 The type of the target_object.
relationship_type Type : ComponentReference The Qualityobjectrelationshipconfig applicable to your recurrence check.
date_quantity Type : Number
Required
Maximum value : 100
Minimum value : 1		 The number of date units to include in the check. For example, if date_quantity is set to 3 and date_unit_entry is set to weeks__v, the recurrence check will cover 3 weeks.
relationship_type_picklist Type : Picklist The picklist defining the options available for relationship_type_entries.
check_type_picklist Type : Picklist
Required		 The picklist defining the options available for check_type.
object_lifecycle Type : Objectlifecycle
Required		 The lifecycle of the target_object
display_fields Type : Subcomponent
Required
Allows multiple values		 Fields from the target_object to display in the record check interface. These fields are not included in the match calculation.

Qualitymatchtier

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.
relationship_type_required Type : Boolean
Required		 If set to true, users must provide a relationship type when analyzing each record of the tier.
tier_label Type : Subcomponent
Required		 The entry from the tier_picklist to display in the UI.
display Type : Boolean
Required		 If set to true, Vault displays the tier as a category when a user performs a recurrence check action.
tier Type : Number
Required
Maximum value : 3
Minimum value : 1		 Determines the order in which the tier appears.
tier_picklist Type : Picklist
Required		 Defines the options available for the tier_label.
justification_required Type : Boolean
Required		 If set to true, users must define a justification when analyzing each record of a tier.
similarity_score Type : Number
Required
Maximum value : 99		 The % minimum similarity score for a tier.
tier_color Type : String
Required
Maximum length : 500		 The HEX color value in which to display records in this tier.

Qualityrelatedrecordmatchfield

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.
related_match_fields Type : Subcomponent
Required
Allows multiple values		 The fields on the related object that must match. Allows facetable fields on the filter_object.
related_inbound_field Type : Subcomponent The related object field for the filter. If the relationship_type is INBOUND, this can be either a parent or reference field. For JOIN relationships, this must be a parent field
relationship_type Type : String
Required
Maximum length : 50		 The type of the relationship, either INBOUND or JOIN.
filter_object Type : Object
Required		 If the relationship_type is INBOUND, this must be the same as related_object. For JOIN relationships, this must reference the second parent object.
related_outbound_field Type : Subcomponent The related object field for the filter. If the relationship_type is INBOUND, you must omit this attribute. For JOIN relationships, this must reference the second parent field.
related_object Type : Object
Required		 The related object for the filter. If the relationship_type is INBOUND, this must be a non-join object. For JOIN relationships, this must be a simple or complex join.

Qualityteam

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.
record_trigger Type : ComponentReference References a record trigger component.
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.
quality_team_member_object_name Type : String
Maximum length : 100		 For internal Veeva use only. Used by Vault to correctly name and associate the appropriate data storage object for a Qualityteam when migrating configurations between Vaults.
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.
recordrole_trigger Type : ComponentReference References a record role trigger component.
object Type : Object
Required		 The object the Qualityteam applies to.
objectlifecycle Type : Objectlifecycle
Required		 Must be the lifecycle for the selected object or type.

Qualityteamrole

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.
exclusive_membership Type : Boolean If true, users in this role cannot be assigned to any other team role while assigned to this team role. If omitted, the default value is false.
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.
linked_field Type : Subcomponent References an object field on the team-enabled object which is bound to the user__sys object. If included, Vault updates the identified user field whenever the membership of the Qualityteamrole on a given record is updated, and users are no longer able to edit that field. If omitted, the default value is null.
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 :
  • NOT_APPLICABLE
  • INHERIT_ALLOW_OVERRIDE
 Indicates if the membership of this role can be governed by the membership of a related records Team Role.
Enums:
  • NOT_APPLICABLE - These team role assignments are self-governed
  • INHERIT_ALLOW_OVERRIDE - These team role assignments will atempt to inherit changes in team role assgnments on the record related by the cascade from the field value. This matches on application role and enables user editing team membership to override or restore team membership assignments at the record level.
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.
objectlifecycle Type : Objectlifecycle
Required		 Must be the lifecycle for the selected object or type.

Queue

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.
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. If the type is job, Vault ignores this attribute.
message_delivery_event_handler Type : ComponentReference Specifies the optional Spark message delivery event handler to use for outbound queues. References the Messagedeliveryeventhandler component.
description Type : String
Maximum length : 500		 The description of the queue.
type Type : Enum
Required
Allowed values :
  • inbound
  • outbound
  • job
 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. If the type is job, Vault ignores this attribute.
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.

Queueconnection

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 : String
Maximum length : 40		 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

Recordaction

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.
icon Type : String
Maximum length : 1500		 Specifies the icon to display for your action in the Vault UI Actions menu. If omitted, no icon is displayed and the action is not eligible to appear in the the most frequently used section of the Action Bar. See the Vault Java SDK Documentation for a list of allowed values.
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.

Recordroletrigger

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 :
  • PRE_CUSTOM
  • POST_CUSTOM
  • UNSPECIFIED
 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 :
  • BEFORE
  • AFTER
 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 :
  • NUMBER_1
  • NUMBER_2
  • NUMBER_3
  • NUMBER_4
  • NUMBER_5
  • NUMBER_6
  • NUMBER_7
  • NUMBER_8
  • NUMBER_9
  • NUMBER_10
  • UNSPECIFIED
 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.

Recordtrigger

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 :
  • PRE_CUSTOM
  • POST_CUSTOM
  • UNSPECIFIED
 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 :
  • BEFORE_INSERT
  • AFTER_INSERT
  • BEFORE_UPDATE
  • AFTER_UPDATE
  • BEFORE_DELETE
  • AFTER_DELETE
 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 :
  • NUMBER_1
  • NUMBER_2
  • NUMBER_3
  • NUMBER_4
  • NUMBER_5
  • NUMBER_6
  • NUMBER_7
  • NUMBER_8
  • NUMBER_9
  • NUMBER_10
  • UNSPECIFIED
 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.

Recordworkflowaction

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 :
  • START
  • TASK
 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.

Relatedrecordsetup

Admins in Quality vaults can configure object lifecycles to automatically create a new, related object record when the source object record enters a specific lifecycle state by adding reate Related Record entry actions. The Relatedrecordsetup component defines a Related Record Configuration, which Admins use to define source and related objects.

Each Relatedrecordfieldvaluemapping subcomponent represents single Field Value Mapping, which Admins use to map fields between the source and related objects.

Learn more about Related Record Configuration 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.
source_object_type Type : Objecttype
Required		 The object type, if the source object allows object types.
related_object_type Type : Objecttype
Required		 The object type, if the related object allows object types.
outbound_reference_field Type : Subcomponent
Required		 The object reference field on the related object record to be created, which references the source object.
description Type : String
Maximum length : 1500		 A description of the Related Record Configuration to display in the Vault Admin UI.
source_object Type : Object
Required		 The source object on which the Create Related Record entry action will be configured.
related_object Type : Object
Required		 The object that will be created by the Create Related Record entry action.

Relatedrecordfieldvaluemapping

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.
mapped_source_object_field Type : Subcomponent
Required		 The field on the source object to be mapped.
related_object_field Type : Subcomponent
Required		 The field on the related object to be mapped.
mapped_source_reference_object_field Type : Subcomponent If the field value is to be derived from a field on a record related to the source object, this represents that source record’s related record field.
source_object Type : Object
Required		 The source object on which the Create Related Record entry action will be configured.
mapped_source_reference_object Type : Object If the field value is to be derived from a field on a record related to the source object, this represents the object on which that field exists.
related_object Type : Object
Required		 The object that will be created by the Create Related Record entry action.

Renditionprofile

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.
pdf_format Type : Enum
Required
Allowed values :
  • DEFAULT
  • PDFA_1B
 Determines the format for PDF viewable renditions.
bookmark_expansion_level Type : Enum
Required
Allowed values :
  • ALL_LEVELS
  • LEVEL_ONE
  • LEVEL_TWO
  • LEVEL_THREE
  • LEVEL_FOUR
  • LEVEL_FIVE
 Determines how many level deep are expanded in the bookmark panel.
generate_toc_lofs_bookmarks Type : Boolean
Required		 If set to true, Vault generates bookmakrs based on the Table of Content and List of Figures.
render_ppt_speaker_notes Type : Boolean
Required		 If set to true, Vault includes Speaker Notes in viewable renditions for PowerPoint documents.
pdf_print_settings Type : Enum
Allowed values :
  • NONE
  • ALLOW_LOW_RESOLUTION
  • ALLOW_HIGH_RESOLUTION
 If protected_pdf is true, specifies the printing resolution allowed for the PDF rendition.
generate_bookmarks_for_title_style Type : Boolean
Required		 If set to true, Vault generates bookmarks for Title Style.
set_link_text_to_blue Type : Boolean
Required		 If set to true, Vault sets link text to blue.
generate_caption_bookmarks_tree Type : Boolean
Required		 If set to true, Vault auto-generates bookmarks for captions.
protected_pdf Type : Boolean If set to true, Vault applies PDF Protection to the viewable PDF rendition.
pdf_edit_settings Type : Enum
Allowed values :
  • NONE
  • ALLOW_ASSEMBLY
  • ALLOW_FORMS
  • ALLOW_ANNOTATIONS
 If protected_pdf is true, specifies the type of editing allowed for the PDF rendition.
caption_bookmarks_exclusion_types Type : String
Allows multiple values
Maximum length : 43		 Lists caption types that Vault excludes when auto-generating bookmarks based on captions.The default value is an empty String.
content_copying_settings Type : Enum
Allowed values :
  • NONE
  • ENABLED
  • ENABLED_FOR_ACCESSIBILITY
 If protected_pdf is true, specifies the content allowed for copying in the PDF rendition.
embed_fonts Type : Enum
Required
Allowed values :
  • DEFAULT
  • FULL_FONT
  • SUB_FONT
 Indicates the type of font embedding. Learn more about font embedding in Vault Help.
include_metadata Type : Boolean If set to true, Vault includes source document metadata in the viewable PDF rendition.
bookmark_list_per_caption_type Type : Boolean If set to true, Vault generates a list of bookmarks sorted into sections by caption type when auto-generating bookmarks based on captions. The default value is determined by the Generate “List of…” bookmark sections per caption type setting in the Vault Admin UI.
no_mark_up Type : Boolean
Required		 If set to true, Vault does not show Markup in the viewable rendition.

Renditiontype

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 -
  • {number}
  • {number}x{number}
format Type : Enum
Allowed values :
  • AAI
  • ART
  • AVS
  • BPG
  • BMP
  • BMP2
  • BMP2
  • BMP3
  • CMYK
  • CMYKA
  • DIB
  • EPDF
  • FAX
  • FITS
  • GIF
  • GRAY
  • GRAYA
  • HDR
  • JP2
  • JPT
  • J2C
  • J2K
  • JPEG
  • MIFF
  • MONO
  • MTV
  • OTB
  • P7
  • PALM
  • PBM
  • PCD
  • PCDS
  • PFM
  • PGM
  • PICON
  • PICT
  • PNG
  • PNG8
  • PNGoo
  • PNG24
  • PNG32
  • PNG64
  • PPM
  • PSB
  • PSD
  • PTIF
  • RGB
  • RGBA
  • SGI
  • SVG
  • TIFF
  • YCbCr
  • YCbCrA
 Specifies the format of an Automated Image Rendition
colorspace Type : Enum
Allowed values :
  • CMY
  • CMYK
  • Gray
  • HSB
  • HSL
  • HWB
  • LAB
  • LinearGray
  • LOG
  • OHTA
  • Rec601Luma
  • Rec601YCbCr
  • Rec709Luma
  • sRGB
  • XYZ
  • YCC
  • YCbCr
  • YIQ
  • YPbPr
  • YUV
 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 If true forces an image to resample, changing the image’s pixel dimensions.

Report

Represents a Vault report.

Learn about Reporting in Vault Help.

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		 A general description about the report.
format Type : Enum
Required
Allowed values :
  • tabular
  • matrix
 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 :
  • Document
  • Workflow
  • ReadAndUnderstand
  • Distribution
  • Bindernode
  • Object
  • Relationship
  • MatchedDocument
  • Binder
  • BinderSection
  • MultiPass
 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 :
  • Standard
  • View
 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.
include_full_longtext Type : Boolean If true, Vault includes the full text of long text fields in exports. If false or omitted, exports only contain the first 250 characters.
include_full_richtext Type : Boolean If true, Vault includes the full text of rich text fields in exports. If false or omitted, exports only contain the first 250 characters.
include_richtext_html_tags Type : Boolean If true, Vault includes HTML markup in exports. This option is only available if include_full_richtext= true.

Reportexceltemplate

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.

Reporttype

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 : 65		 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 :
  • Standard
  • MultiPass
 Indicates whether the report is Standard or Multi-Pass.

Rolepermissionset

Role permissions enable Admins to assign permissions to a specific user without affecting security profiles.

Learn about role permissions 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.
permission_sets Type : Permissionset
Required
Allows multiple values		 Lists the permission sets for a given application role. Limited to a list of one.
application_role Type : String
Required
Maximum length : 60		 The application role to which the permission set or sets applies.

Savedview

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
Maximum length : 32000		 The filters that the saved view applies.
view_layout Type : String
Maximum length : 3000		 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 :
  • DETAIL
  • TILE
  • COMPACT
  • REPORTING
 The layout type of the saved view.
search_criteria_list Type : String
Allows multiple values
Maximum length : 32000		 A serialized string representing a list of search criteria for each section of an expanded search.
collection Type : String
Maximum length : 1500		 The name of the collection used on an expanded search being saved with the view.
report_layouts Type : String
Maximum length : 32000		 The column positions and widths of an expanded search.
vql_search_criteria Type : String
Maximum length : 32000		 The VQL expression that defines what Vault shows in the view.
managed Type : Boolean Inherits the value of mandatory. If true, the view can be included in configuration migration packages.
owner Type : String
Maximum length : 1500		 The user who created the view.
status Type : String
Maximum length : 1500		 If active, Vault shows the view in the View section of a tab.

Sdkjob

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.

Searchablefield

Definition of a searchable object Field.

Learn about Searchable Object Fields 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.
field Type : Subcomponent
Required		 Defines the object field (by [name]) of the searchable field, e.g., abbreviation__v.
required Type : Boolean Whether this component must exist (every Object must have at least one).
object Type : Object
Required		 Defines the object (by [name]) that the searchable field belongs to, e.g., country__v.

Searchcollection

Search collections allow you to create and edit groups of objects that users can search at the same time as expanded searches.

Learn about Search Collections 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.
description Type : String
Maximum length : 255		 A description of the collection which users see when they click the question mark (?) icon on the expanded search results page.

Searchcollectionsection

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
Allows multiple values		 The object type to filter on, if object types are enabled for the selected object.
object_relationships Type : String
Allows multiple values
Maximum length : 1500		 Relationships to objects in the collection. Each value must include a valid inbound relationship. You can configure object relationships from Admin > Configuration > Objects > {Object} > Relationships.
include_on_tab Type : Boolean If true, allows expanded searches on the collection in the related tab, if one is available for the selected object.
object Type : Object
Required		 The object to include in the collection.

Securityprofile

Security profiles are how Vault applies permissions sets to individual users.

Learn about Security Profiles in Vault Help.

Attribute Description
active Type : Boolean
Required		 Indicates whether the component is active.
label Type : String
Required
Maximum length : 100		 UI-friendly string in Vault’s base language.
permission_sets Type : String
Allows multiple values
Maximum length : 100		 List of permiission sets contained within the profile.
description Type : String
Maximum length : 255		 Description of the security profile.

Sharingrule

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
criteria Type : Expression
Maximum length : 4000		 A VQL statement where clause that returns a list of records of the specified object type.
description Type : String
Maximum length : 255		 A general description of the rule.
active Type : Boolean
Required		 Indicates whether the component is active.
label Type : String
Required
Maximum length : 100		 UI-friendly string in Vault’s base language.
object Type : String
Required
Maximum length : 46		 The type of object the rule applies to.

Sharingrole

Attribute Description
members Type : String
Allows multiple values
Maximum length : 256		 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.

Signaturepage

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 :
  • start__v
  • end__v
 Specifies whether the signature page appears at the beginning or end of the document.
header_02 Type : String
Maximum length : 1500		 Header row 2

Tab

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.

Subtab

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.

Tag

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.
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.
active Type : Boolean
Required		 Indicates whether the component is active.

Userdefinedclass

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.

Userdefinedmodel

Allows users to create reusable data access objects, or models, and annotate their getters and setters as user-defined properties.

Learn more about user-defined models.

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.
parent Type : String
Maximum length : 1500		 The name of the user-defined model extended by this user-defined model, if applicable.
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 model and code used to create and edit metadata. Custom means this UDM was developed with the Vault Java SDK.
serialization_include Type : Enum
Allowed values :
  • ALWAYS
  • IGNORE
  • NON_NULL
  • UNSPECIFIED
 The default serialization behavior for this user-defined model.

Userdefinedservice

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.

Vaulttoken

This component type stores tokens which can be resolved Vault-wide. All Vaults include system-provided tokens for Vault id, name, and dns. In addition to these, you can configure up to ten (10) Vault Tokens. Vault Java SDK developers can reference Vault tokens in HTTP Callout or within the Spark message framework.

Learn more in the Vault Java SDK documentation.

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.
clone_behavior Type : Enum
Required
Allowed values :
  • clear__sys
  • persist__sys
 Indicates whether the value attribute is cleared when the Vault is cloned.
type Type : Enum
Required
Allowed values :
  • string__sys
  • boolean__sys
  • number__sys
  • date__sys
  • datetime__sys
  • list_string__sys
 The data type of the token value.
system_managed Type : Boolean Indicates that records are managed by the system.
value Type : String
Maximum length : 255		 The value of the token when resolved.

Visualhierarchyconfiguration

Visual Hierarchies form the backbone of the Process Navigator page, which provides a visually-navigated interface for users to find processes and supporting documents in Vault QualityDocs. Visual Hierarchy Configurations determine which fields are available and the order in which they display on Visual Hierarchy detail pages.

Learn about Visual Hierarchies 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.
visual_hierarchy_type Type : Objecttype The Visual Hierarchy object type. If omitted, Vault applies the configuration to all object types that do not already have a visual hierarchy configuration defined.

Visualhierarchyconfigurationfield

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.
field Type : Subcomponent
Required		 References a field on the Visual Hierarchy object.
display_order Type : Number
Required		 The order in which to display the field.
object Type : Object
Required		 This is always Object.visual_hierarchy__v.

Workflow

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.

Workflowstep

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 :
  • start
  • end
  • usertask
  • notification
  • placeholder
  • changestate
  • decision
  • join
  • action
  • updaterecordfield
  • updatesharingsettings
 The type of worflow step.
next_steps Type : Docworkflowstep
Allows multiple values		 The Docworkflowstep to move to once this step is complete.