Workflow Definition Events

The events in this category occur when a workflow definition is active.

Workflow Event Sequences

The events that occur for the workflow definition commands are shown in the following lists in the sequence that they occur.

Execute transition event sequence

DocGenericEvent_PrepareCommand ¹
DocCWFEvent_PreInitializeExecuteTransition ²
DocCWFEvent_InitializeExecuteTransition
DocCWFEvent_InitializeWizard
DocGenericEvent_OnProperties
DocCWFEvent_TerminateWizard
DocCWFEvent_PreBeforeExecuteTransition
DocCWFEvent_BeforeExecuteTransition
DocCWFEvent_BeforeNewRevision
DocCWFEvent_AfterNewRevision
DocCWFEvent_TerminateNewRevision
DocCWFEvent_AfterExecuteTransition
DocWorkflowEvent_AfterReplaceReleased
DocCWFEvent_TerminateExecuteTransition

Notes

Occurs in PowerUser only.
Occurs in PowerWeb only.

Reassign Managers event sequence

Reroute event sequence

DocCWFEvent_*ExecuteTransition Events

Occurs when a workflow definition transition is executed.

Syntax

DocCWFEvent_*ExecuteTransition(Batch, Transition, Person, Manager, Comment)

Parameters
Name	Description
Batch	An object that represents the batch of documents the user has selected.
Transition	A WorkflowTransition object that represents the transition to execute.
Person	An object that represents the user who is executing the transition.
Manager	An object that represents the user who is the manager of the workflow.
Comment	A string containing the text entered by the user who is executing the transition.

Remarks

This set of events is intended to support user input to a batch process using the Batch.Confirmation Method and its related methods and properties as follows:

The user initiates a workflow transition on a batch of documents
DocCWFEvent_PreInitializeExecuteTransition event is executed and any changes to the event parameters are ignored. Not supported by PowerUser.

Any batch scope confirmations are shown at this time.
DocCWFEvent_InitializeExecuteTransition is executed and any changes to the event parameters are processed.

Any batch scope confirmation results can be queried in script.
For each document in the batch:
- DocCWFEvent_PreBeforeExecuteTransition is executed and any changes to the event parameters are ignored. Not supported by PowerUser.
  
  Any document scope confirmations are shown at this time. The document name is visible to the user.
- DocCWFEvent_BeforeExecuteTransition is executed and any changes to the event parameters are processed.
  
  Any document scope confirmation results can be queried in script.
- DocCWFEvent_AfterExecuteTransition is executed and any changes to the event parameters are ignored.
- DocCWFEvent_TerminateExecuteTransition is executed and any changes to the event parameters are ignored.

DocCWFEvent_*Wizard Events

Occurs when property pages are shown by a transition of the workflow.

Syntax

DocCWFEvent_*Wizard(Batch, Transition, Comment)

Parameters
Name	Description
Batch	An object that represents the batch of documents the user has selected.
Transition	A WorkflowTransition object that represents the transition that is showing the property pages.
Comment	A string that represents the default comment to add to the comment log.

DocCWFEvent_*NewRevision Events

Occurs when a new revision is created by a transition of the workflow.

Syntax

DocCWFEvent_*NewRevision(Batch, Transition)

Parameters
Name	Description
Batch	An object that represents the batch of documents the user has selected.
Transition	A WorkflowTransition object that represents the transition that is creating the new revision.

DocCWFEvent_*Reroute Events

Occurs when a workflow is rerouted to a state other than a default destination state.

Syntax

DocCWFEvent_*Reroute(Batch, State, Person, Comment)

Parameters
Name	Description
Batch	An object that represents the batch of documents the user has selected.
State	An object that represents the destination state.
Person	An object that represents the user who is rerouting the documents.
Comment	A string containing the text entered by the user who is rerouting the documents.