Documentcheck
Class: metadata
Document checks are document type-specific checklist items displayed in the Document Readiness panel to help guide users in documentation reviews.
Learn more about Configuring the Document Readiness Panel in Vault Help.
| Attribute | Metadata | Description |
|---|---|---|
label | Type: String Max length: 60 | UI-friendly string in the Vault’s base language. |
active | Type: Boolean | Indicates whether the component is active. |
document_check_section | Type: ComponentReference Required | The Documentchecksection in which the document check appears. |
help_text | Type: String Max length: 255 | The text to display when users hover over the document check label in the Document Readiness panel. |
order | Type: Number Required | The relative order in which the document check appears in the document check section. |
pending_delete | Type: Boolean | If true, the document check is marked for deletion. |
Supported Operations
Section link for Supported Operations| Operation | Support |
|---|---|
| Create | |
| Recreate | |
| Alter | |
| Drop | |
| Rename | |
| Describe | |
| Generate Recreate | |
| Queryable |