**Source URL:** https://general.veevavault.dev/qualityone/mdl/component-types/doclifecycle.md

**Class: ** `metadata`

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

Learn about <a href="https://platform.veevavault.help/en/lr/2434" target="_blank">Document Lifecycles in Vault Help</a>.

| Attribute | Metadata | Description |
| --- | --- | --- |
| label | Type: StringRequiredMax length: 60 | UI-friendly string in the Vault's base language. |
| active | Type: BooleanRequired | Indicates whether the component is active. |
| description | Type: StringMax length: 255 | General description for this lifecycle. |
| state_labels | Type: StringRequiredMax length: 1500Multi-value | 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: ComponentRequiredMulti-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. |
| expiration | Type: XMLStringMax length: 32000 | Expiration rules. |
| signature_pages | Type: XMLStringMax length: 32000 | Signature page rules. |
| overlays | Type: XMLStringMax length: 32000 | The overlay template applied to a speciifc lifecycle. |

### Doclifecyclerole {#doclifecyclerole}

| Attribute | Metadata | Description |
| --- | --- | --- |
| label | Type: StringRequiredMax length: 60 | UI-friendly string in the Vault's base language. |
| active | Type: BooleanRequired | Indicates whether the component is active. |
| description | Type: StringMax length: 255 | General description for this lifecycle. |
| application_role | Type: StringRequiredMax length: 255 | The name__v field value of the application_role__v record this role corresponds to. |
| note_color | Type: EnumAllowed values:Dark OrangeOrangeDark YellowYellowLimeGreenAquaRoyalPurpleLilacPinkSalmon | Annotations made by users in this role will use this color by default. |
| security_options | Type: XMLStringMax length: 32000 | The default security rules. |

### Doclifecyclestate {#doclifecyclestate}

| Attribute | Metadata | Description |
| --- | --- | --- |
| label | Type: StringRequiredMax length: 128 | UI-friendly string in the Vault's base language. |
| active | Type: BooleanRequired | Indicates whether the component is active. |
| description | Type: StringMax length: 255 | General description for this lifecycle. |
| order | Type: NumberRequired | The relative order in which the action displays. For example, order 1 will display before order 2. |
| cancel_state | Type: Component | Indicates the state documents enter when their document workflow is cancelled. |
| skip_cancel_state | Type: Boolean | If set to true, documents stay in their current state when their workflow is cancelled. If set to false or omitted, documents enter the state defined by cancel_state when the workflow is cancelled. |
| skip_entry_actions_cancel_state | Type: Boolean | If 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_criteria | Type: XMLStringMax length: 128000 | The criteria, and the conditions under which they are enforced, which must be satisfied for a document to enter this state. |
| entry_action | Type: XMLStringMax length: 128000 | The actions, and the conditions under which they are executed, which are performed when a document enters this state. |
| user_action | Type: XMLStringMax length: 128000 | The actions, and the conditions under which they are available, which a user can execute when a document is in this state. |
| security_settings | Type: XMLStringMax length: 32000 | The actions a user, in each role, can perform when a document is in this state. |

### Doclifecycleevent {#doclifecycleevent}

| Attribute | Metadata | Description |
| --- | --- | --- |
| active | Type: BooleanRequired | Indicates whether the component is active. |
| event | Type: StringRequiredMax length: 1500 | The type of event action. |
| rule | Type: XMLStringRequiredMax length: 32000 | The defined rules and conditions for entry criteria, entry actions, or user actions. |
| order | Type: NumberRequired | The relative order in which the action displays. For example, order 1 will display before order 2. |

### Supported Operations {#supported-operations}

| Operation | Support |
| --- | --- |
| Create | Yes* |
| Recreate | Yes* |
| Alter | Yes* |
| Drop | No |
| Rename | No |
| Describe | Yes |
| Generate Recreate | Yes |
| Queryable | No |
**Notes:**

<ul style="padding-left:1.5em;margin-top:0.5rem"><li>**Create, Recreate, Alter:** <span>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.</span></li><li>**Alter:** <span>MDL Operation may not be supported for some multi-value attributes.</span></li></ul>


---

**Previous:** [Docfieldlayout](/qualityone/mdl/component-types/docfieldlayout)  
**Next:** [Docmatchingrule](/qualityone/mdl/component-types/docmatchingrule)