**Source URL:** https://general.veevavault.dev/commercial/mdl/component-types/docparticipantrule.md

# Docparticipantrule

**Class: ** `metadata`

Workflow participant rules control which document fields will force the selected role to be required or hidden in the workflow start dialog.

Learn about <a href="https://platform.veevavault.help/en/lr/31851#wf-participant-rules" target="_blank">Workflow Participant Rules in Vault Help.</a>

| Attribute | Metadata | Description |
| --- | --- | --- |
| lifecycle | Type: ComponentRequired | The document lifecycle the rule applies to. |
| role | Type: ComponentRequired | The lifecycle role the rule applies to. |
| active | Type: BooleanRequired | Indicates whether the component is active. |
| description | Type: StringMax length: 255 | A general description of the rule. |
| label | Type: StringRequiredMax length: 60 | UI-friendly string in the Vault's base language. |

### Docparticipantcriterion {#docparticipantcriterion}

| Attribute | Metadata | Description |
| --- | --- | --- |
| object_field | Type: ComponentRequired | The field of the object the rule is defined on. |
| data_field | Type: ComponentRequired | The field on the document the rule is defined on. |
| object | Type: ComponentRequired | The Object the participant rule is defined on. This can only be workflow_role_setup__v. |

### Supported Operations {#supported-operations}

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


---

**Previous:** [Docmatchingrule](/commercial/mdl/component-types/docmatchingrule)  
**Next:** [Docrelationshiptype](/commercial/mdl/component-types/docrelationshiptype)