Skip to content
Vault Logo
Vault Developer Portal Developer Medical
Advanced Search

    Release Notes

    Doctype

    Class: metadata

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

    AttributeMetadataDescription
    auto_bring_forward_annotationsType: BooleanIf true, Vault automatically brings forward annotations when a new document version is created.
    auto_bring_forward_annotation_typesType: Enum
    Multi-value
    Allowed values:
    • anchor__sys
    • auto_link__sys
    • line__sys
    • link__sys
    • note__sys
    • resolved_note__sys
    		The types of annotations to automatically bring forward.
    milestone_typesType: String
    Max length: 1500
    Multi-value    		The type of milestone.
    default_workflowsType: String
    Max length: 1500
    Multi-value    		The list consists of Doclifecycle/Workflow combinations separated by a colon (:) (e.g., promotional_field__c:start_mld_review__c).
    relationship_typesType: String
    Max length: 1500
    Multi-value    		The list of Docrelationshiptype names supported.
    etmf_rm_v2Type: String
    Max length: 1500    		eTMF Reference Model V2 Hierarchy Item external id, (e.g.,tmf_rm_v2_04.02)
    Available in eTMF Vaults only.
    etmf_rm_v3Type: String
    Max length: 1500    		eTMF Reference Model V3 Hierarchy Item external id, (e.g., tmf_rm_v3_04.02)
    Available in eTMF Vaults only.
    clinical_docs_rmType: String
    Max length: 1500    		Veeva Clinical Docs Hierarchy Item id.
    Available in eTMF Vaults only.
    document_number_formatType: String
    Max length: 512    		The document numbering pattern. If none are specified, the default value is inherited from parent or base
    document_name_formatType: String
    Max 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}
    crosslinkType: String
    Max length: 1500    		Determines whether CrossLinks created for this document type use the source document’s source file or viewable rendition.
    enable_suggested_links_sourceType: BooleanEach document type, subtype, and classification can be enabled or disabled for the Suggest Links action.
    Available in PromoMats Vaults only.
    enable_suggested_links_targetType: BooleanEach document type, subtype, and classification can be enabled as eligible or not eligible for Suggested Links references.
    Available in PromoMats Vaults only.
    enable_binder_thumbnailType: BooleanUse a document from within the binder as the binder thumbnail instead of the standard Vault binder icon.
    binder_unbound_document_display_optionType: Enum
    Allowed values:
    • latest_version
    • latest_viewable_version
    • latest_steady_state_version
    		Select display options for unbound documents.
    create_document_permissionsType: String
    Max length: 1500
    Multi-value    		The list of group or user IDs in the form of user:username or group:Group.name__v.
    create_binder_permissionsType: String
    Max length: 1500
    Multi-value    		The list of group or user IDs in the form of user:username or group:Group.name__v.
    role_defaulting_editorsType: String
    Max length: 1500
    Multi-value    		The list of group or user IDs in the form of user:username or group:Group.name__v.
    role_defaulting_viewersType: String
    Max length: 1500
    Multi-value    		The list of group or user IDs in the form of user:username or group:Group.name__v.
    role_defaulting_consumersType: String
    Max length: 1500
    Multi-value    		The list of group or user IDs in the form of user:username or group:Group.name__v.
    inherit_doctype_groupsType: BooleanIndicates whether the doctype_group values are inherited from the parent Doctype.
    doctype_groupType: String
    Max length: 1500
    Multi-value    		List of Document Group (doc_type_group__v) linked to this Doctype.
    regen_doc_name_on_saveType: BooleanWhether auto-generated names should be refreshed when saving the document.
    allow_attachmentsType: BooleanWhether documents of this type can have attachments.
    rendition_typesType: String
    Max length: 1500
    Multi-value    		The list of Renditiontype names supported.
    available_lifecyclesType: String
    Max length: 1500
    Multi-value    		The list of Doclifecycle names. If none are specified, the default value is inherited from parent or base.
    processesType: String
    Max length: 1500
    Multi-value    		The list of process names.
    These come from processes picklists.
    etmf_departmentType: String
    Max length: 1500    		The department name from the etmf_departmnet picklist
    Available in eTMF Vaults only.
    filtersType: String
    Max length: 1500
    Multi-value    		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
    activeType: Boolean
    Required    		Indicates whether the field is active.
    fieldsType: String
    Max length: 1500
    Multi-value    		The list of Docfield components linked to this Doctype.
    descriptionType: String
    Max length: 500    		A general description of the Doctype.
    labelType: String
    Required
    Max length: 200    		UI-friendly string.

    Supported Operations

    Section link for Supported Operations
    OperationSupport
    Create
    Recreate
    Alter*
    Drop
    Rename
    Describe
    Generate Recreate
    Queryable

    Notes:

    • Alter: MDL Operation may not be supported for some multi-value attributes.