![]() ![]() ![]() ![]() ![]() ![]() ![]() |
The following configuration files must be set up prior to running Oracle Tuxedo Mainframe Adapter for TCP Gateway (hereafter referenced as TMA TCP Gateway):
This document explains the following tasks for configuring TMA TCP Gateway:
As with any Tuxedo server, you must establish a server group for TMA TCP Gateway by adding entries for TMA TCP Gateway in the UBBCONFIG
file for the local region. Specifically, you must add records to:
See the Oracle Tuxedo Administrator’s Guide for more information about the UBBCONFIG
file. For information about the UBBCONFIG
file specific to the gateway, refer to the
Updating the GROUPS Section to Establish a Server Group and
Updating the SERVERS Section sections.
Note: | Lines beginning with an asterisk (*) indicate the beginning of a specification section. Each such line contains the name of the section immediately following the *. The asterisk is required when specifying a section name. |
To establish a server group for TMA TCP Gateway, you must add the following items to the GROUPS
section of the Oracle Tuxedo UBBCONFIG
file:
groupname
variableLMID
parameterNote: | For Windows NT, the LMID must be in uppercase |
GROUPNO
parameterThe syntax of the configuration file entry is as follows.
groupname
LMID=logical_machine_identifier
GROUPNO=group_number
The variable definitions follow.
Here is an example of a UBBCONFIG
entry that establishes a server group.
NODE2GATE LMID=NODE2
GROUPNO=1
This section explains how to specify TMA TCP Gateway servers in the Oracle Tuxedo configuration.
The TMA TCP Gateway product provides the gateway you need to list in the SERVERS
section of the Oracle Tuxedo UBBCONFIG
configuration file.
For each TMA TCP Gateway server group, you can specify one gateway. There must also be entries for domain administration (DMADM
) and gateway administration (GWADM
) servers.
The syntax of each configuration file entry is as follows.
DMADM SVRGRP=groupname
SRVID=integer
GWADM SVRGRP=groupname
SRVID=integer
GWIDOMAIN SVRGRP=groupname
SRVID=integer
CLOPT="-A -- -r"
The following table describes the parts of the syntax.
For more information about Oracle Tuxedo servers and related configuration parameters, see the Oracle Tuxedo Administrator’s Guide.
Output from the -r command line option should be capable of being processed by txrpt
command. The txrpt
command analyzes the standard error output of a Oracle Tuxedo server and provides a summary of service processing time within the server. The report shows the number of times each service was dispatched and the average amount of time it took for each service to process a request during the specified period. txrpt
takes its input from the standard input or from a standard error file redirected as input.
Notes: | The process of gathering statistics creates overhead. Use this option selectively. |
Note: | The -r option applies to servers but does not apply to GWIDOMAIN because it is a Gateway. |
As with other Tuxedo servers, you can use some of Oracle Tuxedo system server boot options with TMA TCP Gateway servers. Boot options must be specified with CLOPT
parameter (before the CLOPT
double-dash separator).
Note: | Because TMA TCP Gateway dynamically advertises services that are listed in its initialization file, you should not advertise services by using the -s option. |
For more information about these and other boot options, see servopts(5)
in the Oracle Tuxedo Administrator’s Guide.
The GWICONFIG
file is the mechanism that system administrators use to configure TMA TCP Gateway. The particular file the gateway uses is determined by the environment variable GWICONFIG
. The configuration file is similar to the Tuxedo Transaction Manager UBBCONFIG
file, both in structure and in composition. This makes it possible for experienced Oracle Tuxedo administrators to configure TMA TCP Gateway without extensive training.
Note: | GWICONFIG is a generic filename. You are free to choose other filenames just as with the Tuxedo UBBCONFIG file and DMCONFIG file. Be sure that the name of the GWICONFIG file is specified in the GWICONFIG environment variable. Also, the GWICONFIG file should be saved to the application directory. |
The GWICONFIG
file is divided into the following required sections:
WARNING: | The GWICONFIG file must contain the required sections in the order shown in Listing 5-4. Each section requires the asterisk (*) in the name. |
*GLOBAL
NWDEVICE="/dev/tcp"
CONNECT_TIME=20
OUTREQ_TIME=20
LATENCY=-2
SECURE=N
MULTIPLEX=2
DFLTWRAP="TPS"
DFLTTYPE="MVS"
*NATIVE
LOCAL IPADDR="//beasun2"
TCP_PORT=9002
IDLE_TIME=20
*FOREIGN
RIGHTY WRAP="TPS"
TYPE="MVS"
IPADDR="//beasun2"
TCP_PORT=9004
MULTIPLEX=2
IDLE_TIME=30
RMTACCT="zeke"
PASSWORD="maple"
MIKE WRAP="TPS"
TYPE="MVS"
IPADDR="//dalvs3"
TCP_PORT=9001
MULTIPLEX=6
*LOCAL_SERVICES
TUXTOUPPER
ECHO
*REMOTE_SERVICES
TUXTOLOWER
OUTREQ_TIME=20
BEASVR07
OUTRECTYPE="VIEW:weird"
TST1V
Note: | Changes to the GWCONFIG file must be made when upgrading from previous releases of TMA TCP. See the Oracle Tuxedo Mainframe Adapter for TCP Release Notes for specific upgrade information. |
The following sections describe parameters that are associated with the GLOBAL
section of the GWICONFIG
file. These parameters describe global characteristics for the gateway.
The format of the GLOBAL
section of the GWICONFIG
file is shown in the following listing.
[ # A comment (from "#" to end of line)]
*GLOBAL
[ NWDEVICE=TCP_device
]
[ CONNECT_TIME=n
]
[ IDLE_TIME=n
]
[ OUTREQ_TIME=n
]
[ LATENCY=n
|1 ]
[ SECURE=Y|N ]
[ MULTIPLEX=n
|1 ]
[ DFLTWRAP=wrapper name
]
[ DFLTTYPE=translation type
]
The following table describes the parameters that are set in the GLOBAL
section.
If
SECURE=Y , then the TMA TCP Gateway supplies user information to remote services and applies remote user information to local services using the appkey .
|
|||
Specifies the name of the default wrapping library to use for wrapping and unwrapping messages for machines without a
FOREIGN section or without a WRAP parameter in the FOREIGN section. A corresponding wrapper object WRAP< wrapper name > must exist. The wrapper name TPS is used in most cases. Specify TPSD if data area security is used. For more information about data area security, refer to
Setting Up Security for Oracle TMA TCP Gateway.
|
|||
Specifies the default foreign system type for encoding and decoding message buffers. If you specify
TYPE in the FOREIGN section, that TYPE definition overrides this default value. For normal C-to-COBOL encoding, specify DFLTYPE="MVSC" to enable COBOL data encoding.
For more information about
DFLTYPE values MVS and MVSC, refer to
Configuring Oracle TMA TCP Gateway for Data Mapping.
|
The following sections describe parameters that are associated with the NATIVE
section of the GWICONFIG
file. These parameters are specific to the local system. You can specify multiple native systems in the same configuration file allowing multiple gateway processes to access the same configuration file. This makes a single repository of connectivity services. The link between the gateway process and the native system entry is made through the GWINAME
environment variable.
The format of the NATIVE
section of the GWICONFIG
file is illustrated in the following listing.
[ # A comment (from "#" to end of line)]
*NATIVE
<GATEWAY_NAME>
[ IPADDR=ip_address
]
[ TCP_PORT=port number ]
[ IDLE_TIME=n
]
[ MULTIPLEX=n]
[ POLL_TIME=n
]
[ MAXCONNECT=n]
The following table describes for each local system that are specified in the NATIVE
section.
The FOREIGN
section of the GWICONFIG
file contains parameters that collectively describe foreign systems.
The format of the FOREIGN
section of the GWICONFIG
file is illustrated in the following listing.
[ # A comment (from "#" to end of line)]
*FOREIGN
<SYSTEM_NAME>
IPADDR=ip_address
[TYPE=system_type
][WRAP=
wrapper name
]
[TCP_PORT=port number]
[MULTIPLEX=n sessions]
[IDLE_TIME=n seconds]
[RMTACCT=”userid
”]
[PASSWORD=”password
”]
[CICS=Y | N]
[CICSHAND=<name>
]
[MAXCONNECT=n]
[CONNSYNC=Y|N]
[CONNECT_TIME=n
]
[CICSDATA="string"
]
The following table describes the parameters that are set for the each foreign system that you specify in the FOREIGN
section.
The following table describes the parameters that are specified in the FOREIGN
section.
Specifies the foreign system type for encoding and decoding the Tuxedo buffers (application data).
TYPE values of MVS and MVSC support C-to-COBOL or COBOL data encoding. If you do not specify TYPE , the value in DFLTYPE in the GLOBAL section is used.
For more information about MVS and MVSC
TYPE values, refer to Configuring Oracle TMA TCP Gateway for Data Mapping.
|
|||
Specifies the name of the wrapping entry to use for wrapping and unwrapping messages for this host. A corresponding wrapper object
wrap<wrapper name> must exist. The wrapper name TPS is used in most cases.
Specify
TPSD if data area security is used. For more information about data area security, refer to Setting Up Security for Oracle TMA TCP Gateway.
|
|||
The LOCAL_SERVICES
section of the GWICONFIG
file contains parameters for each local service specified in the DMCONFIG
file. Each service entry name matches the remote name of the service in the DM_LOCAL_SERVICES
section.
The format of the LOCAL_SERVICES
section of the GWICONFIG
file is illustrated in the following listing.
[ # A comment (from "#" to end of line)]
*LOCAL_SERVICES
<SERVICE_NAME>
[INRECTYPE=”foreign_incoming_buffer_type”
][OUTRECTYPE=
”foreign_outgoing_buffer_type”
]
[SECURE=Y | N]
[CONV=Y | N]
The following section describes the parameters set for each service you specify in the LOCAL_SERVICES
section.
If
SECURE=Y , then the TMA TCP Gateway applies remote user information to local services using the appkey .
|
|||
The REMOTE_SERVICES
section of the GWICONFIG
file contains parameters for each remote service specified in the DMCONFIG
file. Each service entry name matches the remote name of the service in the DM_REMOTE_SERVICES
section.
The format of the REMOTE_SERVICES
section of the GWICONFIG
file is illustrated in the following listing.
[ # A comment (from "#" to end of line)]
*REMOTE_SERVICES
<SERVICE_NAME>
[INRECTYPE=”foreign_outgoing_buffer_type”
][OUTRECTYPE=
”foreign_incoming_buffer_type”
]
[OUTREQ_TIME=n
]
[SECURE=Y | N]
[CONV=Y | N]
The following table describes the parameters set for each service you specify in the REMOTE_SERVICES
section.
The domain configuration file (DMCONFIG
) is made up of specification sections. Lines beginning with an asterisk (*) indicate the beginning of a specification section. Each such line contains the name of the section immediately following the *. The asterisk is required when specifying a section name. Allowable section names are: DM_LOCAL_DOMAINS
, DM_REMOTE_DOMAINS
, DM_LOCAL_SERVICES
, DM_REMOTE_SERVICES
, DM_ROUTING
, and DM_ACCESS_CONTROL
.
Note: | The DM_LOCAL_DOMAINS section must precede the DM_REMOTE_DOMAINS . |
The following paragraphs describe the significant parameters within specific sections of the DMCONFIG
file that define new gateway configurations.
This section identifies local domains and their associated gateway groups. The section must have an entry for each gateway group (local domain). Each entry specifies the parameters required for the domain gateway processes running in that group.
The format of the DM_LOCAL_DOMAINS
section of the DMCONFIG
file is illustrated in the following listing.
LDOM required parameters [optional parameters]
LDOM
is an identifier value used to name each local domain and must be unique within a particular configuration. In the description of the DM_LOCAL_SERVICES
section, LDOM
is the identifier that connects local services with a particular gateway group.
The following table describes the parameters that are set in the DM_LOCAL_SERVICES
section.
Is used for grouping local domain into classes.
TYPE can be set to TDOMAIN or any other domain gateway type. The TDOMAIN value indicates that this local domain can only communicate with another Tuxedo System/Domain. For use with TMA TCP Gateway, specify TYPE=IDOMAIN . Domain types must be defined in the $TUXDIR/udataobj/DMTYPE file.
|
|||
Is used to identify the local domain.
DOMAINID must be unique across both local and remote domains. The value of string can be a sequence of characters (for example, "BA.CENTRAL01 "), or a sequence of hexadecimal digits preceded by "0x" (for example, "0x0002FF98C0000B9D6 "). DOMAINID must be 32 octets or fewer in length. If the value is a string, it must be 31 characters or fewer.
|
|||
Specifies the name of the audit log file for this local domain. The audit log feature is activated from the
dmadmin command and records all the operations within this local domain. If the audit log feature is active and this parameter is not specified, the file DMmmddyy.LOG (where mm =month, dd =day, and yy =year) is created in the directory specified by the $APPDIR environment variable or the APPDIR keyword of the MACHINES section of the TUXCONFIG file.
|
|||
Specifies the mapping to use with remote hosts that are not specified in the
DMCONFIG file. CODEPAGE designates a bidirectional translation table for ASCII to EBCDIC conversion between a local Tuxedo application and a remote mainframe application. The table-identifier describes a file containing a translation table. The name of the file, located in the $TUXDIR/udatajobj/codepage directory, is a composite of the code page numbers used for the translation. This parameter specifies the mapping to use with remote hosts that are not specified in the DMCONFIG file.
For example, specifying
CODEPAGE=00819x00297 designates the translation table for converting ASCII CP-00819 characters to French EBCDIC CP-00297 characters, and vice versa. The translation tables can be modified. For complete character listings, refer to Code Page Translation Tables.
|
|||
Specifies the Tuxedo file system that contains the Domain transaction log (
DMTLOG ) for this machine. The DMTLOG is stored as a Tuxedo System VTOC table on the device. If this parameter is not specified, the domain gateway group is not allowed to process requests in transaction mode. Local domains running on the same machine can share the same DMTLOGDEV file system, but each local domain must have its own log (a table in the DMTLOGDEV ) named as specified by the DMTLOGNAME keyword.
|
|||
This section identifies the known set of remote domains and their characteristics.
The format of the DM_REMOTE_DOMAINS
section of the DMCONFIG
file is illustrated in the following listing.
RDOM required parameters [optional parameters]
RDOM
is an identifier value used to identify each remote domain known to this configuration and must be unique within the configuration.
The following table describes the parameters that are set in the DM_REMOTE_DOMAINS
section.
Is used for grouping remote domain into classes.
TYPE can be set to TDOMAIN or any other domain gateway type. The TDOMAIN value indicates that this remote domain can only communicate with another Tuxedo System/Domain. The OSITP value indicates that this remote domain communicates with another TP domain via the OSI-TP protocol. For use with TMA TCP Gateway, specify TYPE=IDOMAIN .
|
|||
Is used to designate a bidirectional translation table for ASCII to EBCDIC conversion between a local Tuxedo application and a remote mainframe application. The table-identifier describes a file containing a translation table. The name of the file, located in the
$TUXDIR/udatajobj/codepage directory, is a composite of the code page numbers used for the translation.
For example, specifying
CODEPAGE=00819x00297 designates the translation table for converting ASCII CP-00819 characters to French EBCDIC CP-00297 characters, and vice versa. The translation tables can be modified. For complete character listings, refer to Code Page Translation Tables.
|
This section is optional in the DMCONFIG
file and specifies the access control lists used by local domain.
The format of the DM_ACCESS_CONTROL
section of the DMCONFIG
file is illustrated in the following listing.
ACL_NAME required parameters
ACL_NAME
is a name (identifier) used to identify a particular access control list; it must be 15 characters or less in length.
This section provides information on the services exported by each local domain. This section is optional and if it is not specified then all local domains defined in the DM_LOCAL_DOMAINS
section accept requests to all of the services advertised by the Tuxedo System/Domain application. If this section is defined then it should be used to restrict the set of local services that can be requested from a remote domain.
The format of the DM_LOCAL_SERVICES
section of the DMCONFIG
file is illustrated in the following listing.
service [optional parameters]
service
is the local name (identifier) of the exported service, and it must be 15 characters or fewer in length.
This name corresponds to a name advertised by one or more servers running with the local Tuxedo System/Domain application. Notice that exported services inherit the default or special properties specified for the service in an entry in the SERVICES
section of the TUXCONFIG
file. Some of these parameters are: LOAD
, PRIO
, AUTOTRAN
, ROUTING
, BUFTYPE
, and TRANTIME
.
This section provides information on services “imported” and available on remote domains.
The format of the DM_REMOTE_SERVICES
section of the DMCONFIG
file is illustrated in the following listing.
service [optional parameters]
service
is the name (identifier) used by the local Tuxedo System/Domain application for a particular remote service. Remote services are associated with a particular remote domain.
This section is optional in the DMCONFIG
file and provides information for data-dependent routing of service requests using FML
, VIEW
, X_C_TYPE
, and X_COMMON
typed buffers.
The format of the DM_ROUTING
section of the DMCONFIG
file is illustrated in the following listing.
CRITERION_NAME required parameters
CRITERION_NAME
is the (identifier) name of the routing entry that was specified on the services entry. CRITERION_NAME
must be 15 characters or less in length.
Listing 5-16 is a sample DMCONFIG
file and must be set up prior to running the TMA TCP Gateway product. For a sample DMCONFIG
file that uses alternate data mapping tools, refer to the
“Configuring Oracle TMA TCP Gateway
for Data Mapping” section.
#
# Copyright (c) 2008 Oracle Systems, Inc
# All Rights Reserved
#
# THIS IS UNPUBLISHED PROPRIETARY SOURCE CODE OF
# Oracle Systems, Inc.
# The copyright notice above does not evidence any
# actual or intended publication of such source code.
#
#
*DM_LOCAL_DOMAINS
LOCAL GWGRP=GROUP
TYPE=IDOMAIN
DOMAINID="LOCAL"
#
*DM_REMOTE_DOMAINS
REMOTE TYPE=IDOMAIN
DOMAINID="REMOTE"
#
*DM_LOCAL_SERVICES
ECHOX RNAME="ZECHOSV4"
TOLOWER RNAME="TUXTOLOWER"
INBUFTYPE=string
OUTBUFTYPE=string
#
*DM_REMOTE_SERVICES
TOUPPER RDOM=REMOTE
LDOM=LOCAL
RNAME="TUXTOUPPER"
ECHOFAR RDOM=REMOTE
LDOM=LOCAL
RNAME="BEASVR07"
INBUFTYPE="VIEW:myview"
OUTBUFTYPE="FML"
NORMAL RDOM=REMOTE
LDOM=LOCAL
RNAME="TST1V"
![]() ![]() ![]() |