**Source URL:** https://general.veevavault.dev/sitevault/mdl/component-types/objectworkflow.md

**Class: ** `metadata`

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

Learn about <a href="https://platform.veevavault.help/en/lr/33498" target="_blank">Object Workflows in Vault Help</a>.

| Attribute | Metadata | Description |
| --- | --- | --- |
| label | Type: StringRequiredMax length: 40 | UI-friendly string in the Vault's base language. |
| active | Type: BooleanRequired | Indicates whether the component is active. |
| object_lifecycles | Type: ComponentRequiredMulti-value | The Objectlifecycle to which this workflow belongs. The Objectlifecycle must be associated with an Object. |
| document_content_lifecycle | Type: Component | For document workflows only, the Doclifecycle to which this workflow belongs. Must be empty for all other workflow types. |
| record_content_lifecycle | Type: Component | For object workflows only, the Objectlifecycle to which this workflow belongs. Must be empty for all other workflow types. |
| description | Type: StringMax length: 255 | Description of the workflow. |
| auto_start | Type: Boolean | If true, this workflow can be auto-started from an event action or entry action. |
| envelope_name_format | Type: StringMax length: 128 | The format used to auto-number envelope workflows in Vaults where auto-numbering is configured. |
| cancellation_comment | Type: Boolean | If true, the Confirm Cancellation dialog includes a space where users can provide a reason for the cancellation. |
| workflow_variables | Type: XMLStringMax length: 32000 | Admin-defined variables which workflow initiators can select at the start of a workflow. |
| workflow_content_type | Type: EnumAllowed values:DocumentObject | Indicates the type, objects or documents, of the workflow’s contents. |
| class | Type: EnumAllowed values:ReadAndUnderstood | Indicates the classification of the workflow. |
| cardinality | Type: EnumAllowed values:OneOneOrMany | Indicates how many contents can be included in a workflow. |
| show_fields | Type: Boolean | For ReadAndUnderstood workflows created in v21.2+, if set to false, document fields are hidden and cannot be updated while the workflow is in progress. If the value is true or null, document fields are shown as usual. For workflows created in v21.1 and lower, or if class is not ReadAndUnderstood, this must be blank. |
| bound_create_draft | Type: Boolean | For document workflows only, if set to true, the Create Draft action increments the document’s minor version while the active workflow remains on the previous major document version. The default value for document workflows is false. Must be empty or null for object and R&U workflows. |
| users_can_only_complete_one_task | Type: Boolean | Indicates if users can complete more than one task in this workflow. If true, users can only complete one task in this workflow. If false, users can complete multiple tasks in this workflow. Defaults to false. |
| roles_cannot_complete_task | Type: StringMax length: 1500 | If this workflow is configured to exclude specific roles from participating, this field indicates the role names which are not allowed to participate. |
| disallowed_workflow_owner_actions | Type: EnumMulti-valueAllowed values:cancel_workflowemail_participantsremove_contentupdate_participantsupdate_workflow_due_datecancel_taskreassign_taskupdate_task_due_date | Actions not allowed for the workflow owner. |
| disallowed_non_task_owner_actions | Type: EnumMulti-valueAllowed values:cancel_workflowemail_participantsremove_contentupdate_participantsupdate_workflow_due_datecancel_taskreassign_taskupdate_task_due_date | Actions only allowed for the task owner. |
| disallowed_actions | Type: EnumMulti-valueAllowed values:cancel_workflowemail_participantsremove_contentupdate_participantsupdate_workflow_due_datecancel_taskreassign_taskupdate_task_due_date | Actions not allowed for any user. |

### Objectworkflowstep {#objectworkflowstep}

| Attribute | Metadata | Description |
| --- | --- | --- |
| label | Type: StringRequiredMax length: 40 |  |
| type | Type: EnumRequiredAllowed values:startendusertaskcontenttasknotificationplaceholderchangestatedecisionjoinactionupdaterecordfieldupdatesharingsettingsupdatedocumentsharingsettingsupdaterelatedrecordfieldcontentactionjob | The type of step. |
| next_steps | Type: ComponentMulti-value | The Objectworkflowstep to move to once this step is complete. |
| tags | Type: StringMax length: 40Multi-value | Used to determine whether the step should be canceled when short-circuiting tasks. |
| step_detail | Type: XMLStringMax length: 128000 | Details of the step configuration. |
| description | Type: StringMax length: 255 |  |

### WorkflowCancelationAction {#workflowcancelationaction}

| Attribute | Metadata | Description |
| --- | --- | --- |
| rule | Type: XMLStringRequiredMax length: 32000 | An XML String describing the workflow cancellation action rule. |
| order | Type: NumberRequired | The order in which the cancellation action is executed. |

### Supported Operations {#supported-operations}

| Operation | Support |
| --- | --- |
| Create | Yes* |
| Recreate | Yes* |
| Alter | Yes* |
| Drop | Yes |
| Rename | Yes |
| 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:** [Objectvalidation](/sitevault/mdl/component-types/objectvalidation)  
**Next:** [Overlaytemplate](/sitevault/mdl/component-types/overlaytemplate)