A_EmailOps

This action facilitates the sending of an email notification to an operator (email address). Like other actions, the action message flow itself consists of a BeginAction and an EndAction subflow, but it has a compute node between the subflows. The compute node is used to set up parameters from the LocalEnvironment, which feed into an EmailOutput IBM® App Connect Enterprise node.

This new action is included in the FTM Generic Model Actions package and can be used in the same way as any other FTM action.

A number of VALUE table entries need to be created to help send the email notifications. The following table shows the table entries that are needed. For more information about the values that are allowed for the table entries for the EmailOutput node, see the IBM App Connect Enterprise documentation.

Table 1. A_EmailOps VALUE table entries
CATEGORY	KEY	APP_VERSION_ID	VALUE
EMAIL_SMTPSERVER	`ALL` or `<Email Reference Value>`	`<App Version Id>`	For example, localhost:25
EMAIL_TO	`ALL` or `<Email Reference Value>`	`<App Version Id>`	For example, xyz@example.com
EMAIL_CC	`ALL` or `<Email Reference Value>`	`<App Version Id>`	For example, xyz@example.com
EMAIL_BCC	`ALL` or `<Email Reference Value>`	`<App Version Id>`	For example, xyz@example.com
EMAIL_FROM	`ALL` or `<Email Reference Value>`	`<App Version Id>`	For example, xyz@example.com
EMAIL_REPLYTO	`ALL` or `<Email Reference Value>`	`<App Version Id>`	For example, xyz@example.com
EMAIL_SECURITY_ID	`ALL` or `<Email Reference Value>`	`<App Version Id>`	For example, MyIdentity
EMAIL_SUBJECT	`ALL` or `<Email Reference Value>`	`<App Version Id>`	The value is the text that you want to use for the subject of the email. For example, Object ID $ObjData{ID} in alert state
EMAIL_BODY	`ALL` or `<Email Reference Value>`	`<App Version Id>`	The value is the text that you want to use for the body of the email. For example, Object ID $ObjData{ID} of Object Type $ObjData{OBJ_TYPE} and Subtype $ObjData{SUBTYPE} and Status $ObjData{STATUS} failed. $ErrorLog $AuditLog

The value that you choose for the KEY in a VALUE table entry is used to determine whether the entry applies to the current invocation of the A_EmailOps action. The way that the KEY value is interpreted is shown in the following list.

ALL: When ALL is specified as the KEY, the VALUE table entry pertains to all cases where the action is called. For example, use ALL for values that usually do not differ from one scenario to another.; This key value acts like a catch-all, so you can configure entries such as SMTP server, from list, or security ID with a single value by using a KEY of ALL.
Email Reference Value: When the KEY value is set to an email reference value, a value other than ALL is compared to an alias EMAIL_REFERENCE that is selected by the object selector of the action. For example, if the value 1000 is used as the KEY and the object selector selects '...CHANNEL_ID AS EMAIL_REFERENCE,...', that value table entry pertains only to channels with a CHANNEL_ID of 1000.; Use an email reference value as a KEY for the VALUE table entries that are more specific to whatever FSM is calling the action. For example, the VALUE table entries for email subject, to list, or email body might need to differ for the different actions and would be configured with a specific reference KEY.

A number of macros were created for the EMAIL_BODY value. These macros are substituted with actual values in the body of the email. The macros are shown in the following list.

$ObjData: The value from the object selector, if it is present.
$ErrorLog: A list of error records for the object ID in question.
$AuditLog: A list of status histories for the object in question in the form of S_Status1 -> S_Status2 -> S_Status3....

The action raises an E_EmailOpsComplete event when it completes.

Note: Firewall settings might need to be adjusted to allow access to SMTP servers.