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

    Release Notes

    Doclifecycle

    Class: metadata

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

    AttributeMetadataDescription
    labelType: String
    Required
    Max length: 60    		UI-friendly string in the Vault's base language.
    activeType: Boolean
    Required    		Indicates whether the component is active.
    descriptionType: String
    Max length: 255    		General description for this lifecycle.
    state_labelsType: String
    Required
    Max length: 1500
    Multi-value    		Lists lifecycle state labels (by name) defined for this lifecycle. The order defined here must correspond to the order in labeled_states.
    labeled_statesType: Component
    Required
    Multi-value    		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.
    expirationType: XMLString
    Max length: 32000    		Expiration rules.
    signature_pagesType: XMLString
    Max length: 32000    		Signature page rules.
    overlaysType: XMLString
    Max length: 32000    		The overlay template applied to a speciifc lifecycle.

    Doclifecyclerole

    Section link for Doclifecyclerole

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

    AttributeMetadataDescription
    labelType: String
    Required
    Max length: 60    		UI-friendly string in the Vault's base language.
    activeType: Boolean
    Required    		Indicates whether the component is active.
    descriptionType: String
    Max length: 255    		General description for this lifecycle.
    application_roleType: String
    Required
    Max length: 255    		The name__v field value of the application_role__v record this role corresponds to.
    note_colorType: 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_optionsType: XMLString
    Max length: 32000    		The default security rules.

    Doclifecyclestate

    Section link for Doclifecyclestate

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

    AttributeMetadataDescription
    labelType: String
    Required
    Max length: 128    		UI-friendly string in the Vault's base language.
    activeType: Boolean
    Required    		Indicates whether the component is active.
    descriptionType: String
    Max length: 255    		General description for this lifecycle.
    orderType: Number
    Required    		The relative order in which the action displays. For example, order 1 will display before order 2.
    cancel_stateType: ComponentIndicates the state documents enter when their document workflow is cancelled.
    skip_cancel_stateType: BooleanIf 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.
    skip_entry_actions_cancel_stateType: BooleanIf set to true, Vault does not execute entry actions when the workflow is cancelled. If set to false or omitted, entry actions execute as usual.
    entry_criteriaType: XMLString
    Max length: 128000    		The criteria, and the conditions under which they are enforced, which must be satisfied for a document to enter this state.
    entry_actionType: XMLString
    Max length: 128000    		The actions, and the conditions under which they are executed, which are performed when a document enters this state.
    user_actionType: XMLString
    Max 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_settingsType: XMLString
    Max length: 32000    		The actions a user, in each role, can perform when a document is in this state.

    Doclifecycleevent

    Section link for Doclifecycleevent

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

    AttributeMetadataDescription
    activeType: Boolean
    Required    		Indicates whether the component is active.
    eventType: String
    Required
    Max length: 1500    		The type of event action.
    ruleType: XMLString
    Required
    Max length: 32000    		The defined rules and conditions for entry criteria, entry actions, or user actions.
    orderType: Number
    Required    		The relative order in which the action displays. For example, order 1 will display before order 2.

    Supported Operations

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

    Notes:

    • Create, Recreate, Alter: MDL Operation is supported, but the Component Type contains field(s) that use proprietary XML. Direct modification of the XML is not supported or recommended. Instead, creating and/or updating the component is better suited through the Admin UI.
    • Alter: MDL Operation may not be supported for some multi-value attributes.