**Source URL:** https://limited.veevavault.dev/clinical/mdl/component-types/doclifecycle

**Class:** `metadata`

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](https://platform.veevavault.help/en/lr/2434).

| Attribute | Metadata | Description |
| --- | --- | --- |
| `label` | Type: String **Required** Max length: 60 | UI-friendly string in the Vault's base language. |
| `active` | Type: Boolean **Required** | Indicates whether the component is active. |
| `description` | Type: String Max length: 255 | General description for this lifecycle. |
| `state_labels` | Type: 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_states` | Type: 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. |
| `expiration` | Type: XMLString Max length: 32000 | Expiration rules. |
| `signature_pages` | Type: XMLString Max length: 32000 | Signature page rules. |
| `overlays` | Type: XMLString Max length: 32000 | The overlay template applied to a speciifc lifecycle. |

### Doclifecyclerole

| Attribute | Metadata | Description |
| --- | --- | --- |
| `label` | Type: String **Required** Max length: 60 | UI-friendly string in the Vault's base language. |
| `active` | Type: Boolean **Required** | Indicates whether the component is active. |
| `description` | Type: String Max length: 255 | General description for this lifecycle. |
| `application_role` | Type: String **Required** Max 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 Max length: 32000 | The default security rules. |

### Doclifecyclestate

| Attribute | Metadata | Description |
| --- | --- | --- |
| `label` | Type: String **Required** Max length: 128 | UI-friendly string in the Vault's base language. |
| `active` | Type: Boolean **Required** | Indicates whether the component is active. |
| `description` | Type: String Max length: 255 | General description for this lifecycle. |
| `order` | Type: Number **Required** | The relative order in which the action displays. For example, order `1` will display before order `2`. |
| `cancel_state` | Type: 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: 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_action` | Type: XMLString Max length: 128000 | The actions, and the conditions under which they are executed, which are performed when a document enters this state. |
| `user_action` | Type: XMLString 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_settings` | Type: XMLString Max length: 32000 | The actions a user, in each role, can perform when a document is in this state. |

### Doclifecycleevent

| Attribute | Metadata | Description |
| --- | --- | --- |
| `active` | Type: Boolean **Required** | Indicates whether the component is active. |
| `event` | Type: String **Required** Max length: 1500 | The type of event action. |
| `rule` | Type: XMLString **Required** Max length: 32000 | The defined rules and conditions for entry criteria, entry actions, or user actions. |
| `order` | Type: Number **Required** | The relative order in which the action displays. For example, order `1` will display before order `2`. |

### Supported Operations

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

**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.

---

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