Alerting of processing errors

Properties that can be configured to enable email to be sent if errors are detected during processing.

Overview

The ItemValidation and ItemDispatcher collaboration objects send the object to their Notify ports; the ItemCollector collaboration object, to its email port; the Process_Reviewed_Item collaboration object, to its mail port. The Role_Email collaboration object receives it on its From port and then formulates the sendEmail API parameters from the values of the EMAIL_ROLE_ATTRIBUTE, EMAIL_MSG_ATTRIBUTE, and EMAIL_SUBJECT_ATTRIBUTE properties passed to it.

ItemValidation, ItemCollector, ItemDispatcher, and Process_Reviewed_Item collaboration objects contain the following properties that can be configured to enable email to be sent if errors are detected during processing.

Related collaboration templates and business objects

See the following related collaboration templates for more information: See the following related business object for more information:

SEND_MAIL_ON_ERROR

This property controls whether the Retail_Item is sent to the port connected to the Role_Email collaboration object. In essence, its value of true or false controls whether email is sent. This property must be configured by the user.

ERROR_EMAIL_ROLE

This property specifies the Retail_Item attribute containing the recipients that are to receive the message. It must be configured by the user. If an error occurs and this property and the SEND_MAIL_ON_ERROR property exist (and, in the ItemValidation collaboration object, are not BLANK), the value of ERROR_EMAIL_ROLE is stored in the Retail_Item attribute specified by the ItemValidation, ItemCollector, ItemDispatcher, or Process_Reviewed_Item collaboration object's EMAIL_ROLE_ATTRIBUTE property. By default, this Retail_Item attribute is internals.message_recipient_role. To successfully use the Role_Email collaboration object as the notifying collaboration object, the Retail_Item attribute specified in the ItemValidation, ItemCollector, ItemDispatcher, or Process_Reviewed_Item collaboration object's EMAIL_ROLE_ATTRIBUTE property must match the Retail_Item attribute specified in the Role_Email collaboration object's MSG_RECIPIENT_ATTRIBUTE property. This Retail_Item attribute can contain either the actual recipient or list of recipients or a filename containing this value. See Specifying message text, subjects, and recipients in external files.
Note: In the Process_Reviewed_Item collaboration object, if the ERROR_EMAIL_ROLE property does not exist, a value of unknown is set in the Retail_Item attribute specified by the EMAIL_ROLE_ATTRIBUTE property. In the ItemValidation collaboration object, if the ERROR_EMAIL_ROLE property exists but is BLANK, no notification is executed (no default mail recipient exists).

E-mail error properties

The following properties specify the Retail_Item attribute containing the appropriate message text to be sent. If an error occurs and the SEND_MAIL_ON_ERROR and ERROR_EMAIL_ROLE properties exist (and, in the ItemValidation collaboration object, are not BLANK), the value of ERROR_EMAIL_MSG, ERROR_RETRIEVE_EMAIL_MSG, or ERROR_SEND_EMAIL_MSG is stored in the Retail_Item attribute specified by the ItemValidation, ItemCollector, ItemDispatcher, or Process_Reviewed_Item collaboration object's EMAIL_MSG_ATTRIBUTE property. By default, this Retail_Item attribute is internals.message_text. To successfully use the Role_Email collaboration object as the notifying collaboration object, the Retail_Item attribute specified in the ItemValidation, ItemCollector, ItemDispatcher, or Process_Reviewed_Item collaboration object's EMAIL_MSG_ATTRIBUTE property must match the Retail_Item attribute specified in the Role_Email collaboration object's MSG_TEXT_ATTRIBUTE property. This Retail_Item attribute can contain either the actual message text or a filename containing the message text. See Specifying message text, subjects, and recipients in external files.
Note: In the ItemValidation collaboration object, if the ERROR_EMAIL_MSG property exists but is BLANK, a default value is placed in the Retail_Item attribute specified by the EMAIL_MSG_ATTRIBUTE property. In the ItemCollector collaboration object, if the ERROR_RETRIEVE_EMAIL_MSG or ERROR_SEND_EMAIL_MSG properties exist but are BLANK, a default value is placed in the Retail_Item attribute specified by the EMAIL_MSG_ATTRIBUTE property. In the ItemDispatcher collaboration object, if the ERROR_EMAIL_MSG property exists but is BLANK, the exception that occurred in the collaboration object is used as the message text.

ERROR_EMAIL_SUBJECT

This property specifies the Retail_Item attribute containing the appropriate message subject. If an error occurs and the SEND_MAIL_ON_ERROR and ERROR_EMAIL_ROLE properties exist (and, in the ItemValidation collaboration object, are not BLANK), the value of ERROR_EMAIL_SUBJECT is stored in the Retail_Item attribute specified by the ItemValidation, ItemCollector, ItemDispatcher, or Process_Reviewed_Item collaboration object's EMAIL_SUBJECT_ATTRIBUTE property. By default, this Retail_Item attribute is internals.message_subject. To successfully use the Role_Email collaboration object as the notifying collaboration object, the Retail_Item attribute specified in the ItemValidation, ItemCollector, ItemDispatcher, or Process_Reviewed_Item collaboration object's EMAIL_SUBJECT_ATTRIBUTE property must match the Retail_Item attribute specified in the Role_Email collaboration object's MSG_SUBJECT_ATTRIBUTE property. This Retail_Item attribute can contain either the actual subject text or a filename containing the subject text. See Specifying message text, subjects, and recipients in external files.
Note: In the ItemValidation collaboration object, if the ERROR_EMAIL_SUBJECT property exists but is BLANK, a default value is placed in the Retail_Item attribute specified by the EMAIL_SUBJECT_ATTRIBUTE property.

QUALIFICATION_FAILED_EMAIL_MSG

The QUALIFICATION_FAILED_EMAIL_MSG property is used only with the Process_Reviewed_Item collaboration object.

Set this attribute to the appropriate message text to be sent if the status of the item returned on the Process_Reviewed_Item collaboration object's reprocess port from the ItemValidation collaboration object is Rejected.

Parent topic: Alerting email recipients of item status or processing errors