Interaction specification properties

An interaction is an operation. Interaction specification properties control how the operation is run. The external service wizard sets the interaction specification properties when you configure the adapter.

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

Note: Typically, you do not need to change these properties. However, you can change some properties for outbound operations. For example, you might increase the value of the interaction specification property that specifies the maximum number of hits to be returned by a RetrieveAll operation, if your RetrieveAll operations do not return complete information. Use the assembly editor in IBM® Integration Designer to change these properties, which reside in the method binding of the import.

Table 1. Interaction specification properties for Adapter for SAP Software
Property name		Description
In the wizard	In the assembly editor	Description
Custom retrieve function name	customFunctionName	Indicates the name of a custom function to be used by the Query interface to SAP Software to retrieve data from an SAP table.
Function name	functionName	Populates the function name for the specific SAP interface.
Ignore errors in BAPI return	IgnoreBAPIReturn	Indicates if errors in BAPI returns will be ignored.
Maximum number of hits for the discovery	ResultSetLimit	Maximum number of result sets to return during a RetrieveAll operation.
Select the queue name	QRFCQueueName	The name of a customer-defined queue on the SAP server.
Wait until commit call to SAP database is completed and returned	WaitOnCommit	Enables adapter to wait until all time critical updates to SAP database are completed before calling commit on it.

Custom retrieve function name

For the Query interface for SAP Software, this property specifies the name of a custom function that should be used to retrieve data from an SAP table.

Table 2. Custom retrieve function name details
Required	No
Default	No default value
Property type	String
Usage	This property applies to Query interface for SAP Software only. On non-Unicode systems, the default function used to retrieve data from SAP tables (RFC_READ_TABLE) might produce an exception. To avoid the problem, you can create another function on the SAP server and then indicate, during configuration, that the adapter should use this custom function to retrieve data. This property specifies the name of the custom function. Note: You must create the function on the SAP server before you specify this property on the external service wizard. Follow the steps listed in SAP note 758278 to make a copy of RFC_READ_TABLE and modify the copy per the note.
Globalized	No
Bidi supported	No

Function name

The functionName interaction specification property controls the interaction by associating operations with the proper interface.

Table 3. Function name details
Required	Yes
Possible values	`True` `False`
Default	Null
Property type	String
Usage	The BAPI outbound and inbound interfaces support the following values for the functionName interaction specification property: `WBIInteractionSpec.CREATE` `WBIInteractionSpec.UPDATE` `WBIInteractionSpec.RETRIEVE` `WBIInteractionSpec.DELETE` The BAPI result set supports the following values for the functionName interaction specification property: `WBIInteractionSpec.RETRIEVEALL` The ALE outbound interface supports the following value for the functionName interaction specification property: `WBIInteractionSpec.EXECUTE` The ALE inbound interface supports the following values for the functionName interaction specification property: `WBIInteractionSpec.CREATE` `WBIInteractionSpec.UPDATE` `WBIInteractionSpec.RETRIEVE` `WBIInteractionSpec.DELETE` The Query interface for SAP software (QISS) interface supports the following values for the functionName interaction specification property: `WBIInteractionSpec.EXISTS` Throws exceptions `NotExistsException` and `QISSQueryFailedException` `WBIInteractionSpec.RETRIEVEALL` Throws exceptions `QISSQueryFailedException` The Advanced event processing interface for inbound processing supports the following values for the functionName interaction specification property: `WBIInteractionSpec.CREATE` `WBIInteractionSpec.UPDATE` `WBIInteractionSpec.DELETE` The Advanced event processing interface for outbound processing supports the following values for the functionName interaction specification property: `WBIInteractionSpec.CREATE` `WBIInteractionSpec.UPDATE` `WBIInteractionSpec.RETRIEVE` `WBIInteractionSpec.DELETE`
Globalized	No
Bidi supported	No

Ignore errors in BAPI return

This property indicates whether to ignore errors specified in a BAPI return operation. The return structure can be data or a table.

Table 4. Ignore errors in BAPI return details
Required	No
Possible values	`True` `False`
Default	`False`
Property type	Boolean
Usage	This property applies to BAPI outbound synchronous RFC processing only. When set to `True`, the Adapter for SAP Software ignores the checking of error code in the BAPI RETURN structure after BAPI has run, and returns this structure to user as is. Note: RETURN structure is part of every BAPI and contains status of the BAPI execution. Accepting the default value of `False` results in the adapter processing the RETURN structure and throwing an exception if an error code is found.
Globalized	No
Bidi supported	No

Maximum number of hits for the discovery

For the Query interface for SAP Software, this property specifies the maximum number of result sets, which represents data for each row retrieved from a table through a RetrieveAll operation.

Table 5. Result set limit details
Required	Yes
Default	`100`
Property type	Integer
Usage	This property applies to Query interface for SAP Software only. If the number of hits in the table on the SAP server exceeds the value of the ResultSetLimit property, the adapter returns the error `MatchesExceededLimitException`. The adapter uses this property to help avoid out-of-memory issues.
Globalized	No
Bidi supported	No

Select the queue name

For BAPI outbound processing, when Asynchronous queued RFC is selected, this property specifies the name of a queue on the SAP server to which BAPIs will be delivered.

Table 6. Select the queue name details
Required	No
Default	The first queue defined on the SAP server. If no queue is defined on the SAP server, there is no default value.
Property type	String
Usage	This property applies to BAPI outbound asynchronous queued RFC processing only. When you want to deliver BAPI calls to a queue on the SAP server, you must specify the name of the queue. During configuration, you select, from a drop-down list, an existing queue. If no queues exist on the SAP server, you can type the name of a queue.
Globalized	No
Bidi supported	No

Wait until commit call to SAP database is completed and returned

For BAPI outbound processing, this property specifies whether a commit call from the adapter should wait until all the time-critical (V1) updates to the SAP database have been completed. When this property is set to true, the commit to call to SAP waits until all updates are completed and returned. If it is set to false, the commit call returns immediately from the SAP database.

This property is only active when you use the CWYAP_SAPAdapter.rar file.

Table 7. WaitOnCommit property details
Required	No
Default	`False`
Property type	Boolean
Globalized	No
Bidi supported	No