Sybase Technical Library - Product Manuals Home
[Search Forms] [Previous Section with Hits] [Next Section with Hits] [Clear Search] Expand Search

Open string parameters for
DTM XA Interface [Table of Contents] Using the DTM XA Interface
with CICS

XA Interface Integration Guide for CICS, Encina, and TUXEDO Adaptive Server Version 12.5

[-] Chapter 3 Configuring the XA Environment
[-] XA configuration file for DTM XA Interface

XA configuration file for DTM XA Interface

The DTM XA Interface to Adaptive Server provides mechanisms for configuring the Open Client connections using the XA configuration file. Set all connection capabilities, properties, and options using the XA configuration file.

Environment variable for specifying configuration file

The DTM XA Interface uses the environment variable XACONFIGFILE to find the full path and file name of the XA configuration file. You can set this environment variable to specify different locations and names to use for configuration information as necessary.

For example, on UNIX platforms:

setenv XACONFIGFILE /usr/u/sybase/xaconfig1.txt

If XACONFIGFILE is not defined, or if it does not specify a valid configuration file, the DTM XA Interface looks for a file named xa_config in the following directories:

The DTM XA Interface uses the first xa_config file it finds.

[all] section for defining common LRM parameters

The DTM XA Interface uses the [all] section to define parameters that apply to all LRMs.

Certain parameters defined in the [all] section--log file and trace flag definitions--may also be defined in the open string for X/Open XA transaction managers.

Parameter definitions for [all] section

Entries for the [all] section in the XA configuration file are as follows:

[all]
logfile=logfile_name
traceflags=[xa | xl | xc | cm| event | misc | os | ct | all]
[properties=name=value] [...]

Table 3-3 describes each component.

Parameters for [all] section of XA configuration file

Parameter

Meaning

logfile_name

The fully qualified file name to which the DTM XA Interface writes tracing information.

The DTM XA Interface initializes the log file and trace flag settings with the initial xa_open() call.

traceflags

The trace flags control the output that is written to the log file. Specify one or more of the following flags:

all - all tracing.

ct - the ct_debug option with the CS_DBG_ERROR flag (ct_debug functionality is available only from within the debug version of Client-Library).

cmn - entry and exit point tracing of internal XA Interface functions.

event - tracing of significant internal events.

misc - tracing of activities and information for problem resolution.

xa - entry and exit point tracing at the xa_* level.

xc - entry and exit point tracing at the xc_* level.

xl - entry and exit point tracing at the xl_* level.

Tracing at the xc_*, xl_*, event, misc, and cmn levels is intended to be meaningful only to Sybase development. Specify these tracing levels only when instructed to do so by Sybase Technical Support.

properties

The following property must be set in the [all] stanza. You cannot set it in the [xa] stanza:

CS_LOGIN_TIMEOUT=timeout

You can define these optional properties in the [all] section of the XA configuration file:

PROPERTIES=CS_DISABLE_POLL=[CS_TRUE | CS_FALSE]

PROPERTIES=CS_EXTRA_INF=[CS_TRUE | CS_FALSE]

PROPERTIES=CS_HIDDEN_KEYS=[CS_TRUE | CS_FALSE]

PROPERTIES=CS_MAX_CONNECT=number_of_connections

PROPERTIES=CS_NOINTERRUPT=[CS_TRUE | CS_FALSE]

PROPERTIES=CS_TEXTLIMIT=textlimit

PROPERTIES=CS_TIMEOUT=timeout

Editing the XA configuration file

You must customize the XA configuration file for the application environment. Use the text editor of your choice to open the XA configuration for editing. The sample contents of an XA configuration file are as follows:

; Comment line as first line of file REQUIRED!
;
; xa_config - sample xa_config file.
;
; Note that the Adaptive Server names may need 
; to be customized for your environment.

; simprpc.ct sample application entry.

[all]
         logfile=logfile_name
        traceflags=traceflags
        properties=name=value [, name=value] [...]
 [xa]
         lrm=connection1
         server=sqlserver
 
 ; Rentapp sample xa_config entries.
 
 [xa]
         lrm=FLEET_CON
         server=fleetsrv
 
 [xa]
         lrm=RESERVE_CON
         server=rsrvsrv

The first line of the xa_config file MUST be a comment which is denoted by a semicolon (;) in the first character position.

For each additional LRM, create an entry with the following format. Keep the connection1 entry for installation verification.

[xa]
 <tab> lrm=connection_name
 <tab> server=adaptive_server_name
 <tab> capabilities=name=value [, name=value] [...]
 <tab> properties=name=value [, name=value] [...]
 <tab> options=name=value [, name=value] [...]

The connection_name is the symbolic name for the connection between the application and SQL. The adaptive_server_name is the name of the Adaptive Server associated with the connection. adaptive_server_name must correspond to a server name defined in the interfaces file.

See "Additional capabilities, properties, and options" for information a list of capabilities, properties, and options that can be used with the DTM XA Interface.

Additional capabilities, properties, and options

XA configuration file entries for capabilities, properties, and options have the following general format:

<tab> capabilities=name=value [, name=value] [...]
 <tab> properties=name=value [, name=value] [...]
 <tab> options=name=value [, name=value] [...]

Table 3-4, Table 3-5, and Table 3-6 list the names for capabilities, properties, and options that can be defined in the XA configuration file for the DTM XA Interface. Unless otherwise specified in these tables, the valid values for each capability, property, or option are CS_TRUE or CS_FALSE.

All names and values for these capabilities, properties, and options correspond to CS-Library keywords. See the Open Client Client-Library/C Reference Manual for specific descriptions.

XA Interface valid capabilities

Capabilities

CS_CON_NOINBAND

CS_DATA_NOINT2

CS_CON_NOOOB

CS_DATA_NOINT4

CS_DATA_NOBIN

CS_DATA_NOINT8

CS_DATA_NOVBIN

CS_DATA_NOINTN

CS_DATA_NOLBIN

CS_DATA_NOMNY4

CS_DATA_NOBIT

CS_DATA_NOMNY8

CS_DATA_NOBOUNDARY

CS_DATA_NOMONEYN

CS_DATA_NOCHAR

CS_DATA_NONUM

CS_DATA_NOVCHAR

CS_DATA_NOSENSITIVITY

CS_DATA_NOLCHAR

CS_DATA_NOTEXT

CS_DATA_NODATE4

CS_PROTO_NOBULK

CS_DATA_NODATE8

CS_PROTO_NOTEXT

CS_DATA_NODATETIMEN

CS_RES_NOEED

CS_DATA_NODEC

CS_RES_NOMSG

CS_DATA_NOFLT4

CS_RES_NOPARAM

CS_DATA_NOFLT8

CS_RES_NOTDSDEBUG

CS_DATA_NOIMAGE

CS_RES_NOSTRIPBLANKS

CS_DATA_NOINT1

XA Interface valid properties

Properties

CS_ASYNC_NOTIFS

CS_SEC_NEGOTIATE

CS_DIAG_TIMEOUT

CS_TDS_VERSION= [CS_TDS_40 | CS_TDS_42 | CS_TDS_46 | CS_TDS_50]

CS_DISABLE_POLL

CS_TEXTLIMIT=textlimit

CS_HIDDEN_KEYS

CS_EXTRA_INF

CS_PACKETSIZE=packetsize

CS_MAX_CONNECT=connections

CS_SEC_APPDEFINED

CS_NOINTERRUPT

CS_SEC_CHALLENGE

CS_TIMEOUT=timeout

CS_SEC_ENCRYPTION

XA Interface valid options

Options

CS_OPT_ANSINULL

CS_OPT_NOEXEC

CS_OPT_ANSIPERM

CS_OPT_PARSEONLY

CS_OPT_ARITHABORT

CS_OPT_QUOTED_IDENT

CS_OPT_ARITHIGNORE

CS_OPT_RESTREES

CS_OPT_DATEFIRST= [CS_OPT_SUNDAY | CS_OPT_MONDAY | CS_OPT_TUESDAY | CS_OPT_WEDNESDAY | CS_OPT_THURSDAY | CS_OPT_FRIDAY | CS_OPT_SATURDAY]

CS_OPT_ROWCOUNT=rowcount

CS_OPT_DATEFORMAT= [CS_OPT_FMTMDY | CS_OPT_FMTDMY | CS_OPT_FMTYMD | CS_OPT_FMTYDM | CS_OPT_FMTMYD | CS_OPT_FMTDYM]

CS_OPT_SHOWPLAN

CS_OPT_FIPSFLAG

CS_OPT_STATS_IO

CS_OPT_FORCEPLAN

CS_OPT_STATS_TIME

CS_OPT_FORMATONLY

CS_OPT_STR_RTRUNC

CS_OPT_GETDATA

CS_OPT_TEXTSIZE=textsize

CS_OPT_ISOLATION= [CS_OPT_LEVEL1 | CS_OPT_LEVEL3]

CS_OPT_TRUNCIGNORE

CS_OPT_NOCOUNT


Open string parameters for
DTM XA Interface [Table of Contents] Using the DTM XA Interface
with CICS