Standard properties for collaboration templates

Table 102 lists the standard configuration properties for collaboration templates. These properties are based on the CollaborationFoundation template.

Table 102. 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 e-mail when it receives an exception.
USE_RETRIEVE Indicates whether the collaboration retrieves its triggering business object from the destination application before it synchronizes data.

1_EXCLUDE_VALUES

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:

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.

1_FAIL_ON_INVALID_VALUE

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:

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.

1_FILTER_ATTRIBUTE

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 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.

1_INCLUDE_VALUES

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:

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.

ADDITIONAL_RETRIEVE

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:

The default value is false.

CONVERT_CREATE

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:

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.

For a table that illustrates the relationship between the USE_RETRIEVE and CONVERT_CREATE configuration properties, see Use_Retrieve process.

CONVERT_UPDATE

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:

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:

INFORMATIONAL_EXCEPTIONS

The INFORMATIONAL_EXCEPTIONS collaboration configuration property indicates how the collaboration responds to an exception. The property accepts the following values:

The default value is 1000, 2000, 2005, 2010, 2015, 2020, 3000, 3010, 3020.

SEND_EMAIL

The SEND_EMAIL collaboration configuration property indicates whether the collaboration sends e-mail when it receives an exception. Set the SEND_EMAIL property as follows:

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 e-mail 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 InterChange Server Express.

USE_RETRIEVE

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:

The default value is false.

Note:
For more information on using this property, see CONVERT_CREATE and CONVERT_UPDATE.

Copyright IBM Corp. 2004, 2005