Alerting of Accepted item status

Properties that can be configured to enable email to be sent if an item contains a status of Accepted

Overview

The collaboration object sends the business object to its mail port and the Role_Email collaboration object receives it on its From port. The Role_Email collaboration object 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.

A Process_Reviewed_Item collaboration object contains the following properties that can be configured to enable email to be sent if an item contains a status of Accepted.

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_ACCEPTED

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.

ACCEPTED_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_ACCEPTED property exist, and the Retail_Item has a status of Accepted, the value of ACCEPTED_EMAIL_ROLE is stored in the Retail_Item attribute specified by the 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 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: If the ACCEPTED_EMAIL_ROLE property does not exist, a value of unknown is set in the Retail_Item attribute specified in the collaboration object's EMAIL_ROLE_ATTRIBUTE.

ACCEPTED_EMAIL_MSG

This property specifies the Retail_Item attribute containing the appropriate message text to be sent. If the SEND_MAIL_ON_ACCEPTED and ACCEPTED_EMAIL_ROLE properties exist, and the Retail_Item has a status of Accepted, the value of ACCEPTED_EMAIL_MSG is stored in the Retail_Item attribute specified by the 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 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.

ACCEPTED_EMAIL_SUBJECT

This property specifies the Retail_Item attribute containing the appropriate message subject. If the SEND_MAIL_ON_ACCEPTED and ACCEPTED_EMAIL_ROLE properties exist, and the Retail_Item has a status of Accepted, the value of ACCEPTED_EMAIL_SUBJECT is stored in the Retail_Item attribute specified by the 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 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.

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