IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Access external services with adapters > Configure and using adapters > IBM WebSphere Adapters > JDBC > Reference > Configuration properties > Outbound configuration properties

Interaction specification properties

Interaction specification, or InteractionSpec, properties control the interaction for an operation. The external service wizard sets the interaction specification properties when you configure the adapter. Typically, you do not need to change these properties. However, some properties for outbound operations can be changed by the user.

For example, you might increase the value of the interaction specification property that specifies the maximum number of records to be returned by a RetrieveAll operation, if your RetrieveAll operations do not return complete information. To change these properties after the application is deployed, use the assembly editor in IBM Integration Designer. The properties reside in the method binding of the import.

Table 1 lists and describes the interaction specification property that you set. For information about how to read the property detail tables in the sections that follow, see Guide to information about properties.

Interaction specification property for the WebSphere Adapter for JDBC
Property name Description
In the wizard Interaction specification class
Pattern String customFaultPattern Indicates the fault pattern
Custom Fault Name customFaultName Indicates the corresponding fault name

Interaction specification property for RetrieveAll operation in the WebSphere Adapter for JDBC
Property name Description
In the wizard Interaction specification class
Maximum number of records to be returned maxRecords Maximum number of records to return for the RetrieveAll operation
N/A enablePaging Specifies whether to returns records from the starting index for the RetrieveAll operation
Starting index to return records startIndex Starting index to return records for the RetrieveAll operation
Number of records per page pageSize Number of records to be returned from the starting index for the RetrieveAll operation

Interaction specification property for UpdateAll and DeleteAll operation in the WebSphere Adapter for JDBC
Property name Description
In the wizard Interaction specification class
Return exception when no records are affected during the UpdateAll or DeleteAll operation errorOnNoRecordAffect Specifies whether to return an exception when records in the database are not affected during the UpdateAll or DeleteAll operation

Interaction specification property for BatchCreate, BatchUpdate, and BatchDelete operations in the WebSphere Adapter for JDBC
Property name Description
In the wizard Interaction specification class
NA batchSize Specifies the maximum number of business objects in one batch interaction
NA skipErrorsInBatch Indicates how to handle errors when the adapter executes a BatchCreate, BatchUpdate, or a BatchDelete operation
NA returnBOsInBatch Indicates whether the business objects in a batch are to be returned


Pattern String

This property specifies the custom fault pattern.

Pattern String
Required No
Default No default value
Usage Defines the fault pattern by typing a regular expression.

For example ".*Record is locked.*". During run time, the adapter returns a custom fault based on the user defined regular expression.

Property type String
Globalized No
Bidi supported No


Custom Fault Name

This property specifies the corresponding fault name.

Custom Fault Name
Required No
Default False
Usage Defines a fault name, which is used to generate the .xsd file. If the custom fault pattern string matches the predefined faults exception message, the custom fault is returned in precedence to the predefined faults.
Property type Boolean
Globalized No
Bidi supported No


Maximum number of records to be returned

This property specifies the maximum number of records to return for a RetrieveAll operation.

Maximum number of records to be returned details
Required No
Default 100
Usage

Use this property to control the number of records returned by the RetrieveAll operation.

  • If the value -1, the RetrieveAll operation returns all records matching the query. The value for this property is set to -1 internally when you select Return all records.

    When the value of this property is set as -1, the paging of records does not take effect during run time irrespective of the value specified in the Starting index to return records property.

  • If the value is zero or less than zero except -1, the adapter returns a ResourceException with the InvalidMaxRecords message.

  • If the value is greater than zero and the number of matches in the database exceeds the value of this property, the adapter returns the exception MatchesExceededLimitException. If the RetrieveAll operation does not return all the records, increase this value.

    For example, if you set the value to 50 and the table contains 100 records, the adapter returns the exception MatchesExceededLimitException.

  • If the value is greater than zero and the number of matches in the database is lesser than the value of this property, the RetrieveAll operation returns all records.

    For example, if you set the value to 50 and the table contains 25 records, the RetrieveAll operation returns all the 25 records.

Property type Integer
Globalized No
Bidi supported No


enablePaging

This property specifies whether to return records from the starting index for the RetrieveAll operation

Allow paging of records for the RetrieveAll operation details
Required No
Default False
Usage If you set this property to True, the adapter to returns records from the starting index that you specified.

If the number of records retrieved from database exceeds the maximum records value that you specified, only the records in the specified range are returned and no exception is generated.

When you set this property to True, the adapter optimizes the query for the RetrieveAll operation. However, the adapter cannot optimize the query for the RetrieveAll operation on a table business object configured with RetrieveAllSP, as this results in poor performance of the RetrieveAll operation. Hence, configuring RetrieveAllSP on a table, and setting this property to True is not recommended.

When this property is False, the adapter returns the maximum records that you have specified in the Maximum number of records to be returned property. However, if the number of records retrieved from database exceeds the maximum records value that you specified, the adapter returns the MatchesExceededLimitException.

Property type Boolean
Globalized No
Bidi supported No


Starting index to return records

This property specifies the starting index to return records for the RetrieveAll operation.

Starting index to return the records details
Required No
Default 0
Usage

Example: If the Number of records per page property is set to 50 and the Starting index to return records property is set to 20, the adapter returns all records starting from the 21st row to the 70th row.

If the value is less than 0, the adapter returns an exception.

Property type Integer
Globalized No
Bidi supported No


Number of records per page

This property specifies the number of records to be retuned from the starting index for the RetrieveAll operation.

Number of records per page details
Required No
Default 100
Usage

Example: If the Number of records per page property is set to 50 and the Starting index to return records property is set to 20, the adapter returns all records starting from the 21st row to the 70th row.

If the value is less than 1, the adapter returns an exception.

Property type Integer
Globalized No
Bidi supported No


Return exception when no records are affected during the UpdateAll or DeleteAll operation

This property specifies whether to return an exception when records in the database are not affected during the UpdateAll or DeleteAll operation.

Return exception when no records are affected during the UpdateAll or DeleteAll operation
Required No
Default False
Usage If you set this property to True, the adapter returns a RecordNotFoundException error when records in the database are not affected during the UpdateAll or DeleteAll operation.

This property is applicable for the UpdateAll and DeleteAll operations.

Property type Boolean
Globalized No
Bidi supported No


batchSize

This property specifies the maximum number of business objects in one batch interaction.

Batch Size Details
Required No
Default 100
Usage This property specifies the maximum number of business objects in one batch interaction. This property may have different optimized values for different databases and environments. In some cases, a very high value may have a negative effect. Refer to the documentation of the respective databases, or try different values to adjust the performance of your environment.
Property type Integer
Globalized No
Bidi supported No


skipErrorsInBatch

This property indicates how to handle errors when the adapter executes a BatchCreate, BatchUpdate, or a BatchDelete operation.

Skip Errors in Batch Details
Required No
Default True
Usage

  • If the skipErrorsInBatch property is set to True, and an exception occurs while processing individual business objects, the adapter sets the error message to a corresponding error message item. It then continues to process the rest of the business objects.

    You can analyze the return results and take necessary action for the business objects that had exceptions.

  • If skipErrorsInBatch is set to false, and an exception occurs while processing individual business objects, the first exception will be thrown and no resulting business object list will be returned even if you set a value for the returnBOsInBatch option.

Property type Boolean
Globalized No
Bidi supported No


returnBOsInBatch

This property indicates whether the business objects in a batch are to be returned.

Return Business Objects in Batch Details
Required No
Default False
Usage

  • If returnBOsInBatch is set to True, the batch operation will return the result business objects after the operation is completed. If there are sequence UIDs or CopyAttributes ASIs configured to the properties of the input business object, the updated business object will be returned.

  • If returnBOsInBatch is set to False, no result business objects will be returned after the operation is completed.

If skipErrorsInBatch is set to False, and exception occurs while processing individual business objects, no resulting business object list is returned, even if you set a value for the returnBOsInBatch option.

Property type Boolean
Globalized No
Bidi supported No

Outbound configuration properties


Related concepts:

RetrieveAll operation

UpdateAll operation

DeleteAll operation


Related tasks:

Changing interaction specification properties

Setting global properties for operations and creating wrapper business objects