WorkflowState

Tracks the current workflow state of a document.

Attributes:
    workflow: Name of the workflow
    doctype: The DocType of the document in workflow
    document_name: The name/ID of the document
    current_state: Current state name in the workflow
    updated_at: When the state was last updated

Source: workflow_state.py

Fields

Field	Type	Required	Description	Validators
workflow	str		Workflow name	-
doctype	str		Target DocType	-
document_name	str		Document ID	-
current_state	str		Current workflow state	-
updated_at	datetime		Last state update timestamp	-

Permissions

Role	Create	Delete	Read	Write
System Manager	✓	✓	✓	✓
Workflow Manager	✓		✓	✓

Configuration

Setting	Value
Submittable	False
Track Changes	True

Controller

Controller hooks are implemented in *_controller.py files. Available lifecycle hooks:

• validate() - Called before save, raise exceptions for validation errors
• before_insert() - Called before inserting a new document
• after_insert() - Called after successfully inserting
• before_save() - Called before saving (insert or update)
• after_save() - Called after saving
• before_delete() - Called before deleting
• after_delete() - Called after deleting