E-mail Template Example for the Self-Service Console E-mail Template Example for the Self-Service Console
The following example shows the default e-mail template for an account change with customized changes indented.
Recent account change:${MailComposer.NL}${MailComposer.NL}
Account change: ${MailComposer.RequestType}${MailComposer.NL}
Performed by: #(${Principal.UserID})${MailComposer.NL}
Date of account change: ${MailComposer.RequestDate}${MailComposer.NL}${MailComposer.NL}
If you have not authorized this change, contact your administrator with the information in this e-mail.
E-mail Template Tag Syntax E-mail Template Tag Syntax
The syntax for e-mail template tags is:
${objectname.propertyname}
where:
-
objectname is the name of a Self-Service object.
-
propertyname is the property name of the object.
For example:
${Principal.UserID}
is the user’s identification.
Note: Do not modify e-mail tag syntax, for example, ${objectname.propertyname}.
E-mail Template Tag Default Values E-mail Template Tag Default Values
Use the default e-mail template tags to customize the e-mail notifications. The following table lists the e-mail template tags and a description of each.
Object Name |
Property Name |
Type |
Description |
Conditional Statement Support |
Principal |
UserID |
String |
User ID (request approver, token distributor, or user). |
Yes |
Principal |
FirstName |
String |
User first name (request approver, token distributor, or user). |
Yes |
Principal |
LastName |
String |
User last name (request approver, token distributor, or user). |
Yes |
Principal |
MiddleName |
String |
User middle name (request approver, token distributor, or user). |
Yes |
Principal |
|
String |
User e-mail address (request approver, token distributor, or user). |
Yes |
Principal |
LastLogin |
Date |
Date of user's last login. |
No |
Principal |
isEnabled |
boolean |
User account is enabled of disabled. |
Yes |
UCMRequest |
CreatedBy |
String |
User who created the request. |
No. Use Principal UserID instead. |
UCMRequest |
CreatedOn |
Date |
Date the request was created. |
No |
UCMRequest |
ModifiedBy |
String |
User who made the last change to the request. |
No |
UCMRequest |
ModifiedOn |
Date |
Date when the request was modified. |
No |
UCMRequest |
Status |
int |
Status of the request. The request statuses and their values are: Open - 1 Complete - 2 Cancelled - 3 Error - 5 Rejected - 6 Approved - 7 Distributed - 8 The request status does not change until the final step in the workflow. In a token workflow that requires approval only, the “Approved - 7” status indicates that the token is issued. In a workflow with multiple steps, an intermediate approval from a Request Approver does not change the request status. The final distribution from a Token Distributor changes the status to “Distributed - 8.” |
Yes |
UCMRequest |
ConfirmNumber |
String |
Confirmation number of request. |
Yes |
SecurityDomain |
ParentName |
String |
Parent security domain of this security domain instance. System names appear in e-mails, rather than the display names you create. |
Do not use if there is no parent domain. |
SecurityDomain |
Name |
String |
Name of the security domain. System names appear in e-mails, rather than the display names you create. |
Yes |
IdentitySource |
Name |
String |
Name of the identity source. System names appear in e-mails, rather than the display names you create. |
Yes |
MailComposer |
RequestDate |
String |
Date of request. |
Yes |
MailComposer |
RequestType |
String |
Type of request. |
Yes |
MailComposer |
WorkflowParticipantConsoleURL |
String |
URL for the Security Console. |
No |
MailComposer |
RejectionDate |
String |
Date request was rejected. |
No |
MailComposer |
ApprovalDate |
String |
Date request was approved. |
No |
MailComposer |
GroupName |
String |
Group name of requested group name. System names appear in e-mails, rather than the display names you create. |
Yes |
MailComposer |
SelfServiceConsoleURL |
String |
URL for the Self-Service Console. Specified on the E-Mail Notifications for User Account Changes page. |
No |
MailComposer |
TokenType |
String |
For hardware tokens, this is the display name set in the Manage Authenticators page of the Security Console. For software tokens, this is the device type specified in the software token profile. |
Yes |
MailComposer |
CtkipCode |
String |
CT-KIP token activation code. |
Yes |
MailComposer |
CtkipURL |
String |
URL to import token using CT-KIP (URL will be formatted appropriately based on the device type). |
No |
MailComposer |
EnablementURL |
String |
URL to enable a disabled token. |
No |
MailComposer |
EnablementCode |
String |
Code to enable a disabled token. |
Yes |
MailComposer |
SerialNumber |
String |
Serial number of token. |
Yes |
MailComposer |
DownloadURL |
String |
URL to download the software token client application. Specified on the Manage Authenticators page in the Application Installation Download URL field. |
No |
MailComposer |
HelpLink |
String |
Help link for the software token device. Specified on the Manage Authenticators page by the Device Help Document URL. |
No |
MailComposer |
SmsOttURL |
String |
URL to download the on-demand tokencode. |
No |
MailComposer |
NL |
String |
Adds a new line. Do not use in conditional statements. |
No |
MailComposer |
ReasonEnteredByWorkflowParticipant |
String |
Reason that approver rejected request. |
Yes |
MailComposer |
AdditionalEmailComments |
String |
Comments added by workflow participant when resending e-mails to users. |
Yes |
MailComposer |
ReasonForFailure |
String |
Reason request failed. |
Yes |
MailComposer |
TokenTypeCtkip |
Boolean |
Checks if token type uses CT-KIP. |
Yes |
MailComposer |
ParticipantMailID |
String |
List of workflow participants' mail IDs. For example, dsmith@acme.com, gjones@acme.com |
Yes |
MailComposer |
ApprovalDetails |
String |
Comments entered by administrators. |
No |
MailComposer |
RequestHistory |
String |
Steps in a request. The steps used to complete a request and the status. For example: <ActivityName> - <ActivityStatus> on <date&time> by <userID>. Comments to user: <comments> |
No |
MailComposer |
TokenTypeCTF |
Boolean |
Checks if token type uses CTF. |
Yes |
MailComposer |
CtfString |
String |
URL to import token using CTF. |
No |