Skip to content

IdentityIQ Email Templates

Many events in IdentityIQ generate email notifications to notify users of actions required by them or actions taken that directly affects them. These email messages are created based on email templates. Basic templates are provided with the product to construct messages corresponding to each of the email-generating events, and these messages can be customized to meet your specific needs.

Note

The default email templates should not be modified directly because they might be overwritten during the IdentityIQ release upgrade process.

To customize any of these templates, copy and rename the template using a unique name.

  1. Copy and rename the template using a unique name.

  2. Associate the customized template to the email-generating event through the IdentityIQ user interface or configuration XML. See Importing Email Templates (link) into IdentityIQ.

Accessing the Templates

The default email templates that ship with the product are located in the following area:

  • Directory – iiq_installation_directory/WEB-INF/config directory where iiq_installation_directory is the location where you expanded the IdentityIQ installation media

  • Files – emailtemplates.xml and lcmemailtemplates.xml

A third file, named emailtemplatesSample.xml, contains additional example templates that are not loaded into IdentityIQ during the initial load process. These templates describe how to create HTML email messages. Any of the templates in these files can be cloned to create custom templates.

After the email templates are loaded into IdentityIQ, either during the initial load or using the console or user interface import option, the templates are stored as XML objects. The templates can be viewed or modified through the IdentityIQ Debug pages. The default templates should not be modified from here because the template are overwritten during any IdentityIQ version update. However, customized templates can be edited directly through the Debug pages, if the organization's source code control procedures allows.

To view the list of email templates from the Debug pages, select EmailTemplate from the object list and click List. Select the desired template to view or edit its XML representation.

Importing Email Templates into IdentityIQ

When email templates are edited outside of IdentityIQ, they must be imported into the system before they can be used for any notifications. Email templates can be imported through the IdentityIQ user interface or console.

To import a template through the user interface, navigate to the gear icon > Global Settings > IdentityIQ Configuration > Import from File. Click Browse to select the email template's XML file from the file system and click Import. IdentityIQ parses the XML during the import process and recognizes the file's contents as an EmailTemplate object. The import fails if the XML is invalid.

Note

Import files can contain one or more EmailTemplate objects. However, if a file contains more than one object, the import methods expect the set of objects to be wrapped in a block.

To import the email template through the IdentityIQ console:

  1. Navigate to the IdentityIQ_Installation/WEB-INF/bin directory.

  2. Start the console and use the console import command to import the file. The import is successful only if the XML is valid. Any errors encountered are reported to the console.