Alerting of Rejected item status

Properties that can be configured to enable e-mail to be sent if an item contains a status of Rejected.

Overview

The ItemValidation collaboration object sends the object to its Notify 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 and Process_Reviewed_Item collaboration objects contain the following properties that can be configured to enable e-mail to be sent if an item contains a status of Rejected

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_REJECTION

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 e-mail is sent. This property must be configured by the user.

REJECT_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 this property and the SEND_MAIL_ON_REJECTION property exist (and, in the ItemValidation collaboration object, are not BLANK), and the Retail_Item has a status of ,Rejected the value of REJECT_EMAIL_ROLE is stored in the Retail_Item attribute specified by the ItemValidation 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 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 REJECT_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 REJECT_EMAIL_ROLE property exists but is BLANK, no notification is executed (no default mail recipient exists).

REJECT_EMAIL_MSG

This property specifies the Retail_Item attribute containing the appropriate message text to be sent. If the SEND_MAIL_ON_REJECTION and REJECT_EMAIL_ROLE properties exist (and, in the ItemValidation collaboration object, are not BLANK), and the Retail_Item has a status of Rejected, the value of REJECT_EMAIL_MSG is stored in the Retail_Item attribute specified by the ItemValidation 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 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 REJECT_EMAIL_MSG property exists but is BLANK, a default value is placed in the Retail_Item attribute specified by the EMAIL_MSG_ATTRIBUTE property.

REJECT_EMAIL_SUBJECT

This property specifies the Retail_Item attribute containing the appropriate message subject. If the SEND_MAIL_ON_REJECTION and REJECT_EMAIL_ROLE properties exist (and, in the ItemValidation collaboration object, are not BLANK), and the Retail_Item has a status of Rejected, the value of REJECT_EMAIL_SUBJECT is stored in the Retail_Item attribute specified by the ItemValidation 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 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 REJECT_EMAIL_SUBJECT property exists but is BLANK, a default value is placed in the Retail_Item attribute specified by the EMAIL_SUBJECT_ATTRIBUTE property.

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