Component Types

Component types are the configuration elements of a vault. MDL allows you to access these elements and execute scripts to automate complex or repetitive configuration changes in your vault. This page contains details for the component types available in Vault.

Accountmessage

View and edit messages that Vault sends to users as both emails and in-application notifications.

Learn about Email and Message Administration in Vault Help.

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
email_body Type : LongString
Required
Maximum length : 1500
The body of the email sent to the notification recipient.
subject Type : String
Required
Maximum length : 255
Subject of the email sent to the notification recipient.
default_lang Type : String
Maximum length : 255
The default language for the email.

Atomicsecurity

Atomic security provides an additional layer of control by allowing you to configure security at the lifecycle state and/or assigned role level.

Learn about Atomic Security in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 60
UI-friendly string in the vault’s base language.
active Type : Boolean Indicates whether the component is active.
object Type : Object
Required
The Object the security applies to. For example, Object.country__v
object_lifecycle Type : Objectlifecycle
Required
The Objectlifecycle the security applies to. For example, Objectlifecycle.general_lifecycle__c
state Type : Objectlifecyclestate
Required
The Objectlifecyclestate of the Objectlifecycle the security applies to. For example, Objectlifecyclestate.active_state__c

Fieldsecurity

Attribute Description
label Type : String
Required
Maximum length : 60
UI-friendly string in the vault’s base language.
active Type : Boolean Indicates whether the component is active.
role Type : Objectlifecyclerole
Required
The Objectlifecyclerole of the Objectlifecycle the security applies to.
For example, Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles.
type Type : Enum
Required
Allowed values :
  • read__v
  • hide__v
  • edit__v
The type of permission to apply.
fields Type : Field
Required
Allows multiple values
The fields to apply this permission to.

Actionsecurity

Attribute Description
label Type : String
Required
Maximum length : 60
UI-friendly string in the vault’s base language.
active Type : Boolean Indicates whether the component is active.
role Type : Objectlifecyclerole
Required
The Objectlifecyclerole of the Objectlifecycle the security applies to.
For example, Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles.
type Type : Enum
Required
Allowed values :
  • hide__v
  • view__v
  • execute__v
The type of permission to apply.
object_actions Type : Objectaction
Allows multiple values
The Object level action(s) to apply this permission to.
lifecycle_actions Type : Objectlifecyclestateuseraction
Allows multiple values
The Lifecycle level action(s) to apply this permission to.

Relationshipsecurity

Attribute Description
label Type : String
Required
Maximum length : 60
UI-friendly string in the vault’s base language.
active Type : Boolean Indicates whether the component is active.
role Type : Objectlifecyclerole
Required
The Objectlifecyclerole of the Objectlifecycle the security applies to.
For example, Objectlifecyclerole.editor__v or Objectlifecyclerole.DEFAULT if specifying the default for all roles.
type Type : Enum
Required
Allowed values :
  • read__v
  • edit__v
The type of permission to apply.
document_fields Type : Docfield
Allows multiple values
Lists the object fields corresponding to the object-to-document inbound relationship on the specified object.
object_fields Type : Field
Allows multiple values
Lists the object fields corresponding to the object-to-object relationship on the specified object.

Checklisttype

Checklists are a data entry method that allows a user to enter data in question and answer format.

Learn about Designing Checklists in Vault Help.

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in the vault’s base language.
active Type : Boolean Indicates whether the component is active.
target_object Type : Object
Required
The object the checklist applies to.
target_object_type Type : Objecttype
Required
The target object’s Objecttype.

Checklistmatchingfield

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in the vault’s base language.
active Type : Boolean Indicates whether the component is active.
target_matching_field Type : Subcomponent The field on the target object. This is used to match a value from the target object record with the corresponding matching field value on the Checklist Design object.
target_object Type : Object
Required
The object the checklist applies to.
checklist_design_matching_field Type : Subcomponent
Required
The field on the checklist design object. This is used to match a value from the Checklist Design object record with the corresponding matching field value on the target object.
checklist_design_object Type : Object
Required
The object the checklist design applies to.

Dashboard

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

Learn about Dashboards in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
description Type : String
Maximum length : 255
A general description of the dashboard.
editors Type : String
Allows multiple values
Maximum length : 300
Users with the Editor permission required to edit dashboards.
viewers Type : String
Allows multiple values
Maximum length : 300
Users with the Viewer permission required to view dashboards.
dashboard_markup Type : XMLString
Required
Maximum length : 32000
Describes the layout of the dashboard.

Docfield

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

Learn about Document Fields in Vault Help.

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

Regular users can create Document scoped fields only
Creating DocumentVersion scoped fields requires special security permissions
required Type : Boolean
Required
Indicates whether the field is required.
min_value Type : Number Applicable to fields of type number only.
max_length Type : Number
Maximum value : 1500
Minimum value : 1
Applicable to fields of type string only.
object Type : String
Maximum length : 1500
Possible values supported are names of VOF objects, User, Group, and Lifecycle.
type Type : String
Required
Maximum length : 1500
options:
  • String
  • Number
  • Boolean
  • Picklist
  • Date
  • URL
  • Formula
  • ObjectReference
  • Lookup
default_value Type : String
Allows multiple values
Maximum length : 1500
The default value used when the field is not set.

Docfielddependency

Dependent fields allows you to configure a relationship between a controlling field and one or more controlled or dependent fields.

Learn about Dependent Fields in Vault Help.

Attribute Description
doctype Type : Doctype
Required
The Doctype the field dependency applies to.
docfield Type : Docfield The Docfield the field dependency applies to.
docfield_value Type : String Specifies the field value that triggers the the action.
deprule_docfield Type : Docfield
Required
Specifies the Docfield the dependency rule applies to.
deprule_docfield_action Type : Enum
Required
Allowed values :
  • isVisible
  • isRequired
  • isHidden
  • picklist
  • isReadOnly
The action applied. Specifies the actions to take on the field values.
deprule_docfield_values Type : String The value(s) available when deprule_docfield_action is picklist.
lifecycle Type : String The Doclifecycle the dependency rule applies to.
state Type : String The Doclifecycle state the dependency rule applies to.
role Type : String The Doclifecycle role the dependency rule applies to.

Docfieldlayout

The field layout for document fields.

Learn about Document Field Layouts.

Attribute Description
label Type : String
Required
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean
Required
Whether the layout is active.
icon Type : Enum
Allowed values :
  • UNDEFINED
  • AUSTRALIA
  • AUSTRIA
  • BELGIUM
  • CANADA
  • CHINA
  • EUROPEAN_UNION
  • FRANCE
  • GERMANY
  • GLOBAL
  • IRELAND
  • ITALY
  • JAPAN
  • NETHERLANDS
  • SPAIN
  • SWEDEN
  • SWITZERLAND
  • UNITED_KINGDOM
  • UNITED_STATES
  • VEEVA
The icon to display in the section header.
order Type : Number The order of the section relatve to other sections.
fields Type : Docfield
Allows multiple values
Ordered : True
The Docfield’s listed in order they should appear in the section.

Doclifecycle

Document lifecycles are the sequences of states (Draft, In Review, etc.) a document goes through during its life.

Learn about Document Lifecycles in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean
Required
Indicates whether the component is active.
description Type : String
Maximum length : 255
General description for this lifecycle.
state_labels Type : String
Required
Allows multiple values
Maximum length : 1500
Ordered : True
Lists lifecycle state labels (by name) defined for this lifecycle. The order defined here must correspond to the order in labeled_states.
labeled_states Type : Doclifecyclestate
Required
Allows multiple values
Ordered : True
Lists “special states” (by name). The order of the state in this list dictates which state from state_labels is assigned to the specific special state.
expiration Type : XMLString
Maximum length : 32000
Expiration rules.
signature_pages Type : XMLString
Maximum length : 32000
Signature page rules.
overlays Type : XMLString
Maximum length : 32000
The overlay template applied to a speciifc lifecycle.

Doclifecyclerole

Attribute Description
label Type : String
Required
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean
Required
Indicates whether the component is active.
description Type : String
Maximum length : 255
General description for this lifecycle.
application_role Type : String
Required
Maximum length : 255
The name__v field value of the application_role__v record this role corresponds to.
note_color Type : Enum
Allowed values :
  • Dark Orange
  • Orange
  • Dark Yellow
  • Yellow
  • Lime
  • Green
  • Aqua
  • Royal
  • Purple
  • Lilac
  • Pink
  • Salmon
Annotations made by users in this role will use this color by default.
security_options Type : XMLString
Maximum length : 32000
The default security rules.

Doclifecyclestate

Attribute Description
label Type : String
Required
Maximum length : 128
UI-friendly string in Vault’s base language.
active Type : Boolean
Required
Indicates whether the component is active.
description Type : String
Maximum length : 255
General description for this lifecycle.
order Type : Number
Required
The order this state appears in the list.
cancel_state Type : Doclifecyclestate deprecated - replaced by state_labels and labeled_states
entry_criteria Type : XMLString
Maximum length : 64000
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 : 64000
The actions, and the conditions under which they are executed, which are performed when a document enters this state.
user_action Type : XMLString
Maximum length : 64000
The actions, and the conditions under which they are available, which a user can execute when a document is in this state.
security_settings Type : XMLString
Maximum length : 32000
The actions a user, in each role, can perform when a document is in this state.

Doclifecycleevent

Attribute Description
active Type : Boolean
Required
Indicates whether the component is active.
event Type : String
Required
Maximum length : 1500
rule Type : XMLString
Required
Maximum length : 32000
order Type : Number
Required
The order this state appears in the list.

Docmatchingrule

Dynamic Access Control (DAC) is an access control model for documents, which automates the assignment of users to document roles.

Learn about Dynamic Access Control for Documents in Vault Help.

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

Docmatchingcriterion

Attribute Description
object_field Type : Field
Required
The field of the object to match on.
data_field Type : Docfield
Required
The field on the document to match on.
object Type : Object
Required
The Object the matching rule is defined on.

Docparticipantrule

Attribute Description
lifecycle Type : Doclifecycle
Required
role Type : Doclifecyclerole
Required
active Type : Boolean
Required
description Type : String
Maximum length : 255
label Type : String
Required
Maximum length : 60

Docparticipantcriterion

Attribute Description
object_field Type : Field
Required
data_field Type : Docfield
Required
object Type : Object
Required

Docrelationshiptype

Document relationship types define the type on relationship between two documents.

Learn about Document Relationships in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 40
UI-friendly string in the vault’s base language.
active Type : Boolean
Required
Indicates whether the component is active.
single_use Type : Boolean True when only one relationship of this type can be created for the source document.
target_doctype Type : String
Maximum length : 1500
The Doctype of the related document.
source_version_specific Type : Boolean Whether the relationship is bound to the current version of the source document.
carry_forward_source_specific Type : Boolean Whether the relationship will be brought forward when the source document is versioned.
target_version_specific Type : Boolean Whether the relationship is bound to the current version of the target document.
carry_forward_target_specific Type : Boolean Whether the relationship will be brought forward when the target document is versioned.
relationship_filter Type : XMLString
Maximum length : 32000
A criteria which restricts the documents that can be related using this type.

Doctype

Document types refer to a hierarchical taxonomy to differentiate the various types of documents stored in Vault.

Learn about Document Types in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 200
UI-friendly string
active Type : Boolean
Required
Indicates whether the field is active
allow_attachments Type : Boolean Whether documents of this type can have attachments.
binder_unbound_document_display_option Type : Enum
Allowed values :
  • latest_version
  • latest_viewable_version
  • latest_steady_state_version
document_number_format Type : String
Maximum length : 512
The document numbering pattern. If none are specified, the default value is inherited from parent or base
document_name_format Type : String
Maximum length : 512
The document numbering pattern. If none are specified the default value is inherited from parent or base
If not specified at root, the default is:{FileName}
etmf_department Type : String
Maximum length : 1500
The department name from the etmf_departmnet picklist
Available in eTMF Vaults only.
enable_binder_thumbnail Type : Boolean
create_document_permissions Type : String
Allows multiple values
Maximum length : 1500
The list of group or user IDs in the form of user:username or Group.name__v
create_binder_permissions Type : String
Allows multiple values
Maximum length : 1500
The list of group or user IDs in the form of user:username or Group.name__v
role_defaulting_editors Type : String
Allows multiple values
Maximum length : 1500
The list of group or user IDs in the form of user:username or Group.name__v
role_defaulting_viewers Type : String
Allows multiple values
Maximum length : 1500
The list of group or user IDs in the form of user:username or Group.name__v
role_defaulting_consumers Type : String
Allows multiple values
Maximum length : 1500
The list of group or user IDs in the form of user:username or Group.name__v
processes Type : String
Allows multiple values
Maximum length : 1500
The list of process names.
These come from processes picklists
doctype_group Type : String
Allows multiple values
Maximum length : 1500
List of Document Group (doc_type_group__v) linked to this Doctype
regen_doc_name_on_save Type : Boolean Whether auto-generated names should be refreshed when saving the document.
etmf_rm_v2 Type : String
Maximum length : 1500
eTMF Reference Model V2 Hierarchy Item external id, (e.g.,tmf_rm_v2_04.02)
Available in eTMF Vaults only.
etmf_rm_v3 Type : String
Maximum length : 1500
eTMF Reference Model V3 Hierarchy Item external id, (e.g., tmf_rm_v3_04.02)
Available in eTMF Vaults only.
clinical_docs_rm Type : String
Maximum length : 1500
relationship_types Type : String
Allows multiple values
Maximum length : 1500
The list of Docrelationshiptype names supported.
default_workflows Type : String
Allows multiple values
Maximum length : 1500
The list consists of Doclifecycle/Workflow combinations separated by a colon (:) (e.g., promotional_field__c:start_mld_review__c)
milestone_types Type : String
Allows multiple values
Maximum length : 1500
available_lifecycles Type : String
Allows multiple values
Maximum length : 1500
The list of Doclifecycle names. If none are specified, the default value is inherited from parent or base
rendition_types Type : String
Allows multiple values
Maximum length : 1500
The list of Renditiontype names supported.
description Type : String
Maximum length : 350
filters Type : String
Allows multiple values
Maximum length : 1500
Names of fields for document fields using MDL notation (e.g., Docfield.field__v)
Additional special filters:
  • date_search
  • user_search
  • version_search
  • file_format_search
fields Type : String
Allows multiple values
Maximum length : 1500
The list of Docfield components linked to this Doctype

Documentaction

Documents can have custom actions that perform specific instructions. You can use a custom action to automate certain business processes.

Learn about Record Role Triggers in Vault Help.

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
lifecycle Type : Doclifecycle The lifecycle where this document action is available.
user_input_object_type Type : Objecttype If your action takes user input, identifies the user input object type.
checksum Type : String
Maximum length : 1500
Used to check data for errors.
user_input_object Type : Object If your action takes user input, identifies the user input object.
usages Type : String
Allows multiple values
Maximum length : 1500
Specifies where in Vault this action is available for configuration and execution. For example, User Action or Entry Action. UNSPECIFIED means the action is available everywhere document actions are supported.
source_code Type : SdkCode
Maximum length : 1048576
The source of this document action. For example, Custom means this is a custom action developed with the Vault Java SDK.

Documentstagegroup

Lifecycle Stages allow organizations to group document and object lifecycle states into ordered collections of “stages”.

Learn about Lifecycle Stages.

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
document_lifecycle Type : Doclifecycle
Required
A component reference to Doclifecycle.
description Type : String
Maximum length : 255
A general description of the lifecycle stage group. A general description for this document stage.

Documentstage

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
document_lifecycle_states_ref Type : String
Allows multiple values
Maximum length : 1500
A component reference to Doclifecyclestate.
description Type : String
Maximum length : 255
A general description of the lifecycle stage group. A general description for this document stage.
order Type : Number
Required
Minimum value : 1
A number automatically assigned to a stage after it’s created and represents the order of stages in a stage group.

Formattedoutput

Formatted output templates allow quick transfer of complete object record data into a customized template file.

Learn about Formatted Output in Vault Help.

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
root_object_type Type : Objecttype
Required
Root Object for the formatted output if the object has object types.
root_object Type : Object
Required
Root Object for the formatted output, for example, Application.
template_file Type : File
Required
A template XFA PDF file to upload and attach.

Integrationrule

Spark Integration Rules provide platform configuration and SDK services for developers building Vault to Vault integration features that require data mapping.

Learn about Integration Rules in the SDK Documentation.

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
connection Type : String
Required
Maximum length : 40
Reference to the connection record by api_name__sys.

Fieldrule

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
reference_lookup_type Type : Enum
Allowed values :
  • picklist
  • object
  • lifecyclestate
target_object_field Type : Subcomponent Subcomponent reference to the Object field. This is required of the target_object is set.
query_field Type : String
Maximum length : 100
Name of the mapped query field (field_name__c). For example, name__v or doc_number__v.
target_object Type : Object References the Object if the target is an Object.
target_docfield Type : Docfield References the Docfield of the target is a Document.
query_object Type : String
Maximum length : 100
Name of the mapped query object object_name__c. Must be specified as returned in VQL response.
field_default Type : String
Maximum length : 1500
Mapping to a static default.
reference_lookup Type : String
Maximum length : 45
Set field based on a reference lookup from the reference_lookup__sys object.

Job

Vault’s job scheduler provides a simpler, streamlined way for Admins to create a batch operation and schedule it to repeatedly execute.

Learn about Jobs in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 1500
UI-friendly string in Vault’s base language.
active Type : Boolean
Required
Indicates whether the component is active.
trigger_date Type : Expression
Maximum length : 4000
Tthe special date Vault evaluates for documents as of the job’s run date, each tie the job runs
month_repeat_type Type : Enum
Allowed values :
  • dayOfTheMonth
  • dayOfTheWeek
Day of the month or week for a scheduled job.
week_day Type : Enum
Allowed values :
  • Sun
  • Mon
  • Tue
  • Wed
  • Thu
  • Fri
  • Sat
Day of the week
repeat_on_days Type : Enum
Allows multiple values
Allowed values :
  • Sun
  • Mon
  • Tue
  • Wed
  • Thu
  • Fri
  • Sat
The number of the day to repeat the job on.
timezone Type : String
Maximum length : 1500
Timezone as used in the TZ variable. Example: America/Los_Angeles
schedule Type : String
Maximum length : 1500
The frequency of a scheuled job. options:
  • Manual
  • Once
  • Daily
  • Weekly
  • Monthly
owner Type : String
Maximum length : 1500
The group or user that owns the report job.
time Type : String
Maximum length : 1500
The scheduled time of the report job.
  • Format:hour:min
  • Hour: 24 hour clock
  • min: 00-60
  • For example, 22:30.
day_of_month Type : Number
Maximum value : 31
Specify the day of the month for a monthly report.
week_number Type : Number
Maximum value : 5
Week number for a monthly report that runs on a “day of the week”
priority Type : String
Maximum length : 1500
e.g. normal
type Type : String
Maximum length : 1500
Indicates job type. Example:
  • Task Reminder Notification
  • Date Based Document Operation

Changestatejobaction

Attribute Description
label Type : String
Required
Maximum length : 1500
UI-friendly string in Vault’s base language.
primary_action Type : Boolean The primary operation that the job completes. Always set to true.
related_doc_conditions Type : String
Allows multiple values
Maximum length : 1500
relationship_types Type : String
Allows multiple values
Maximum length : 1500
notify_on_status_condition Type : Boolean Always set to true.
trigger_date_target Type : String
Maximum length : 1500
conditions Type : String
Allows multiple values
Maximum length : 1500
Defines the query that finds and selects qualified documents for a document operation job.
destination_state Type : String
Maximum length : 1500
Defines the lifecycle state to set.
terminate_existing_workflows Type : Boolean Indicates whether to cancel existing workflows to perform action.

Sendnotificationjobaction

Attribute Description
label Type : String
Required
Maximum length : 1500
UI-friendly string in Vault’s base language.
primary_action Type : Boolean The primary operation that the job completes. Always set to true.
related_doc_conditions Type : String
Allows multiple values
Maximum length : 1500
relationship_types Type : String
Allows multiple values
Maximum length : 1500
notify_on_status_condition Type : Boolean Always set to true.
trigger_date_target Type : String
Maximum length : 1500
conditions Type : String
Allows multiple values
Maximum length : 1500
Defines the query that finds and selects qualified documents for a document operation job.
recipients Type : String
Allows multiple values
Maximum length : 1500
template Type : String
Maximum length : 1500

Sendobjectnotificationjobaction

Attribute Description
label Type : String
Required
Maximum length : 1500
UI-friendly string in Vault’s base language.
primary_action Type : Boolean The primary operation that the job completes. Always set to true.
conditions Type : String
Required
Allows multiple values
Maximum length : 1500
Defines the query that finds and selects qualified documents for a document operation job.
object Type : String
Required
Maximum length : 1500
recipients Type : String
Allows multiple values
Maximum length : 1500
template Type : String
Maximum length : 1500

Changeobjectstatejobaction

Attribute Description
label Type : String
Required
Maximum length : 1500
UI-friendly string in Vault’s base language.
primary_action Type : Boolean The primary operation that the job completes. Always set to true.
conditions Type : String
Required
Allows multiple values
Maximum length : 1500
Defines the query that finds and selects qualified documents for a document operation job.
object Type : String
Required
Maximum length : 1500
terminate_existing_workflows Type : Boolean
Required
Indicates whether to cancel existing workflows to perform action.
destination_state Type : String
Required
Maximum length : 1500
Defines the lifecycle state to set.

Noopjobaction

Attribute Description
label Type : String
Required
Maximum length : 1500
UI-friendly string in Vault’s base language.
primary_action Type : Boolean The primary operation that the job completes. Always set to true.
related_doc_conditions Type : String
Allows multiple values
Maximum length : 1500
relationship_types Type : String
Allows multiple values
Maximum length : 1500
notify_on_status_condition Type : Boolean Always set to true.
trigger_date_target Type : String
Maximum length : 1500
conditions Type : String
Allows multiple values
Maximum length : 1500
Defines the query that finds and selects qualified documents for a document operation job.
recipients Type : String
Allows multiple values
Maximum length : 1500
template Type : String
Maximum length : 1500

Httppostjobaction

Attribute Description
label Type : String
Required
Maximum length : 1500
UI-friendly string in Vault’s base language.
primary_action Type : Boolean The primary operation that the job completes. Always set to true.
run_as_user Type : String
Maximum length : 1500
Defines the user account the vault uses to complete an extenral URL call job.
external_url Type : String
Maximum length : 1500
Defines (as a link) what URL is accessed then the job executs the External URL Call job action.
session_granted_by Type : String
Maximum length : 1500
Defines which user to “Run as”.
post_session_creds Type : Boolean Indicates whether to post session credentials via form data with key “Session.id”.

Edlmatchjobaction

Attribute Description
label Type : String
Required
Maximum length : 1500
UI-friendly string in Vault’s base language.
primary_action Type : Boolean The primary operation that the job completes. Always set to true.
conditions Type : String
Allows multiple values
Maximum length : 1500
Defines the query that finds and selects qualified documents for a document operation job.

Flashreportjobaction

Attribute Description
label Type : String
Required
Maximum length : 1500
UI-friendly string in Vault’s base language.
primary_action Type : Boolean The primary operation that the job completes. Always set to true.
send_notifications_on_completion Type : Boolean Always set to true.
only_send_notifications_if_result Type : Boolean Indicates whether to send a notification when no results are returned.
include_report_in_email Type : Boolean Indicates whether to include a copy of the report in the notification.
report_name Type : String
Maximum length : 1500
Defines the name of the report.

Schedulededcjobaction

Attribute Description
label Type : String
Required
Maximum length : 1500
UI-friendly string in Vault’s base language.
primary_action Type : Boolean The primary operation that the job completes. Always set to true.
edcAsyncPayload Type : JSONString
Maximum length : 32000

Layoutrule

Layout rules streamline the data entry process by dynamically hiding irrelevant fields and sections on an object record detail page based on business needs.

Learn about Configuring Layout Rules in Vault Help.

Attribute Description
hide_sections Type : String
Allows multiple values
Maximum length : 1500
Indicates the sections to hide in the layout rule.
hide_fields Type : String
Allows multiple values
Maximum length : 1500
Indicates the fields to hide in the layout rule.
active Type : Boolean
Required
label Type : String
Required
Maximum length : 40
expression Type : String
Required
Maximum length : 3900
A valid expression.
order Type : Number The relative order of the layout rules on the Layout Rules list page.
description Type : String
Maximum length : 255

Link

Defines a Web Action.

Learn about Web Actions in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 40
UI-friendly string in Vault’s base language.
send_session_via_post_message Type : Boolean Specifies the option to send post session credentials via post message instead of through the URL.
url Type : String
Required
Maximum length : 2083
Defines the URL link for the web action.
component Type : Enum
Required
Allowed values :
  • Document
  • Object
Specifies whether the action applies to documents or objects records.
target Type : Enum
Required
Allowed values :
  • self
  • blank
Controls where the target URL displays when a user executes the web action.

Matchingrule

Matching Sharing Rules are part of Dynamic Access Control for objects. These rules allow assignment of users to Auto Managed groups and dynamic assignment of those groups to roles on specific object records.

Learn about Configuring Matching Sharing Rules for Objects in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 100
UI-friendly string in Vault’s base language.
active Type : Boolean
Required
Indicates whether the field is active.
description Type : String
Maximum length : 255
General description of the matching rule.
object Type : Object
Required
The object the rule applies to.
role Type : String
Required
Maximum length : 60
The role the rule applies to.
user_role_fields Type : String
Required
Allows multiple values
Maximum length : 56
Ordered : True
A list of User Role Object Fields used to identify matching rows.
data_fields Type : String
Required
Allows multiple values
Maximum length : 56
Ordered : True
A list of Object or Document Fields used to identify matching rows.

Messageprocessor

Message Processors provide logic to handle Spark Messages. For example, all inbound queues must include a Message Processor to provide the operations to perform on the received messages.

Learn about Message Processors.

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the field is active.
checksum Type : String
Maximum length : 1500
Used to check data for errors.
source_code Type : SdkCode
Maximum length : 1048576
The source code of this Message Processor. Custom means this Message Processor was developed with the Vault Java SDK.

Notificationtemplate

Defines a template for email and notification messages sent by Vault.

Notification templates use special pieces of text called tokens. When sending a notification, Vaule replaces the token with the values it represents. Learn about Notification Messages in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 40
UI-friendly string in Vault’s base language.
active Type : Boolean
Required
Indicates whether the component is active.
description Type : String
Maximum length : 255
Additional description of the notification template.
subject Type : String
Required
Maximum length : 255
Subject of the email sent to the receipient.
notification Type : String
Required
Maximum length : 1023
The message that appears in Vault’s notification page for the recipient.
email_body Type : String
Required
Body of the email sent to the notification recipient.
entity_type Type : Enum
Required
Allowed values :
  • document
  • object
  • custom
Indiciates whether the message is intended for documents or objects.
referenced_component Type : Object The specific Object (when entity_type is object).

Object

Objects define the data model for the vault.

Learn about Vault Objects in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 40
UI-friendly string in the vault’s base language.
active Type : Boolean
Required
Indicates whether the object is active.
label_plural Type : String
Required
Maximum length : 40
Plural of the label in the vault’s base language.
description Type : String
Maximum length : 255
Description of the object in the vault’s base language.
help_content Type : String
Maximum length : 255
Hover text to display for the (?) icon in the Business Admin for this object. Custom help text that appears in the UI when users hover over the field.
in_menu Type : Boolean
Required
Indicates whether the object appears in the Business Admin menu.
enable_esignatures Type : Boolean Indicates whether eSignatures are enabled on the object.
allow_attachments Type : Boolean Indicates whether the object allows file attachments.
audit Type : Boolean
Required
Indicates whether Vault tracks object record changes in the audit logs.
order Type : Number Order for the object to display in the Business Admin sidebar. The order in which the fields appears in List Layout.
dynamic_security Type : Boolean Enables Custom Sharing Rules for the object.
system_managed Type : Boolean Indicates that records are managed by the system.
available_lifecycles Type : Objectlifecycle Defines the lifecycle (by name) that manages the object, e.g., Objectlifecycle.general_lifecycle__v.
object_class Type : Enum
Allowed values :
  • base
  • component
  • userrolesetup
  • legalhold
  • usertask
  • esignature
  • checklist
  • section
  • response
  • availableanswer
  • dependency
  • qualityteammember
  • lifecyclestagesobject
Classification of the object.
allow_types Type : Boolean Indicates whether the object supports Objecttype.
user_role_setup_object Type : Object
default_obj_type Type : Objecttype The default Objecttype
secure_sharing_settings Type : Boolean Enables ability to contol user access to sharing settings.
secure_attachments Type : Boolean
prevent_record_overwrite Type : Boolean

Field

Attribute Description
label Type : String
Required
Maximum length : 40
UI-friendly string in the vault’s base language.
controlling_picklist Type : String
Maximum length : 50
The name of the controlling picklist.
type Type : Enum
Required
Allowed values :
  • String
  • Number
  • Boolean
  • Date
  • DateTime
  • Object
  • Picklist
  • ID
  • users
  • Component
  • documents
  • LongText
  • Binary
  • ObjectReference
  • ObjectParent
Defines the field’s data type.
active Type : Boolean
Required
Indicates whether the object is active.
required Type : Boolean
Required
Indicates whether the user must always enter a value
unique Type : Boolean Indicates whether the field’s value must be unique.
max_length Type : Number
Maximum value : 32000
Minimum value : 1
(Text fields only) Defines the maximum number of characters for the field value.
max_value Type : Number (Number fields only) Defines the maximum numeric value for the field value.
min_value Type : Number (Number fields only) Defines the minimum numeric value for the field value.
scale Type : Number
Maximum value : 9
(Number fields only) Defines the maximum number of decimal places for the field value.
help_content Type : String
Maximum length : 255
Hover text to display for the (?) icon in the Business Admin for this object. Custom help text that appears in the UI when users hover over the field.
list_column Type : Boolean
Required
Indicates if the field should display in default object record lists, hovercards, etc.
order Type : Number Order for the object to display in the Business Admin sidebar. The order in which the fields appears in List Layout.
multi_value Type : Boolean (Picklist fields only) Indicates if the field is multi-select.
object Type : String
Maximum length : 50
(Object fields only) Defines the related object (by name), e.g., country__v.
relationship_type Type : Enum
Allowed values :
  • parent
  • reference
  • child
  • reference_inbound
  • reference_outbound
(Object fields only) Indicates the relationship type.
relationship_outbound_name Type : String
Maximum length : 50
(Object fields only) Indicates the Outbound Relationship Name, e.g., edl__vr on EDL Item.
relationship_inbound_name Type : String
Maximum length : 50
(Object fields only) Indicates the Inbound Relationship Name, e.g., edl_item__vr on EDL.
relationship_inbound_label Type : String
Maximum length : 40
(Object fields only) Indicates the Outbound Relationship Label, e.g., EDL on EDL Item.
controlling_field Type : String
Maximum length : 50
Controlling field name, if any.
relationship_deletion Type : Enum
Allowed values :
  • block
  • cascade
  • setnull
(Object fields only) Defines the Deletion Rules that apply to when users try to delete the referenced or parent object record.
relationship_criteria Type : Expression
Maximum length : 4000
(Object fields only) VQL WHERE clause expression which specifies the criteria that an object record must meet for the relationship.
system_managed_name Type : Boolean Indicates if the [name] value is automatically generated by the system. When true, the field becomes read-only.
start_number Type : Number
Minimum value : 1
First sequence number for the system-managed name value.
value_format Type : String
Maximum length : 500
Format for the system-managed name value, e.g., VV-{###}.
component Type : String
Maximum length : 40
(Component fields only) The Component Type values can refer to.
relationship_deep_copy Type : Boolean (Object fields only) Indicates if the child records associated via this field are available for hierarchical copy.
picklist Type : String (Picklist fields only)
lookup_relationship_name Type : String
Maximum length : 50
(Lookup fields only) Defines the relationship (by [name]) that a Lookup field uses.
lookup_source_field Type : String
Maximum length : 50
(Lookup fields only) Defines the field on the referenced object that should appear as a Lookup field on the current object.
document_version_reference Type : String
Maximum length : 40
Either specific or latest
related_document_reference_field Type : String
Maximum length : 128
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
sequential_naming Type : Boolean Indicates the system controls the name be seqential.
default_value Type : String
Maximum length : 1500
The default value of the field.
checkbox Type : Boolean Indicates whether “Yes/No” field will display as a checkbox.
formula Type : String
Maximum length : 1500
An expression surrounded in [ ] character combination.
multi_part_field Type : Enum
Allowed values :
  • suffix
  • prefix
Indicates whether the prefix and suffix of multi-part field is editable.
multi_part_readonly Type : String
Maximum length : 1500
The read-only text of a multi-part field.
show_as_icon Type : Boolean
show_in_header Type : Enum
Allowed values :
  • left
  • right
secure_relationship Type : Boolean Enables relationship security on a referenced object.
picklist_dependencies Type : String
Maximum length : 1500
Contains comma-delimited list of all dependencies for the conrolling picklist.
For example, ’{"english__c": [“united_kindon__c", "united_states__c`”]}’
related_corporate_currency_field Type : String
Maximum length : 1500
Contains the name of the related corporate currency field.
related_local_currency_field Type : String
Maximum length : 1500
Contains the name of the local currency code field, e.g., local_currency_type (local_currency__sys).
subtype Type : Enum
Allowed values :
  • Currency
Determines that the field is of the Currency type.

Objectaction

Object user actions are configurable instances of a Vault Action that you can define for an object and object types.

Learn about Object Actions in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 40
UI-friendly string in Vault’s base language.
active Type : Boolean
Required
Indicates whether the component is active.
description Type : String
Maximum length : 255
General description of the object action.
parameters Type : XMLString
Maximum length : 32000
Values for any parameters the Action requires.
action Type : Recordaction
Required
The Action code to run.
active Type : Boolean
Required
Indicates whether the component is active.
available_all_states Type : Boolean Indiciates if the Action is available for all lifecycle states.

Objectlifecycle

Definition of the lifecycle of an Object.

Object lifecycles are sequences of states (In Review, Approved, etc.) that an object record can go through during its life. Learn about Object Lifecycles.

Attribute Description
label Type : String
Required
Maximum length : 40
UI-friendly string in Vault’s base language.
active Type : Boolean
Required
Indicates whether the component is active.
labeled_states Type : Objectlifecyclestate
Allows multiple values
Ordered : True
Lists “special states” (by name). The order of the state in this list dictates which state from state_labels is assigned to the specific special state.
state_labels Type : String
Allows multiple values
Maximum length : 255
Ordered : True
Lists lifecycle state labels (by name) defined for this lifecycle. The order defined here must correspond to the order in labeled_states.
starting_state Type : Objectlifecyclestate deprecated - replaced by state_labels and labeled_states
description Type : String
Maximum length : 255
Additional information to describe the lifecycle.

Objectlifecyclestate

Attribute Description
label Type : String
Required
Maximum length : 40
UI-friendly string in Vault’s base language.
active Type : Boolean
Required
Indicates whether the component is active.
record_status Type : Enum
Allowed values :
  • active__v
  • inactive__v
  • in_migration__v
  • archived__v
Indicates the status of a record while in this state.
record_inactive Type : Boolean deprecated - replaced by record_status
description Type : String
Maximum length : 255
Additional information to describe the lifecycle.

Objectlifecyclestateentrycriterion

Attribute Description
rule Type : XMLString
Required
Maximum length : 32000
The defined rules and conditions for entry criteria, entry actions, or user actions.

Objectlifecyclestateentryaction

Attribute Description
rule Type : XMLString
Required
Maximum length : 32000
The defined rules and conditions for entry criteria, entry actions, or user actions.

Objectlifecyclestateuseraction

Attribute Description
label Type : String
Required
Maximum length : 60
UI-friendly string in Vault’s base language.
rule Type : XMLString
Required
Maximum length : 32000
The defined rules and conditions for entry criteria, entry actions, or user actions.
order Type : Number
Required
The relative order in which the action displays.

Objectlifecycleevent

Attribute Description
rule Type : XMLString
Required
Maximum length : 32000
The defined rules and conditions for entry criteria, entry actions, or user actions.
event Type : String
Required
Maximum length : 1500
order Type : Number
Required
The relative order in which the action displays.

Objectlifecyclerole

Attribute Description
active Type : Boolean
Required
Indicates whether the component is active.
application_role Type : String
Required
Maximum length : 60
The name__v field value of the application_role__v record this role corresponds to. (Prefixed with Applicationrole.)
permissions Type : Enum
Allows multiple values
Allowed values :
  • Read
  • Edit
  • Delete
List of permissions assigned to the object role. Note that:
  • Read is always present
  • Edit is always present if Delete is present

Objectlifecyclepermission

Attribute Description
states Type : Objectlifecyclestate
Required
Allows multiple values
Ordered : True
Lists the object lifecycle states in which the permission applies.
role Type : Objectlifecyclerole
Required
The role to which this permission applies.
permission Type : Enum
Required
Allowed values :
  • Read
  • Edit
  • Delete
The permission to apply.

Objectlifecyclestagegroup

Lifecycle Stages allow organizations to group document and object lifecycle states into ordered collections of “stages”.Learn about Lifecycle Stages.

Learn about Lifecycle Stages.

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
object_type Type : Objecttype
Required
The Objecttype of the Lifecycle Stage Group. If an object type is not enabled, the object type will be BASE by default.
description Type : String
Maximum length : 255
General description for this object lifecycle stage group. General description for this object stage.
object_lifecycle Type : Objectlifecycle
Required
Reference to Objectlifecycle component type. Validation ensures that only one 1Objectstagegroup1 exists per Objectlifecycle.Objecttype.

Objectlifecyclestage

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
object_lifecycle_states_ref Type : String
Allows multiple values
Maximum length : 1500
Reference to the Objectlifecyclestate. Validation ensures that a Objectlifecyclestate only exists in one object stage.
description Type : String
Maximum length : 255
General description for this object lifecycle stage group. General description for this object stage.
order Type : Number
Required
Minimum value : 1
A number automatically assigned to a stage after it’s created and represents the order of stages in a stage group.

Objecttype

An object type is a collection of fields that are grouped to capture similar but not identical data within a single object.

Not all objects use object types. Learn about Object Types in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 40
UI-friendly string in the vault’s base language.
label_plural Type : String
Required
Maximum length : 40
Plural of the label in the vault’s base language.
active Type : Boolean
Required
Indicates whether the object is active.
additional_type_validations Type : String
Allows multiple values
Maximum length : 1500
Contains a list of all validation rules for the specified object type.

Typefield

Attribute Description
source Type : Enum
Required
Allowed values :
  • standard
  • sample
  • custom
  • application
  • system
The owner of the type. e.g. standard indicates owned by vault.
required Type : Boolean Indicates whether the user must always enter a value
relationship_criteria Type : Expression
Maximum length : 4000
The VQL used to constrain records in the referenced Object.
pickentries Type : String
Allows multiple values
Maximum length : 1500
The picklist values allowed for this field when the record is of this type. (Only valid for Fields of type Picklist)

Typeaction

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

Objectworkflow

Object workflows apply to a single object lifecycle and a single object.

Learn about Object Workflows in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 40
UI-friendly string in Vault’s base language.
active Type : Boolean
Required
Indicates whether the component is active.
object_lifecycles Type : Objectlifecycle
Required
Allows multiple values
The Objectlifecycle to which this workflow belongs.
document_content_lifecycle Type : Doclifecycle
description Type : String
Maximum length : 255
Description of the workflow.
auto_start Type : Boolean

Objectworkflowstep

Attribute Description
label Type : String
Required
Maximum length : 40
UI-friendly string in Vault’s base language.
type Type : Enum
Required
Allowed values :
  • start
  • end
  • usertask
  • contenttask
  • notification
  • placeholder
  • changestate
  • decision
  • join
  • action
  • updaterecordfield
  • updatesharingsettings
  • updatedocumentsharingsettings
  • updaterelatedrecordfield
  • contentaction
The type of step.
next_steps Type : Objectworkflowstep
Allows multiple values
The Objectworkflowstep to move to once this step is complete.
tags Type : String
Allows multiple values
Maximum length : 40
step_detail Type : XMLString
Maximum length : 32000
Details of the step configuration.
description Type : String
Maximum length : 255
Description of the workflow.

Objectvalidation

Validation rules enhance data quality by comparing user-entered data with Admin-defined rules for an object record.

Learn about Record Validation Rules in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 40
UI-friendly string in the vault’s base language.
active Type : Boolean
Required
Indicates whether the validation is active.
expression Type : String
Required
Maximum length : 3900
A valid expression.
description Type : String
Maximum length : 255
Describes the details of the validation rule.
error_message Type : String
Required
Maximum length : 255
Describes the error that displays if the rule fails.
error_location Type : String
Required
Allows multiple values
Maximum length : 255
Select fields for the error location.

Overlaytemplate

Overlays allow you to apply information to a vieable rendition when users download it from Vault.

Learn about Managing Overlays in Vault Help.

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active. Indicates whether the component is active.
watermark Type : String
Maximum length : 1500
Diagnal watermark that appears across the center of the downloaded rendition.
footer_01 Type : String
Maximum length : 1500
Footer row 1
footer_02 Type : String
Maximum length : 1500
Footer row 2
active Type : Boolean Indicates whether the component is active. Indicates whether the component is active.
header_01 Type : String
Maximum length : 1500
Header row 1
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language.
header_02 Type : String
Maximum length : 1500
Header row 2

Overlayoverride

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language. UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active. Indicates whether the component is active.
file Type : File
Required
Reference to the file

Pagelayout

The layout of an object detail page.

Learn about Page Layouts in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 100
UI-friendly string in Vault’s base language.
page_markup Type : XMLString
Required
Maximum length : 32000
Defines page layout using HTML markup.

Pagelink

Represents a page link that navigates users to custom page destinations.

Learn about Page Links in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 40
UI-friendly string in Vault’s base language.
description Type : String
Maximum length : 255
A general description of the page link.
url Type : String
Required
Maximum length : 1500
Defines the URL link for the page link.
mode Type : Enum
Required
Allowed values :
  • Create
  • Edit
  • Copy
  • View
Determines which action redirects the user to a custom page.
page_type Type : Enum
Required
Allowed values :
  • Object
Specifies the type of page link. Object is the only allowed value at this time.
object Type : Object Sepcifies the object that the page link will override behavior for.

Permissionset

Permission sets are a way to group permissions together. Security profiles then use the permission sets to grant or restrict users’ access to certain features.

Note that the configuration of this component varies by vault. Learn about Permission sets in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
description Type : String
Maximum length : 255
A general description of the permission.

Picklist

Picklists allow users to select a value for a field from a range of predefined options.

Learn about Picklists in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 40
UI-friendly string in the vault’s base language.
active Type : Boolean
Required
Indicates whether the component is active.

Picklistentry

Attribute Description
active Type : Boolean
Required
Indicates whether the component is active.
value Type : String
Required
Maximum length : 128
UI-friendly string for the value of the entry (in the vault’s base language).
order Type : Number
Required
Defines the ordinal position of the entry in the picklist.

Qualityteam

Admins can create and configure Quality Teams and Quality Team Roles to suit their needs. Quality Teams allow users to make individual work assignments to individual Change Controls, Audits, CAPAs, or other Quality Event-related processes.

Learn about Rendition Types in Vault Help.

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active. If the component or subcomponent is inactive, no one in the vault can edit team membership using this team or Team Role.
destination_state Type : Subcomponent If change state on team completion is selected, this is the state the team enabled record will change into.
Note: This is required on change state when team completion is selected.
initial_state Type : Subcomponent If change state on team completion is selected, it will only occur while team complete happens if the team enabled record is in this state.
Note: Required change state when team completion is selected.
process_relationships Type : String
Allows multiple values
Maximum length : 1500
No function at this time.
locked_in_states Type : String
Allows multiple values
Maximum length : 1500
While the record is any one of these states, no user in the vault may change team member assignments for any role. This supersedes all security configurations.
Note: When using cascade of team member updates between records, records in this state will not reflect team membership changes, but will also not cause an error.
objecttype Type : Objecttype If left blank, team will apply to all records of this object that do not have a team defined for this type.
object Type : Object
Required
The object the Qualityteam applies to. The object the Qualityteamrole applies to.
objectlifecycle Type : Objectlifecycle
Required
Must be the lifecycle for the selected object or type.

Qualityteamrole

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active. If the component or subcomponent is inactive, no one in the vault can edit team membership using this team or Team Role.
maximum_user_in_role Type : Number
Required
Maximum value : 20
Minimum value : 1
Maximum number of users selected for a Team Role per record. Maximum must be greater than minimum.
help_content Type : String
Maximum length : 255
Hover text to display for the (?) icon in the Business Admin for this object. Custom help text that appears in the UI when users hover over the field.
linked_application_role Type : String
Required
Maximum length : 1500
The role into which Team Role assignments for a team enabled record are inserted. This role defines the permissions and sharing settings role that team members will be granted.
cascade_from_relationship Type : Subcomponent Required if cascade behavior is set to anything other than NOT_APPLICABLE. Defines the field which indicates the record from which team assignments should be inherited.
display_order Type : Number
Required
Maximum value : 25
The order in which this Team Role will display to viewers and editors of the team enabled record.
cascade_behavior Type : Enum
Required
Allowed values :
  • NOT_APPLICABLE
  • INHERIT_ALLOW_OVERRIDE
Indicates if the membership of this role can be governed by the membership of a related records Team Role.
Enums:
  • NOT_APPLICABLE - These team role assignments are self-governed
  • INHERIT_ALLOW_OVERRIDE - These team role assignments will atempt to inherit changes in team role assgnments on the record related by the cascade from the field value. This matches on application role and enables user editing team membership to override or restore team membership assignments at the record level.
constraining_role Type : String
Maximum length : 1500
Limits selection of users when editing this team role’s membership to the current membership of the specified application role on the team enabled record.
locked_in_states Type : String
Allows multiple values
Maximum length : 1500
While the record is any one of these states, no user in the vault may change team member assignments for any role. This supersedes all security configurations.
Note: When using cascade of team member updates between records, records in this state will not reflect team membership changes, but will also not cause an error.
minimum_user_in_role Type : Number
Required
Maximum value : 20
Minimum number of users selected for a Team Role per record. Value of zero means the role is purely optional. Population of the role will not effect team completeness record behaviors.
object Type : Object
Required
The object the Qualityteam applies to. The object the Qualityteamrole applies to.
objectlifecycle Type : Objectlifecycle
Required
Must be the lifecycle for the selected object or type.

Queue

Spark Messaging is a message notification system that allows for loosely coupled, asynchronous, near real-time integration between vaults or external applications. Messages are processed by a queuing system to provide reliable delivery. Outbound messages are placed in an outbound queue, and delivered messages enter an inbound queue.

Learn about Creating & Managing Queues in Vault Help.

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the field is active.
sequential Type : Boolean Indiciates if the messages intended for this queue must be process sequentially, meaning one after another in the order they are received.
description Type : String
Maximum length : 500
The description of the queue.
type Type : Enum
Required
Allowed values :
  • inbound
  • outbound
Specifices whether the queue is Outbound (sends messages), or Inbound (receives messages).
message_processor_user Type : String
Maximum length : 1500
Indicates the user who will process messages delivered to an Inbound queue.
rollback_on_error Type : Boolean Indicates whether this queue will continue the transaction when a message fails to enter the queue.
message_processor Type : ComponentReference References the Messageprocessor component.

Queueconnection

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the field is active.
connection_type Type : Enum
Required
Allowed values :
  • Vault-to-Vault
  • External
  • Local
The type of queue connection.
connection_name Type : String
Required
Maximum length : 40
The name of the connection.
deliver_to_queue Type : String
Maximum length : 1500

Recordaction

Custom actions for records, called record actions, are invoked by a user on a specific record from the UI or API.

Learn about Defining User Actions for Objects.

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
user_input_object_type Type : Objecttype If your action takes user input, identifies the user input object type.
user_input_object Type : Object If your action takes user input, identifies the user input object.
type Type : String
Maximum length : 1500
The type of record action, for example, Object.
checksum Type : String
Maximum length : 1500
Used to check data for errors.
usages Type : String
Allows multiple values
Maximum length : 1500
If specified, the action is available for configuring in the specified usages only. For example, USER_ACTION. If omitted, the action is available across all supported usages.
source_code Type : SdkCode
Maximum length : 1048576
The source of this record action code used to create and edit metadata. For example, Custom means this is a custom action developed with the Vault Java SDK.
object Type : Object The object this record action is associated to, for example, product__v.

Recordroletrigger

Record role triggers execute custom code whenever roles are directly (manually) added or removed from an object record.

Learn about Record Role Triggers in Vault Help.

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
checksum Type : String
Maximum length : 1500
Used to check data for errors.
source_code Type : SdkCode
Maximum length : 1048576
The source of this record role trigger and code used to create and edit metadata. Custom means this record role trigger was developed with the Vault Java SDK.
event_segment Type : Enum
Allowed values :
  • PRE_CUSTOM
  • POST_CUSTOM
  • UNSPECIFIED
For internal Veeva use only. This Enum is used for a variety of features in Vault. Contains valid values for specifying eventSegment.
events Type : Enum
Allows multiple values
Allowed values :
  • BEFORE
  • AFTER
The Events specifying when this record role trigger executes. For example, BEFORE means the trigger executes right before the record role assignment.
order Type : Enum
Allowed values :
  • NUMBER_1
  • NUMBER_2
  • NUMBER_3
  • NUMBER_4
  • NUMBER_5
  • NUMBER_6
  • NUMBER_7
  • NUMBER_8
  • NUMBER_9
  • NUMBER_10
  • UNSPECIFIED
If multiple triggers exist on the same object, this specifies the order this record role trigger will execute. Order 1 executes first and Order 10 executes last. UNSPECIFIED means this trigger will always execute last.
object Type : Object
Required
The object this record role trigger is associated to, for example, product__v.

Recordtrigger

Record triggers execute custom code when a record Event occurs.

Learn about Record Triggers in Vault Help.

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
checksum Type : String
Maximum length : 1500
Used to check data for errors.
source_code Type : SdkCode
Maximum length : 1048576
The source of this record trigger and code used to create and edit metadata. Custom means this record trigger was developed with the Vault Java SDK.
event_segment Type : Enum
Allowed values :
  • PRE_CUSTOM
  • POST_CUSTOM
  • UNSPECIFIED
For internal Veeva use only. This Enum is used for a variety of features in Vault. Contains valid values for specifying eventSegment.
events Type : Enum
Allows multiple values
Allowed values :
  • BEFORE_INSERT
  • AFTER_INSERT
  • BEFORE_UPDATE
  • AFTER_UPDATE
  • BEFORE_DELETE
  • AFTER_DELETE
The Events specifying when this record trigger executes. For example, BEFORE_UPDATE means the trigger executes right before the record updates.
order Type : Enum
Allowed values :
  • NUMBER_1
  • NUMBER_2
  • NUMBER_3
  • NUMBER_4
  • NUMBER_5
  • NUMBER_6
  • NUMBER_7
  • NUMBER_8
  • NUMBER_9
  • NUMBER_10
  • UNSPECIFIED
If multiple triggers exist on the same object, this specifies the order this record role trigger will execute. Order 1 executes first and Order 10 executes last. UNSPECIFIED means this trigger will always execute last.
object Type : Object
Required
The object this record trigger is associated to, for example,product__v.

Renditiontype

Renditions are files that users can add to documents. Rendition types describe the kind or purpose of the rendition.

Learn about Rendition Types in Vault Help.

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
automated_image Type : Boolean Indicates that the rendition is an Automated Image Rendition
density Type : String
Maximum length : 1800
Specifies the density of the Automated Image Rendition. The value must be numeric. You can also populate this field with a height and width value such as 300x200. You can use the following expected values -
  • {number}
  • {number}x{number}
format Type : Enum
Allowed values :
  • AAI
  • ART
  • AVS
  • BPG
  • BMP
  • BMP2
  • BMP2
  • BMP3
  • CMYK
  • CMYKA
  • DIB
  • EPDF
  • FAX
  • FITS
  • GIF
  • GRAY
  • GRAYA
  • HDR
  • JP2
  • JPT
  • J2C
  • J2K
  • JPEG
  • MIFF
  • MONO
  • MTV
  • OTB
  • P7
  • PALM
  • PBM
  • PCD
  • PCDS
  • PFM
  • PGM
  • PICON
  • PICT
  • PNG
  • PNG8
  • PNGoo
  • PNG24
  • PNG32
  • PNG64
  • PPM
  • PSB
  • PSD
  • PTIF
  • RGB
  • RGBA
  • SGI
  • SVG
  • TIFF
  • YCbCr
  • YCbCrA
Specifies the format of an Automated Image Rendition
colorspace Type : Enum
Allowed values :
  • CMY
  • CMYK
  • Gray
  • HSB
  • HSL
  • HWB
  • LAB
  • LinearGray
  • LOG
  • OHTA
  • Rec601Luma
  • Rec601YCbCr
  • Rec709Luma
  • sRGB
  • XYZ
  • YCC
  • YCbCr
  • YIQ
  • YPbPr
  • YUV
Specifies the color space of an Automated Image Rendition
quality Type : String Specifies the the quality of an Automated Image Rendition. The value must be numeric.
resize Type : Number Specifies the size and dimensions of an Automated Image Rendition. The value must be numeric.
resample Type : Boolean

Renditionprofile

Rendition profiles allow you to choose rendition settings that differ from the Vault-wide rendition settings.

Learn about Rendition Profiles in Vault Help.

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
bookmark_expansion_level Type : Enum
Required
Allowed values :
  • ALL_LEVELS
  • LEVEL_ONE
  • LEVEL_TWO
  • LEVEL_THREE
  • LEVEL_FOUR
  • LEVEL_FIVE
Determines how many level deep are expanded in the bookmark panel.
generate_toc_lofs_bookmarks Type : Boolean
Required
Generates bookmakrs based on the Table of Content and List of Figures.
render_ppt_speaker_notes Type : Boolean
Required
Viewable Renditions for PowerPoint documents will be rendered with Speakrer Notes.
generate_bookmarks_for_title_style Type : Boolean
Required
Generates bookmarks for Title Style.
set_link_text_to_blue Type : Boolean
Required
Sets link text to blue.
generate_caption_bookmarks_tree Type : Boolean
Required
Auto-generates bookmarks for captions.
embed_fonts Type : Enum
Required
Allowed values :
  • DEFAULT
  • FULL_FONT
  • SUB_FONT
no_mark_up Type : Boolean
Required
Does not show Markup in the viewable rendition.

Report

Represents a Vault report.

Learn about Reporting in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean
Required
Indicates whether the component is active.
description Type : String
Maximum length : 255
A general description about the report.
format Type : Enum
Required
Allowed values :
  • tabular
  • matrix
The output format of the report. For example, a Tabular or Matrix report.
definition Type : XMLString
Required
Maximum length : 32000
The query to use to pull the data.
layout Type : XMLString
Required
Maximum length : 32000
The layout of the data.
content_type Type : Enum
Required
Allowed values :
  • Document
  • Workflow
  • ReadAndUnderstand
  • Distribution
  • Bindernode
  • Object
  • Relationship
  • MatchedDocument
  • Binder
  • BinderSection
  • MultiView
Specifies the type of data the report refers to.
report_type Type : Reporttype The Reporttype this instance of the report was created from.
viewers Type : String
Allows multiple values
Maximum length : 1500
Users with the Viewer permission required to view reports.
editors Type : String
Allows multiple values
Maximum length : 1500
Users with the Editor permission required to edit reports.

Reporttype

Report Type determines the “reporting objects” for Vault reports. Vault report types allow you to build the foundation for users to create and customize reports.

Learn about Report Types in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 40
UI-friendly string in Vault’s base language.
active Type : Boolean
Required
Indicates whether the component is active.
description Type : String
Maximum length : 255
A general description about the report type.
primary_object Type : String
Required
Maximum length : 255
Primary entity or Object for the report type, for example, Document.
configuration Type : XMLString
Required
Maximum length : 32000
Details of the report type.

Searchablefield

Definition of a searchable object Field.

Learn about Searchable Object Fields in Vault Help.

Attribute Description
field Type : Object.Field Defines the object field (by [name]) of the searchable field, e.g., abbreviation__v.
active Type : Boolean Indicates whether the component is active.
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
required Type : Boolean Whether this component must exist (every Object must have at least one).
object Type : Object Defines the object (by [name]) that the searchable field belongs to, e.g., country__v.

Securityprofile

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

Learn about Security Profiles in Vault Help.

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

Sharingrule

Vault uses Sharing Rules to manage users’ roles on specific object records by matching rule criteria to specific user assignments.

Note that the configruation of this component varies by vault. Learn about Custom Sharing Rules in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
description Type : String
Maximum length : 255
A general description of the rule.
object Type : Object
Required
The type of object the rule applies to.
criteria Type : Expression
Maximum length : 4000
A VQL statement where clause that returns a list of records of the specified object type.

Sharingrole

Attribute Description
members Type : String
Allows multiple values
Maximum length : 300
A list of the groups and/or users that will be given the associated permission.
To specify users: User.user@domain.com.
To specify groups: Group.public_key__v.

Signaturepage

Signature pages display the manifested signatures for a Vault document.

Learn about Signature Pages in Vault Help.

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
signature_block_02 Type : String
Maximum length : 1500
Signature block 2
signature_block_01 Type : String
Maximum length : 1500
Signataure block 1
file Type : File Reference to the file
footer_01 Type : String
Maximum length : 1500
Footer row 1
footer_02 Type : String
Maximum length : 1500
Footer row 2
header_01 Type : String
Maximum length : 1500
Header row 1
location Type : Enum
Allowed values :
  • start__v
  • end__v
Specifies whether the signature page appears at the beginning or end of the document.
header_02 Type : String
Maximum length : 1500
Header row 2

Tab

A Tab within the UI of Vault.

Learn about Tabs in Vault Help.

Attribute Description
label Type : String
Required
Maximum length : 40
UI-friendly string in Vault’s base language.
order Type : Number
Required
The relative order of the tabs within Vault’s navigation bar.
object Type : String
Maximum length : 50
(Object tabs) The Object to display records for e.g. product__v.
doctype Type : String
Maximum length : 50
(Document type tab) The Doctype to display documents for e.g., promotional_piece__c.
subtype Type : String
Maximum length : 100
(Document type tab) The Doctype subtype to display documents for e.g. promotional_piece__c.advertising__c.
classification Type : String
Maximum length : 150
(Document type tab) The Doctype classification to display documents for e.g. promotional_piece__c.advertising__c.print__c.
url Type : LongString
Maximum length : 2048
The target URL (if a web Tab).
send_session_via_post_message Type : Boolean Whether to send the user’s current session token (if a web Tab)
parent Type : String
Maximum length : 43
Name of the parent Tab.
all_view_label Type : String
Maximum length : 40
UI-friendly string in All view
my_view_label Type : String
Maximum length : 40
UI-friendly string in My view
recent_view_label Type : String
Maximum length : 40
UI-friendly string in Recent view
vault_target Type : String
Maximum length : 50
object_type Type : Objecttype The Objecttype (if an object type Tab)
active Type : Boolean
filter_criteria__v Type : String
Maximum length : 32000
prevent_create__v Type : Boolean
modal_create_record Type : Boolean

Subtab

Attribute Description
label Type : String
Required
Maximum length : 40
UI-friendly string in Vault’s base language.
order Type : Number
Required
The relative order of the tabs within Vault’s navigation bar.
object Type : String
Maximum length : 50
(Object tabs) The Object to display records for e.g. product__v.
doctype Type : String
Maximum length : 50
(Document type tab) The Doctype to display documents for e.g., promotional_piece__c.
subtype Type : String
Maximum length : 100
(Document type tab) The Doctype subtype to display documents for e.g. promotional_piece__c.advertising__c.
classification Type : String
Maximum length : 150
(Document type tab) The Doctype classification to display documents for e.g. promotional_piece__c.advertising__c.print__c.
url Type : LongString
Maximum length : 2048
The target URL (if a web Tab).
send_session_via_post_message Type : Boolean Whether to send the user’s current session token (if a web Tab)
parent Type : String
Maximum length : 43
Name of the parent Tab.
all_view_label Type : String
Maximum length : 40
UI-friendly string in All view
my_view_label Type : String
Maximum length : 40
UI-friendly string in My view
recent_view_label Type : String
Maximum length : 40
UI-friendly string in Recent view
vault_target Type : String
Maximum length : 50
object_type Type : Objecttype The Objecttype (if an object type Tab)
active Type : Boolean
filter_criteria__v Type : String
Maximum length : 32000
prevent_create__v Type : Boolean
modal_create_record Type : Boolean

Tag

Admins can create tags to label any document with a topic, category, or any other type of identification. Users can easily find tagged documents by searching or filtering on the tag name.

Learn about Configuring Document Tags.

Attribute Description
label Type : String
Required
Maximum length : 40
UI-friendly string in Vault’s base language.
active Type : Boolean
Required
Indicates whether the component is active.
phrases Type : String
Allows multiple values
Maximum length : 50
Text used to automatically tag document versions when an exact match is found.
auto_tag Type : Boolean Determines if automatic document tagging is turned on.
include_archive Type : Boolean Determines if archived documents should be analyzed for tagging.

Userdefinedclass

Allow users to apply custom business logic on objects when a record is created, updated, or deleted.

Attribute Description
label Type : String
Maximum length : 60
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
checksum Type : String
Maximum length : 1500
Used to check data for errors.
source_code Type : SdkCode
Maximum length : 1048576
The source of this User-Defined Class and code used to create and edit metadata. Custom means this UDC was developed with the Vault Java SDK.

Workflow

A workflow is a series of steps configured in Vault to align with a specific business purpose.

Learn about Document Workflows in Vault Help.
Use the Workflow Migration Services API to manage Workflow configuration.

Attribute Description
label Type : String
Maximum length : 40
UI-friendly string in Vault’s base language.
active Type : Boolean Indicates whether the component is active.
lifecycle Type : Docifecycle
Required
Allows multiple values
The Doclifecycle to which this workflow belongs.
description Type : String
Maximum length : 255
Description of the workflow. Description of the workflow.
workflow_type Type : String
Allows multiple values
Maximum length : 1500
The type of workflow.
bulk_email_message Type : LongString
Required
Maximum length : 1500
When the workflow is started through bulk actions, this message template will be used to inform users.

Workflowstep

Attribute Description
label Type : String
Maximum length : 40
UI-friendly string in Vault’s base language.
status Type : Boolean Indicates whether the component is active.
description Type : String
Maximum length : 255
Description of the workflow. Description of the workflow.
flow_type Type : Enum
Required
Allowed values :
  • start
  • end
  • usertask
  • notification
  • placeholder
  • changestate
  • decision
  • join
  • action
  • updaterecordfield
  • updatesharingsettings
The type of worflow step.
next_steps Type : Docworkflowstep
Allows multiple values
The Docworkflowstep to move to once this step is complete.