General properties of a mail template
The following general properties are displayed for a mail template:
Table 10: Mail template properties
|
Mail template |
Name of the mail template. This name will be used to display the mail templates in the administration tools and in the Web Portal. Translate the given text using the  button. |
|
Base object |
Mail template base object. A base object only needs to be entered if the mail definition properties of the base object are referenced.
Use the AttestationCase or AttestationHelper base object for notifications about attestation. |
|
Report (parameter set) |
Report, made available through the mail template. |
|
Description |
Mail template description. Translate the given text using the button. |
|
Target format |
Format in which to generate email notification. Permitted values are:
-
HTML: The email notification is formatted in HTML. Text formats, for example, different fonts, colored fonts, or other text formatting, can be included in HTML format.
-
TXT: The email notification is formatted as text. Text format does not support bold, italics, or colored font, or other text formatting. Images displayed directly in the message are not supported. |
|
Design type |
Design in which to generate the email notification. Permitted values are:
- Mail template: The generated email notification contains the mail body in accordance with the mail definition.
- Report: The generated email notification contains the report specified under Report (parameter set) as its mail body.
- Mail template, report in attachment: The generated email notification contains the mail body in accordance with the mail definition. The report specified under Report (parameter set) is attached to the notification as a PDF file.
|
|
Importance |
Importance for the email notification. Permitted values are Low, Normal, and High. |
|
Confidentiality |
Confidentiality for the email notification. Permitted values are Normal, Personal, Private, and Confidential. |
|
Can unsubscribe |
Specifies whether the recipient can unsubscribe email notification. If this option is set, the emails can be unsubscribed through the Web Portal. |
|
Deactivated |
Specifies whether this mail template is disabled. |
|
Mail definition |
Unique name for the mail definition. |
|
Language |
Language that applies to the mail template. The recipient's language preferences are taken into account when an email notification is generated. |
|
Subject |
Subject of the email message. |
|
Mail body |
Content of the email message. |
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
-
Open the mail template in the Mail Template Editor.
-
Click the 
button next to the Mail definition list.
-
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 detailed 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
-
Open the mail template in the Mail Template Editor.
-
Select the language in Mail definition.
-
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 detailed information, see the One Identity Manager Configuration Guide.
Example
An attestor should receive email notification of new attestations.
Table 11: 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 path to the Web Portal. You edit the configuration parameter in the Designer.
http://<server name>/<application>
with:
<server name> = name of server
<application> = path to the Web Portal 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.
