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.
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
Using the script in mail templates.
$SCRIPT(CCC_Script, "Param1|Param2")$
For more 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
Using the script in mail templates.
$SCRIPT(CCC_HtmlMailText):HTML$
Use this method to pass additional parameters to a function. Email notifications are generated during the process handling. Use the MailComponent process component to provide the SendRichMail process task for this purpose.
To compile a hyperlink in a process, for example, cancellation of email notifications, use the [ParamName 1-n] and [ParamValue 1-n] free process parameters of the process component.
NOTE: By default, 10 pairs of parameters are available. If this number is not sufficient, you can create additional custom process parameters, which you can then use as parameters in the Process Editor.
Example: Populating process parameters
ParamName1: Value = "NoSubscription"
ParamValue1: Value = VI_BuildITShopLink_Unsubscribe (values("UID_RichMail").ToString())
UID_RichMail is determined by the pre-script for generating within the process and passed to the function.
Take implementation examples from base object PersonWantsOrg processes that are triggered by changes to IT Shop requests.
The process parameter is referenced when a hyperlink is inserted in a mail definition using the Hyperlink menu in the Address field.
Syntax:
$PC(<ParamName>)$
Example:
$PC(NoSubscription)$
For more information about creating and editing processes, see the One Identity Manager Configuration Guide.
Related topics
To define default fonts for mail templates
To define default font sizes for mail templates
