Component types are the configuration elements of a Vault. MDL allows you to access these elements and execute scripts to automate complex or repetitive configuration changes in your Vault. This page contains details for the component types available in Vault.
Some component types are visible through the Vault REST API, but are not included in this reference. These component types can only be used by internal Veeva developers.
View and edit messages that Vault sends to users as both emails and in-application notifications.
Learn about Email and Message Administration in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the 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. |
Internal Vault developers use Application Security Rules to control access to records. External developers cannot create custom Application Security Rules, but they can create two types of subcomponents, Appsecurityfield
and Appsecutityassignment
, that map Appsecrityrule
s to Object
s. This allows assignments to be moved between Vaults using migration packages (VPKs).
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. |
help_content | Type : String Maximum length : 255 | UI-friendly help string. |
allow_custom_objects | Type : Boolean Required | If true , the rule can be applied to custom objects. |
description | Type : String Maximum length : 255 | A general description of the rule. |
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. |
multi_value | Type : Boolean | If true , allows multiple values. |
picklist | Type : Picklist | Reference to the Picklist component. |
type | Type : Enum Required Allowed values :
| The type of the field. |
object | Type : Object | Reference to Object component. |
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. |
field | Type : Subcomponent Required | Reference to an object field subcomponent in the format Field.{field_name} . For example, Field.study_migration__v . |
securityrule | Type : ComponentReference | (Read-only) Reference to the parent Appsecurityrule component. |
appsecurityfield | Type : ComponentReference | Legacy reference to Appsecurityfield subcomponent. As of 24R1.2, this attribute has been deprecated and replaced by securityfield . |
securityfield | Type : SubcomponentReference | Reference to Appsecurityfield subcomponent. |
object | Type : Object Required | Reference to Object component in the format Object.{object_name} . For example, Object.procedure__v . |
Atomic security provides an additional layer of control by allowing you to configure security at the lifecycle state and/or assigned role level.
Learn about Atomic Security in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
object | Type : Object Required | The Object the security applies to. For example, Object.country__v |
object_lifecycle | Type : Objectlifecycle Required | The Objectlifecycle the security applies to. For example, Objectlifecycle.general_lifecycle__c |
state | Type : Objectlifecyclestate Required | The Objectlifecyclestate of the Objectlifecycle the security applies to. For example, Objectlifecyclestate.active_state__c |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
role | Type : Objectlifecyclerole Required | The Objectlifecyclerole of the Objectlifecycle the security applies to. For example, Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles. |
type | Type : Enum Required Allowed values :
| The type of permission to apply. |
fields | Type : Field Required Allows multiple values | The fields to apply this permission to. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
role | Type : Objectlifecyclerole Required | The Objectlifecyclerole of the Objectlifecycle the security applies to. For example, Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles. |
type | Type : Enum Required Allowed values :
| The type of permission to apply. |
object_controls | Type : Objectcontrol Required Allows multiple values | The object control permissions to apply. Learn more about Object Control Permissions 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. |
role | Type : Objectlifecyclerole Required | The Objectlifecyclerole of the Objectlifecycle the security applies to. For example, Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles. |
type | Type : Enum Required Allowed values :
| The type of permission to apply. |
object_actions | Type : Objectaction Allows multiple values | The Object level action(s) to apply this permission to. |
lifecycle_actions | Type : Objectlifecyclestateuseraction Allows multiple values | The Lifecycle level action(s) to apply this permission to. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
role | Type : Objectlifecyclerole Required | The Objectlifecyclerole of the Objectlifecycle the security applies to. For example, Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles. |
type | Type : Enum Required Allowed values :
| The type of permission to apply. |
workflow_actions | Type : Enum Allows multiple values Allowed values :
| The workflow action to apply. |
workflow_task_actions | Type : Enum Allows multiple values Allowed values :
| The workflow task action to apply. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
role | Type : Objectlifecyclerole Required | The Objectlifecyclerole of the Objectlifecycle the security applies to. For example, Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles. |
type | Type : Enum Required Allowed values :
| The type of permission to apply. |
document_fields | Type : Docfield Allows multiple values | Lists the object fields corresponding to the object-to-document inbound relationship on the specified object. |
object_fields | Type : Field Allows multiple values | Lists the object fields corresponding to the object-to-object relationship on the specified object. |
This component type contains the configuration details of a Case Child section in the Medical Inquiry user interface and is available only in MedInquiry Vaults. Direct modification of Casechildconfig components through MDL is not supported or recommended, and you should instead create or modify case children in the Medical Inquiry Admin UI.
Learn more about Configuring Medical Inquiry 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. |
object_key | Type : String Required Maximum length : 1500 | The object type name for the child section. For example, case_response__v.phone__v . |
field_keys | Type : String Required Allows multiple values Maximum length : 1500 | A list of child object field names. For example, [\"source__v\",\"link__sys\"] . |
parent_field_key | Type : String Required Maximum length : 1500 | The name of the parent object. For example, case_request__v . |
save_all_on_create | Type : Boolean | If true , users must save all information entered in this section before continuing the input process. |
auto_suggest_faqs | Type : Boolean | If true , MedInquiry will automatically send incoming emails to an FAQ and suggest a standard response. |
request_details_field_key | Type : String Maximum length : 1500 | The name of the field MedInquiry will use for FAQ matching. |
grandparent_field_key | Type : String Maximum length : 1500 | The name of the grandparent object. For example, case__v . |
children | Type : String Allows multiple values Maximum length : 1500 | A list of the section’s children, if any exist. |
config_key | Type : String Required Maximum length : 1500 | The full name of the section including parent and grandparent sections. For example, case_request__v.case_response__v.phone__v . |
order | Type : Number | The order in which the child section appears within the Case Contact section. |
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 . Optional in some Vault Applications. |
version_controlled | Type : Boolean | Indicates whether the checklist type is version controlled. Learn more about checklist versioning in Vault Help. |
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
target_matching_field | Type : Subcomponent | The field on the target object. This is used to match a value from the target object record with the corresponding matching field value on the Checklist Design object. |
target_object | Type : Object Required | The object the checklist applies to. |
checklist_design_matching_field | Type : Subcomponent Required | The field on the checklist design object. This is used to match a value from the Checklist Design object record with the corresponding matching field value on the target object. |
checklist_design_object | Type : Object Required | The object the checklist design applies to. |
Developers can create custom web APIs using the Vault Java SDK.
Learn more in the Vault Java SDK documentation.
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. |
api_group | Type : ComponentReference Required | The Webapigroup to which the custom web api is assigned. |
checksum | Type : String Maximum length : 1500 | Used to check data for errors. |
endpoint_name | Type : String Required Maximum length : 1500 | The endpoint name as specified in the WebApiInfo annotation. |
minimum_version | Type : String Required Maximum length : 1500 | The minimum Vault REST API version required to use the custom web API as specified in the WebApiInfo annotation. |
source_code | Type : SdkCode Maximum length : 1048576 | The Vault Java SDK source code for this custom web API. |
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 the 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. |
tags | Type : String Allows multiple values Maximum length : 1500 Ordered : True | A list of tags associated with the dashboard. |
Atomic security for documents provides more granular control, based on lifecycle state and role, over who can perform specific lifecycle user actions like changing document state and starting a workflow. For example, the Editor role may be able to start the Review workflow, but not the Expedited Approval workflow.
Learn more about Atomic Security for Documents in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the field is active. |
document_lifecycle | Type : Doclifecycle Required | Indicates the lifecycle that atomic security applies to. |
state | Type : String Required Maximum length : 1500 | Indicates the lifecycle state that atomic security applies to. |
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the field is active. |
role | Type : String Required Maximum length : 1500 | Indicates the role override that the permission applies to. |
type | Type : Enum Required Allowed values :
| Indicates the permission type. |
workflow_actions | Type : Enum Allows multiple values Ordered : True Allowed values :
| Indicates the active workflow action that the permission applies to. |
workflow_task_actions | Type : Enum Allows multiple values Ordered : True Allowed values :
| Indicates the active workflow task action that the permission applies to. |
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the field is active. |
role | Type : String Required Maximum length : 1500 | Indicates the role override that the permission applies to. |
type | Type : Enum Required Allowed values :
| Indicates the permission type. |
lifecycle_actions | Type : String Allows multiple values Maximum length : 1500 Ordered : True | Indicates the user action that the permission applies to. |
Attribute of a document associated to one or more document types.
Learn about Document Fields in Vault Help.
Attribute | Description | |
---|---|---|
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. |
scale | Type : Number Maximum value : 9 | Applicable to fields of type number only. |
queryable | Type : Boolean | Indicates whether the field is queryable through VQL. This attribute is read-only. |
default_security | Type : String Maximum length : 1500 | options:
|
secure_relationship | Type : Boolean | Enables relationship security on a referenced object. |
shared | Type : Boolean Required | Indicates whether the field is shared or local. |
multi_value | Type : Boolean | Indicates whether the field accepts multiple values. |
display_section | Type : String Required Maximum length : 1500 | Name of the display section. For example, Docfieldlayout.general_properties__v |
formula | Type : Expression Maximum length : 4000 | An expression surrounded in [ ] character combination. |
blank_fields | Type : String Maximum length : 1500 | options:
|
controlling_field | Type : String Maximum length : 1500 | Controlling field name, if any. |
editable | Type : Boolean | Whether the field is editable by the user. The value here is specific to the user and depends on security_overrides. |
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 . |
set_on_create_only | Type : Boolean | Can only set if the user has a proper MDL admin permission. |
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. |
defined_in | Type : String Maximum length : 1500 | The Doc Type this field belongs to (local fields only). e.g. Doctype.my_doc_type__c |
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 |
relationship_type | Type : String Maximum length : 1500 | Can only return “reference” at this time. |
lookupObjectFieldKey | Type : String Maximum length : 1500 | Reference to Doc field component. Used for the Lookup field type. |
lookupObjectId | Type : String Maximum length : 1500 | Reference to Object component. Used for the Lookup field type. |
lookupFieldId | Type : String Maximum length : 1500 | Reference to Object field component. Used for the Lookup field type. |
relationship_criteria | Type : String Allows multiple values Maximum length : 1500 | The VQL used to constrain records in the referenced Object |
no_copy | Type : Boolean | When true a value will not be set in a copied document. Cannot be true when required is true . |
can_change_section | Type : Boolean | For internal Veeva use only. |
can_change_required | Type : Boolean | For internal Veeva use only. |
can_change_disabled | Type : Boolean | For internal Veeva use only. |
can_change_multiple | Type : Boolean | For internal Veeva use only. |
can_change_no_copy | Type : Boolean | For internal Veeva use only. |
help_content | Type : String Maximum length : 500 | UI-friendly help string |
max_length | Type : Number Maximum value : 1500 Minimum value : 1 | Applicable to fields of type string only. |
active | Type : Boolean Required | Indicates whether the field is active. |
label | Type : String Required Maximum length : 1500 | UI-friendly string in the Vault’s base language. |
required | Type : Boolean Required | Indicates whether the field is required. |
scope | Type : String Maximum length : 1500 | options:
Regular users can create Document scoped fields only. Creating DocumentVersion scoped fields requires special security permissions. |
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. |
object | Type : String Maximum length : 1500 | Possible values supported are names of VOF objects, User, Group, and Lifecycle. |
type | Type : String Required Maximum length : 1500 | options:
|
default_value | Type : String Allows multiple values Maximum length : 1500 | The default value used when the field is not set. |
Dependent fields allows you to configure a relationship between a controlling field and one or more controlled or dependent fields.
Learn about Dependent Fields in Vault Help.
Attribute | Description | |
---|---|---|
doctype | Type : Doctype | The Doctype the field dependency applies to. |
docfield | Type : Docfield | The Docfield the field dependency applies to. |
docfield_multi_value | Type : String Allows multiple values | Specifies the field value or values that trigger the action. |
docfield_value | Type : String | Specifies the field value that triggers the the action. This attribute cannot support individual values containing a comma, for example, “Tanzania, United Republic of”. This attribute is deprecated as of 19R2.3. |
deprule_docfield | Type : Docfield Required | Specifies the Docfield the dependency rule applies to. |
deprule_docfield_action | Type : Enum Required Allowed values :
| The action applied. Specifies the actions to take on the field values. |
deprule_docfield_multi_values | Type : String Allows multiple values | The value(s) available when deprule_docfield_action is picklist . |
deprule_docfield_values | Type : String | The value(s) available when deprule_docfield_action is picklist . This attribute cannot support individual values containing a comma, for example, “Tanzania, United Republic of”. This attribute is deprecated as of 19R2.3. |
lifecycle | Type : String | The Doclifecycle the dependency rule applies to. |
state | Type : String | The Doclifecycle state the dependency rule applies to. |
role | Type : String | The Doclifecycle role the dependency rule applies to. |
Defines how a field layout section appears on the Doc Info page in the Vault UI. While multiple Docfieldlayout
s can use the same label
, each one must have a unique name
.
Learn about Document Field Layouts in Vault Help.
Attribute | Description | |
---|---|---|
active | Type : Boolean Required | Whether the layout is active. |
allow_field_assignment | Type : Boolean | For internal Veeva use only. |
show_in_edit_mode | Type : Boolean | For internal Veeva use only. |
panel | Type : String Maximum length : 1500 | For internal Veeva use only. |
label | Type : String Required Maximum length : 60 | UI-friendly string in the Vault’s base language. |
icon | Type : Enum Allowed values :
| The icon to display in the section header. |
order | Type : Number | The order of the section relatve to other sections. |
fields | Type : Docfield Allows multiple values Ordered : True | The Docfield ’s listed in order they should appear in the section. |
Document lifecycles are the sequences of states (Draft, In Review, etc.) a document goes through during its life.
Learn about Document Lifecycles in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | General description for this lifecycle. |
state_labels | Type : String Required Allows multiple values Maximum length : 1500 Ordered : True | Lists lifecycle state labels (by name) defined for this lifecycle. The order defined here must correspond to the order in labeled_states . |
labeled_states | Type : Doclifecyclestate Required Allows multiple values Ordered : True | Lists “special states” (by name). The order of the state in this list dictates which state from state_labels is assigned to the specific special state. |
expiration | Type : XMLString Maximum length : 32000 | Expiration rules. |
signature_pages | Type : XMLString Maximum length : 32000 | Signature page rules. |
overlays | Type : XMLString Maximum length : 32000 | The overlay template applied to a speciifc lifecycle. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | General description for this lifecycle. |
application_role | Type : String Required Maximum length : 255 | The name__v field value of the application_role__v record this role corresponds to. |
note_color | Type : Enum Allowed values :
| Annotations made by users in this role will use this color by default. |
security_options | Type : XMLString Maximum length : 32000 | The default security rules. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 128 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | General description for this lifecycle. |
order | Type : Number Required | The relative order in which the action displays. For example, order 1 will display before order 2 . |
cancel_state | Type : Doclifecyclestate | Indicates the state documents enter when their document workflow is cancelled. |
skip_cancel_state | Type : Boolean | If set to true , documents stay in their current state when their workflow is cancelled. If set to false or omitted, documents enter the state defined by cancel_state when the workflow is cancelled. |
entry_criteria | Type : XMLString Maximum length : 128000 | The criteria, and the conditions under which they are enforced, which must be satisfied for a document to enter this state. |
entry_action | Type : XMLString Maximum length : 128000 | The actions, and the conditions under which they are executed, which are performed when a document enters this state. |
user_action | Type : XMLString Maximum length : 128000 | The actions, and the conditions under which they are available, which a user can execute when a document is in this state. |
security_settings | Type : XMLString Maximum length : 32000 | The actions a user, in each role, can perform when a document is in this state. |
Attribute | Description | |
---|---|---|
active | Type : Boolean Required | Indicates whether the component is active. |
event | Type : String Required Maximum length : 1500 | The type of event action. |
rule | Type : XMLString Required Maximum length : 32000 | The defined rules and conditions for entry criteria, entry actions, or user actions. |
order | Type : Number Required | The relative order in which the action displays. For example, order 1 will display before order 2 . |
Dynamic Access Control (DAC) is an access control model for documents, which automates the assignment of users to document roles.
Learn about Dynamic Access Control for Documents in Vault Help.
Attribute | Description | |
---|---|---|
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 the Vault’s base language. |
Attribute | Description | |
---|---|---|
object_field | Type : Field Required | The field of the object to match on. |
data_field | Type : Docfield Required | The field on the document to match on. |
object | Type : Object Required | The Object the matching rule is defined on. |
Workflow participant rules control which document fields will force the selected role to be required or hidden in the workflow start dialog.
Learn about Workflow Participant Rules in Vault Help.
Attribute | Description | |
---|---|---|
lifecycle | Type : Doclifecycle Required | The document lifecycle the rule applies to. |
role | Type : Doclifecyclerole Required | The lifecycle role the rule applies to. |
active | Type : Boolean Required | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | A general description of the rule. |
label | Type : String Required Maximum length : 60 | UI-friendly string in the Vault’s base language. |
Attribute | Description | |
---|---|---|
object_field | Type : Field Required | The field of the object the rule is defined on. |
data_field | Type : Docfield Required | The field on the document the rule is defined on. |
object | Type : Object Required | The Object the participant rule is defined on. This can only be workflow_role_setup__v . |
Document relationship types define the type on relationship between two documents.
Learn about Document Relationships in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
single_use | Type : Boolean | True when only one relationship of this type can be created for the source document. |
target_doctype | Type : String Maximum length : 1500 | The Doctype of the related document. |
source_version_specific | Type : Boolean | Whether the relationship is bound to the current version of the source document. |
carry_forward_source_specific | Type : Boolean | Whether the relationship will be brought forward when the source document is versioned. |
target_version_specific | Type : Boolean | Whether the relationship is bound to the current version of the target document. |
carry_forward_target_specific | Type : Boolean | Whether the relationship will be brought forward when the target document is versioned. |
relationship_filter | Type : XMLString Maximum length : 32000 | A criteria which restricts the documents that can be related using this type. |
Document types refer to a hierarchical taxonomy to differentiate the various types of documents stored in Vault.
Learn about Document Types in Vault Help.
Attribute | Description | |
---|---|---|
milestone_types | Type : String Allows multiple values Maximum length : 1500 | The type of milestone. |
rendition_types | Type : String Allows multiple values Maximum length : 1500 | The list of Renditiontype names supported. |
allow_attachments | Type : Boolean | Whether documents of this type can have attachments. |
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. |
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 ). |
processes | Type : String Allows multiple values Maximum length : 1500 | The list of process names. These come from processes picklists. |
etmf_department | Type : String Maximum length : 1500 | The department name from the etmf_departmnet picklist Available in eTMF Vaults only. |
doctype_group | Type : String Allows multiple values Maximum length : 1500 | List of Document Group (doc_type_group__v ) linked to this Doctype. |
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} |
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. |
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 :
| Select display options for unbound documents. |
create_document_permissions | Type : String Allows multiple values Maximum length : 1500 | The list of group or user IDs in the form of user:username or Group.name__v |
create_binder_permissions | Type : String Allows multiple values Maximum length : 1500 | The list of group or user IDs in the form of user:username or Group.name__v |
role_defaulting_editors | Type : String Allows multiple values Maximum length : 1500 | The list of group or user IDs in the form of user:username or Group.name__v |
role_defaulting_viewers | Type : String Allows multiple values Maximum length : 1500 | The list of group or user IDs in the form of user:username or Group.name__v |
role_defaulting_consumers | Type : String Allows multiple values Maximum length : 1500 | The list of group or user IDs in the form of user:username or Group.name__v |
inherit_doctype_groups | Type : Boolean | Indicates whether the doctype_group values are inherited from the parent Doctype . |
regen_doc_name_on_save | Type : Boolean | Whether auto-generated names should be refreshed when saving the document. |
relationship_types | Type : String Allows multiple values Maximum length : 1500 | The list of Docrelationshiptype names supported. |
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:
|
active | Type : Boolean Required | Indicates whether the field is active. |
description | Type : String Maximum length : 500 | A general description of the Doctype. |
label | Type : String Required Maximum length : 200 | UI-friendly string. |
fields | Type : String Allows multiple values Maximum length : 1500 | The list of Docfield components linked to this Doctype. |
Documents can have custom actions that perform specific instructions. You can use a custom action to automate certain business processes.
Learn about Record Role Triggers in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the Vault’s base language. Although you can enter up to 60 characters, the Vault UI only displays the first 40 characters. |
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. |
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 the 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. |
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. |
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 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. |
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 the 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 :
| Indicates the type of senders from whom this email processor can receive emails. |
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 the 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. |
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 the 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 :
| Indicates the type of senders from whom this inbound email address can receive emails. |
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 the 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 . |
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. |
query_object | Type : String Required Maximum length : 1500 | Name of the mapped query object object_name__c . Must be specified as returned in the VQL response. |
filter_clause | Type : Expression Maximum length : 4000 | A Criteria VQL expression containing the logic for this query object rule. |
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
target_field_lookup | Type : Subcomponent | If target_object_field is an object reference field corresponding to an object with an outbound relationship to this field rule’s target_object , this is a set field which is a unique field related to the object referenced in the field rule’s target_object . Only supported for object query_field_type s. |
query_field_select | Type : Subcomponent | If populated, overrides the query_field . Used in cases where you need to transform the data with a VQL function such as TONAME() . If an alias (AS ) exists in this field, that alias must also exist in the query_field . |
query_field_type | Type : Enum Allowed values :
| The type (object or document) and data type of the query field. |
target_obj_field_ref_obj | Type : Object | |
query_object | Type : String Maximum length : 100 | Name of the mapped query object object_name__c . Must be specified as returned in the 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 if the target_object is set. |
target_docfield | Type : Docfield | References the Docfield if the target is a Document. |
reference_lookup_type | Type : Enum Allowed values :
| The type of the reference_lookup . lifecyclestate is deprecated as of 19R2.2. Use either objectlifecyclestate or documentlifecyclestate . |
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. |
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 the Vault’s base language. |
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. For example: America/Los_Angeles. If omitted, the default value is the Vault time zone. |
trigger_date | Type : Expression Maximum length : 4000 | (Date Based Object Operation and Date Based Document Operation jobs only) The object record or document’s Date or DateTime field, as of the job’s run date, that Vault evaluates each time the job runs. |
repeat_on_days | Type : Enum Allows multiple values Allowed values :
| The day(s) of the week to repeat the job on. For example, 'Mon','Wed','Fri' . |
month_repeat_type | Type : Enum Allowed values :
| Day of the month or week for a scheduled job. |
week_day | Type : Enum Allowed values :
| Day of the week. |
hourly_interval | Type : Number Maximum value : 12 Minimum value : 1 | For jobs where schedule is set to hourly , the number of hours to wait before repeating the job. Allowed values are 1 , 2 , 3 , 4 , 6 , 12 . |
schedule | Type : String Maximum length : 1500 | The frequency of a scheduled job. Options:
|
active | Type : Boolean Required | Indicates whether the component is active. |
priority | Type : String Maximum length : 1500 | Indicates job priority. For example, normal |
type | Type : String Maximum length : 1500 | Indicates job type. For example:
|
owner | Type : String Maximum length : 1500 | The group or user that owns the report job. |
time | Type : String Maximum length : 1500 | The scheduled time of the report job.
|
day_of_month | Type : Number Maximum value : 31 | Specify the day of the month for a monthly report. |
week_number | Type : Number Maximum value : 5 | Week number for a monthly report that runs on a “day of the week.” |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in the Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
related_doc_conditions | Type : String Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any related documents. |
trigger_date_target | Type : String Maximum length : 1500 | Defines the date field to be evaluated against the trigger date. |
relationship_types | Type : String Allows multiple values Maximum length : 1500 | Defines which document relationship type to run the primary action on. |
conditions | Type : String Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any records. |
notify_on_status_condition | Type : Boolean | Always set to true . |
recipients | Type : String Allows multiple values Maximum length : 1500 | Defines the notification recipients based on a list of roles on the affected records. |
template | Type : String Maximum length : 1500 | Defines the notification template to be used when sending a notification as a result of the job. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in the Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
conditions | Type : String Required Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any records. |
object | Type : String Required Maximum length : 1500 | Defines the Vault Object the job will run on. Only records in this Object can be affected. |
terminate_existing_workflows | Type : Boolean Required | Indicates whether to cancel existing workflows to perform action. |
destination_state | Type : String Required Maximum length : 1500 | Defines the lifecycle state to set. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in the Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
related_doc_conditions | Type : String Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any related documents. |
trigger_date_target | Type : String Maximum length : 1500 | Defines the date field to be evaluated against the trigger date. |
relationship_types | Type : String Allows multiple values Maximum length : 1500 | Defines which document relationship type to run the primary action on. |
conditions | Type : String Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any records. |
notify_on_status_condition | Type : Boolean | Always set to true . |
recipients | Type : String Allows multiple values Maximum length : 1500 | Defines the notification recipients based on a list of roles on the affected records. |
template | Type : String Maximum length : 1500 | Defines the notification template to be used when sending a notification as a result of the job. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in the Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
conditions | Type : String Required Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any records. |
object | Type : String Required Maximum length : 1500 | Defines the Vault Object the job will run on. Only records in this Object can be affected. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in the Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
post_session_creds | Type : Boolean | Indicates whether to post session credentials via form data with key “Session.id”. |
run_as_user | Type : String Maximum length : 1500 | Defines the user account the Vault uses to complete an external URL call job. |
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”. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in the Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
job_metadata | Type : String Required Maximum length : 1500 | Reference to the Jobmetadata component of the job to be run. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in the Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
conditions | Type : String Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any records. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in the 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. |
send_notifications_to_group_by_users | Type : Boolean | If true for flash reports grouped by user fields, Vault distributes reports to the users in report resuts. Users only see the report results associated with them. |
enable_flash_refresh | Type : Boolean | If true , a flash report may be refreshed by users. |
send_standard_email_to_shared_users | Type : Boolean | |
custom_flash_email | Type : Boolean | If true , allows you to customize the email using the values of custom_flash_email_subject and custom_flash_email_body . |
custom_flash_email_subject | Type : String Maximum length : 1500 | The subject for the custom notification email when custom_flash_email is true . |
custom_flash_email_body | Type : String Maximum length : 1500 | The body for the custom notification email when custom_flash_email is true . |
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. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in the 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 :
| 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 . |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in the Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
conditions | Type : String Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any records. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in the Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
conditions | Type : String Required Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any records. |
object | Type : String Required Maximum length : 1500 | Defines the Vault Object the job will run on. Only records in this Object can be affected. |
recipients | Type : String Allows multiple values Maximum length : 1500 | Defines the notification recipients based on a list of roles on the affected records. |
template | Type : String Maximum length : 1500 | Defines the notification template to be used when sending a notification as a result of the job. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in the Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
related_doc_conditions | Type : String Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any related documents. |
trigger_date_target | Type : String Maximum length : 1500 | Defines the date field to be evaluated against the trigger date. |
relationship_types | Type : String Allows multiple values Maximum length : 1500 | Defines which document relationship type to run the primary action on. |
conditions | Type : String Allows multiple values Maximum length : 1500 | The set of conditions that must be met for the job to execute on any records. |
notify_on_status_condition | Type : Boolean | Always set to true . |
document_version | Type : Enum Allowed values :
| Determines which document version the job will run on. |
terminate_existing_workflows | Type : Boolean | Indicates whether to cancel existing workflows to perform action. |
override_checkout_state_change | Type : Boolean | If true , allow the state change action to proceed even when a minor version of the document is checked out. Only available when the configured Current State is the lifecyle’s configured steady state type and the destination_state is the lifecycle’s configured obsolete state type. |
destination_state | Type : String Maximum length : 1500 | Defines the lifecycle state to set. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in the Vault’s base language. |
primary_action | Type : Boolean | The primary operation that the job completes. Always set to true . |
edcAsyncPayload | Type : JSONString Maximum length : 32000 | For internal Veeva use only. |
The Jobmetadata
component is used to define the metadata of an SDK Job. Because SDK Jobs are invoked through their Jobmetadata
, every class implemented using the Job
interface must be associated to a Jobmetadata
component. Note: You may see Vault-supplied SDK jobs which work to deliver various features.
Learn about Administering SDK Job Metadata in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the field is active. |
chunk_size | Type : Number Maximum value : 500 Minimum value : 1 | Defines the number of Job items to be processed in each task. |
single_instance_states | Type : Enum Allows multiple values Allowed values :
| Defines a state or states as single instance. Only one instance of a job is allowed to be in a single instance state at any given time. |
description | Type : String Maximum length : 1500 | Description of the job which displays in the UI. |
job_code | Type : ComponentReference Required | References the fully qualified class name of an Sdkjob component. |
queue | Type : ComponentReference | The queue the job will place messages into. Custom jobs cannot reference standard queues. |
Layout profiles are collections of layouts for various objects. Admins can associate one profile to each user__sys
record to determine which layouts are available to that user when viewing object records.
Learn about layout profiles 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. |
description | Type : String Maximum length : 255 | A description of the layout profile. |
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. |
record_creation_layout | Type : Pagelayout | The Pagelayout users see when creating an object record. |
objecttype | Type : Objecttype | If applicable, the object type to which the layout applies. |
object | Type : Object Required | The Vault object to which the layout applies. |
pagelayouts | Type : Pagelayout Required Allows multiple values Ordered : True | The Pagelayouts available to users when viewing an object record. |
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_layout | Type : Boolean | If set to true , Vault hides this layout when the layout rule evaluates to true. |
focus_on_layout | Type : Boolean | If set to true , Vault displays this layout when the layout rule evaluates to true. |
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. |
hidden_pages | Type : String Allows multiple values Maximum length : 1500 | Lists the pages Vault will hide when the layout rule evaluates to true. |
displayed_as_required_fields | Type : String Allows multiple values Maximum length : 1500 | Lists the fields Vault will display as required (with yellow background color and “*”) when the layout rule evaluates to true. |
displayed_as_readonly_fields | Type : String Allows multiple values Maximum length : 1500 | Lists the fields Vault will display as read-only when the layout rule evaluates to true. |
hide_controls | Type : String Allows multiple values Maximum length : 1500 | Indicates the custom control to hide in the layout rule. |
expression | Type : String Required Maximum length : 3900 | A valid expression. |
active | Type : Boolean Required | Indicates whether the component is active. |
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. |
label | Type : String Required Maximum length : 40 | UI-friendly string in the Vault’s base language. |
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 the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
document_lifecycle | Type : Doclifecycle | The document lifecycle the state type belongs to. Not currently supported. |
label_message_key | Type : String Maximum length : 255 | |
description | Type : String Maximum length : 255 | Text description of the state type and how it is used. |
state_required | Type : Boolean Required | Indicates whether a lifecycle must have a lifecycle state associated with the state type. |
lifecycle_scope | Type : Enum Required Allowed values :
| Determines whether the state type applies to all lifecycles, is available to all lifecycles (but not required for all lifecycles), or is relevant to only a specific lifecycle. |
object_lifecycle | Type : Objectlifecycle | The object lifecycle the state type belongs to. |
lifecycle_type | Type : Enum Required Allowed values :
| Indicates whether the state type is supporting document or object lifecycles. Only object lifecycles are currently supported. |
Lifecycle state type associations join a state and a lifecycle state type record.
Learn more about Object Lifecycle State Types in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
document_lifecycle | Type : Doclifecycle | The document lifecycle the state type belongs to. Not currently supported. |
state_type | Type : ComponentReference Required | The state type that is joined to the object lifecycle state. |
description | Type : String Maximum length : 255 | Text description of the state type and lifecycle state association. It is not exposed in the user interface. |
object_lifecycle_state | Type : Subcomponent | The object lifecycle state that is joined to the state type. |
document_lifecycle_state | Type : String Maximum length : 1500 | Describes the document lifecycle state being joined to the state type. Not currently supported. |
object_lifecycle | Type : Objectlifecycle | The object lifecycle that the state type and object lifecycle state belong to. |
Defines a Web Action.
Learn about Web Actions in Vault Help.
Attribute | Description | |
---|---|---|
send_session_via_post_message | Type : Boolean | Specifies the option to send post session credentials via post message instead of through the URL. |
url | Type : String Required Maximum length : 2083 | Defines the URL link for the web action. |
component | Type : Enum Required Allowed values :
| Specifies whether the action applies to documents or objects records. |
label | Type : String Required Maximum length : 40 | UI-friendly string in the Vault’s base language. |
target | Type : Enum Required Allowed values :
| Controls where the target URL displays when a user executes the web action. |
Matching Sharing Rules are part of Dynamic Access Control for objects. These rules allow assignment of users to Auto Managed groups and dynamic assignment of those groups to roles on specific object records.
Learn about Configuring Matching Sharing Rules for Objects in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 100 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean Required | Indicates whether the field is active. |
description | Type : String Maximum length : 255 | General description of the matching rule. |
object | Type : Object Required | The object the rule applies to. |
role | Type : String Required Maximum length : 60 | The role the rule applies to. |
user_role_fields | Type : String Required Allows multiple values Maximum length : 56 Ordered : True | A list of User Role Object Fields used to identify matching rows. |
data_fields | Type : String Required Allows multiple values Maximum length : 56 Ordered : True | A list of Object or Document Fields used to identify matching rows. |
Spark message delivery event handlers provide a way to handle undelivered Spark messages. For example, implement MessageDeliveryEventHandler
in your custom code and add it to an Outbound Queue. When an undeliverable message is encountered, Vault executes the logic coded in the handler.
Learn about Spark Message Delivery Event Handlers.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
checksum | Type : String Maximum length : 1500 | Used to check data for errors. |
source_code | Type : SdkCode Maximum length : 1048576 | The source of this Spark message delivery event handler and code used to create and edit metadata. Custom means this handler was developed with the Vault Java SDK. |
To provide a localized experience, Vault Java SDK developers can create translations for messages displayed to the end user in Vault. To do this, they create the message groups and messages with MDL or use the Message Catalog in the Vault UI. Learn more about creating message groups and messages in Vault Help.
Developers retrieve the messages using TranslationService
. Learn more in the Javadocs.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the field is active. |
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the field is active. |
default_value | Type : String Required Maximum length : 1500 | The default translation value for this message. |
system_managed | Type : Boolean | Indicates whether users can overwrite translation values for this message. |
Spark message processors provide logic to handle Spark messages. For example, all inbound queues must include a Spark message processor to provide the operations to perform on the received messages. You create Spark message processors with the MessageProcessor
interface in the Vault Java SDK.
Learn about Spark Message Processors.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the 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. |
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 :
| 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. |
A tab within the UI of Vault Mobile. Admins can configure mobile tabs from Admin > Configuration > Mobile Setup > Mobile Tabs in the Vault UI.
Learn more about mobile tabs 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. |
icon | Type : String Maximum length : 1500 | For internal Veeva use only. |
minimum_app_version | Type : String Maximum length : 1500 | The minimum version of the Vault Mobile app required to support the tab. This attribute is read-only. |
page | Type : ComponentReference | For internal Veeva use only. |
mobile_label | Type : String Maximum length : 40 | UI-friendly string to display in the Vault Mobile app. If omitted, Vault Mobile displays the label . |
order | Type : Number Minimum value : 1 | The relative order in which the mobile tab appears in the Vault Mobile navigation bar. |
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 the Vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | Additional description of the notification template. |
subject | Type : String Required Maximum length : 255 | Subject of the email sent to the receipient. |
notification | Type : String Required Maximum length : 1023 | The message that appears in Vault’s notification page for the recipient. |
email_body | Type : String Required | Body of the email sent to the notification recipient. |
entity_type | Type : Enum Required Allowed values :
| Indiciates whether the message is intended for documents or objects. |
email_preferences | Type : String Maximum length : 255 | The frequency with which Vault sends emails. |
referenced_component | Type : Object | The specific Object (when entity_type is object ). |
notification_category | Type : String Maximum length : 255 |
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 Business Admin for this object. |
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. |
dynamic_security | Type : Boolean | Enables Custom Sharing Rules for the object. |
system_managed | Type : Boolean | Indicates that records are managed by the system. |
available_lifecycles | Type : Objectlifecycle | Defines the lifecycle (by name) that manages the object, e.g., Objectlifecycle.general_lifecycle__v . |
object_class | Type : Enum Allowed values :
| Classification of the object. |
allow_types | Type : Boolean | Indicates whether the object supports Objecttype . |
data_store | Type : Enum Allowed values :
| Indicates the data store for this object, either standard or raw . Once set, this attribute cannot change. |
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 . Deprecated - As of 24R1.3, this attribute is stored in the default_type attribute on related Objecttype records. It is accepted in MDL commands, but is not returned during exports. |
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. |
triggers_disallowed | Type : Boolean | If true , custom triggers cannot be added to this object. This attribute is read-only. |
configuration_data | Type : Boolean | If true , object records are copied when creating sandbox Vaults. This attribute is read-only. |
enable_merges | Type : Boolean | Indicates if this object allows record merges. |
in_merge | Type : Enum Allowed values :
| Indicates if this object record is actively undergoing a record merge, and if the record is the main or duplicate record. If this picklist value is null, the object record is not undergoing a record merge. Only present for objects that have record merges enabled. |
summary_fields | Type : String Allows multiple values Maximum length : 1500 | Lists the fields to display in the Summary Info panel. For example, field_1__c,field_2__c . Learn more about configuring the Summary Info panel in Vault Help. |
Attribute | Description | |
---|---|---|
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_in_header | Type : Enum Allowed values :
| If set to left or right , the field is shown as an icon in the left or right of the header. Can only be used on formula fields with a return type of text. |
secure_relationship | Type : Boolean | Enables relationship security on a referenced object. |
picklist_dependencies | Type : String | Contains comma-delimited list of all dependencies for the controlling picklist. For example, ’{ "english__c" : [“united_kindom__c ”, “united_states__c ”]}’ |
show_as_icon | Type : Boolean | If true , show_in_header settings are applied. Can only be used on formula fields with a return type of text. |
related_corporate_currency_field | Type : String Maximum length : 1500 | Contains the name of the related corporate currency field. |
controlling_picklist | Type : String Maximum length : 50 | The name of the controlling picklist, if any. |
searchable | Type : Boolean | Indicates whether the field is searchable. This field is read-only and only applies to lookup fields. |
editable | Type : Boolean | Indicates whether the field is editable. This field is read-only. |
encrypted | Type : Boolean | Indicates whether the field is encrypted. Learn more about encryption in Vault Help. |
subtype | Type : Enum Allowed values :
| Determines the field subtype, if any. Fields with a subtype have the same Data Type as their type, but have additional standard configuration as well as special behaviors. For example, fields with subtypes may have a standard format_mask . |
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 ). |
label | Type : String Required Maximum length : 40 | UI-friendly string in the Vault’s base language. |
type | Type : Enum Required Allowed values :
| Defines the field’s data type. |
active | Type : Boolean Required | Indicates whether the object is active. |
required | Type : Boolean Required | Indicates whether the user must always enter a value |
description | Type : String Maximum length : 1000 | A general description of the field that appears in the Admin UI to assist in object configuration and is not visible to users. |
unique | Type : Boolean | Indicates whether the field’s value must be unique. |
max_length | Type : Number Maximum value : 32000 Minimum value : 1 | (String, LongText, and RichText type fields only) Defines the maximum number of characters for the field value. |
max_value | Type : Number | (Number type fields only) Defines the maximum numeric value for the field value. |
min_value | Type : Number | (Number type fields only) Defines the minimum numeric value for the field value. |
scale | Type : Number Maximum value : 9 | (Number type fields only) Defines the maximum number of decimal places for the field value. |
format_mask | Type : String Maximum length : 3900 | Format masks are custom or standard expressions configured by your Vault Admin to instruct Vault how to display this field to Vault UI users. Learn more about format masks in Vault Help. Only available for:
TODISPLAYFORMAT() or the Vault Java SDK RecordDisplayService. |
help_content | Type : String Maximum length : 255 | Hover text to display for the (?) icon in Business Admin for this object. |
list_column | Type : Boolean Required | Indicates if the field should display in default object record lists, hovercards, etc. |
order | Type : Number | The order in which the field appears by default in hovercards and object record lists. |
multi_value | Type : Boolean | (Picklist fields only) Indicates if the field is multi-select. |
object | Type : String Maximum length : 50 | (Object fields only) Defines the related object (by name), e.g., country__v . |
relationship_type | Type : Enum Allowed values :
| (Object fields only) Indicates the relationship type. |
relationship_outbound_name | Type : String Maximum length : 50 | (Object fields only) Indicates the Outbound Relationship Name, e.g., edl__vr on EDL Item. |
relationship_inbound_name | Type : String Maximum length : 50 | (Object fields only) Indicates the Inbound Relationship Name, e.g., edl_item__vr on EDL. |
relationship_inbound_label | Type : String Maximum length : 40 | (Object fields only) Indicates the Outbound Relationship Label, e.g., EDL on EDL Item. |
controlling_field | Type : String Maximum length : 50 | Controlling field name, if any. |
relationship_deletion | Type : Enum Allowed values :
| (Object fields only) Defines the Deletion Rules that apply to when users try to delete the referenced or parent object record. Can only be set to cascade if relationship_type is parent . |
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. |
relationship_deep_copy | Type : Boolean | (Object fields only) Indicates if the child records associated via this field are available for hierarchical copy. |
picklist | Type : String | (Picklist fields only) Defines the picklist to use for the field. |
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 | Indicates which document version the field references. This can be either specific , latest , or latest_steady_state_version . |
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 | The formula expression. |
enhanced_blank_handling | Type : Enum Allowed values :
| (Formula fields only) Indicates the blank field handling setting for the field. Learn more about Blank Field Handling in Vault Help. |
multi_part_field | Type : Enum Allowed values :
| Indicates whether the prefix and suffix of multi-part field is editable. |
multi_part_readonly | Type : String Maximum length : 1500 | The read-only text of a multi-part field. |
currency_type | Type : Enum Allowed values :
| (Currency subtype fields only) Indicates whether the currency formula field value should use local or corporate currency. Learn more about currency fields in Vault Help. |
For use with objects where data_store
is raw
. While Vault indexes standard
objects for search and filtering automatically, Vault indexes raw
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 raw objects in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 1500 | UI-friendly string in the Vault’s base language. |
fields | Type : String Required Allows multiple values Maximum length : 1500 | The list of fields for this index. Note that Vault cannot index LongText fields, or Text fields longer than 255 characters. |
description | Type : String Maximum length : 1500 | A description of this index. |
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 the 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. |
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 the 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. |
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. |
record_inactive | Type : Boolean | Deprecated - replaced by record_status |
record_status | Type : Enum Allowed values :
| Indicates the status of a record while in this state. |
description | Type : String Maximum length : 255 | Additional information to describe the lifecycle. |
Attribute | Description | |
---|---|---|
rule | Type : XMLString Required Maximum length : 32000 | The defined rules and conditions for entry criteria, entry actions, or user actions. |
order | Type : Number | The relative order in which the action displays. For example, order 1 will display before order 2 . |
Attribute | Description | |
---|---|---|
rule | Type : XMLString Required Maximum length : 32000 | The defined rules and conditions for entry criteria, entry actions, or user actions. |
order | Type : Number | The relative order in which the action displays. For example, order 1 will display before order 2 . |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 60 | UI-friendly string in the Vault’s base language. |
rule | Type : XMLString Required Maximum length : 32000 | The defined rules and conditions for entry criteria, entry actions, or user actions. |
order | Type : Number Required | The relative order in which the action displays. For example, order 1 will display before order 2 . |
Attribute | Description | |
---|---|---|
rule | Type : XMLString Required Maximum length : 32000 | The defined rules and conditions for entry criteria, entry actions, or user actions. |
event | Type : String Required Maximum length : 1500 | |
order | Type : Number Required | The relative order in which the action displays. For example, order 1 will display before order 2 . |
Attribute | Description | |
---|---|---|
active | Type : Boolean Required | Indicates whether the component is active. |
application_role | Type : String Required Maximum length : 60 | The name__v field value of the application_role__v record this role corresponds to. (Prefixed with Applicationrole. ) |
permissions | Type : Enum Allows multiple values Allowed values :
| List of permissions assigned to the object role. Note that
|
Attribute | Description | |
---|---|---|
states | Type : Objectlifecyclestate Required Allows multiple values Ordered : True | Lists the object lifecycle states in which the permission applies. |
role | Type : Objectlifecyclerole Required | The role to which this permission applies. |
permission | Type : Enum Required Allowed values :
| The permission to apply. |
Lifecycle Stages allow organizations to group document and object lifecycle states into ordered collections of “stages”.
Learn about Lifecycle Stages.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the 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. |
object_lifecycle | Type : Objectlifecycle Required | Reference to Objectlifecycle component type. Validation ensures that only one Objectstagegroup exists per Objectlifecycle.Objecttype . |
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the 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 stage. |
order | Type : Number Required Minimum value : 1 | A number automatically assigned to a stage after it’s created and represents the order of stages in a stage group. |
An object type is a collection of fields that are grouped to capture similar but not identical data within a single object.
Not all objects use object types. Learn about Object Types in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in the Vault’s base language. |
label_plural | Type : String Required Maximum length : 40 | Plural of the label in the Vault’s base language. |
active | Type : Boolean Required | Indicates whether the object type is active. |
description | Type : String Maximum length : 1000 | A description of the object type that appears in the Admin UI to assist in object type configuration and is not visible to users. |
additional_type_validations | Type : String Allows multiple values Maximum length : 1500 | Contains a list of all validation rules for the specified object type. |
default_type | Type : Boolean | If true , this is the default object type. Only one object type per object can be set to true . If no value is specified, the default value is false . |
summary_fields | Type : String Allows multiple values Maximum length : 1500 | Lists the fields to display in the Summary Info panel. For example, field_1__c,field_2__c . Learn more about configuring the Summary Info panel in Vault Help. |
Attribute | Description | |
---|---|---|
source | Type : Enum Required Allowed values :
| The owner of the type. e.g. standard indicates owned by Vault. |
required | Type : Boolean | Indicates whether the user must always enter a value |
relationship_criteria | Type : Expression Maximum length : 4000 | The VQL used to constrain records in the referenced Object . |
pickentries | Type : String Allows multiple values Maximum length : 1500 | The picklist values allowed for this field when the record is of this type. (Only valid for Fields of type Picklist ) |
default_value | Type : String Maximum length : 3900 | The type specific default expression for the field. |
Attribute | Description | |
---|---|---|
action | Type : String Required Maximum length : 1500 | The Objectaction allowed. |
Validation rules enhance data quality by comparing user-entered data with Admin-defined rules for an object record.
Learn about Record Validation Rules in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean Required | Indicates whether the validation is active. |
expression | Type : String Required Maximum length : 3900 | A valid expression. |
description | Type : String Maximum length : 255 | Describes the details of the validation rule. |
error_message | Type : String Required Maximum length : 255 | Describes the error that displays if the rule fails. |
error_location | Type : String Required Allows multiple values Maximum length : 255 | Select fields for the error location. |
Object workflows apply to a single object lifecycle and a single object.
Learn about Object Workflows in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in the 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 :
| Indicates the type, objects or documents, of the workflow’s contents. |
users_can_only_complete_one_task | Type : Boolean | Indicates if users can complete more than one task in this workflow. If true , users can only complete one task in this workflow. If false , users can complete multiple tasks in this workflow. Defaults to false . |
roles_cannot_complete_task | Type : String | If this workflow is configured to exclude specific roles from participating, this field indicates the role names which are not allowed to participate. |
class | Type : Enum Allowed values :
| Indicates the classification of the workflow. |
cardinality | Type : Enum Allowed values :
| 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. |
users_can_only_complete_one_task | Type : Boolean | Indicates if users can complete more than one task in this workflow. If true , users can only complete one task in this workflow. If false , users can complete multiple tasks in this workflow. Defaults to false . |
roles_cannot_complete_task | Type : String Maximum length : 1500 | If this workflow is configured to exclude specific roles from participating, this field indicates the role names which are not allowed to participate. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in the Vault’s base language. |
type | Type : Enum Required Allowed values :
| The type of step. |
next_steps | Type : Objectworkflowstep Allows multiple values | The Objectworkflowstep to move to once this step is complete. |
tags | Type : String Allows multiple values Maximum length : 40 | |
step_detail | Type : XMLString Maximum length : 128000 | Details of the step configuration. |
description | Type : String Maximum length : 255 | Description of the workflow. |
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. |
This component defines the configuration of an Outbound Email Domain and is specific to MedInquiry, Clinical, and QMS Vaults with Outbound Email Domains enabled.
Vault sends outbound emails from a Veeva Vault domain address by default. You can use an Outboundemaildomain
to configure Vault to send emails from customized domains and allow users to change the sending email address to one associated with your organization.
Learn more about Configuring Outbound Email Addresses 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. |
dns_records | Type : LongString Maximum length : 32000 | Stores the DNS records for the sender domain in JSON format. This attribute is read-only. |
description | Type : String Maximum length : 1500 | A description of the outbound email domain. |
verification_status | Type : Enum Allowed values :
| Indicates the status of the sender domain. This attribute is read-only. |
sender_domain | Type : String Required Maximum length : 255 | The full sender domain in the format {subdomain}.{root_domain}. for subdomains, or {root_domain}. for root domains. |
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 the 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 |
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. |
file | Type : File Required | Reference to the file |
The layout of an object detail page.
Learn about Layouts in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 100 | UI-friendly string in the Vault’s base language. |
default_layout | Type : Boolean | If true , this layout is assigned to all users unless another layout is specified in their assigned layout profile. |
page_markup | Type : XMLString Required Maximum length : 64000 | Defines page layout using XML. |
active | Type : Boolean | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | A description of the layout. |
display_lifecycle_stages | Type : Boolean | For objects with lifecycle stages configured, if true , Vault displays the Lifecycle Stages Chevron panel on all views for the object. |
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 the Vault’s base language. |
description | Type : String Maximum length : 255 | A general description of the page link. |
url | Type : String Required Maximum length : 1500 | Defines the URL link for the page link. |
mode | Type : Enum Required Allowed values :
| Determines which action redirects the user to a custom page. |
page_type | Type : Enum Required Allowed values :
| Specifies the type of page link. Object is the only allowed value at this time. |
object | Type : Object | Sepcifies the object that the page link will override behavior for. |
page | Type : Page | For internal Veeva use only. |
Permission sets are a way to group permissions together. Security profiles then use the permission sets to grant or restrict users’ access to certain features.
Note that the configuration of this component varies by Vault. 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 the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
Picklists allow users to select a value for a field from a range of predefined options.
Learn about Picklists in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
can_add_values | Type : Boolean | (Read Only) If true , Picklistentry values can be added to the picklist. |
can_reorder_values | Type : Boolean | (Read Only) If true , Picklistentry values can be reordered. |
Picklistentry
does not support the DROP
command.
Attribute | Description | |
---|---|---|
value | Type : String Required Maximum length : 256 | 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. |
This component defines the configuration of a Printable View for Test Scripts and is specific to Quality Vaults with Vault Validation Management enabled.
Learn more about configuring Printable Views for Test Scripts 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 Printable View is active. |
template | Type : File Required | The XML template file that defines the configuration for the Printable View. |
header_logo | Type : File | The uploaded image displayed on the Printable View. |
This component is specific to Quality family Vaults and supports the Change Control features of the QMS application. Action Paths allow administrators to define Action Paths and Steps for the Change Control Process. With this enabled, end users can bundle related Change Actions into a group called an Action Step. Action Steps can then be sequenced, allowing the user to work on small subsets of actions together.
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_object | Type : Object Required | The parent object, either change_plan__v or change_control__v . |
parent_locked_states | Type : Subcomponent Allows multiple values | Lists one or more object lifecycle states. If the parent object is in one of these states, it cannot be moved by a change action. |
parent_object_type | Type : Objecttype Required | The parent object type, for example, change_plan__v . |
description | Type : String Maximum length : 1500 | A general description of the Action Path Configuration. |
parent_object_lifecycle | Type : Objectlifecycle Required | The parent object lifecycle, for example, change_plan_lifecycle__v . |
action_object | Type : Object Required | The Action object used by this path. Records of this object will be created and managed when a Change Action Path is instantiated. In 24R2, the only supported value is change_action__qdm . |
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_start_state | Type : Subcomponent Required | When a change control enters this state, its associated change actions will be moved to the action_start_state . |
action_start_state | Type : Subcomponent Required | The state that the change action moves into when the parent record enters the parent_start_state . |
included_action_states | Type : Subcomponent Required Allows multiple values | Change actions must be in these states when the parent record enters the parent_start_state to be moved. Actions in other states are skipped. |
parent_finish_state | Type : Subcomponent Required | The state that the parent record enters when all actions are complete. |
action_object_lifecycle | Type : Objectlifecycle Required | The lifecycle for the action, for example,change_action_lifecycle__c . |
action_finish_states | Type : Subcomponent Required Allows multiple values | Once all actions in the action group reach this step, the parent change control will move to the parent_finish_state . |
parent_object_lifecycle | Type : Objectlifecycle Required | The parent object lifecycle, for example, change_control_lifecycle__v . |
order | Type : Number Required Maximum value : 10 Minimum value : 1 | The order in which the step executes. |
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 the 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. |
This component type is only available in Quality Vaults with QMS enabled.
Defines a Quality External Notification, which is used to define distribution groups and notification templates, send emails, and share documents.
Learn more about Quality External Notifications 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 | Type : Objecttype Required | If object types are configured on the target object, the object type for the notification. |
target_object | Type : Object Required | The Object for the notification. For example, complaint__v . |
description | Type : String Maximum length : 1500 | A general description of the notification. |
do_not_include_header_footer | Type : Boolean Required | If true , the standard Vault header and footer are excluded from notifications. Only available when the target object is complaint__v or mt_complaint__v . |
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. |
maximum_recipients | Type : Number Required Maximum value : 10 Minimum value : 1 | The maximum number of recipients for the group. This can be any number from 1-50. |
help_content | Type : String Maximum length : 255 | UI-friendly help string. |
minimum_recipients | Type : Number Required Maximum value : 10 | The minimum number of recipients for the group. This can be any number from 1-50. |
This component type is only available in Quality Vaults with QMS enabled.
Defines a Notification Template, which determines the recipients and other configuration options for the associated Quality External Notification.
Learn more about Quality External Notifications 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. |
recipient_roles | Type : String Allows multiple values Maximum length : 255 | Specifies one or more application roles to receive notifications. |
download_option | Type : Enum Allowed values :
| Indicates the document rendition type(s) a recipient can download. If set to NONE , recipients cannot download the document. |
help_content | Type : String Maximum length : 255 | UI-friendly help string. |
target_object | Type : Object Required | The object associated with the Quality External Notification. |
notification_template | Type : Notificationtemplate Required | The Notificationtemplate configured for this Quality External Notification. |
document_link_field | Type : Subcomponent | The text field on the supported object to contain the document package URL. |
object_fields_on_document | Type : Docfield Allows multiple values | The document field referencing the target object. |
can_add_or_remove_documents | Type : Boolean | If true , users can add or remove documents from the notification before sending. |
expiry_period | Type : Number Maximum value : 100000 Minimum value : 1 | The number of days the document package URL will remain available. |
recipients | Type : Subcomponent Allows multiple values | Specifies the Person object reference field(s) to receive notifications. |
recipient | Type : Subcomponent | Specifies a single Person object reference field to receive notifications. |
document_reference_fields | Type : Subcomponent Allows multiple values | One or more document reference fields on the supported object. Vault includes all referenced documents in the document package. |
can_add_or_remove_participants | Type : Boolean Required | If true , users can edit the recipients list for the notification before sending. |
quality_external_notification | Type : ComponentReference Required | The associated Qualityexternalnotification. |
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. |
quality_distribution_group | Type : SubcomponentReference Required | The associated Qualitydistributiongroup . |
quality_external_notification | Type : ComponentReference Required | The associated Qualityexternalnotification. |
This component type is only available in Quality Vaults with QMS enabled.
Defines a Quality Incident Layout Configuration, which determines the fields Vault displays on an intake form. You can add up to 10 fields to a layout.
Learn more about Configuring Quality Incidents 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. |
description | Type : String Maximum length : 1500 | A general description of the layout. |
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 on which the field_to_display appears. For example, Object.quality_incident__v . |
field_to_display | Type : Subcomponent Required | The Field to display on the intake form. Fields must be active and either standard object reference fields on the Quality Incident object (country__v , organization__v , facility__v , department__v ), or one of the following data types: Boolean, text, number, date, or picklist. For example, Field.summary__v . |
order | Type : Number Required Maximum value : 10000 Minimum value : 1 | The order of the field relative to other fields. Can be any value from 1-10. |
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. |
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 Picklist component to be mapped. |
picklist_value | Type : Subcomponent Required | The mapped Picklistentry value on the current object. |
This component type is available only in Quality Vaults with QMS enabled.
This component defines a Reason for Change configuration. Admins can create configurations to prompt users for a Reason for Change upon editing specific fields on an object type record in a particular lifecycle state.
Learn more about Reasons for Change 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. |
description | Type : String Maximum length : 1500 | UI-friendly string in the Vault’s base language. |
target_object | Type : Object Required | The object on which the Reason for Change is configured. |
target_object_type | Type : Objecttype | The Objecttype of the target_object . |
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. |
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. |
reason_for_change_picklist | Type : Picklist Required | Defines the Reason for Change picklist. |
value_requiring_comment | Type : Subcomponent Required | Indicates whether a Comment is required for a specific reason_for_change_picklist value. |
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. |
field_criteria | Type : SubcomponentReference Required | Reference to Qualityreasonforchangefieldcriteria subcomponent. |
lifecycle_state | Type : Subcomponent Required | Indicates the lifecycle state in which Vault should require a Reason for Change for the chosen field. |
object_lifecycle | Type : Objectlifecycle Required | The lifecycle of the target_object . |
reason_for_change | Type : ComponentReference Required | References the associated Qualityreasonforchange component. |
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. |
field | Type : Subcomponent Required | The field on which to require a Reason for Change. |
field_criteria | Type : SubcomponentReference Required | Reference to Qualityreasonforchangefieldcriteria subcomponent. |
reason_for_change | Type : ComponentReference Required | References the associated Qualityreasonforchange component. |
target_object | Type : Object Required | The object on which the Reason for Change is configured. |
target_object_type | Type : Objecttype | The Objecttype of the target_object . |
type_field | Type : Subcomponent | The Typefield of the field . |
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. As of 24R2.3, creating a new Quality Record Check creates a new Qualityrecordchecklifecycleassociation
component that captures the lifecycle state associations.
Learn more about Quality Record Checks 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. |
allow_date_overrides | Type : Boolean | If true , a user can modify the timeframe upon executing a recurrence check. |
allow_match_field_overrides | Type : Boolean | If true , a user can modify the exact match field values upon executing a recurrence check. |
check_type | Type : Subcomponent Required | The type of check to be executed. |
check_type_picklist | Type : Picklist Required | The picklist defining the options available for check_type . |
date_field | Type : Subcomponent Required | The date field from the target_object from which to base your timeframe. |
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. |
date_unit_entry | Type : Subcomponent Required | The unit of measurement for the date, for example, days__v or years__v . |
date_unit_picklist | Type : Picklist Required | References the picklist from which users choose the date_unit_entry . |
description | Type : String Maximum length : 1500 | A description of the Quality Record Check. |
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. |
lifecycle_states_to_not_transition | Type : Subcomponent Allows multiple values | If populated, target object records in the indicated lifecycle state(s) will not change state when a user performs a record check. As of 24R2.3, this attribute is deprecated and stored in the lifecycle_states_to_not_transition attribute on the Qualityrecordchecklifecycleassociation component. Updates to this attribute for existing components will be unsuccessful. |
object_lifecycle | Type : Objectlifecycle | The lifecycle of the target_object . As of 24R2.3, this attribute is deprecated and stored in the object_lifecycle attribute on the Qualityrecordchecklifecycleassociation component. Updates to this attribute for existing components will be unsuccessful. |
object_lifecycle_states | Type : Subcomponent Allows multiple values | The lifecycle states from the object_lifecycle to include in the recurrence check. As of 24R2.3, this attribute is deprecated and stored in the lifecycle_states_to_include attribute on the Qualityrecordchecklifecycleassociation component. Updates to this attribute for existing components will be unsuccessful. |
relationship_type | Type : ComponentReference | The Qualityobjectrelationshipconfig applicable to your recurrence check. |
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 . |
relationship_type_picklist | Type : Picklist | The picklist defining the options available for relationship_type_entries . |
search_fields | Type : Subcomponent Allows multiple values | The text fields on which to run the recurrence check. |
simple_match_fields | Type : Subcomponent Allows multiple values | The fields on the target_object that must match. |
target_object | Type : Object Required | The object on which the Quality Record Check is configured. |
target_object_type | Type : Objecttype Required | The type of the target_object . |
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. |
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. |
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. |
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. |
This component type is only available in Quality Vaults with QMS enabled.
This component defines the configuration for a Quality Record Check Insight. You can create configurations for the Recurrence Check Insights page for a particular Quality Record Check.
Learn more about the Recurrence Check Insights Page 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 | Type : Objecttype Required | If applicable, the type of the target_object . |
probable_similarity_score | Type : Number Required Maximum value : 99 | The percent (%) minimum similarity score for the Probable tier. |
target_object | Type : Object Required | The object on which the Quality Record Check Insight is configured. |
description | Type : String Maximum length : 1500 | A description of the Quality Record Check Insight. |
likely_similarity_score | Type : Number Required Maximum value : 98 | The percent (%) minimum similarity score for the Likely tier. |
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. |
related_inbound_field | Type : Subcomponent Required | The related inbound field on the related object to summarize. |
summary_field | Type : Subcomponent Required | The summary field on the related object to summarize. |
relationship_type | Type : String Required Maximum length : 50 | The relationship type between the target_object of the insight configuration and the related_object . |
summary_object | Type : Object Required | The object from which summary results will be collected. If the relationship_type is INBOUND , the summary_object should be the same as the related_object . |
related_outbound_field | Type : Subcomponent | The related outbound field on the related_object that references the summary_object . If the summary relationship_type is JOIN ,this field is required. It should be left blank otherwise. |
related_object | Type : Object Required | The related object to the target_object of the insight configuration to use when collecting summary results. If the relationship_type is INBOUND , the related_object should be the same as the summary_object . |
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 | Type : Objecttype Required | If applicable, the type of the target_object . |
target_object | Type : Object Required | The object on which the Quality Record Check Insight is configured. |
display_field | Type : Subcomponent Required | The field of the target object of the Quality Record Check Insight to display in the Insights UI. |
order | Type : Number Required Maximum value : 10000 Minimum value : 1 | Numeric value used to determine the order the displayed fields appear in the Insights UI. |
display_type_field | Type : Subcomponent Required | The type field of the target_object_type for the display_field to display in the UI. |
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. |
summary_type_field | Type : Subcomponent Required | The type field of the target_object_type for the summary_field to collect field suggestion data for. |
target_object_type | Type : Objecttype Required | If applicable, the type of the target_object . |
summary_field | Type : Subcomponent Required | The field of the target object of the Quality Record Check Insight to collect field suggestion data for. This supports Boolean, Object, and Picklist references. |
target_object | Type : Object Required | The object on which the Quality Record Check Insight is configured. |
This component type is only available in Quality Vaults with QMS enabled.
This component defines the lifecycle state associations for a Quality Record Check. It also stores a reference to a source Qualityrecordcheck
component. Creating, editing, or deleting a Qualityrecordcheck
performs the same operation on a Qualityrecordchecklifecycleassociation
.
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. |
lifecycle_states_to_include | Type : Subcomponent Allows multiple values | The lifecycle states from the object_lifecycle to include in the recurrence check. |
lifecycle_states_to_not_transition | Type : Subcomponent Allows multiple values | If populated, target object records in the indicated lifecycle state(s) will not change state when a user performs a record check. |
object_lifecycle | Type : Objectlifecycle Required | The lifecycle of the target_object . |
quality_record_check | Type : ComponentReference Required | References the Qualityrecordcheck . |
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. |
object_lifecycle | Type : Objectlifecycle Required | The lifecycle of the target_object . |
object_lifecycle_state | Type : Subcomponent | The lifecycle state of the object_lifecycle . |
quality_object_relationship_config | Type : ComponentReference Required | The associated Qualityobjectrelationshipconfig . |
quality_picklist_value_map | Type : SubcomponentReference Required | References the picklist values available on a relationship configuration. For example, is a Duplicate of or is a Follow-up of. |
quality_record_check | Type : ComponentReference Required | References the Qualityrecordcheck . |
This component type is only available in Quality Vaults with QMS or Vault Product Surveillance (VPS) enabled.
This component defines the configuration for a Reportability Decision Tree. You can define multiple decision trees to determine the reportability of Complaints. Optionally, you can create a single Decision Tree Qualifier for each configuration. When configured alongside decision rules, Vault decides which decision trees are applicable for a given Complaint record, determines which countries require the incident to be reported, and provides the corresponding timeline for report submission.
Learn more about Reportability Assessments 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. |
description | Type : String Maximum length : 1500 | A description of the Reportability Decision Tree configuration. |
reportability_assessment_type | Type : Objecttype Required | The type of Reportability Assessment to create a decision tree for. |
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. |
description | Type : String Maximum length : 1500 | A description of the Decision Tree Qualifier. |
object | Type : Object Required | The object for which to link to a Reportability Assessment. For example, country__v . |
object_field | Type : Subcomponent Required | The field on the selected object . |
picklist | Type : Picklist Required | References the picklist associated with the selected object_field . This is not visible in the UI. |
picklist_value | Type : Subcomponent Required | References the picklist value selected from the picklist . |
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 the 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. |
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. If the component or subcomponent is inactive, no one in the Vault can edit team membership using this team or Team Role. |
role | Type : String Required Maximum length : 1500 | The role to which to apply the restriction. For example, Applicationrole.editor__c . Only roles with exclusive_membership set to false are eligible. |
exclusive_role | Type : String Required Maximum length : 1500 | The role to restrict. Users in the specified role cannot be assigned to this role. |
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. 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 Business Admin for this object. Custom help text that appears in the UI when users hover over the field. |
linked_application_role | Type : String Required Maximum length : 1500 | The role into which Team Role assignments for a team enabled record are inserted. This role defines the permissions and sharing settings role that team members will be granted. |
cascade_from_relationship | Type : Subcomponent | Required if cascade behavior is set to anything other than NOT_APPLICABLE . Defines the field which indicates the record from which team assignments should be inherited. |
display_order | Type : Number Required Maximum value : 25 | The order in which this Team Role will display to viewers and editors of the team enabled record. |
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_multiple_relationship | Type : Subcomponent Allows multiple values | The object reference fields from which the team role should inherit behavior. For example, 'Field.complaint__v','Field.medtech_capa__v’ . |
cascade_behavior | Type : Enum Required Allowed values :
| Indicates if the membership of this role can be governed by the membership of a related records Team Role. Enums:
|
constraining_role | Type : String Maximum length : 1500 | Limits selection of users when editing this team role’s membership to the current membership of the specified application role on the team enabled record. |
locked_in_states | Type : String Allows multiple values Maximum length : 1500 | While the record is any one of these states, no user in the Vault may change team member assignments for any role. This supersedes all security configurations. Note: When using cascade of team member updates between records, records in this state will not reflect team membership changes, but will also not cause an error. |
minimum_user_in_role | Type : Number Required Maximum value : 20 | Minimum number of users selected for a Team Role per record. Value of zero means the role is purely optional. Population of the role will not affect 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. |
Corresponds to the Related Objects to Secure section on a Quality Team.
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. If the component or subcomponent is inactive, no one in the Vault can edit team membership using this team or Team Role. |
outbound_reference_field | Type : Subcomponent Required | Specifies the outbound reference field from the related object which defines the Quality-Team-enabled object. For example, Field.source_deviation__v . |
app_security_assignment | Type : SubcomponentReference Required | For internal Veeva Use only. |
app_security_rule | Type : ComponentReference Required | For internal Veeva Use only. |
quality_team_role | Type : ComponentReference Required | Specifies the Quality Team Role on the Quality Team-enabled object that defines the mapping. For example, Qualityteamrole.owner__c . |
application_role | Type : String Required Maximum length : 1500 | Specifies the application role defining the access that the quality_team_role should possess on the related object. For example, Applicationrole.owner__v . |
related_object | Type : Object Required | The Object for which to define the security mapping. For example, Object.related_event__v . |
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 the 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 :
| 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. |
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the 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 |
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 the 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 . |
Record merge event handlers contain custom logic to execute as a merge starts or after the merge finishes.
Learn about Record Merge Event Handlers 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. |
checksum | Type : String Maximum length : 1500 | Used to check data for errors. |
source_code | Type : SdkCode Maximum length : 1048576 | The source of this record merge event handler and code used. Custom means this record merge event handler was developed with the Vault Java SDK. |
object | Type : Object Required | The object this record merge event handler is associated to, for example, product__v . |
Record role triggers execute custom code whenever roles are directly (manually) added or removed from an object record.
Learn about Record Role Triggers in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
checksum | Type : String Maximum length : 1500 | Used to check data for errors. |
source_code | Type : SdkCode Maximum length : 1048576 | The source of this record role trigger and code used to create and edit metadata. Custom means this record role trigger was developed with the Vault Java SDK. |
event_segment | Type : Enum Allowed values :
| For internal Veeva use only. This Enum is used for a variety of features in Vault. Contains valid values for specifying eventSegment . |
events | Type : Enum Allows multiple values Allowed values :
| The Events specifying when this record role trigger executes. For example, BEFORE means the trigger executes right before the record role assignment. |
order | Type : Enum Allowed values :
| If multiple triggers exist on the same object, this specifies the order this record role trigger will execute. Order 1 executes first and Order 10 executes last. UNSPECIFIED means this trigger will always execute last. |
object | Type : Object Required | The object this record role trigger is associated to, for example, product__v . |
Record triggers execute custom code when a record Event occurs.
Learn about Record Triggers in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
checksum | Type : String Maximum length : 1500 | Used to check data for errors. |
source_code | Type : SdkCode Maximum length : 1048576 | The source of this record trigger and code used to create and edit metadata. Custom means this record trigger was developed with the Vault Java SDK. |
event_segment | Type : Enum Allowed values :
| For internal Veeva use only. This Enum is used for a variety of features in Vault. Contains valid values for specifying eventSegment . |
events | Type : Enum Allows multiple values Allowed values :
| The Events specifying when this record trigger executes. For example, BEFORE_UPDATE means the trigger executes right before the record updates. |
order | Type : Enum Allowed values :
| If multiple triggers exist on the same object, this specifies the order this record role trigger will execute. Order 1 executes first and Order 10 executes last. UNSPECIFIED means this trigger will always execute last. |
object | Type : Object Required | The object this record trigger is associated to, for example,product__v . |
Record workflow actions execute custom code during object workflow events.
Learn more about Record Workflow Actions
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
checksum | Type : String Maximum length : 1500 | Used to check data for errors. |
source_code | Type : SdkCode Maximum length : 1048576 | The source of this workflow action. For example, Custom means this is a custom action developed with the Vault Java SDK. |
step_types | Type : Enum Allows multiple values Allowed values :
| Indicates the step types where this record workflow action is allowed to execute. |
object | Type : Object | Indicates the object the record workflow action supports. This action is only available for workflows on this supported object. The default value is "" , indicating all objects are supported. |
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. |
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. |
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 the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
pdf_format | Type : Enum Required Allowed values :
| Determines the format for PDF viewable renditions. |
bookmark_expansion_level | Type : Enum Required Allowed values :
| Determines how many level deep are expanded in the bookmark panel. |
generate_toc_lofs_bookmarks | Type : Boolean Required | 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 :
| 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. |
preprocess_pdf | Type : Boolean | If set to true , Vault renders non-compliant PDF source documents according to ICH standards. Only RIM Submissions and Submissions Publishing Vaults with Generate compliant rendition for Source PDFs enabled allow non-null values for this attribute. |
pdf_edit_settings | Type : Enum Allowed values :
| 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 :
| If protected_pdf is true , specifies the content allowed for copying in the PDF rendition. |
embed_fonts | Type : Enum Required Allowed values :
| 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. |
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 the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
density | Type : String Maximum length : 1500 | Specifies the density of the Automated Image Rendition. The value must be numeric. You can also populate this field with a height and width value such as 300x200. You can use the following expected values:
|
format | Type : String Maximum length : 1500 | Specifies the format of an Automated Image Rendition |
quality | Type : String Maximum length : 1500 | Specifies the the quality of an Automated Image Rendition. The value must be numeric. |
flatten_image | Type : Boolean | Set to true to merge image layers into a single layer. |
include_source_doc_name | Type : Boolean | Set to true to name renditions in the format {document name} - {rendition}.{format extension} . |
automated_image | Type : Boolean | Indicates that the rendition is an Automated Image Rendition |
colorspace | Type : String Maximum length : 1500 | Specifies the color space of an Automated Image Rendition |
transparency | Type : Boolean | Set to true to maintain transparent backgrounds from source files. Transparency is only preserved with .PNG, .GIF, .BMP, and .TIFF formats. |
resize | Type : String Maximum length : 1500 | 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. |
Represents a Vault report.
Learn about Reporting in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 128 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean Required | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | A general description about the report. |
format | Type : Enum Required Allowed values :
| The output format of the report. For example, a Tabular or Matrix report. |
definition | Type : XMLString Required Maximum length : 32000 | The query to use to pull the data. |
layout | Type : XMLString Required Maximum length : 32000 | The layout of the data. |
content_type | Type : Enum Required Allowed values :
| Specifies the type of data the report refers to. |
report_type | Type : Reporttype | The Reporttype this instance of the report was created from. |
editors | Type : String Allows multiple values Maximum length : 1500 | Lists users and Groups in the Editor role. Users in this role can edit reports. |
viewers | Type : String Allows multiple values Maximum length : 1500 | Lists users and Groups in the Viewer role. Users in this role can view reports. |
owners | Type : String Allows multiple values Maximum length : 1500 | Lists users and Groups in the Owner role. Users in this role can assign other users and groups to the Owner role on reports. |
class | Type : Enum Allowed values :
| Indicates whether the report is Standard or Multi-Pass. |
excel_template | Type : Reportexceltemplate | Indicates which, if any, Excel template is associated with the report. |
fit_pdf_to_page | Type : Boolean | Indicates whether all columns should fit on a single page in the exported PDF. |
tags | Type : String Allows multiple values Maximum length : 1500 Ordered : True | Any tags assigned to the report. |
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 . |
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 the 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 file system. |
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 the 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_objects | Type : String Allows multiple values Maximum length : 255 | This attribute supports future functionality and cannot be used at this time. |
primary_object | Type : String Maximum length : 255 | Primary entity or Object for the report type, for example, Document. |
configuration | Type : XMLString Required Maximum length : 32000 | Details of the report type. |
class | Type : Enum Allowed values :
| Indicates whether the report is Standard or Multi-Pass. The UnionAll report type exists to support future functionality and cannot be used at this time. |
Event Change Details are the building blocks of Event Change Types.
Learn more about Event Change Details 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. |
detail_description | Type : String Maximum length : 255 | General description of the event change detail. |
detail_object | Type : Object Required | The associated Event relationship object. For example, Object.event_product_characteristic__v . |
detail_object_type | Type : Objecttype | The object type of the associated detail_object . For example, Objecttype.event_product_characteristic__v.basic_udi_attributes__v . |
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. |
detail_field_is_required | Type : Boolean | If true , users must complete this field when using the wizard. |
detail_object | Type : Object Required | The associated Event relationship object. For example, Object.event_product_characteristic__v . |
detail_field | Type : Subcomponent Required | The associated Event relationship object field. |
detail_field_order | Type : Number Required Minimum value : 1 | The relative order in which to display the field in the Vault UI. |
Event Change Types define the required and optional details for a specific kind of change that can be selected in the Create Event Details wizard.
Learn more about Event Change Types 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. |
related_change_type_add | Type : Subcomponent Required | The corresponding value from the Related Change Type picklist to be added to Event details for the Add change type. |
related_change_type_picklist | Type : Picklist Required | The associated Related Change Type Picklist. See Vault Help for configuration details. |
primary_event_change_detail | Type : ComponentReference Required | The Primary Event Change Detail for the change type. References a single Rimeventchangedetail record. For example, Rimeventchangedetail.packaginglevel_drug_shelf_life_details__v . |
related_change_type_replacing | Type : Subcomponent Required | The corresponding value from the Related Change Type picklist to be populated on Event details that will replace existing Event details for the Replace change type. |
related_change_type_withdraw | Type : Subcomponent Required | The corresponding value from the Related Change Type picklist to be populated on Event details for the Withdraw change type. |
related_change_type_replaced_by | Type : Subcomponent Required | The corresponding value from the Related Change Type picklist to be populated on Event details that will be replaced by another Event detail for the Replace change type. |
type_description | Type : String Maximum length : 255 | A general description of the event change type. |
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. |
type_detail | Type : ComponentReference Required | Reference to the associated Rimeventchangedetail . |
detail_order | Type : Number Required Minimum value : 1 | The relative order in which to display the detail in the Vault UI. |
detail_is_required | Type : Boolean | If true , users must complete this detail when using the wizard. |
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 the 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. |
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 the Vault’s base language. |
description | Type : String Maximum length : 255 | A general description of the saved view. |
tab | Type : Tab | 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 Allowed values :
| 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. |
grid_id | Type : String Maximum length : 1500 | For internal Veeva use only. |
grid_location | Type : String Maximum length : 1500 | For internal Veeva use only. |
object_public_key | Type : String Maximum length : 1500 | For internal Veeva use only. |
view_type | Type : String Maximum length : 1500 | For internal Veeva use only. |
Job processors provide logic to process jobs in bulk. You cannot create these with the Vault Java SDK. You may see Vault-supplied Jobs here which work to deliver various features.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
idempotent | Type : Boolean | If true , Vault automatically restarts the job if interrupted by a system failure. |
visible | Type : Boolean | If true , the job appears in the Scheduled, Running, and History tables in the Job Admin UI. |
admin_configurable | Type : Boolean | If true , the job processor is available to be called with custom SDK code or by configuration by an Admin as a Job Definition in the Vault UI. |
checksum | Type : String Maximum length : 1500 | Used to check data for errors. |
source_code | Type : SdkCode Maximum length : 1048576 | The source code of this SDK job. Standard indicates a Vault-supplied, read-only job. |
Definition of a searchable object Field.
Learn about Searchable Object Fields in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 60 | UI-friendly string in the 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, for example, abbreviation__v. Optional in some Vault Applications. |
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, for example, country__v . Optional in some Vault Applications. |
Search collections allow you to create and edit groups of documents and 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 the 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. |
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. |
vql_criteria | Type : String Maximum length : 1500 | A Criteria VQL expression that defines the search scope of this collection. |
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. |
tab_assignments | Type : String Allows multiple values Maximum length : 255 | If include_on_tab is true and the object has more than one tab available, specifies the tabs where users can access the collection. |
object | Type : Object | The object to include in the collection. |
document_type | Type : Doctype | The document type to include in the collection. |
Security profiles are how Vault applies permissions sets to individual users.
Learn about Security Profiles in Vault Help.
Attribute | Description | |
---|---|---|
permission_sets | Type : String Allows multiple values Maximum length : 100 | List of permiission sets contained within the profile. |
active | Type : Boolean Required | Indicates whether the component is active. |
label | Type : String Required Maximum length : 100 | UI-friendly string in the Vault’s base language. |
description | Type : String Maximum length : 255 | Description of the security profile. |
Vault uses Sharing Rules to manage users’ roles on specific object records by matching rule criteria to specific user assignments.
Note that the configruation of this component varies by Vault. Learn about Custom Sharing Rules in Vault Help.
Attribute | Description | |
---|---|---|
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 the Vault’s base language. |
object | Type : String Required Maximum length : 46 | The type of object the rule applies to. |
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 . |
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 the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
signature_block_02 | Type : String Maximum length : 1500 | Signature block 2 |
signature_block_01 | Type : String Maximum length : 1500 | Signataure block 1 |
file | Type : File | Reference to the file |
footer_01 | Type : String Maximum length : 1500 | Footer row 1 |
footer_02 | Type : String Maximum length : 1500 | Footer row 2 |
header_01 | Type : String Maximum length : 1500 | Header row 1 |
location | Type : Enum Allowed values :
| Specifies whether the signature page appears at the beginning or end of the document. |
header_02 | Type : String Maximum length : 1500 | Header row 2 |
A Tab within the UI of Vault.
Learn about Tabs in Vault Help.
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in the Vault’s base language. |
order | Type : Number Required | The relative order of the tabs within Vault’s navigation bar. |
dashboard | Type : String Maximum length : 50 | When set to the name of a dashboard, sets this component to a dashboard Tab. |
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. |
default_view | Type : Savedview | The Savedview that Vault displays to users who are viewing the tab for the first time or have not selected another view. You can only set the default view to mandatory saved views. |
enable_global_search | Type : Boolean | For internal Veeva use only. |
global_search_placeholder | Type : String Maximum length : 1500 | For internal Veeva use only. |
related_section | Type : String Maximum length : 1500 | When a user creates a saved view for a related list in a dynamic tab, Vault creates a Tab record and indicates the source page layout and related object type in this field. |
Attribute | Description | |
---|---|---|
label | Type : String Required Maximum length : 40 | UI-friendly string in the Vault’s base language. |
order | Type : Number Required | The relative order of the tabs within Vault’s navigation bar. |
dashboard | Type : String Maximum length : 50 | When set to the name of a dashboard, sets this component to a dashboard Tab. |
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. |
default_view | Type : Savedview | The Savedview that Vault displays to users who are viewing the tab for the first time or have not selected another view. You can only set the default view to mandatory saved views. |
enable_global_search | Type : Boolean | For internal Veeva use only. |
global_search_placeholder | Type : String Maximum length : 1500 | For internal Veeva use only. |
related_section | Type : String Maximum length : 1500 | When a user creates a saved view for a related list in a dynamic subtab, Vault creates a Tab record and indicates the source page layout and related object type in this field. |
Tab collections are groups of related tabs relevant to particular roles or tasks. When you view a tab collection, Vault displays its tabs in the primary navigation bar.
Learn more 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. |
help_content | Type : String Maximum length : 150 | Text that appears in the UI when users hover over the label in the tab bar. |
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. |
tab | Type : Tab | For items of type Tab, the Tab to include in the collection. For example, Tab.products__c . |
tabs | Type : Tab Allows multiple values Ordered : True | For items of type Menu, a list of Tab s to include in the menu. |
type | Type : Enum Required Allowed values :
| Indicates whether the item is a Tab or a Menu. |
order | Type : Number Required | The order in which the Tab appears in the Tab Collection Menu. |
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 the 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. |
Internal Vault developers use Tag Security Rules to control access to records. External developers cannot create custom Tag Security Rules, but they can create Tagsecutityruleassignment
subcomponents to map Tagsecrityrule
s to Object
s. This allows assignments to be moved between Vaults using migration packages (VPKs).
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. |
help_content | Type : String Maximum length : 255 | UI-friendly help string. |
allow_custom_objects | Type : Boolean Required | If true , the rule can be applied to custom objects. |
description | Type : String Maximum length : 255 | A general description of the rule |
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. |
object | Type : Object Required | Reference to the Object component. An object can only be included in one Tagsecurityrule . |
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 the 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. |
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 :
| The default serialization behavior for this user-defined model. |
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 the 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. |
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 the Vault’s base language. |
active | Type : Boolean | Indicates whether the component is active. |
clone_behavior | Type : Enum Required Allowed values :
| Indicates whether the value attribute is cleared when the Vault is cloned. |
type | Type : Enum Required Allowed values :
| 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. |
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 the 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. |
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. |
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 . |
Each Customwebapi
must be assigned to a Webapigroup
, which in turn must be assigned to a Permissionset
. Admins can manage access in the Vault Admin UI.
Learn more in the Vault Java SDK documentation.
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. |
description | Type : String Required Maximum length : 1500 | A general description of the web API group. |
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 the 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. |
workflow_type | Type : String Allows multiple values Maximum length : 1500 | The type of workflow. |
bulk_email_message | Type : LongString Required Maximum length : 1500 | When the workflow is started through bulk actions, this message template will be used to inform users. |
Attribute | Description | |
---|---|---|
label | Type : String Maximum length : 40 | UI-friendly string in the Vault’s base language. |
status | Type : Boolean | Indicates whether the component is active. |
description | Type : String Maximum length : 255 | Description of the workflow. |
flow_type | Type : Enum Required Allowed values :
| The type of worflow step. |
next_steps | Type : Docworkflowstep Allows multiple values | The Docworkflowstep to move to once this step is complete. |