23.4 Working with the installed e-mail template

Identity Manager ships with an e-mail template that is designed specifically for workflow-based provisioning. This e-mail template is called New Provisioning Request. All provisioning request templates that ship with the product are associated with this e-mail template. Therefore, any new request definitions you create will use this e-mail template.

You can edit the New Provisioning Request template to change the content and format of e-mail messages, but you can not create new e-mail templates.

To edit the New Provisioning Request template, you need to use the Email Templates task within the Workflow Administration role in iManager.

NOTE:This task is a shortcut to the Edit Email Templates task under the Passwords role.

23.4.1 Default content and format

Here’s what the New Provisioning Request template looks like after you install the product:


Dear $userFirstName$,
A new provisioning request has been submitted that requires your approval.
Request name: $requestTitle$
Submitted by: $initiatorFullName$
Recipient: $recipientFullName$
Please review the details of this request at $PROTOCOL$://$HOST$:$PORT$/$TASK_DETAILS$ to take the appropriate action.
You can review a list of all requests pending your approval at $PROTOCOL$://$HOST$:$PORT$/$TASKLIST_CONTEXT$.

The template identifies the provisioning request definition that triggered the e-mail message. In addition, it includes a URL that redirects the addressee to the task that requires approval, as well as a URL that displays the complete list of tasks pending for that user.

23.4.2 Editing the template

You can change the content or format of the New Provisioning Request template. Note that the template applies to all provisioning requests in the Identity Manager user application, so be sure your edits are suitable for all users and workflow tasks.

To edit the template:

  1. Select the Identity Manager category in iManager.

  2. Open the Workflow Administration role.

  3. Click on the Email Templates task.

    iManager displays the Edit Email Templates screen.

    Description: Description: Illustration

  4. Click on New Provisioning Request in the list of templates.

    iManager displays the Modify E-mail Message screen.

    Description: Description: Illustration

  5. Make your changes in the Message Body box.

  6. If necessary, copy one or more of the supplied tags in the Replacement Tags list box to include dynamic text in the message body.

    The replacement tags are described briefly below:

    Tag

    Description

    $userFirstName$

    The first name of the addressee.

    $requestTitle$

    The display name of the provisioning request definition.

    $initiatorFullName$

    The full name of the initiator.

    $recipientFullName$

    The full name of the recipient.

    $PROTOCOL$

    The protocol for URLs included in the e-mail message.

    $SECURE_PROTOCOL$

    The secure protocol for URLs included in the e-mail message.

    $HOST$

    The host for the JBoss application server that is running the Identity Manager user application.

    $PORT$

    The port for the Identity Manager user application.

    $SECURE_PORT$

    The secure port for the Identity Manager user application.

    $TASKLIST_CONTEXT$

    The page that displays the list of all requests pending for the addressee.

    $TASK_DETAILS$

    The page that displays details for the request for which this e-mail message was generated.

  7. When you’re done, click OK.

23.4.3 Modifying default values for the template

At installation time, you can set default values for several of the replacement tags used in e-mail templates. After you’ve completed the installation, you can also modify these values by using the User Application Configuration tool.

To modify the installation settings:

  1. Run the ldapconfig.sh script in the idm folder.

    
./configupdate.sh

    NOTE:On Windows, the file to run is configupdate.bat.

    Description: Description: Illustration

  2. Make changes as necessary to any of the following fields:

    Field

    Description

    Email Notify Host

    Used to replace the $HOST$ token in e-mail templates used in approval flows. If left blank, computed by the server. (This is the JBoss host.)

    Email Notify Port

    Used to replace the $PORT$ token in e-mail templates used in approval flows.

    Email Notify Secure Port

    Used to replace the $SECURE_PORT$ token in e-mail templates used in approval flows.

  3. Click OK to confirm your changes.