HC_Z01_Email Collaboration Template

The HC_Z01_Email collaboration template processes MQWF_Z01_Email business objects. The HC_Z01_Email collaboration template uses data contained in the MQWF_Z01_Email business object to create an appropriate email message for the Compliance Report use case. The collaboration then sends the email message to a configured list of recipients.

This collaboration object performs the following tasks:

Collaboration object setup

This section includes information on port bindings and required steps for setting up collaboration objects based on HC_Z01_Email. For information on standard features, ports, and configuration properties for collaboration templates, and for general information on creating collaboration objects, refer to the documents listed in Required Documents for Creating Collaboration Objects.

Port information

The following diagram illustrates HC_Z01_Email's ports:

Note: To keep the collaboration object from using a port, bind that port to the Port connector. Doing so indicates that the port is unused without causing the collaboration object to provide additional functionality.

From
Business object Bound to Function Verbs used
MQWF_Z01_Email Source application's connector or calling collaboration object. Receives the triggering business object. Create

Setting up HC_Z01_Email as a stand-alone object

To set up HC_Z01_Email as a stand-alone collaboration object, complete the following steps:

  1. Create the HC_Z01_Email collaboration object.
  2. Bind all ports as described in Port information.
  3. Configure HC_Z01_Email as described in Configuration properties.

Collaboration template processes

This section illustrates the business processing logic for this collaboration template:

Overall process logic

This section illustrates this collaboration template's process logic for the supported verb, Create.

Create

The following diagrams show the process logic for this collaboration template's Create verb.

Diagram showing this collaboration's Main Scenarion process

     Main Scenario diagram

Configuration properties

This section describes the configuration properties for this collaboration:

Collaboration-specific properties

This collaboration template has the following configuration properties specific to it:

SUBSTITUTION_VARIABLE_PREFIX

This property specifies the characters that are used to indicate the start of a substitution variable in the e-mail subject and e-mail message. The collaboration uses these characters to parse the e-mail subject and e-mail message and locate substitution variables. The collaboration then substitutes the value of the variable into the subject or message text.

SUBSTITUTION_VARIABLE_PREFIX configuration property
Default value Usage
${ Defines the characters that should be used in the e-mail message and e-mail subject to indicate the start of a substitution variable.
Substitution variable values
Variable Description
Root Causes the collaboration to insert the entire string representation of the triggering business object into the text.
CR Causes the collaboration to insert the appropriate operating system line separator into the text.
Date Causes the collaboration to insert the current date into the text.
getVerb Causes the collaboration to insert the verb associated with the triggering business object into the text.
getName Causes the collaboration to insert the name of the triggering business object into the text.
triggeringBusObj_attribute_name Causes the collaboration to insert the value of the specified triggering business object's attribute into the text. If an error occurs when attempting to obtain the value of the attribute (for example, an invalid attribute name specified) the text of the error is inserted into the text at the point where the value of the attribute was required.

SUBSTITUTION_VARIABLE_SUFFIX

This property specifies the characters that are used to indicate the end of a substitution variable in the email subject and email message.

SUBSTITUTION_VARIABLE_SUFFIX configuration property
Default value Usage
} Defines the characters that are used in the e-mail message and e-mail subject to indicate the end of a substitution variable.

FILE_NAME_PREFIX

This property specifies the character that must be specified in the first character of the SUCCESS_SUBJECT, SUCCESS_MESSAGE, SUCCESS_RECIPIENTS, ERROR_SUBJECT, ERROR_MESSAGE, and ERROR_RECIPIENTS collaboration properties to indicate that the property contains the name of a file. If this character appears as the first character in these collaboration properties, the collaboration will treat the remaining value of the collaboration property as the path and name of a file. The collaboration will attempt to read the file to obtain the subject text, message text, or recipient list.

FILE_NAME_PREFIX configuration property
Default value Usage
@ Defines the characters that should be used as the first characters in the SUBJECT, MESSAGE, and RECIPIENTS collaboration properties to indicate that the property contains the name of a file.

SUCCESS_SUBJECT

This property specifies the text, or the name of a file containing the text, that will appear in the successful e-mail subject. If this property is left blank, the collaboration will use the contents of its collaboration message number 8005 as the e-mail subject.

SUCCESS_SUBJECT configuration property
Possible values Usage
Blank (default value) Causes this collaboration object to use the contents of its 8005 message as the e-mail subject.
Text Causes this collaboration object to use the contents of this property as the e-mail subject.
@path_and_filename If the first character is the same as the value of the FILE_NAME_PREFIX collab property,  causes this collaboration object to read the contents of the path_and_filename file and use the contents as the e-mail subject.

SUCCESS_MESSAGE

This property specifies the text, or the name of a file containing the text, that will appear in the successful e-mail message body. If this property is left blank, the collaboration will use the contents of its collaboration message number 8004 as the e-mail message.

SUCCESS_MESSAGE configuration property
Possible values Usage
Blank (default value) Causes this collaboration object to use the contents of its 8004 message as the e-mail message.
Text Causes this collaboration object to use the contents of this property as the e-mail message.
@path_and_filename If the first character is the same as the value of the FILE_NAME_PREFIX collab property, it causes this collaboration object to read the contents of the path_and_filename file and use the contents as the e-mail message.

SUCCESS_RECIPIENTS

This property specifies a comma-separated list of e-mail addresses, or the name of a file containing a comma-separated list, which will receive the successful e-mail message.

SUCCESS_RECIPIENTS configuration property
Possible values Usage
Blank (default value) No successful e-mail message recipients.
E-mail addresses of recipients Causes this collaboration object to send the successful e-mail message to each of the comma separated e-mail addresses in the list.
@path_and_filename If the first character is the same as the value of the FILE_NAME_PREFIX collab property, it causes this collaboration object to read the contents of the path_and_filename file and send the successful e-mail message to each of the comma separated e-mail addresses in the list.

ERROR_SUBJECT

This property specifies the text, or the name of a file containing the text, that will appear in the error e-mail subject. If this property is left blank, the collaboration will use the contents of its collaboration message number 8003 as the e-mail subject.

ERROR_SUBJECT configuration property
Possible values Usage
Blank (default value) Causes this collaboration object to use the contents of its 8003 message as the e-mail subject.
Text Causes this collaboration object to use the contents of this property as the e-mail subject.
@path_and_filename If the first character is the same as the value of the FILE_NAME_PREFIX collaboration property, it causes this collaboration object to read the contents of the path_and_filename file and use the contents as the e-mail subject.

ERROR_MESSAGE

This property specifies the text, or the name of a file containing the text, that will appear in the error e-mail message body. If this property is left blank, the collaboration will use the contents of its collaboration message number 8002 as the e-mail message.

ERROR_MESSAGE configuration property
Possible values Usage
Blank (default value) Causes this collaboration object to use the contents of its 8002 message as the e-mail message.
Text Causes this collaboration object to use the contents of this property as the e-mail message.
@path_and_filename If the first character is the same as the value of the FILE_NAME_PREFIX collaboration property, it causes this collaboration object to read the contents of the path_and_filename file and use the contents as the e-mail message.

ERROR_RECIPIENTS

This property specifies a comma-separated list, or the name of a file containing a comma-separated list, of e-mail addresses to receive the error e-mail message.

ERROR_RECIPIENTS configuration property
Possible values Usage
Blank (default value) No successful e-mail message recipients.
Email addresses of recipients Causes this collaboration object to send the error e-mail message to each of the comma separated e-mail addresses in the list.
@path_and_filename If the first character is the same as the value of the FILE_NAME_PREFIX collab property, it causes this collaboration object to read the contents of the path_and_filename file and send the error e-mail message to each of the comma separated e-mail addresses in the list.

MESSAGE_VARIABLE

This property specifies the URL which will appear in the success e-mail message if the SUCCESS_MESSAGE collaboration property is left blank. If SUCCESS_MESSAGE is blank, this collaboration uses message number 8000 as the e-mail message text. Message number 8000 contains a variable place holder into which the value of the MESSAGE_VARIABLE collaboration property is inserted. The URL is a link to a Web application for viewing the database table that contains the Compliance Report results.

MESSAGE_VARIABLE configuration property
Possible values Usage
http://www.ibm.com (default value) This value should be set to the URL of the link to a Web application for viewing the Compliance Report database results.

LOG_ERROR

This property specifies whether the collaboration object should log an error if an exception is detected when trying to send the e-mail.

LOG_ERROR configuration property
Possible values Usage
true Causes this collaboration object to log an error for a send e-mail exception.
false (default value) Causes this collaboration object to not log an error for a send e-mail exception.

Related reference

Copyright IBM Corp. 2002, 2003