taskContextInformation

Administration Guide › Email Notifications › How to Use Email Templates › Custom Email Templates › Email Template API › taskContextInformation

taskContextInformation

Contains a collection of information about the current task, such as task name, organization name, and constituent events. This information is called context information for the task.

This object is available for email messages based on Completed templates. For information about this template, see Email Templates.

Methods: All the methods below return a String except for the method getExposedEventContexts(), which returns a Java Vector.

Method	Description
getAdminName()	Returns the name of the person submitting the task. Deprecated in CA IdentityMinder 5.6. Use one of the following inherited methods: getAdministrator() getAdminFriendlyName()
getExposedEventContexts()	Returns a Java Vector of all events associated with the task. Each object in the Vector is an event context object. You can use the methods listed in _eventContextInformation to retrieve context information for a given event object. The return object is a standard Java Vector object. You can use any of the Vector object’s methods--for example, get() and size()--to manage the elements in the Vector.
getOrgName()	Returns the name of the organization where the task is being executed. Deprecated in CA IdentityMinder 5.6. Use the inherited method getObjectOrganizationFriendlyName().
getTaskName()	Returns the name of the task being executed. Deprecated in CA IdentityMinder 5.6. Use one of the following inherited methods: getAdminTask() getTaskFriendlyName()

Note: The methods in _taskContextInformation are provided through the interface ExposedTaskContextInformation. Since ExposedTaskContextInformation inherits methods in the core CA IdentityMinder API, _taskContextInformation can also call these methods from an email template, along with the methods in the above table. For more information about these inherited methods, see Additional Methods.

Example--Body of an email notification template for a password change:

<%
var imsEventContexts =              _taskContextInformation.getExposedEventContexts();
if(imsEventContexts != null)
   {
   for(var i=0;i<imsEventContexts.size();i++)
      {
      var eventContext = imsEventContexts.get(i);
      template.add("Hi "+ eventContext.getPrimaryObjectName()                                                         + ",");
      template.add("<br>Your new password is: <b>"+
                              eventContext.getPassword());</br>
      template.add("<hr>");
      }
   }
%>

Possible email body:

Hi Victor Imperioso,
Your new password is: LFH7F1226