setCOmanage Registry provides various notification messages that can be customized. These messages support substitutions, or tokens that can be replaced with content appropriate to the message context. Substitutions are available for the relevant message subject as well as the message body.
A substitution is made by taking the relevant string, such as CO_NAME
, and prefixing it with an @
and embedding it within parentheses. This will generate a token like (@CO_NAME)
.
Substitution Availability
Substitution | Description | Enrollment Flow1,2 | Expiration Policy2 | Authenticators and Self Service Dashboard Widgets | Other Notifications3 |
---|---|---|---|---|---|
| The name of the CO Person who caused an action to happen | ||||
APPROVER_COMMENT |
As of v3.3.0 | ||||
AUTHENTICATOR | The description of the Authenticator | ||||
| The name of the CO | ||||
| The name of the subject CO Person | ||||
CO_PERSON_ID | The CO Person ID of the subject | As of v4.1.0 | As of v4.1.0 | ||
| Comment, or brief event description, as registered in the notification | ||||
| Number of days since expiration of subject CO Person Role | ||||
| Number of days until expiration of subject CO Person Role | ||||
IDENTIFIER:x | Identifier of type x associated with CO Person. The type matches the Name, not the Display Name, of the Identifier, as configured via Extended Types. If more than one identifier is found, they will be joined together with commas. Note that identifiers generated via Identifier Assignments during enrollment will only be assigned by and available for Finalization Notifications. | As of v2.0.0 | As of v2.0.0 | As of v4.1.0 Password Authenticators only | |
INVITE_URL | For invitation confirmation, the URL the recipient should click on to reply | ||||
LINK_EXPIRY | Expiration time of link | ||||
| Updated (new) affiliation for subject CO Person Role | ||||
| Updated (new) COU for subject CO Person Role | ||||
| Updated (new) status for subject CO Person Role | ||||
| URL for more information about the notification | ||||
| Current (old) affiliation for subject CO Person Role | ||||
| Current (old) COU for subject CO Person Role | ||||
| Current (old) status for subject CO Person Role | ||||
| Description of expiration policy that matched | ||||
RESET_URL | URL for self service Authenticator reset | ||||
| URL for the item that caused the notification | ||||
| Name of CO Person sponsor for subject CO Person Role | ||||
SPONSOR_ID | CO Person ID for sponsor of subject CO Person Role | As of v4.1.0 | As of v4.1.0 | ||
| Title of subject CO Person Role | ||||
TOKEN | Token for Email Address confirmation | ||||
| Valid from date for subject CO Person Role | ||||
| Valid through date (original, not cleared/updated) for subject CO Person Role |
1 Invitation/verification/confirmation email and Approval/Denial notification sent to Enrollee as part of Enrollment Flow.
2 Email Message Templates are supported.
3 Other notifications. These do not support Message Templates, but can be localized.