Events

The Review, Commenting, and Approval building block provides custom events that you can use in custom processes that you create. Do not modify the custom events because they are critical for building block to function correctly. A schema file is available for each event that defines the event data. The schema files for the events are found in the ReviewCommentingAndApproval application in the resources/schemas folder. (See Schema files under ReviewCommentingAndApproval/resources/schemas .)

The following events are available:

AddApproverEvent:

Thrown when an approver is added to an approval stage during a review. The AddApproverEventData.xsd file defines the schema for the event data.

AddReviewerEvent:

Thrown when a reviewer is added to a review stage during a review. The AddReviewerEventData.xsd file defines the schema for the event data.

ApproverAssignTaskEvent:

Thrown when a task is assigned to approver. The ApproverAssignTaskEventData.xsd file defines the schema for the event data.

ApproverDecisionEvent:

Thrown when an approver completes their approver task. The ApproverDecisionEventData.xsd file defines the schema for the event data.

RemoveApproverEvent:

Thrown when an approver is removed from an approval stage during a review. The RemoveApproverEventData.xsd file defines the schema for the event data.

RemoveReviewerEvent:

Thrown when a reviewer is removed from a review stage during a review. The RemoveReviewerEventData.xsd file defines the schema for the event data.

ReviewCompleteEvent:

Thrown when a review completes. The review can complete when all the stages complete, if a stage expired, or if the review was revoked. The ReviewCompleteEventData.xsd file defines the schema for the event data.

ReviewerAssignTaskEvent:

Thrown when a reviewer is assigned reviewer task. The ReviewerAssignTaskEvenData.xsd file defines the schema for the event data.

ReviewerDecisionEvent:

Thrown when a reviewer completes the review task. The ReviewerDecisionEventData.xsd file defines the schema for the event data.

StageCompleteEvent:

Thrown when a stage completes. A stage completes when all mandatory participants complete their tasks, if the stage expired, or if the stage was revoked. Status attributes in the event data can be used to determine the reason for the stage completion. The StageCompleteEventData.xsd file defines the schema for the event data.

StageStartEvent:

Thrown when a stage starts. There is no review start event. Use the StageStartEvent for the first stage perform any processing required when the review starts. The StageStartEventData.xsd file defines the schema for the event data.

UpdateStageDurationEvent:

Thrown when a stage duration is updated. The UpdateStageDurationEventData.xsd file defines the schema for the event data.

Only the ReviewCompleteEvent is thrown by default. To use all the events, then enable the Throw LiveCycle Events option in the ReviewCommenting & Approval Core service using the Components view in Workbench.