This section illustrates the process logic for the Role_Email collaboration
template.
Flow
This section describes the flow of the collaboration
template.
- A Role_Email collaboration object is triggered by the receipt of a Retail_Item
business object in its From port.
- The collaboration object extracts the message text of the Retail_Item
by using the value specified in its MSG_TEXT_ATTRIBUTE configuration property. This property specifies the
name of the attribute of the Retail_Item that contains the message text of
the e-mail message (by default, internals.message_text). The Retail_Item attribute
contains either the actual message text or a filename containing the message
text. See Specifying message text, subjects, and recipients in external files.
- The collaboration object extracts the subject text of the Retail_Item
by using the value specified in its MSG_SUBJECT_ATTRIBUTE configuration property. This property specifies the
name of the attribute of the Retail_Item that contains the subject text of
the e-mail message (by default, internals.message_subject). The Retail_Item
attribute contains either the actual subject text or a filename containing
the subject text. See Specifying message text, subjects, and recipients in external files.
- The Role_Email collaboration object parses the obtained message and subject
text for any substitution variables. If any variables are found, the Role_Email
collaboration object replaces the variable references in the text with values
from the Retail_Item business object. See Using substitution variables in message and subject text, SUBSTITUTION_VARIABLE_PREFIX, and SUBSTITUTION_VARIABLE_SUFFIX.
- The collaboration object extracts the e-mail recipient or list of recipients
designated by the Retail_Item by using the value specified in its MSG_RECIPIENT_ATTRIBUTE configuration property. This property specifies the
name of the attribute of the Retail_Item that contains the recipients of the
e-mail message (by default, internals.message_recipient_role). The Retail_Item
attribute contains either the actual recipient or list of recipients or a
filename containing this value. See Specifying message text, subjects, and recipients in external files.
- The collaboration object parses the recipients list to determine if one
or more recipients exist in it (the value or file specified in the attribute
can contain one e-mail address or a comma-delimited list of e-mail addresses).
- The Role_Email collaboration object assembles the message and subject
text and the mail recipients, and passes them to the sendEmail API. If the
Role_Email collaboration object's LOG_ERROR configuration property is set to true, any errors
detected during the sending of the e-mail are logged by the collaboration
object in the configured IBM® WebSphere® InterChange Server (ICS) log destination.
If the configuration property LOG_ALL_MAIL is set to true, the collaboration object places an
entry in the configured ICS log destination indicating that an e-mail message
was generated.