上一主题: _util下一主题: _taskContextInformation

电子邮件通知 › 如何使用电子邮件模板 › 自定义电子邮件模板 › 电子邮件模板 API › _eventContextInformation

_eventContextInformation

包含与当前任务生成的事件相关的信息，如事件名和审批状态。 此信息叫做事件的上下文信息。

_eventContextInformation 对象是通过包 com.netegrity.imapi 的 ExposedEventContextInformation 类创建的。

此对象可用于已批准、未决和已拒绝模板的电子邮件。 有关这些模板的信息，请参阅“电子邮件模板”。

方法：以下所有方法都返回一个字符串。

方法

说明

getAdminName()

返回提交生成事件的任务的人的名称。

在 CA IdentityMinder 5.6 中启用。 使用下列继承的方法之一：

  • getAdministrator()
  • getAdminFriendlyName()

getApprovalStatus()

返回事件的批准状态。 这些值之一：

APPROVAL_STATUS_APPROVED
APPROVAL_STATUS_REJECTED

getApprovalTime()

返回事件被批准的时间。

getEventName()

返回事件的名称。

有关事件名的列表，请参阅“CA IdentityMinder 事件”。

getOrgName()

返回任务正在执行的组织的友好名称。

在 CA IdentityMinder 5.6 中启用。 使用继承的方法 getObjectOrganizationFriendlyName()。

getPassword()

如果主要对象是类型 USER，返回该用户的密码。

getPrimaryObjectTypeName()

返回主要对象的类型。

返回的主要对象类型：

ACCESSROLE
ACCESSTASK
ADMINROLE
ADMINTASK
GROUP
ORGANIZATION
USER

getPrimaryObjectName()

返回受事件影响的主要对象的名称。

主要对象是直接受事件影响的对象。 如果有的话，次要对象是主要对象绑定的对象。

例如：

  • CreateUserEvent 的主要对象类型是 USER。 次要对象是创建该用户的对象－也就是 ORGANIZATION。
  • CreateAdminRoleEvent 的主要对象类型是 ADMINROLE。 此对象没有绑定到其他对象，因此不存在次要对象。

如果主要对象的类型是 USER，getPrimaryObjectName() 可能返回 John Jones。

getSecondaryObjectTypeName()

如果次要对象受到事件的影响，返回对象类型。

返回的次要对象类型：

ACCESSROLE
ACCESSTASK
ADMINROLE
ADMINTASK
GROUP
ORGANIZATION
USER

getSecondaryObjectName()

如果次要对象受到事件的影响，返回该对象名。

有关主要和次要对象的详细信息，请参阅 getPrimaryObjectName()。

如果次要对象的类型为 ORGANIZATION，方法 getSecondaryObjectName() 可能返回 HR。

注意：_eventContextInformation 中的方法是通过接口 ExposedEventContextInformation 提供的。 因为 ExposedEventContextInformation 继承了核心 CA IdentityMinder API 中的方法，_eventContextInformation 也能调用来自电子邮件模板的这些方法以及上面的表中的方法。 有关这些继承的方法的详细信息，请参阅“其他方法”。

示例－关于未决事件的电子邮件通知：

<% 
_cc = "" ;
_bcc = ""; 
_subject = _eventContextInformation.getEventName() +
                                             " Approval Request";
%>
<!--- Start of Body --->
<html>
<body text="Navy">

The following item has been added to your work list for approval:
<br><br><br>
Event: <b><%=_eventContextInformation.getEventName()%></b> <br>
<%=_eventContextInformation.getPrimaryObjectTypeName()%>:
<b><%=_eventContextInformation.getPrimaryObjectName()%></b><br>
In <%=_eventContextInformation.getSecondaryObjectTypeName()%>: 
<b><%=_eventContextInformation.getSecondaryObjectName()%></b><br>
</body>
</html>

可能的电子邮件正文：

From: lsmith@security.com [mailto:lsmith@security.com] 
To: vimperioso@security.com
Subject: CreateUserEvent Approval Request

The following item has been added to your work list for approval:

Event: CreateUserEvent
USER: Richard Ferrigamo
In ORGANIZATION: Mortgages & Loans

注意：“From”字段的值是从 email.properties 文件获得的。 要更改值，请编辑以下文件：

<iam_im.ear>\config\com\netegrity\config\email.properties

其中，<iam_im.ear> 是应用程序服务器域的 CA IdentityMinder 的安装位置，例如：

对于 WebLogic：

<WebLogic_home>\user_projects\<domain>\applications\iam_im.ear

对于 JBoss：

<Identity Manager_home>\jboss-3.2.2\server\default\deploy\iam_im.ear

对于 WebSphere：

<im_admin_tools_dir >\WebSphere-ear\iam_im.ear

要将受该事件影响的用户的附加信息添加到前一个示例的电子邮件中，请添加类似以下内容的文本：

<% user = _eventContextInformation.getEvent().getUser(); %>
<b>User information:</b><br>
Last Name: <b><%=user.getAttribute("%LAST_NAME%")%></b><br>   
First Name: <b><%=user.getAttribute("%FIRST_NAME%")%></b><br>
Full Name: <b><%=user.getAttribute("%FULL_NAME%")%></b><br>
Email: <b><%=user.getAttribute("%EMAIL%")%></b><br>
Organization Membership: <b><%=user.getAttribute("%ORG_MEMBERSHIP%")%></b><br>

可能的电子邮件正文：

From: lsmith@security.com [mailto:lsmith@security.com] 
To: vimperioso@security.com
Subject: CreateUserEvent Approval Request

The following item has been added to your work list for approval:

Event: CreateUserEvent
USER: Richard Ferrigamo
In ORGANIZATION: Mortgages & Loans
User information:
Last Name: Ferrigamo
First Name: Richard
Full Name: Richard Ferrigamo
Email: rferrigamo@mybank.org
Organization Membership: Mortgages & Loans