Creating Message Templates
COmanage Registry v2.0.0 introduces Message Templates, which allow for notification and email messages to be specified once and reused in multiple instances of a supported context. Available contexts are:
- Enrollment Flow Invitation (as of Registry v3.2.0)
- Enrollment Flow Verification (prior to Registry v4.0.0, used for Invitation/Confirmation)
- Enrollment Flow Approval Notification (to the Enrollee; as of Registry v3.3.0 this context can also be used for denials)
- Enrollment Flow Finalization
- Expiration Notification
So, for example, a given confirmation message can be defined once and then attached to multiple Enrollment Flows.
Message Templates support Notification Message Substitutions.
If a Message Template is set to Suspended, it cannot be added to new context instances but will continue to be used by any instances to which it is already attached.
Message Templates
COmanage Registry has Message Templates, which allow for notification and email messages to be specified once and reused in multiple instances of a supported context. Available contexts are:
- Enrollment Flow Invitation
- Enrollment Flow Verification (prior to Registry v4.0.0, used for Invitation/Confirmation)
- Enrollment Flow Approval Notification (to the Enrollee; as of Registry v3.3.0 this context can also be used for denials)
- Enrollment Flow Finalization
- Expiration Notification
So, for example, a given confirmation message can be defined once and then attached to multiple Enrollment Flows.
Message Templates support Notification Message Substitutions.
If a Message Template is set to Suspended, it cannot be added to new context instances but will continue to be used by any instances to which it is already attached.
Notification Message Substitutions
COmanage 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 flow [1,2] | Expiration Policy [2] | Other Notifications [3] |
|---|---|---|---|---|
| ACTOR_Name | The name of the CO Person who caused an action to happen | (tick) Approval/Denial only | (tick) | (tick) |
| APPROVER_COMMENT | (tick) Approval/Denial only | |||
| CO_NAME | The name of the CO | (tick) | (tick) | (tick) |
| CO_PERSON | The name of the subject CO Person | (tick) | (tick) | |
| COMMENT | Comment, or brief event description, as registered in the notification | (tick) Approval/Denial only | (tick) | (tick) |
| DAYS_SINCE_EXPIRY | Number of days since expiration of subject CO Person Role | (tick) | ||
| DAYS_TO_EXPIRY | Number of days until expiration of subject CO Person Role | (tick) | ||
| 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. | (tick) | (tick) | |
| INVITE_URL | For invitation confirmation, the URL the recipient should click on to reply | (tick) Invitation only | ||
| NEW_AFFIL | Updated (new) affiliation for subject CO Person Role | (tick) | ||
| NEW_COU | Updated (new) COU for subject CO Person Role | (tick) | (tick) | |
| NEW_STATUS | Updated (new) status for subject CO Person Role | (tick) | ||
| NOTIFICATION_URL | URL for more information about the notification | (tick) Approval/Denial only | (tick) | (tick) |
| ORIG_AFFIL | Current (old) affiliation for subject CO Person Role | (tick) | ||
| ORIG_COU | Current (old) COU for subject CO Person Role | (tick) | ||
| ORIG_STATUS | Current (old) status for subject CO Person Role | (tick) | ||
| POLICY_DESC | Description of expiration policy that matched | (tick) | ||
| SOURCE_URL | URL for the item that caused the notification | (tick) Approval/Denial only | (tick) | (tick) |
| SPONSOR | Name of CO Person sponsor for subject CO Person Role | (tick) | (tick) | |
| TITLE | Title of subject CO Person Role | (tick) | ||
| VALID_FROM | Valid from date for subject CO Person Role | (tick) | ||
| VALID_THROUGH | Valid through date (original, not cleared/updated) for subject CO Person Role | (tick) |
[1] Invitation/verification/confirmation email and Approval/Denial notification sent to Enrollee as part of Enrollment Flow. [2] Message Templates are supported. [3] Other notifications. These do not support Message Templates, but can be localized.
Copyright (C) 2018-2020 University Corporation for Advanced Internet Development (Internet2) - All Rights Reserved