Identity Governance notifies users of tasks in their queue, as well as other review events, as specified in review definitions. Depending on your configuration, various events associated with functional areas, such as bulk data update, business role approval, request, review, Separation of Duties (SoD), and fulfillment, might trigger email notifications. For example, the Bulk Data Administrator can be notified when a bulk data template is generated and when a bulk data update occurs; and an SoD Policy Owner can be notified when a new SoD violation has been detected after data source collection and publication. The application supplies default templates with preconfigured tokens for the email notifications and uses the templates as is unless you customize them for your environment.
You can also customize the product name in email notifications to brand it for your organization instead of the default name of NetIQ Identity Governance. To change the product name, run the Identity Governance Configuration Utility, and enter the product name you prefer on the Identity Governance Server Details tab. For more information, see Running the Identity Governance Configuration Utility.
For information about configuring Identity Governance to send email notifications, see Configuring the Mail Server for Notifications. For information about Review related notifications, see Setting Up Review Notifications.
Identity Governance allows you to modify an XML file that contains the email text in the languages supported for Identity Governance. You can edit the XML file in one of the following programs to customize it for your organization:
XML editor
Text editor
Designer for NetIQ Identity Manager
To modify an email template content:
Log in to Identity Governance as a Global Administrator.
Select Administration > Notification Emails.
(Conditional) To customize all email templates in a single file, under email templates (all languages), select Download.
Depending on your browser settings, you might be prompted for the download path.
NOTE:If prompted, do not rename the EmailTemplates.xml file. Identity Governance cannot upload a file that does not match the expected name.
(Conditional) To customize email templates for specific functional areas, such as Bulk Data or Business Role Approval, next to View functional areas by:
Select Email Name.
Select an email name, such as Bulk Data Update Performed from the list of functional areas.
HINT:Click on an email name and then select Email source preview (en) to view the template. Enter an email address to Send notification preview.
Select Download to download the email template for the languages for your locale.
Modify the content in the email templates you have downloaded.
NOTE:Do not modify any text in the code strings in the file. Identity Governance might not function appropriately if you change the code strings incorrectly. For descriptions of the email tokens, see Email Tokens.
Save and close the files.
To submit the modified files, select the Upload icon next to email templates (all languages).
Select Save.
When customizing emails be careful in handling the tokens. Some email templates expect only certain processing tokens. Therefore, the product might not be able to replace a token with a value in some situations. In these situations, the template contains blank values when unexpected tokens are present. Notifications sent during review preview mode that enable administrators and review owners to preview notifications, might also not always replace tokens with values, and names seen in the preview might not be the name that is sent in the live mode email.
The email templates use the following processing tokens:
|
Token |
Notes |
|---|---|
|
applicationId |
Application ID, unused in the Certification External Provisioning Start Error template |
|
applicationName |
Application name |
|
appName |
Application name |
|
approverName |
Business role approver |
|
certifierFullName |
Reviewer's full name |
|
certifyTaskLink |
Link to task |
|
changesetId |
Unused in the Certification External Provisioning Start Error template |
|
content |
Used in the generic email template |
|
curatorFullName |
Bulk data feed curator |
|
error |
Fulfillment error |
|
errorMessage |
Error message text |
|
externalPrdLink |
Unused in the Certification External Provisioning Start Error template |
|
feedName |
Bulk data update definition |
|
fulfillerName |
Full name of the fulfiller |
|
host |
The workflow hostname |
|
inputFile |
Bulk data CSV file |
|
link |
URL link |
|
message |
The output message from a system process. |
|
newTaskType |
Used in the Certification Auto Provisioning Start Failed template |
|
ownerName |
Owner of the SoD policy |
|
permissionsToLose |
List of application permissions |
|
prdName |
Workflow name used in the external fulfillment template |
|
prevReviewerFullName |
User that the task was reassigned from |
|
productName |
Configured product name, such as Identity Governance or Access Review |
|
reassignedByFullName |
User who reassigned the task |
|
reassignComment |
Optional comment entered at reassignment |
|
retryCount |
Number of fulfillment items in a retry state |
|
reviewLink |
URL link to review |
|
reviewName |
Name of the review |
|
reviewOwner |
Review owner’s name |
|
reviewOwnerPhone |
Review owner’s phone number |
|
roles |
List of business approval roles |
|
subject |
Found in Certification Started and Certification Changed email templates with no reference to the token in the templates. |
|
taskTimeoutDays |
Task timeout in days |
|
theTerminator |
The user that terminated a review |
|
userFullName |
Identity Governance user's full name |
|
violations |
Used in the Detected SoD Violation email template. |
In addition to modifying an email template, you can also add an image or logo to the email template.
To add an image to the email template:
Select the image you want to add to the template and encode it in base64 string format.
HINT:Use base64encode website or similar encoders to encode the image.
Download email template.
Add the <img src="data:image/png;base64, %base64-value% "/>tag where you want the image to appear. For example, <p>Powered by <img src="data:image/png;base64,iVBORw0KAAA..."/></p>.
Upload the modified file.