Associating Templates with Events

Email templates are associated to their respective email-generating events in several places in the IdentityIQ user interface and configuration XML. The information below shows the notification type, the default template name, and their association location. To use a custom template for any of these notifications, specify the custom template name in place of the default template in that notification configuration.

For details about the arguments which are provided by default to all instances of email messages sent as part of IdentityIQ's core processes, see the Email Template Arguments technical white paper on Compass.

Note: HTML cannot be passed into a template as an argument value. All HTML must be included as part of the base template.

Note: Different email templates accept and use different arguments. The selection lists in the user interface for each notification lists all email templates, no matter what arguments they require. Because IdentityIQ provides a fixed set of arguments for each notification type, only templates whose arguments list matches the provided arguments work correctly to create a useful event notification. Refer to the default template XML to see the arguments (names and variable types) for each notification, and ensure that the selected template's argument list matches the default template's arguments.

The following templates can be configured in the Gear icon > Global Settings > IdentityIQ Configuration > Notification Settings > NotificationsTemplates section.

Server Root Path

The root path of the server, including the scheme, server name [port], and root directory. For example, if the value was set to https://localhost:80/iiq, then the expected URL would look like <serverrootpath>/example.jsf or https://localhost:80/iiq/example.jsf

Templates

For reminder notices

Work Item Reminder

For escalation notices

Work Item Escalation

For work item comment notices

Work Item Comment

For work item forwarding notices

Work Item Forward

For policy violation notices

Policy Violation

For task and report signoff notices

Task Result Signoff

For work item assignment notices

Work Item Assignment

For work item assignment removal notices

Work Item Assignment Removal

For remediation item assignment notices

Remediation Item Assignment

For remediation item assignment removal notices

Remediation Item Assignment Removal

For delegation notices

Delegation

For delegation finished notices

Delegation Finished

For delegation revocation notices

Delegation Revocation

For remediation work item notices

Remediation Work Item

For certification reminder notices

Certification Reminder

For policy violation delegation notices

Policy Violation Delegation

For open certifications notices

Open Certifications

For access request reminder notices

Access Request Reminder

For notice of deprovisioning of sunsetted roles and entitlements

Sunset Expiration Reminder

These notifications are used with Certifications. Navigate to gear icon > Compliance Manager and scroll down to the Notification Templates section.

Note: When the challenge period is enabled, Challenge-related notification email templates can be overwritten for individual certifications on the Lifecycle page in each certification configuration.

Note: Initial Notification and Bulk Reassignment notices can be overwritten for each certification on the Notifications page in each certification configuration.

Suppress Initial Notifications

Check this option if you do not want to send initial notification emails to certifiers. This sets the default initial notification behavior at a global level, but you can still change it for an individual certification campaign as needed.

Templates

Initial Notification Email Template

Certification

Exceptions Expiration Notices

Mitigation Expiration

Bulk Reassignment Modification notices

Bulk Reassignment

Challenge Period Start Notices to Challengers

Challenge Period Start

Challenge Period End Notices to Certifiers

Challenge Period End

Challenge Creation Notices to Challengers

Challenge Creation Notification

Challenged Decision Notices to Certifiers

Certification Decision Challenged Notification

Challenge Expiration Notices to Challengers

Challenge Expiration

Challenge Decision Expiration Notices to Challengers and Certifiers

Challenge Decision Expiration

Challenge Accepted Notices to Challengers

Challenge Accepted

Challenge Rejected Notices to Challengers

Challenge Rejected

Sign-off Approval Notices to Approvers

Certification Sign-off Approval

These are set in the Notifications step in each certification configuration when the associated reminder or escalation option is enabled.

Reminder Email Template

Work Item Reminder

Escalation Email Template

Work Item Escalation

(Revocation) Reminder Email Template

Work Item Reminder

(Revocation) Escalation Email Template

Work Item Escalation

Note: Because this is cumbersome, you might choose to edit the Default Report Template directly rather than cloning it. This customization must be reapplied after any IdentityIQ version upgrade, as it is overwritten during the upgrade process.

Not specified in the user interface. When a report is defined, its XML can be edited to add an emailTemplateId argument to change the email message template.

Configured in report specification if Require Signoff is selected when the report is defined.

Report signoff initial notification

Task Result Signoff

Report signoff reminder notice

No default in UI but argument list matches Work Item Reminder

Report signoff escalation notice

No default in UI but argument list matches Work Item Escalation

Send PDF of report to someone

Default Report Template

Email templates may be specified within workflow definitions in Setup >Business Processes as a process variable, step argument, or work item configuration email notification template.

Note: For templates referenced from a workflow, all workflow variables, and all steps arguments and approval arguments defined for the step that invokes the email template are also available for use in the email message (subject, body, cc, etc.).

Various Process Variables and Step Arguments

LCM Requester Notification

LCM Manager Notification

LCM User Notification

Approval Work Item Configuration Email Notification Template

LCM Identity Update Approval

The following workflows (including sub-processes) use these templates:

  • Identity Correlation

  • Do Manual Actions

  • Do Provisioning Forms

  • Assimilate Provisioning Form

  • Provisioning Approval Subprocess

  • Identity Request Notify

  • Identity Request Provision

  • LCM Create and Update

  • LCM Manage Passwords

  • LCM Provisioning

  • Lifecycle Event – Leaver

  • Lifecycle Event Reinstate

  • Role Modeler – Impact Analysis

  • Role Modeler – Owner Approval

The following templates do not include a Type in their XML definitions, so they may be used in various workflows: 

  • LCM Pending Manual Changes

  • LCM Password Change Notification

  • Pending Manual Changes

  • Account Selection Notification

  • Provisioning Form Notification

  • Role Modeler – Approval

  • Role Modeler – Impact Analysis Review

XML email templates cannot be configured through the user interface, they can only be edited through the email template's XML.

From IdentityIQ Debug Pages > Object Browser, select the EmailTemplate object, then select the individual template to edit.

Important: There is no rollback mechanism for edits to objects that are saved in the Debug pages. Although objects can be viewed and edited in the Debug pages, it is a best practice to export or check out the object, edit the XML as needed outside of IdentityIQ, and then import the updated object to a test environment for validation before importing into your production instance. This also allows you to manage your changes in a source control system, to facilitate rollback. Use caution when editing objects in the Debug pages, as there is no mechanism in the Debug pages for rolling back changes once they have been saved.

To edit a template's value in your implementation, select the Configuration object, then System Configuration and search the XML for these email template names or key values:

key=delegationEmailTemplate

Delegation

key=delegationRevocationEmailTemplate

Delegation Revocation

key=delegationFinishedEmailTemplate

Delegation Finished

key=remediationEmailTemplate

Remediation Work Item

key=remediationNotificationEmailTemplate

Remediation Notification

Sent when Notify Users of Revocations is selected in a certification configuration.

key= certificationReminderEmailTemplate

Certification Reminder

Sent on demand from certification.

key= policyViolationDelegationEmailTemplate

Policy Violation Delegation

key= AccountGroupPermissions. challengeGenerationEmailTemplate

Account Group Challenge Creation Notification

Specialized form of the Challenge Creation Notification email

key= accessRequestReminderEmailTemplate

Access Request Reminder

Sent on demand from the Access Requests page

key=openCertsEmailTemplate

Open Certifications