Chat now with support
Chat with Support

Identity Manager 8.1.4 - Operational Guide

About this guide Simulating data changes in the Manager Scheduling operations activation times Re-applying templates Exporting data with Manager Analyzing data and data changes Analyzing process monitoring in the Manager Schedules in One Identity Manager Mail templates in One Identity Manager Password policies in One Identity Manager Working with change labels Checking data consistency Compiling a One Identity Manager database Transporting custom changes Importing data with Data Import Importing and exporting individual files for the software update Command line programs

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 for IT Shop requests, in Identity Audit, policy checks and 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

  1. Click the position in the mail text of the mail definition where you want to insert a hyperlink.

  2. 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.

  3. To accept the input, click OK.
Related topics

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.

$Script(<Function>)$

Example:

$Script(VI_BuildITShopLink_Show_for_Requester)$

$Script(VI_BuildAttestationLink_Approve)$

$Script(VI_BuildComplianceLink_Show)$

$Script(VI_BuildQERPolicyLink_Show)$

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 23: Functions of the VI_BuildAttestationLinks script

Function

Usage

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.

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 24: Functions of the VI_BuildITShopLinks script

Function

Usage

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.

Default functions for identity audit

The VI_BuildComplianceLinks script contains a collection of default functions for composing hyperlinks for exception approval of rule violations.

Table 25: Functions of the VI_BuildComplianceLinks script

Function

Usage

VI_BuildComplianceLink_Show

Opens the exception approval page in the Web Portal.

Default function for policy checking

The VI_BuildComplianceLinks script contains a collection of default functions for composing hyperlinks for exception approval of policy violations.

Table 26: Functions of the VI_BuildComplianceLinks script

Function

Usage

VI_BuildQERPolicyLink_Show

Opens the exception approval page in the Web Portal.

Related topics

Using scripts in mail templates

For more information about using scripts, see the One Identity Manager Configuration Guide.

In mail templates, any parameters can be used when calling a script.

Syntax

$SCRIPT(ScriptName, "Options")$

The Options parameter is optional and is passed as a string. Custom parameters can be coded in any way in this string. Quotes ("") are masked by doubling. In the script, the parameter is passed as the second parameter after the base object. The base object can be either IEntity or ISingleDbObject.

Script example

Public Function CCC_Script(baseEntity as IEntity, options as String) as String

Dim arr = options.Split("|"c)

Dim p1 = arr(0)

Dim p2 = arr(1)

End Function

Example of use in mail templates

$SCRIPT(CCC_Script, "Param1|Param2")$

Support for dynamically generated HTML code in mail templates

For detailed information about using dollar ($) notation, see the One Identity Manager Configuration Guide.

In dollar notation, you can select the HTML type. The HTML code is accepted in scripts and columns but not masked. There is no security check.

Example script with HTML code:

Public Function CCC_HtmlMailText(obj As IEntity) As String

Return "<h1 style='color:red'>" & obj.Display & "</h1>"

End Function

Call in mail template:

$SCRIPT(CCC_HtmlMailText):HTML$

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating