EmailContext

The object provides access to contextual information specific to a type of notification that is sent.

Some methods for accessing information change are based upon the listed notification types. (The Reminder/Approval/RFI/WorkOrder/ComplianceAlert Notification does not support this.)

Activity Timeout Template
Change Account Template
Compliance Template
New Account Template
New Password Template
Process Completion Template
Process Timeout Template
Restore Account Template
Suspend Account Template

Availability

IBM® Security Identity Manager 4.6

Provided by

com.ibm.itim.workflow.script.EmailContextExtension

Synopsis

Call methods documented in this section as an EmailContext object. For example:

notificationActivity=EmailContext.getActivity();
owner=EmailContext.getAccountOwnerName()

Common methods

These methods are available for all types of notifications:

getActivity(): Returns information about the most recent running activity. (Returns the ActivityInfoOC Java™ Object. To get the activity information in JavaScript object, use the object, ‘activity'.
getActivity(java.lang.String actDefID): Returns information about the activity with the specified definition ID. (Returns the ActivityInfoOC Java Object.) This obtains information by using the Process.$dataName.get()workflow process. To get the activity information in JavaScript object, use ‘process.getActivity(java.lang.String actDefID)'.
getParentProcess(): Returns information about the parent process of the currently running process. (Returns the ProcessInfoOC Java object.) To get the process information of the parent process in JavaScript object, use ‘process.getParent()'.
getProcess(): Returns the information about the currently running process. (Returns the ProcessInfoOC Java object.) To get the process information of the parent process in JavaScript object, use the object, ‘process'.
getRootProcess(): Returns information about the root process of the current running process. (Returns the ProcessInfoOC Java object.) To get the process information of the parent process in JavaScript object, use ‘process.getRootProcess ()').

Account notification methods

These methods are available for all types of account notifications:

getAccountOwnerName(): Returns the account owner name for the account.
getAccountServiceName(): Returns the account service name for the account.
getAccountServiceProfileName(): Returns the account service profile name for the account.
getAccountUserId(): Returns the account user ID for the account.
hasNewAccess(): Returns true if the account has new access and false otherwise.
hasRemovedAccess(): Returns true if the account removed access and false otherwise.
getAccountNewAccessAsString(): Returns String that contains list of new access separated by commas.
getAccountNewAccessList(): Returns Array of String that contains the new access.
getAccountRemovedAccessAsString(): Returns a string that contains the list of removed access separated by commas.
getAccountRemovedAccessList(): Returns Array of String that contains the list of removed access.

Account Suspend/Deprovisioning Notification Methods:

These methods are only available for all types of account suspend/deprovision notifications:

getAction(): Returns the action taken against the service (resource) itself.
getReason(): Returns a descriptive reason for the deprovision.

Account New/Modify/Restore Notification Methods:

These methods are only available for all types of notifications for new, modified, and restored accounts:

showPassword(): Returns whether to display the password when the user is notified of their new account.
getAccountPassword(): Returns the account password for the account. .
getPasswordExpirePeriod(): Returns the password delivery expiration period.
getPasswordRetrievalUrl(): Returns the password delivery URL in order to retrieve the password with the accounts shared secret.
getTransactionId(): Returns the password delivery transaction ID for picking up the password created for this account.

Account Password Change Notification Methods:

These methods are available for all types of account password change notifications:

getAccountPassword(): Returns the account password for the account.
getPasswordExpirePeriod(): Returns the password delivery expiration period.
getPasswordRetrievalUrl(): Returns the password delivery URL in order to retrieve the password with the accounts shared secret.
getTransactionId(): Returns the password delivery transaction ID for picking up the password created for this account.