Scalable Database Server, HiRDB Version 8 UAP Development Guide

[Contents][Index][Back][Next]

6.6.2 Specifications for using a UAP under OLTP as the client

Organization of this subsection
(1) Using a UAP under OpenTP1 as the client
(2) Using a UAP under TP1/LiNK as the client
(3) Using a UAP under TPBroker as the client
(4) Using a UAP under TUXEDO as the client
(5) Using a UAP under WebLogic Server as the client
(6) Using a UAP under TP1/EE as the client (limited to UNIX version)
(7) Fixing the communication-target server by specifying the PDFESHOST name in PDHOST (limited to HiRDB/Parallel Server)

(1) Using a UAP under OpenTP1 as the client

For the operation mode in which a UAP under OpenTP1 is used as the client, specify the client environment definitions in the system service definitions for OpenTP1. The environment variables are specified in the following OpenTP1 definitions:

Table 6-20 shows the OpenTP1 definitions in which the environment variables are specified. Environment variables other than those shown in Table 6-20 can be specified as needed.

The putenv format is used to specify environment variables.

Table 6-20 OpenTP1 definitions in which the environment variables are specified

Environment variable System environment definition Transaction service definition User service default definition User service definition
HiRDB_PDHOST9 M1 N N N
HiRDB_PDNAMEPORT9 M2 N N N
HiRDB_PDTMID9 O3,4 N N N
HiRDB_PDXAMODE9 O5 N N N
PDHOST N M1, 6 M1, 6 O1, 6, 7
PDNAMEPORT N M2, 6 M2, 6 O2, 6, 7
PDTMID9 N O3, 4, 6 O3, 4, 6 O3, 4, 6, 7
PDXAMODE9,10 N O5, 6 O5, 6 O5, 6, 7
PDTXACANUM9 N O O O
PDCLTPATH N O O O
PDUSER N N M M
PDCWAITTIME N O O O
PDSWAITTIME N M M M
PDSQLTRACE N O O O
PDUAPERLOG N O O O
PDCLTAPNAME N O O8 O8
PDSWATCHTIME N N M M
PDTRCMODE N O O O
PDUAPREPLVL N O O O
PDREPPATH N O O O
PDTRCPATH N O O O
PDSQLTRCOPENMODE N O O O
PDAUTOCONNECT N N N N
PDXARCVWTIME9 N O N N
PDCWAITTIMEWRNPNT N O O O
PDTCPCONOPT N O O O
PDAUTORECONNECT N N N N
PDRCCOUNT N N N N
PDRCINTERVAL N N N N
PDKALVL N N N N
PDKATIME N N N N
PDSQLTEXTSIZE N O O O
PDSQLEXECTIME N O O O
PDRCTRACE N N N N
Other environment variable N N O O

M: Required.

O: Optional; specify as needed.

N: Not required.

Note
For details about the OpenTP1 system service definitions, see the manual OpenTP1 System Definition.

1 When HiRDB_PDHOST is specified, it is not necessary to specify PDHOST because the value specified in HiRDB_PDHOST is assumed for PDHOST. However, if HiRDB_PDHOST is not specified, PDHOST must be specified. If PDHOST and HiRDB_PDHOST are both specified, HiRDB_PDHOST takes precedence.

When PDHOST is specified in an environment variable group, the PDHOST specification of the environment variable group becomes effective.

For guidelines on the value to be specified in PDHOST, see (7) Fixing the communication-target server by specifying the PDFESHOST name in PDHOST (limited to HiRDB/Parallel Server).

2 When HiRDB_PDNAMEPORT is specified, it is not necessary to specify PDNAMEPORT because the value specified in HiRDB_PDNAMEPORT is assumed for PDNAMEPORT. However, if HiRDB_PDNAMEPORT is not specified, PDNAMEPORT must be specified. If PDNAMEPORT and HiRDB_PDNAMEPORT are both specified, HiRDB_PDNAMEPORT takes precedence.

When PDNAMEPORT is specified in an environment variable group, the PDNAMEPORT specification of the environment variable group becomes effective.

3 This information must be specified for accessing one HiRDB server using an X/Open-compatible API from multiple OLTPs.

4 When HiRDB_PDTMID is specified, it is not necessary to specify PDTMID because the value specified in HiRDB_PDTMID is assumed for PDTMID. However, if HiRDB_PDTMID is not specified, PDTMID must be specified. If PDTMID and HiRDB_PDTMID are both specified, HiRDB_PDTMID takes precedence.

5 When HiRDB_PDXAMODE is specified, it is not necessary to specify PDXAMODE because the value specified in HiRDB_PDXAMODE is assumed for PDXAMODE. However, if HiRDB_PDXAMODE is not specified, PDXAMODE must be specified. If PDXAMODE and HiRDB_PDXAMODE are both specified, HiRDB_PDXAMODE takes precedence.

6 The same information must be specified in the various definitions.

7 The same specification must be made at the servers of all users who access HiRDB. For this reason, specify this information in the user service default definition, rather than in the separate user service definitions.

8 So that the user servers can be distinguished, this information should be specified in the individual user service definitions, rather than in the separate user-service default definition.

9 When the multi-connection facility is used, the environment variable specification variables become invalid, even if these environment variables are set to the environment variable group that was registered for each connection destination. Also, in the Windows environment, variables become invalid even though they are specified in the HiRDB.ini file. The information that was specified in the OpenTP1 system service definitions becomes valid for these environment variables.

10 Note that if the trnstring option and the PDXAMODE setting do not match, the xa function results in a -6 error.

(2) Using a UAP under TP1/LiNK as the client

If a UAP under TP1/LiNK is used as the client, the client environment definitions must be specified in the TP1/LiNK definitions. The specification procedures are as follows.

Table 6-21 shows the TP1/LiNK definitions in which the environment variables are specified.

Table 6-21 TP1/LiNK definitions in which the environment variables are specified

Environment variable Transaction Service Environment Variables field User Server Environment Variables field
Global field Local field
HiRDB_PDHOST N N N
HiRDB_PDNAMEPORT N N N
HiRDB_PDTMID N N N
HiRDB_PDXAMODE N N N
PDHOST M2 M2 O2, 3
PDNAMEPORT M2 M2 O2, 3
PDTMID5 O1, 2 O1, 2 O1, 2, 3
PDXAMODE5 O2 O2 O2, 3
PDTXACANUM5 O O O
PDCLTPATH O O O
PDUSER N N M
PDCWAITTIME O O O
PDSWAITTIME M M M
PDSQLTRACE O O O
PDUAPERLOG O O O
PDCLTAPNAME O O4 O4
PDSWATCHTIME M M M
PDTRCMODE O O O
PDUAPREPLVL O O O
PDREPPATH O O O
PDTRCPATH O O O
PDSQLTRCOPENMODE O O O
PDAUTOCONNECT N N N
PDXARCVWTIME O N N
PDCWAITTIMEWRNPNT O O O
PDTCPCONOPT O O O
Other environment variable N O O

M: Required.

O: Optional; specify as needed.

N: Not required.

Note
For details about the TP1/LiNK definitions, see the TP1/LiNK User's Guide.

1 This information must be specified for accessing one HiRDB server using an X/Open-compatible API from multiple OLTPs.

2 The same information must be specified in the various definitions.

3 The same specification must be made at the servers of all users who access HiRDB. For this reason, specify this information in the Global field of the User Server Environment Variables field, rather than in the Local field.

4 So that the user servers can be distinguished, this information should be specified in the Local field of the User Server Environment Variables field, rather than in the Global field.

5 When the multi-connection facility is used, the environment variable specification variables become invalid, even if these environment variables are set to the environment variable group that was registered for each connection destination. Also, in the Windows environment, variables become invalid even though they are specified in the HiRDB.ini file. The information that was specified in the TP1/LiNK definitions becomes valid for these environment variables.

(3) Using a UAP under TPBroker as the client

If a UAP under TPBroker is used as the client, the client environment definitions must be specified in the TPBroker system definitions. For details about the TPBroker system definitions, see the TPBroker User's Guide.

The client environment definitions are specified with the following format.

Table 6-22 shows the TPBroker definitions in which the environment variables are specified.

Table 6-22 TPBroker definitions in which the environment variables are specified

Environment variable Transaction completion process Transaction recovery process Each UAP
HiRDB_PDHOST8 O1, 4 O1, 4 O1, 4
HiRDB_PDNAMEPORT8 O1, 5 O1, 5 O1, 5
HiRDB_PDTMID8 O1, 3, 6 O1, 3, 6 O1, 3, 6
HiRDB_PDXAMODE8 O1, 7 O1, 7 O1, 7
PDHOST O1, 4 O1, 4 O1, 4
PDNAMEPORT O1, 5 O1, 5 O1, 5
PDTMID8 O1, 3, 6 O1, 3, 6 O1, 3, 6
PDXAMODE8 O1, 7 O1, 7 O1, 7
PDTXACANUM8 O O O
PDCLTPATH O O O
PDUSER M N M
PDCWAITTIME O O O
PDSWAITTIME M M M
PDSQLTRACE O O O
PDUAPERLOG O O O
PDCLTAPNAME O O O2
PDSWATCHTIME N N N
PDTRCMODE O O O
PDUAPREPLVL O O O
PDREPPATH O O O
PDTRCPATH O O O
PDSQLTRCOPENMODE O O O
PDAUTOCONNECT N N N
PDCWAITTIMEWRNPNT O O O
PDTCPCONOPT O O O
PDAUTORECONNECT N N N
PDRCCOUNT N N N
PDRCINTERVAL N N N
PDKALVL N N N
PDKATIME N N N
PDSQLTEXTSIZE O O O
PDSQLEXECTIME O O O
PDRCTRACE N N N
Other environment variable O N O

M: Required.

O: Optional; specify as needed.

N: Not required.

1 The same information must be specified in the client environment definitions for the transaction completion process, transaction recovery process, and each UAP.

2 So that the processes can be distinguished, this information should be specified in the individual processes.

3 This information must be specified for accessing one HiRDB server using an X/Open-compatible API from multiple OLTPs.

4 When HiRDB_PDHOST is specified, it is not necessary to specify PDHOST because the value specified in HiRDB_PDHOST is assumed for PDHOST. However, if HiRDB_PDHOST is not specified, PDHOST must be specified. If PDHOST and HiRDB_PDHOST are both specified, HiRDB_PDHOST takes precedence.

When PDHOST is specified in an environment variable group, the PDHOST specification of the environment variable group becomes effective.

For guidelines on the value to be specified in PDHOST, see (7) Fixing the communication-target server by specifying the PDFESHOST name in PDHOST (limited to HiRDB/Parallel Server).

5 When HiRDB_PDNAMEPORT is specified, it is not necessary to specify PDNAMEPORT because the value specified in HiRDB_PDNAMEPORT is assumed for PDNAMEPORT. However, if HiRDB_PDNAMEPORT is not specified, PDNAMEPORT must be specified. If PDNAMEPORT and HiRDB_PDNAMEPORT are both specified, HiRDB_PDNAMEPORT takes precedence.

When PDNAMEPORT is specified in an environment variable group, the PDNAMEPORT specification of the environment variable group becomes effective.

6 When HiRDB_PDTMID is specified, it is not necessary to specify PDTMID because the value specified in HiRDB_PDTMID is assumed for PDTMID. However, if HiRDB_PDTMID is not specified, PDTMID must be specified. If PDTMID and HiRDB_PDTMID are both specified, HiRDB_PDTMID takes precedence.

7 When HiRDB_PDXAMODE is specified, it is not necessary to specify PDXAMODE because the value specified in HiRDB_PDXAMODE is assumed for PDXAMODE. However, if HiRDB_PDXAMODE is not specified, PDXAMODE must be specified. If PDXAMODE and HiRDB_PDXAMODE are both specified, HiRDB_PDXAMODE takes precedence.

8 When the multi-connection facility is used, the environment variable specification variables become invalid, even if these environment variables are set in the environment variable group that was registered to each connection destination. Also, in the Windows environment, variables become invalid even though they are specified in the HiRDB.ini file. The information that was specified in the TPBroker system definitions becomes valid for these environment variables.

(4) Using a UAP under TUXEDO as the client

For the operation mode in which a UAP under TUXEDO is used as the client, specify the client environment definitions in the file specified by the ENVFILE parameter in the TUXEDO configuration file (UBBCONFIG file).

Table 6-23 shows which environment variables can be specified.

Table 6-23 Environment variable specification status (for a UAP under TUXEDO)

Environment variable Specification status
HiRDB_PDHOST N
HiRDB_PDNAMEPORT N
HiRDB_PDTMID N
HiRDB_PDXAMODE N
PDHOST M1
PDNAMEPORT M1
PDTMID4 O1, 3
PDXAMODE4 M1
PDTXACANUM N
PDUSER M
PDSWAITTIME M
PDCLTAPNAME O2
PDSWATCHTIME N
PDAUTORECONNECT N
PDRCCOUNT N
PDRCINTERVAL N
PDKALVL N
PDKATIME N
PDRCTRACE N
Other environment variable O

M: Required.

O: Optional; specify as needed.

N: Do not specify.

1 The same information must be specified in the environment variables for the transaction manager server, TUXEDO system server, and each UAP.

For guidelines on the value to be specified in PDHOST, see (7) Fixing the communication-target server by specifying the PDFESHOST name in PDHOST (limited to HiRDB/Parallel Server).

2 So that the processes can be distinguished, this information should be specified in the individual processes.

3 This information must be specified for accessing one HiRDB server using an X/Open-compatible API from multiple OLTPs.

4 In the Windows environment, variables become invalid even though they are specified in the HiRDB.ini file. The information that was specified in the file specified by the ENVFILE parameter in the TUXEDO configuration file becomes valid for these environment variables.

(5) Using a UAP under WebLogic Server as the client

For the operation mode in which a UAP under WebLogic Server is used as a client, specify the client environment definitions in the environment variables of the WebLogic Server process.

Table 6-24 shows which environment variables can be specified.

Table 6-24 Environment variable specification status (for a UAP under WebLogic Server)

Environment variable Specification status
HiRDB_PDHOST N
HiRDB_PDNAMEPORT N
HiRDB_PDTMID N
HiRDB_PDXAMODE N
PDHOST M3
PDNAMEPORT M
PDTMID4 O1
PDXAMODE4 M
PDUSER M
PDSWAITTIME M
PDCLTAPNAME O2
PDSWATCHTIME N
PDAUTORECONNECT N
PDRCCOUNT N
PDRCINTERVAL N
PDKALVL N
PDKATIME N
PDRCTRACE N
Other environment variable O

M: Required.

O: Optional; specify as needed.

N: Do not specify.

1 This environment variable must be specified when multiple OLTP programs use an X/Open-compliant API to access one HiRDB system.

2 This environment variable should be specified in each process so that the individual processes can be identified.

3 For guidelines on the value to be specified in PDHOST, see (7) Fixing the communication-target server by specifying the PDFESHOST name in PDHOST (limited to HiRDB/Parallel Server).

4 In the Windows environment, variables become invalid even though they are specified in the HiRDB.ini file. The information that was specified in the file specified by the ENVFILE parameter in the TUXEDO configuration file becomes valid for these environment variables.

Notes
  1. For the timeout second count that can be specified in the transaction attributes of WebLogic Server, specify a value that is larger than the maximum wait time specified by PDCWAITTIME. If you specify a value that is smaller than the maximum wait time specified by PDCWAITTIME, the system may not be able to complete UAP process transactions.
  2. If the maximum number of concurrent transactions per process specified by PDTXACANUM is less than the number of connections specified by the JDBC connection pool of WebLogic Server, the number of connections established by the JDBC connection pool cannot exceed the PDTXACANUM value.

(6) Using a UAP under TP1/EE as the client (limited to UNIX version)

For the operation mode in which a UAP under TP1/EE is used as a client, specify the client environment definitions in the OpenTP1 system service definitions of the TP1/EE execution environment. For details, see (1) Using a UAP under OpenTP1 as the client.

Be sure to specify PDXAMODE. If the value specified for the OpenTP1 system in which TP1/EE is executed and the value specified for PDXAMODE are different, specify PDXAMODE in the user service definitions of the OpenTP1 system.

(7) Fixing the communication-target server by specifying the PDFESHOST name in PDHOST (limited to HiRDB/Parallel Server)

When the PDFESHOST host name is specified in PDHOST, the HiRDB client can be connected to the HiRDB server if a failure occurs in the system manager unit. In addition, the SQL execution destination, the PC cancel destination, and the XA recovery request destination can be fixed to a single communication-target server. PC cancel refers to the server completion instruction when the PDCWAITTIME duration is exceeded. XA recovery refers to the transaction completion instruction when a UAP under OLTP is used. For certain combinations of the client and server versions, the host name that can be specified in PDHOST is limited to the host name of the system manager.

Figure 6-1 shows the differences between fixing and not fixing the communication-target server.

Figure 6-1 Differences between fixing and not fixing the communication-target server

[Figure]

Application standard
The following conditions must be satisfied if the communication-target server is to be fixed:
  • HiRDB/Parallel Server is being used.
  • The connection is a FES host direct connection or high-speed connection.
  • The table below shows that specifying the PDFESHOST name in PDHOST is recommended for the UAP execution environment.
    UAP execution environment Specification recommended
    Non-OLTP system A UAP has one connection, or the same PDFESHOST is specified for each connection when a UAP has multiple connections. Y
    A different PDFESHOST is specified for each connection when a UAP has multiple connections. N
    OLTP system OLTP system (WebLogic Server) operating with a single process (multi-thread) The same PDFESHOST is specified for all connection destinations in the OLTP system (the connection destinations are the same).1 Y
    Each thread operating in the OLTP system specifies a different PDFESHOST.1 N
    OLTP system (OpenTP1, TUXEDO, TPBroker, or TP1/LiNK) operating with multiple processes All processes operating as a UAP specify the same PDFESHOST.1 Y
    Each process operating as a UAP specifies a separate PDFESHOST.1 Client environment definition of a process operating as UAP for which PDFESHOST is specified2 The same PDFESHOST is specified for all connection destinations of a process operating as a UAP for which PDFESHOST is specified. Y
    A different PDFESHOST is specified for each connection destination of a process operating as a UAP for which PDFESHOST is specified. N
    Client environment definition for the transaction manager3 N
Legend:
Y: Specifying the PDFESHOST host name in PDHOST is recommended.
N: Specify the host name of the transaction manager in PDHOST.
1 Specify the host name in the following location:
  • For OpenTP1
    Environment variables specified in the user service, user default, or system environment definitions
  • For TUXEDO
    Client environment definitions of the transaction manager server, the TUXEDO system server, and each UAP
  • For TPBroker
    Transaction definitions (for completed processes and recovery processes) and client environment definitions for each UAP
  • For TP1/LiNK
    Global and Local fields of the User server environment variables field
  • When the multi-connection facility is used
    Environment variable settings file
2 Specify the host name in the following location:
  • For OpenTP1
    Environment variables specified in the user service or user default definitions
  • For TUXEDO
    Client environment definitions of each UAP
  • For TPBroker
    Transaction definitions (for completed processes) and client environment definitions of the UAP
  • For TP1/LiNK
    Global and Local fields of the User server environment variables field
  • When the multi-connection facility is used
    Environment variable settings file
3 Specify the host name in the following location:
  • For OpenTP1
    Environment variables specified in the transaction service definitions
  • For TUXEDO
    Client environment definitions of the transaction manager server and the TUXEDO system server
  • For TPBroker
    Transaction definition (recovery process)
  • For TP1/LiNK
    Transaction service environment variables field
  • When the multi-connection facility is used
    Environment variable settings file

Note
If a host number is specified in PDFESHOST, connect the port number of the connection destination to PDNAMEPORT.