Workitem Change Notifications

Workitem change notification includes following additional data:

Field Description Data Type Valid Values
UserID Unique ID of the user who made the change. Long  
UserName Login name of the user. String  
EventID Associated event ID. Long  
WorkitemID ID of the work item affected. Long  
State New state of the work item. String OPEN, CLOSED, CLOSED_PENDING, CLOSED_PARALLEL, REASSIGNED, CLOSED_CANCELLED, CANCELLED, and OPEN_TIMEDOUT
OldState Old state of the work item. String  
  • When a workitem is created using the CreateWorkItem activity, a CREATED notification is generated for each workitem.
  • Reassigning the workitem generates two or more notifications:
    • The workitem which is reassigned is closed (notification is generated with action = REASSIGNED)
    • New workitems created as a result of reassignment generate CREATED events.
  • When a workitem is closed, the status of the workitem changes to CLOSED_PENDING to register the request. This triggers a STATE_CHANGE event. Immediately, when the workitem is actually closed, another STATE_CHANGE event is generated. As these are two discrete state change requests, if the second state change notification is not received, it indicates that the workflow could not be closed successfully.
  • When a workitem times out, STATE_CHANGE message is generated.
  • When workitem expiry date is recomputed for timeout method = COMPUTE, no notification event is generated.
  • When workitems are cancelled, CANCELLED notification is generated. Cancellation happens through the ManageWorkItem Activity (which may be called when a workflow is cancelled).