The Approval Collector is an Enrollment Flow Plugin that allows for a Petition to be approved or denied by existing members of the CO.

Configuration

  1. When adding a new Enrollment Flow Step, the Plugin is CoreEnroller.ApprovalCollectors.
  2. The Actor Type should be Approver.
    1. If appropriate, an Approver Group may also be configured, see Enrollment Flow Step Approvers for more information.
  3. If Require Comment is enabled, the Approver must add a comment when approving or denying the Petition.
  4. If a Denial Message Template is selected, and an Enrollee Email was collected at the start of the Enrollment Flow, a notification will be sent to the Enrollee's email address using the Denial Message Template if the Approver denies the Petition.
  5. If configured, the Redirect on Denial URL is used to redirect the Approver after denying the Petition, it is not used for the Enrollee. If not configured, on denial the Approver is redirected to the  is redirected to the default-handoff Mostly Static Page.
    1. This configuration is needed because a denial effectively terminates the Enrollment Flow for the Petition, and no further handoffs or Steps will take place. On approval, the Enrollment Flow continues and the standard rules governing Enrollment Flow Step handoffs apply.

Usage

When the Enrollment Flow transitions to the Approval Collector Step, the Petition is placed in Pending Approval status and a Notification will be sent to the members of the Approvers Group configured for the Step. Note that while there may be multiple members of this Group, only one response is needed or expected. (To require multiple Approvers, instantiate the Plugin multiple times, each Step associated with a different Group containing one required Approver, though note that if the current Approver for a Step is also in the Approvers Group for the next step no handoff will take place.)

When the Approval Collector runs, the Approver will be able to view the entire Petition (as of the Approval Step) and an option to Approve or Deny the Petition.

If the Petition is approved, the Petition is updated to Approved status and the Enrollment Flow continues to the next configured step.

If the Petition is denied, the Petition is updated to Denied status and the Enrollment Flow terminates. The Approver is redirected to the Redirect on URL target, as configured above.

If the Enrollment Flow is configured with multiple Approval Steps, the Petition status will flip back to Pending Approval at the start of each subsequent Approval Step. In general, all Approval Steps must result in an approval for the Petition to be successful, any one denial will terminate the Petition.

(info) The Approval Collector does not perform any tasks during Finalization.

Notifying Enrollees

Enrollee Notification requires the Collect Enrollee Email setting on the Enrollment Flow to be enabled. The collected email address will generally be used for notifications sent to the Enrollee.

To notify the Enrollee on denial, use the Denial Message Template Approval Collector configuration. If this is not enabled, there will be no automatic Notification that the Petition was denied.

There is no explicit configuration to notify an Enrollee when an Approval is granted. In general, the Enrollment Flow Finalization Message Template setting on the Enrollment Flow can be used for this since Finalization implies all Approvals have been granted (and indeed, all Steps have been completed). If further action is required by the Enrollee, then a handoff to a subsequent Enrollment Flow Step with Actor Type set to Enrollee can also be used to notify the Enrollee of the Approval (along perhaps with information regarding what subsequent actions are required by the Enrollee).

See Also

Changes From Earlier Versions

As of Registry v5.2.0

  • The Approval Collector Enroller Plugin is available.
  • No labels