The Invitation Accepter is an Enrollment Flow Plugin that permits an invited Enrollee to accept or decline participation in the CO.

Configuration

  1. When adding a new Enrollment Flow Step, the Plugin is CoreEnroller.InvitationAccepters.
  2. The Actor Type should be Enrollee.
  3. The Invitation Validity is specified in minutes, a value of 0 means invitations do not expire.
    1. (warning) Reissuing an expired invitation is not yet supported.
  4. The Welcome Message is rendered when the Enrollee views the Invitiation.

(info) The Invitation Accepter is designed to be used only once per Enrollment Flow. A Petition can not have multiple Invitation Acceptance actions.

Usage

When the Enrollment Flow transitions to the Invitation Accepter step, the Petition is placed in Pending Acceptance status. When the Invitation Accepter runs, the Enrollee will be presented with the Welcome Message and an option to Accept or Decline the invitation.

If the invitation is accepted, the Petition is updated to Accepted status and the Enrollment Flow continues to the next configured step.

If the invitation is declined, the Petition is updated to Declined status and the Enrollment Flow terminates. The Enrollee is redirected to the petition-complete Mostly Static Page.

See Also

Changes From Earlier Versions

As of Registry v5.1.0

  • Invitation Confirmer Plugins are no longer supported. Deployments can write a completely custom plugin (optionally based on Invitation Accepter) and modify it to suit their needs without needing to use the out-of-box Invitation Accepter.

Invitation Accepter was not available in Registry v5.0.x.

  • No labels