Table 90 lists the standard configuration properties for
collaboration templates. These properties are based on the
CollaborationFoundation template.
Table 90. Standard properties for collaboration templates
Standard configuration property
| Description
|
1_EXCLUDE_VALUES
| Specifies values for the collaboration to use as a filter to prevent
synchronization of the triggering business object.
|
1_FAIL_ON_INVALID_VALUE
| Indicates how the collaboration handles the value of an attribute
specified in 1_FILTER_ATTRIBUTE that does not meet the filtering
criteria.
|
1_FILTER_ATTRIBUTE
| Specifies the business object attribute for the collaboration to use when
comparing values specified in the 1_EXCLUDE_VALUES and 1_INCLUDE_VALUES
properties.
|
1_INCLUDE_VALUES
| Specifies values for the collaboration to use as a filter to allow
synchronization of the triggering business object.
|
ADDITIONAL_RETRIEVE
| Indicates whether the collaboration retrieves the business object from
the destination application after it successfully synchronizes its
data.
|
CONVERT_CREATE
| Indicates how the collaboration responds to a Create request if the
triggering business object that has been created in the source application
already exists in the destination application.
|
CONVERT_UPDATE
| Indicates how the collaboration responds to an Update request if the
triggering business object that has been updated in the source application
does not exist in the destination application.
|
INFORMATIONAL_EXCEPTIONS
| Specifies how the collaboration responds to an exception.
|
SEND_EMAIL
| Indicates whether the collaboration sends email when it receives an
exception.
|
USE_RETRIEVE
| Indicates whether the collaboration retrieves its triggering business
object from the destination application before it synchronizes data.
|
The 1_EXCLUDE_VALUES collaboration configuration property specifies values
for the collaboration to use as a filter to prevent synchronization of the
triggering business object. The collaboration excludes a business
object from synchronization if the value of the attribute specified by
1_FILTER_ATTRIBUTE matches one of the values listed in this property.
The possible values for 1_EXCLUDE_VALUES are as follows:
- A comma-delimited list of values to exclude (such as "in-stock,
at-customer").
- The value none, which indicates that no objects are to be
excluded from processing.
- No value, which is useful to exclude an attribute whose value is either a
null (CxIgnore) or an empty string (CxBlank).
The default value is none.
You can delete this property from the list of configuration properties
available for the collaboration template. When the 1_EXCLUDE_VALUES
property is deleted, it indicates that the property is not used in the
filtering process.
Note that the collaboration is not sensitive to the case of the specified
values, nor is it sensitive to extra spaces in a list of values.
Specify values for this property if the list of exclusion values is
shorter than the list of inclusion values. Otherwise,
specify values for 1_INCLUDE_VALUES. If specifying values in
1_INCLUDE_VALUES, set the value of 1_EXCLUDE_VALUES to none.
The 1_FAIL_ON_INVALID_VALUE collaboration configuration property indicates
how the collaboration handles the value of an attribute specified in
1_FILTER_ATTRIBUTE that does not meet the filtering criteria. Set the
1_FAIL_ON_INVALID_VALUE property to one of the following values:
- true--Set to true to cause the collaboration to raise an exception
and stop processing if the value of the attribute specified in
1_FILTER_ATTRIBUTE does not meet the filtering criteria specified in
1_EXCLUDE_VALUES or 1_INCLUDE_VALUES.
- false--Set to false to cause the collaboration to perform one of the
following processes when the specified attribute's value does not pass
the filtering criteria:
- If the attribute specified in 1_FILTER_ATTRIBUTE is part of the parent
business object, the collaboration continues processing.
- If the attribute specified in 1_FILTER_ATTRIBUTE is part a child business
object, the collaboration removes the child business object that contains the
attribute as well as all of its children; the collaboration continues
processing.
The default value is true. The values are not case
sensitive.
You can delete this property from the list of configuration properties
available to the collaboration template. Deleting the property
indicates that it is not used in the filtering process.
The 1_FILTER_ATTRIBUTE collaboration configuration property specifies the
business object attribute for the collaboration to use when comparing values
specified in the 1_EXCLUDE_VALUES and 1_INCLUDE_VALUES properties. The
collaboration compares the value in the specified attribute against the values
specified for exclusion or inclusion to prevent or ensure synchronization of
business objects with specific values. For example, assume that a
top-level business object named BusObjA contains a child business object named
BusObjB. To filter on an attribute named Type in the BusObjB business
object, set the value of 1_FILTER_ATTRIBUTE to
BusObjA.BusObjB.Type.
- Note:
- The collaboration evaluates this property only if its 1_EXCLUDE_VALUES
evaluates to a value other than none or its 1_INCLUDE_VALUES evaluates to a
value other than all.
Valid values for this collaboration configuration property are as
follows:
- The exact name of the business object and its attribute as it is defined
in InterChange Server Express (for example,
InstallShipment.ShipmentType). To determine the attribute's
name, do one of the following:
- View the business object in System Manager.
- View the repository file for the business object, which is named
repository\BO_BusinessObjectName.txt
- Note:
- In this document backslashes (\) are used as the convention for directory
paths. For UNIX installations, substitute backslashes with slashes
(/). All file pathnames are relative to the directory where the product
is installed on your system.
- BusinessObjectName.ObjectEventId, which is the attribute
that contains a unique, internal identifier for each business object.
This is the default value for 1_FILTER_ATTRIBUTE.
The collaboration template is designed to filter on any number of business
object attributes. To add more filters, add a set of configuration
properties (X_FILTER_ATTRIBUTE, X_FAIL_ON_INVALID_VALUE,
and either X_EXCLUDE_VALUES or X_INCLUDE_VALUES) to the
collaboration, where X is an integer from 2 to N. Additional
properties must be added in order from 2 to N and must have the exact names
listed above.
The 1_INCLUDE_VALUES collaboration configuration property specifies values
for the collaboration to use as a filter to allow synchronization of the
triggering business object. The collaboration synchronizes only
business objects with the specified values if the value of the attribute
specified by 1_FILTER_ATTRIBUTE matches one of the values listed in this
property.
Valid values for the 1_INCLUDE_VALUES property are as follows:
- A comma-delimited list of values to include (such as "standard,
in-stock, at-customer").
- The value all, which indicates that all objects should be
included in processing.
The default value is all. Note that the values do not have to be
case sensitive. In addition, the collaboration ignores extra spaces in
a list of values.
If this property is not to be used in the filtering process, you can delete
it from the list of configuration properties available to the
collaboration.
Specify values for this property if the list of inclusion values is
shorter than the list of exclusion values. Otherwise,
specify values for 1_EXCLUDE_VALUES. If specifying values in
1_EXCLUDE_VALUES, set the value of 1_INCLUDE_VALUES to all.
The ADDITIONAL_RETRIEVE collaboration configuration property indicates
whether the collaboration retrieves the business object from the destination
application after it successfully synchronizes its data. Set the
ADDITIONAL_RETRIEVE property as follows:
- Set to true to cause the collaboration to retrieve the business object
from the destination application after it has successfully synchronized its
data. This setting is useful when the source application requires a
full-valued business object to be returned from the destination application,
but the destination application's connector does not return a complete
business object after creating or updating its data.
- If the collaboration successfully retrieves the full-valued business
object, it saves it in the triggeringBusObj variable to return it to the
source application. If the collaboration is bound to a source connector
that makes a synchronous request, the triggering business object's values
are returned to the source connector as soon as the collaboration completes
processing. The values are returned as if the business object's
values had been passed by reference.
- Note:
- The collaboration also resets the verb of the triggeringBusObj variable from
Retrieve to the original verb. Resetting the verb allows the
collaboration to use the original triggering verb if required in the
Additional Processing 5 subprocess. For more information about the
Additional Retrieve process, see Additional Retrieve process.
- If the collaboration does not successfully retrieve the full-valued
business object, it raises an exception. Exception handling is
determined by the setting of the INFORMATIONAL_EXCEPTIONS property.
- Set to false to cause the collaboration not to retrieve the business
object from the destination application after it has successfully synchronized
its data.
The default value is false.
The CONVERT_CREATE collaboration configuration property indicates how the
collaboration responds to a Create request if the triggering business object
that has been created in the source application already exists in the
destination application. Set the CONVERT_CREATE property as
follows:
- Set to true to cause the collaboration to convert a Create request to an
Update request if the triggering business object that has been created in the
source application already exists in the destination.
- Set to false to cause the collaboration to raise an exception.
Exception handling is determined by the setting of the
INFORMATIONAL_EXCEPTIONS property.
The default value is false.
The actions that the collaboration takes for CONVERT_CREATE depend on the
value of the USE_RETRIEVE collaboration configuration property.
- If USE_RETRIEVE evaluates to true, the collaboration evaluates the
CONVERT_CREATE property only if the triggering verb is Create and the
collaboration succeeded in retrieving the business object.
- If USE_RETRIEVE evaluates to false, the collaboration evaluates the
CONVERT_CREATE property only after it fails in its attempt to create the
triggering business object in the destination.
For a table that illustrates the relationship between the USE_RETRIEVE and
CONVERT_CREATE configuration properties, see Use_Retrieve process.
The CONVERT_UPDATE collaboration configuration property indicates how the
collaboration responds to an Update request if the triggering business object
that has been updated in the source application does not exist in the
destination application. Set the CONVERT_UPDATE property as
follows:
- Set to true to cause the collaboration to convert an Update request to a
Create request if the triggering business object that has been updated in the
source application does not exist in the destination.
- Set to false to cause the collaboration to raise an exception.
Exception handling is determined by the setting of the
INFORMATIONAL_EXCEPTIONS property.
The default value is false.
The actions that the collaboration takes for CONVERT_UPDATE depend on the
value of the USE_RETRIEVE collaboration configuration property:
- If USE_RETRIEVE evaluates to true, the collaboration evaluates the
CONVERT_UPDATE property only if the triggering verb is Update and the retrieve
ascertains that the business object does not exist in the destination.
- If USE_RETRIEVE evaluates to false, the collaboration evaluates the
CONVERT_UPDATE property only after it fails in its attempt to update the
triggering business object in the destination.
The INFORMATIONAL_EXCEPTIONS collaboration configuration property indicates
how the collaboration responds to an exception. The property accepts
the following values:
- All--Whenever an exception occurs, the collaboration sends
it to a trace and ends in success.
- None--Whenever an exception occurs, the collaboration
raises it and ends in failure.
- A comma-delimited list of message numbers--Whenever one of the listed
exceptions occurs, the collaboration sends the exception to a trace and ends
in success. The exception message numbers correspond to those in the
collaboration's message file
(collaborations\messages\CollaborationName.txt.).
The default value is 1000, 2000, 2005, 2010, 2015, 2020, 3000, 3010,
3020.
The SEND_EMAIL collaboration configuration property indicates whether the
collaboration sends email when it receives an exception. Set the
SEND_EMAIL property as follows:
- All--Whenever an exception occurs, the collaboration sends
email.
- None--Whenever an exception occurs, the collaboration does
not send email.
- A comma-delimited list of message numbers--Whenever one of the listed
exceptions occurs, the collaboration sends email. The exception message
numbers correspond to those in the collaboration's message file
(collaborations\messages\CollaborationName.txt.).
- A range of message numbers--Whenever one of the exceptions located in
the specified range occurs, the collaboration sends email.
The default value is none.
- Note:
- Specify the address in the Email notification address field on the
Collaboration Object Properties dialog box in System Manager. If an
email address is specified for a collaboration, the collaboration calls the
Email collaboration when an error occurs. The Email collaboration can
be installed and configured as part of WebSphere Business Integration
Express.
The USE_RETRIEVE collaboration configuration property indicates whether the
collaboration retrieves its triggering business object from the destination
application before it synchronizes data. Set the USE_RETRIEVE property
as follows:
- Set to true to cause the collaboration to retrieve its triggering business
object from the destination application before synchronizing data. This
setting is useful when:
- The collaboration is triggered by another collaboration and might be
required to perform compensation processing if any step of the grouped
collaborations fails. Forcing the collaboration to retrieve values
before changing them allows the collaboration to restore the original values
in an Update or Delete process.
- The collaboration is triggered by a Wrapper Collaboration, which always
sends the triggering business object with the Create verb. Setting this
property to true prevents the collaboration from failing if the business
object already exists in the destination. When USE_RETRIEVE evaluates
to true, the collaboration compares values in the source and destination
applications before performing a Create or Update. If the objects are
identical, it ends successfully.
- Set to false to cause the collaboration to begin processing without
retrieving its triggering business object from the destination
application. This setting is useful when it is not important to compare
the values in the source and destination business objects.
The default value is false.
- Note:
- For more information on using this property, see CONVERT_CREATE and CONVERT_UPDATE.
