The events in the DocWorkflowEvent category allow you to customize the actions performed by the workflows configured for document types.
Document Type Workflow Event Sequences
The events that occur for the document type workflow commands are shown in the following lists in the sequence that they occur.
Change To-Do Person event sequence
-
DocGenericEvent_PrepareCommand
-
DocWorkflowEvent_InitializeChangeWFPerson
-
DocWorkflowEvent_BeforeChangeWFPerson
-
DocWorkflowEvent_AfterChangeWFPerson
-
DocWorkflowEvent_TerminateChangeWFPerson
Change Workflow Manager event sequence
-
DocGenericEvent_PrepareCommand
-
DocWorkflowEvent_InitializeChangeWFManager
-
DocWorkflowEvent_BeforeChangeWFManager
-
DocWorkflowEvent_AfterChangeWFManager
-
DocWorkflowEvent_TerminateChangeWFManager
Execute transition event sequence
-
DocGenericEvent_PrepareCommand
-
DocWorkflowEvent_InitializeChangeWFState
-
DocWorkflowEvent_BeforeChangeWFState
-
DocWorkflowEvent_AfterChangeWFState
-
DocWorkflowEvent_TerminateChangeWFState
Revoke event sequence
-
DocGenericEvent_PrepareCommand
-
DocWorkflowEvent_PreInitializeRevokeWF
-
DocWorkflowEvent_InitializeRevokeWF
-
DocWorkflowEvent_PreBeforeRevokeWF
-
DocWorkflowEvent_BeforeRevokeWF
-
DocWorkflowEvent_AfterRevokeWF
-
DocWorkflowEvent_TerminateRevokeWF
DocWorkflowEvent_*ChangeWFManager Events
Occurs when the manager of a document type workflow is manually changed to a different user.
Syntax
DocWorkflowEvent_*ChangeWFManager(Batch, Person)
| Name | Description |
|---|---|
|
Batch |
An object that represents the batch of documents the user has selected. |
|
Person |
An object that represents the user that is selected as the new workflow manager. |
DocWorkflowEvent_*ChangeWFPerson Events
Occurs when the to-do person of a document type workflow is manually changed to a different user.
Syntax
DocWorkflowEvent_*ChangeWFPerson(Batch, Person, Comment)
| Name | Description |
|---|---|
|
Batch |
An object that represents the batch of documents the user has selected. |
|
Person |
An object that represents the user that is selected as the new workflow manager. |
|
Comment |
A string that contains the comment entered by the user that is assigning the to-do person. |
DocWorkflowEvent_*ChangeWFState Events
Occurs when a document type workflow is routed to a different state.
Syntax
DocWorkflowEvent_*ChangeWFState(Batch, TargetState, Person, Comment)
DocWorkflowEvent_*RevokeWF Events
Occurs when a document type workflow is revoked by a user.
Syntax
DocWorkflowEvent_*RevokeWF (Batch)
| Name | Description |
|---|---|
|
Batch |
An object that represents the batch of documents the user has selected. |
Remarks
The PreBeforeRevokeWF event is used to add a confirmation page before the revoke a document workflow action, and the PreInitializeRevokeWF event is used to add a confirmation page before initializing the action.
Learn how to create confirmation pages. You can also see examples of this functionality in this Knowledgebase article.
AfterReplaceReleased Event
Occurs for a document after a document that replaced it has been released from a workflow.The released document must have been made by the Replace Document command.
Syntax
AfterReplaceReleased (Batch, ReplacingDoc)
| Name | Description |
|---|---|
|
Batch |
An object that represents the batch of documents the user has selected. |
|
ReplacingDoc |
An object that represents the document that is being released. |
Remarks
This event occurs after all other events for the document. It can be used to perform such actions as:
