Creating and editing a mail definition
Mail texts can be defined in these different languages in a mail template. This ensures that the language of the recipient is taken into account when the email is generated.
To create a new mail definition
-
In the Manager, select the Attestation > Basic configuration data > Mail templates category.
This shows all the mail templates that can be used for attestation cases in the result list.
-
Select a mail template in the result list and run the Change main data task.
-
In the result list, select the language for the mail definition in the Language menu.
All active languages are shown. To use another language, in the Designer, enable the corresponding countries. For more information, see the One Identity Manager Configuration Guide.
-
Enter the subject in Subject.
-
Edit the mail text in the Mail definition view with the help of the Mail Text Editor.
- Save the changes.
To edit an existing mail definition
-
In the Manager, select the Attestation > Basic configuration data > Mail templates category.
This shows all the mail templates that can be used for attestation cases in the result list.
-
Select a mail template in the result list and run the Change main data task.
-
In the Mail definition menu, select the language for the mail definition.
NOTE: If the Common | MailNotification | DefaultCulture configuration parameter is set, the mail definition is loaded in the default language for email notifications when the template is opened.
-
Edit the mail subject line and the body text.
- Save the changes.
Using base object properties
In the subject line and body text of a mail definition, you can use all properties of the object entered under Base object. You can also use the object properties that are referenced by foreign key relation.
To access properties use dollar notation. For more information, see the One Identity Manager Configuration Guide.
Example:
An attestor should receive email notification of new attestations.
Table 16: Email notification properties
|
Base object |
AttestationHelper |
|
Subject |
New attestations |
|
Mail body |
Dear $FK(UID_PersonHead).Salutation[D]$ $FK(UID_PersonHead).LastName$,
There are new attestations pending for the attestation policy "$FK(UID_AttestationCase).UID_AttestationPolicy[D]$".
Created: $FK(UID_AttestationCase).PolicyProcessed:Date$
You can see this request in the "One Identity Manager Self Service Portal".
Best regards |
Use of hyperlinks in the Web Portal
You can add hyperlinks to the Web Portal in the mail text of a mail definition. If the recipient clicks on the hyperlink in the email, the Web Portal opens on that web page and further actions can be carried out. In the default version, this method is implemented in attestations.
Prerequisites for using this method
-
The QER | WebPortal | BaseURL configuration parameter is enabled and contains the URL to the API Server. You edit the configuration parameter in the Designer.
http://<server name>/<application>
with:
<server name> = name of server
<application> = path to the API Server installation directory
To add a hyperlink to the Web Portal in the mail text
-
Click the position in the mail text of the mail definition where you want to insert a hyperlink.
-
Open the Hyperlink context menu and enter the following information.
-
Display text: Enter a caption for the hyperlink.
-
Link to: Select the File or website option.
-
Address: Enter the address of the page in the Web Portal that you want to open.
NOTE: One Identity Manager provides a number of default functions that you can use to create hyperlinks in the Web Portal.
- To accept the input, click OK.
Default functions for creating hyperlinks
Several default functions are available to help you create hyperlinks. You can use the functions directly when you add a hyperlink in the mail body of a mail definition or in processes
Direct function input
You can reference a function when you add a hyperlink in the Address field of the Hyperlink context menu.
Syntax:
$Script(<Function>)$
Example:
$Script(VI_BuildAttestationLink_Approve)$
Default functions for requests
The VI_BuildAttestationLinks script contains a collection of default functions for composing hyperlinks to directly grant or deny approval of requests from email notifications.
Table 17: Functions of the VI_BuildAttestationLinks script
|
VI_BuildAttestationLink_Show |
Opens the attestation page in the Web Portal. |
|
VI_BuildAttestationLink_Approve |
Approves an attestation and opens the attestation page in the Web Portal. |
|
VI_BuildAttestationLink_Deny |
Denies an attestation and opens the attestation page in the Web Portal. |
|
VI_BuildAttestationLink_AnswerQuestion |
Opens the page for answering a question in the Web Portal. |
|
VI_BuildAttestationLink_Pending |
Opens the page with pending attestations in the Web Portal. |
