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 general properties in ra.xml

The general configuration properties are relevant for outbound communication via OSI-TP / LU6.2 and for inbound communication.

Alternatively you can deploy the resource adapter with the predefined settings. Then specify the values by using the application server's GUI. These settings can be lost while undeploying.

Adapting the ra.xml file

You can adapt ra.xml in two ways

  • with the BeanConnect Management Console provided that the BeanConnect RAR archive and the Management Console are located on the same host, or an MC-CmdHandler is installed on the same computer as the BeanConnect RAR archive and is configured in the Management Console.

    When you do this, the deployment descriptor is modified directly in the RAR archive. You can either edit the values of the properties (Edit ra.xml of BeanConnect Resource Adapter RAR... command) or update them on the basis of the values that have been configured for a defined proxy (Update ra.xml of BeanConnect Resource Adapter RAR command). Updating has the advantage that the Management Console determines the correct value for the property proxyURL.

    For more information, see Configuring the BeanConnect resource adapter ).

  • Manually using a text editor.

    1. Extract the file ra.xml from the BeanConnect RAR archive:

      jar xf BC65A00.rar META-INF/ra.xml

    2. Use a text editor of your choice to modify the following general configuration properties in the file ra.xml:

      proxyURL (outbound and availability check of the proxy)

      transactionLogging (outbound only)

      transactionLogDir (outbound only)

      inboundListenerPort (inbound and availability check of the resource adapter)

      RevisionNumber

    3. Insert the file ra.xml in the BeanConnect RAR archive in the subdirectory META-INF again:

      jar uf BC65A00.rar META-INF/ra.xml

In multiple resource adapter mode or in cluster operation, it is necessary to make additional settings, see Special characteristics of multiple resource adapter mode and Special characteristics in cluster operation .

proxyURL

The proxyURL defines the way the resource adapter assigns the proxy.

proxyURL is defined globally for all connections.

Definition:

oltp://<host>:<port>/<name>

Explanation:

<host>

Host on which the proxy container is installed  <host> can be specified as a symbolic name or as an IPv4 address.


<port>

Port number of the proxy container + 4


<name>

Application name of the proxy container (BCU<port>)

Default:

oltp://localhost:31004/BCU31004

Example:

<config-property>
  <description>BeanConnect Proxy URL for OLTP outbound
         communication</description>
  <config-property-name>proxyURL</config-property-name>
  <config-property-type>java.lang.String
  </config-property-type>
  <config-property-value>oltp://proxyhost:31004/BCU31004
  </config-property-value>
</config-property>

If you use the Management Console function Update ra.xml of BeanConnect Resource Adapter RAR then the correct values are set for proxyURL.

If you edit ra.xml, you must determine the value for <port> from the value specified during the installation of the proxy (port +4). You must enter a value for <name> that consists of the prefix BCU and <port>.

The Management Console displays the proxy URL to be used in the properties dialog of the resource adapter. The proxy URL cannot be modified after installation.

For information on configuration for cluster operation, see Special characteristics in cluster operation .

transactionLogging

This attribute defines whether or not BeanConnect is to write persistent transaction logs for transactions with EIS partners during outbound communication.

Definition:

[NONE | FILE]

Explanation:

Activates or deactivates persistent transaction logging


NONE:

No persistent transaction logs are written.


FILE:

Persistent transaction logs are written. The directory to which the logs are written is specified in the attribute transactionLogDir.

Default:

NONE

Example:

<config-property>
  <description>BeanConnect transaction logging:
      possible values are NONE | FILE
  </description>
  <config-property-name>transactionLogging
  </config-property-name>
  <config-property-type>java.lang.String
  </config-property-type>
  <config-property-value>FILE
  </config-property-value>
</config-property>

During transaction recovery operations following a program or system crash, persistent transaction logs make it possible for BeanConnect to provide information about the status of the transactions that were being processed at the time of the crash. Activating this option has an impact on performance since two file access operations are required for every transaction which is terminated with two-phase commit.

If FILE is specified then it is also necessary to enter a value for the attribute transactionLogDir.

If transaction logging is configured then the resource adapter writes a separate transaction log for each transaction. The file name consists of the prefix tx. and a number.

A transaction log file is written on Prepare and deleted on Commit or Rollback, i.e. it is normally temporary. However, situations exist in which it is retained:

  • If the resource adapter is terminated between Prepare and Rollback or Commit. This type of log file is retained until the recovery has been completed for this transaction.

  • If a heuristic decision has been made for a transaction. This type of log file is retained for an indefinite period.

All the transaction log files are read in when the resource adapter is started. New transaction log files are written for transactions which have the status Prepared after start-up or for which a heuristic decision has been made.

For transactions associated with heuristic decisions, the transaction log files are retained for an indefinite period. They should therefore be deleted from time to time. The creation time of the log files may serve as a criterion when deciding which log files are to be deleted. Files whose creation date and time correspond to the last resource adapter start-up contain heuristic logs and the application server has not called forget() for these transactions; these files can be deleted. To identify the application start time, BeanConnect writes a file during the start phase after processing the transaction log files. This file has the name tx.startup-complete.<date>.<time> and is written in the transaction log directory.

BeanConnect deletes old startup-complete files on the next start-up.

transactionLogDir

This attribute defines the directory to which BeanConnect is to write the persistent transaction logs. A value must be specified for this attribute if the attribute transactionLogging has been assigned the value FILE.

Definition:

Name of a directory

Default:

persistence\BeanConnect

Example:

<config-property> 
  <description>Directory where transaction log files are to be
               stored (only needed if transactionLogging=FILE)
  </description>
  <config-property-name>transactionLogDir
  </config-property-name>
  <config-property-type>java.lang.String
  </config-property-type>
  <config-property-value>persistence/BeanConnect
  </config-property-value>
</config-property>

The directory can be specified with an absolute or relative path name. Any relative path specification is understood to be relative to the application server's home directory.

If the directory specified for transactionLogDir does not exist, BeanConnect creates it.

inboundListenerPort

For inbound communication, the resource adapter listens at a socket port for connection requests initiated by the proxy. You must specify the port number of this socket port with the global configuration property inboundListenerPort. This value must be adapted before deploying the resource adapter.

Definition:

<port number>

Explanation:

Port number of the socket port on which the resource adapter listens for inbound communication requests.0 means that no inbound communication is possible.

Default:

31099

Example:

<config-property>
  <description>Resource Adapter Listener Port for Inbound 
     Communication
  </description>
  <config-property-name>inboundListenerPort
  </config-property-name>
  <config-property-type>java.lang.String
  </config-property-type>
  <config-property-value>31099
  </config-property-value>
</config-property>

Even if no inbound functionality is used, you should specify a value here if you want to check the availability of the resource adapter as seen by the proxy (e.g. using the Management Console). You should only enter the value 0 if you also do not require this functionality.

The port number that is defined with inboundListenerPort must match the listener port number that you specified via the Management Console when adding the resource adapter to a proxy.

RevisionNumber

This attribute indicates the revision level of the file ra.xml. You should increase the value of the attribute revisionNumber every time you modify the ra.xml file in order to make it easier to identify possible inconsistencies in the configuration.

Example:

<config-property>
  <description>Revision number of the ra.xml. This number 
    should be incremented with each change of the resource 
    adapter properties.
  </description>
  <config-property-name>revisionNumber
  </config-property-name>
  <config-property-type>java.lang.String
  </config-property-type>
  <config-property-value>2
  </config-property-value>
</config-property>