Your Browser is not longer supported

Please use Google Chrome, Mozilla Firefox or Microsoft Edge to view the page correctly
Loading...

{{viewport.spaceProperty.prod}}

Defining configuration properties for outbound communication

&pagelevel(4)&pagelevel

For outbound communication, BeanConnect supports the following connection-specific configuration properties:

  • bufferedIO (via OSI-TP / LU6.2 only)

  • connectionURL

  • displayName

  • encoding

  • encodingActive

  • logLevel

  • reconnectThreshold (via UPIC only)

  • timeout

  • transactional (via OSI-TP / LU6.2 only)

The connection which you obtain with a ConnectionFactory.getConnection() call is preinitialized with these configuration properties.

bufferedIO (via OSI-TP / LU6.2 only)

The bufferedIO configuration property is used to define whether I/O buffering is carried out between the resource adapter and the proxy. If set, interaction between resource adapter and proxy is minimized. To reach maximum performance within a production environment you should set this property to true. During deployment or operation, you can set this value to false by means of the connection factory MBean to detect user errors as early as possible during the test.

Definition:

[true | false]

Explanation:

Switches IO buffering between resource adapter and proxy on or off.

true:

false:

IO buffering is used.

IO buffering is not used.

Default:

true

Example:

<property>    
   <name>bufferedIO</name>    
   <value>true</value> 
</property>

connectionURL (via OSI-TP / LU6.2)

For communication via OSI-TP or LU6.2, the connectionURL configuration property specifies the name of the outbound communication endpoint which stands for a connection to an EIS partner and was defined in the proxy using the Management Console. The name begins with a prefix which describes the type of EIS partner, e.g. utm or cics.

The name of the outbound communication endpoints is a freely definable string. It must be the same as the corresponding name of the outbound communication endpoint configured in the proxy, see Configuring outbound communication.

Definition:

<type>://<name>

Explanation:

<type>

Type of the EIS partner, possible values:



utm

The EIS partner is of type openUTM.



cics

The EIS partner is of type CICS.



xatmi-rr

The EIS partner is of type XATMI and communication is conducted using the Request/Reply paradigm.



xatmi-cv

The EIS partner is of type XATMI and communication is conducted using the Conversational paradigm.


<name>

Name of an outbound communication endpoint as it was defined using the Management Console

Default:

utm://outboundCommunicationEndpoint

Example:

<property>    
   <name>connectionURL</name>    
   <value>utm://HELLO</value> 
</property>

connectionURL (via UPIC)

The  connectionURL  property defines the EIS partner and, if required, the service that is to be addressed. Only EIS partners of type openUTM are permitted for outbound communication via UPIC.

In the case of a connection with a UTM cluster application, you can specify a list of URLs under  connectionURL. The individual URLs in this list must be separated by commas.

The  getConnection()  method of a connection factory supplies a connection with the appropriate configuration properties. The  getConnection()  property can be used by both the  EISConnection  or the  EISUpicConnection  interface.

Definition:

upic://<host>[:<port>]/[<local>:]<remote>[/<tac>]
[?tsel[;tsel]]

Explanation:

host

Host on which the UTM partner application is running.


port

Port number of the port at which the UTM partner application listens (optional). Default: 102


local

Local name of the client (PTERM). Default:  JUPIC


remote

Name of the UTM partner application (BCAMAPPL or APPLINAME).


tac

TAC (ServiceName) which is to be called in the UTM partner application (optional).
This value can be overwritten by methods which are defined in the  EISConnection  interface.


tsel

TSEL format definition for the locale address (lt) or remote addresses (rt) in the form (optional):
[lt={a|e|t}]|[rt={a|e|t}]
a =ASCII, e = EBCDIC, t = TRANSDATA
Default:
lt=t  if  local  does not contain any lowercase characters,  a  otherwise
rt=t  if  remote  does not contain any lowercase characters  a  otherwise

Default:

upic://<host>:<port>/application/service

Example:

EIS partner in a BS2000 system:

<property>
    <name>connectionURL</name>
    <value>upic://BS2HOST/UTMAPP/INFO</value>
</property>

EIS partner on Linux/Windows systems:

<property>
    <name>connectionURL</name>
    <value>upic://unixhost:24000/UTMAPP/INFO?rt=a</value>
</property>

displayName

This attribute allows you to define a name for a managed connection factory. This name is then used by BeanConnect when outputting information about this managed connection factory, e.g. during the output of MBeans and LogWriter records.

Definition:

[<name>]

Explanation:

Freely definable name of a managed connection factory as it is to be used, for example in MBean and LogWriter output.

Default:

No default value.
If you do not specify a name then the internal name of the managed connection factory is used. This consists of the prefix "MCF" and a 5-digit number.

Example:

<property>    
   <name>displayName</name>    
   <value>sample application/test</value> 
</property>

encoding

The encoding configuration property defines a code table for converting byte code (for example EBCDIC) to Unicode. These code tables are used for converting byte streams to strings and vice versa. These conversions are always called implicitly when interactions (sndString(), rcvString() for example) are executed which contain strings as I/O parameters.

The code table that is defined with the encoding configuration property is used as default for the corresponding connection. The bean programmer may determine that a different code table is to be used for the connection by explicitly calling the setEncoding(Encoding) method of the EISConnection interface or of the OltpMessageContext interface (see Encoding).

Code conversion using this code table is only carried out if encodingActive is actually activated. You can select this with the encodingActive configuration property or by calling the method setEncodingActive(true).

There are different definitions for UTM-Partners and CICS partners.

For outbound communication to UTM partners apply:

Definition:

[<builtin_encoding_table> |
builtin:<builtin_encoding_table> |
jdk:<jdk_encoding_table> |
custom:<encoding_table>]

Explanation:

Name of a code table to be used for code conversion.
If no prefix is specified or if the prefix builtin: is specified, you must specify the name of a built-in code table provided by BeanConnect.
The following built-in code tables are provided:
OSD_EBCDIC_DF03_IRV, OSD_EBCDIC_DF04_1, OSD_EBCDIC_DF04_15, OSD_EBCDIC_DF04_DRV
Use the prefix jdk: to specify a code table contained in the JDK.
Use the prefix custom: to assign your own code table. Here you must specify the fully qualified class name of the code table. For further details on using your own code tables, refer to the JavaDoc for BeanConnect.

Default:

For UTM partners, this value is set to "OSD_EBCDIC_DF04_DRV".

Example:

<property>    
   <name>encoding</name>    
   <value>OSD_EBCDIC_DF03_IRV</value> 
</property>

For outbound communication to CICS partners apply:

Definition:

[jdk:<jdk_encoding_table> |
custom:<encoding_table>]

Explanation:

Name of a code table to be used for code conversion.
Use the prefix jdk: to specify a code table contained in the JDK.
Use the prefix custom: to assign your own code table. Here you must specify the fully qualified class name of the code table. For further details on using your own code tables, refer to the JavaDoc for BeanConnect.

Default:

jdk:Cp1047

Example:

<property>    
   <name>encoding</name>    
   <value>jdk:Cp1250</value> 
</property>

encodingActive

The encodingActive configuration property specifies whether code conversion is to be activated.

Definition:

[true | false]

Explanation:

Flag specifying whether code conversion is to be activated.


true:

Code conversion according to the settings of the encoding configuration property is activated.


false:

The default code table of the JDK is used to convert byte streams to strings.

Default:

false

Example:

<property>    
   <name>encodingActive</name>    
   <value>true</value> 
</property>

The deployment settings can be overwritten using the setEncodingActive() method defined in the EISConnection interface.

logLevel

This attribute can be used to set the level for the output of log records to a LogWriter for a connection factory. LogWriters for connection factories are configured in different ways depending on the employed application server. For more detailed information on LogWriter configuration and output, see LogWriter for connection factories.

Definition:

[NONE | ERROR | INFO | ALL]

Explanation:

NONE

No output is written to the LogWriter.


ERROR

Only information relating to exceptions and transaction rollbacks is written to the LogWriter.


INFO

In addition to the information listed for ERROR, all transaction-related events are logged, e.g. the beginning or committing of transactions


ALL

In addition to the information listed for INFO, all events relating to connection lifecycles are logged. These include, for example, the requesting or releasing of connection handles by the application or events which affect pooling.

Default:

NONE

Example:

<property>    
   <name>logLevel</name>    
   <value>INFO</value> 
</property>

reconnectThreshold (via UPIC only)

The configuration property  reconnectThreshold  defines how often a (physical) connection can be used (number of  getConnection()  calls) before it is to be disconnected and reestablished by BeanConnect. This type of forced disconnection can be of use if the EIS partner is a cluster application and it is necessary to redistribute the connections to the cluster nodes from time to time.

The value 0 means that BeanConnect will not force any disconnections for this connection.

Definition:

Upper limit for the number of times a physical connection can be used

Default:

0

I.e. BeanConnect does not force disconnection

Example:

<property>
     <name>reconnectThreshold</name>
     <value>10</value>
</property>

timeout

The timeout configuration property specifies the maximum time the resource adapter waits for the proxy or EIS partner to answer.

The value specified here must be greater than the maximum time that the EIS system needs to process a call. If the timer expires, an exception is thrown to the application and the connection between the resource adapter and the proxy is reinitialized. This generally causes the transaction to be reset at the EIS partner.

Definition:

Time in millisecods.

Explanation:

> 0

0

Maximum time in milliseconds the resource adapter waits.

The resource adapter waits indefinitely.

Default:

300000

  30000

corresponds to 5 minutes (via OSI-TP / LU6.2)

corresponds 30 seconds (via UPIC)

Example:

<property>    
   <name>timeout</name>    
   <value>30000</value> 
</property>

transactional (via OSI-TP / LU6.2 only)

The transactional configuration property specifies whether the communication between the application server and the EIS should be transactional. In this case the transaction of the EIS is included in the transaction of the application server.

Definition:

[true | false]

Explanation:

true:

false:

Participation in the application server transaction is activated.

Participation in the application server transaction is deactivated.

Default:

false

Example:

<property>    
   <name>transactional</name>    
   <value>true</value> 
</property>