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 IT Shop requester should receive email notification about the status of the request.
Table 77: Email notification properties
|
Base object |
PersonWantsOrg |
|
Subject |
"$DisplayOrg[D]$" status change |
|
Mail body |
Dear $FK(UID_PersonOrdered).Salutation[D]$ $FK(UID_PersonOrdered).FirstName$ $FK(UID_PersonOrdered).LastName$,
The status was changed on the following request on $DateHead:Date$.
Requested by: $DisplayPersonInserted$
Requested by: $DisplayPersonInserted$
Reason: $OrderReason$
Current status of your request:
Approval: granted
Approver: $DisplayPersonHead[D]$
Reason: $ReasonHead[D]$ |
The generated email notification could look like the following, for example, once it has been formatted.
Use of hyperlinks to 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 for IT Shop requests.
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_BuildITShopLink_Show_for_Requester)$
Default functions for IT Shop requests
The VI_BuildITShopLinks script contains a collection of default functions for composing hyperlinks to directly grant or deny approval of IT Shop requests from email notifications.
Table 78: Functions of the VI_BuildITShopLinks script
|
VI_BuildITShopLink_Show_for_Approver |
Opens the overview page for request approval in the Web Portal. |
|
VI_BuildITShopLink_Show_for_Requester |
Opens the overview page for requests in the Web Portal. |
|
VI_BuildITShopLink_Approve |
Approves a request and opens the approvals page in the Web Portal. |
|
VI_BuildITShopLink_Deny |
Denies a request and opens the approvals page in the Web Portal. |
|
VI_BuildITShopLink_AnswerQuestion |
Opens the page for answering a question in the Web Portal. |
|
VI_BuildITShopLink_Reject |
Opens the page with denied requests in the Web Portal. |
|
VI_BuildAttestationLink_Pending |
Opens the page with pending requests in the Web Portal. |
|
VI_BuildITShopLink_Unsubscribe |
Creates the link for canceling email notification. This function is used in processes for unsubscribing email notifications. |
Customize email signatures
Configure the email signature for mail templates using the following configuration parameters. Edit the configuration parameters in the Designer.
Table 79: Configuration parameters for email signatures
|
Common | MailNotification | Signature |
Data for the signature in email automatically generated from mail templates. |
|
Common | MailNotification | Signature | Caption |
Signature under the salutation. |
|
Common | MailNotification | Signature | Company |
Company name. |
|
Common | MailNotification | Signature | Link |
Link to the company's website. |
|
Common | MailNotification | Signature | LinkDisplay |
Display text for the link to the company's website. |
VI_GetRichMailSignature combines the components of an email signature according to the configuration parameters for use in mail templates.
