ODACCESS statement

The ODACCESS statement defines connection attributes for IMS DB communications.

On the client side, the ODACCESS statement defines connection attributes between IMS Connect and the IMS Universal drivers and other DRDA clients. On the server side, the ODACCESS statement defines attributes for connections between IMS Connect and the CSL Open Database Manager (ODBM). IMS Connect must register with ODBM to enable access to IMS DB for clients that use the IMS Open Database architecture.

Specify only one ODACCESS statement.

ODACCESS statement syntax

Read syntax diagramSkip visual syntax diagramODACCESS(C)
C
Read syntax diagramSkip visual syntax diagramAPPL= appl_name,DRDAPORT=(ID= port_number,KEEPAV= seconds,PORTTMOT= 100ths_of_sec)IMSPLEX=(MEMBER= icon_imsplex_name,TMEMBER= imsplex_sci_name)ODBMAUTOCONN=NY,ODBMTMOT= 100ths_of_secODRACFST=NY

ODACCESS statement parameters

APPL=
Specifies the 1- to 8- character application name that is defined to RACF® in the PTKTDATA class for IMS Connect clients that access IMS DB by using the Distributed Relational Database Architecture™ (DRDA) protocol. The value that is specified on this parameter is used, in addition to the user ID and the RACF PassTicket, by IMS Connect in the RACF call RACROUTE REQUEST=VERIFY to authenticate the IMS Connect client to IMS DB.

This parameter is optional and defaults to blanks. If a RACF PassTicket is passed from a DRDA client to IMS Connect but this parameter is not specified, the HWS ID from the ID= parameter of the HWS statement is used instead by IMS Connect on the RACF call RACROUTE REQUEST=VERIFY.

This parameter is used only if RACF=Y is specified in the HWS statement of the HWSCFGxx member.

DRDAPORT=
Defines the port numbers, the TCP/IP keep alive value, and the timeout values for the ports that IMS Connect uses to provide access to IMS for client applications of the Open Database APIs and user-written DRDA client applications.

The total combined number of ports that can be defined in an IMS Connect configuration member cannot exceed 200 ports. Ports defined by the DRDAPORT parameter are included in the count toward the maximum.

If you use SSL with DRDA ports, implement SSL using the z/OS® Application Transparent Transport Layer Security (AT-TLS), which performs SSL processing at the z/OS TCP/IP layer.

Subparameters of DRDAPORT:
ID=
The port number of the port being defined by the DRDAPORT parameter. Port numbers are specified by a 1- to 5-character numeric value. Valid port numbers are from 1 to 65535. Port numbers must be unique among all ports used by IMS Connect within the TCP/IP domain, including the basic TCP/IP ports specified on the PORT or PORTID parameter and any Secured Socket Layer (SSL) port specified on the SSLPORT parameter.
KEEPAV=
A 1- to 8-character decimal field that sets the interval after which the keep alive mechanism of the z/OS TCP/IP layer sends a packet on idle connections on this port to maintain the connections. TCP/IP accepts a range of 1 seconds to 2,147,460 seconds. Specify 0 to use the Keepalive value defined in the z/OS TCP/IP stack. The default for KEEPAV is 0.
PORTTMOT=
Defines the amount of time that IMS Connect waits for the next input message from a client application that is connected on a DRDA port before IMS Connect disconnects the client.
The timeout interval is specified as a decimal integer in hundredths of a second. Valid values for PORTTMOT are from 0 to 2,147,483,647 (X'7FFFFFFF'). The default is 6,000 (1 minute). A 0 disables the timeout function.
Specifying a timeout value can avoid hang conditions when a client stops sending messages as expected due to, for example:
  • A looping client application
  • A terminated client application
For client connections, ODBMTMOT differs from PORTTMOT in that ODBMTMOT applies only to the first input message after a socket connection is established and PORTTMOT applies only to input messages that follow a previous input message.
The following code provides an example of DRDAPORT parameter specifications:
DRDAPORT=(ID=1111,KEEPAV=5,PORTTMOT=50),
DRDAPORT=(ID=2222,KEEPAV=10,PORTTMOT=500)

You can also create DRDA port definitions dynamically with the CREATE IMSCON TYPE(PORT) PORTTYPE(DRDA) type-2 command.

IMSPLEX= ()
Enables IMSplex communications between IMS Connect and ODBM. IMSplex communications are managed by the Structured Call Interface (SCI) component of the IMS Common Service Layer (CSL).
If the IMSPLEX statement in this member of the IMS PROCLIB data set already joins IMS Connect to the IMSplex in which ODBM is a member, then this IMSPLEX substatement is optional; however, at least one IMSPLEX statement must be specified in the HWSCFGxx member of the IMS PROCLIB data set to enable IMSplex communications between this IMS Connect instance and ODBM.
If an IMSPLEX substatement is not included on the ODACCESS statement, and more than one IMSPLEX statement is specified elsewhere in this HWSCFGxx member of the IMS PROCLIB data set, IMS Connect uses the first IMSPLEX statement in the HWSCFGxx member of the IMS PROCLIB data set for communications between IMS Connect and ODBM.
The IMSPLEX substatement keyword parameters include:
MEMBER=
A 1- to 8-character name that identifies IMS Connect within the IMSplex. SCI uses this name when managing communications between IMS Connect and ODBM. The name must start with an alphabetic character.
Note: An IMS Connect instance can register only a single name in an IMSplex. If the same IMSplex name is specified on two or more TMEMBER parameters in the HWSCFGxx member of the IMS PROCLIB data set, then the same IMS Connect name must be specified on each of the corresponding MEMBER parameters. If the MEMBER parameters differ on two or more IMSplex statements that specify the same IMSplex name, IMS Connect issues an error message and abends on startup.
TMEMBER=
The name of the IMSplex that manages communications between IMS Connect and ODBM. This name must match the IMSplex name that is defined in the NAME parameter of the IMSPLEX keyword of the SCI initialization member of the IMS PROCLIB data set (CSLSIxxx).
Restriction: A name specified on the TMEMBER parameter cannot be the same as a name specified on the ID parameter of a DATASTORE statement.
ODBMAUTOCONN=
Specifies whether IMS Connect automatically connects to new and existing instances of ODBM within an IMSplex.

When ODBMAUTOCONN=N is specified (or left blank), IMS Connect does not automatically register with instances of ODBM during IMS Connect initialization or when new instances of ODBM enter the IMSplex while IMS Connect is already running.

When ODBMAUTOCONN=Y is specified, IMS Connect automatically registers with all instances of ODBM currently in the IMSplex when IMS Connect initializes and with any instances of ODBM that join the IMSplex while IMS Connect is already running.

You can enable or disable automatic connection with ODBM by using the IMS Connect command SETOAUTO.

If ODBMAUTOCONN=N, you can start a connection with ODBM by using the IMS Connect command STARTOD.

ODBMTMOT=
Defines the amount of time that IMS Connect waits for both:
  • A response message on connections with ODBM.
  • An initial input message after a socket connection is established on connections with a client application
The timeout interval is specified as a decimal integer in hundredths of a second. Valid values for ODBMTMOT are from 0 to 2 147 483 647 (X'7FFFFFFF'). The default value is 18 000 (3 minutes). A value of 0 disables the timeout function.
For connections with ODBM, specifying a timeout value can avoid hang conditions when an ODBM instance stops responding.
For connections to a client application, specifying a timeout value terminates a socket connection if a client does not send data after obtaining the socket connection before the ODBMTMOT value expires.
For example, if you specify a value of 1000, if a client application establishes a socket connection with IMS Connect and then does not send an input message within 10 seconds, IMS Connect terminates the socket connection; however, if the client application establishes a socket connection and sends an input message within 10 seconds, but after IMS Connect sends the input message to ODBM, IMS Connect does not receive a response from ODBM within 10 seconds, IMS Connect returns message HWSJ2530W to the client application and retains the socket connection.
For client connections, ODBMTMOT differs from PORTTMOT in that ODBMTMOT applies only to the first input message after a socket connection is established and PORTTMOT applies only to input messages that follow a previous input message.
ODRACFST=

Specifies whether RACF statistics are recorded and updated when IMS Connect issues the RACROUTE REQUEST=VERIFY call to authenticate connections from an ODBM client to IMS DB.

This parameter is used only if RACF=Y is specified in the HWS statement of the HWSCFGxx configuration member.

N is the default value.

You can change the value of this parameter by using the SET(ODRACFST(ON)) or SET(ODRACFST(OFF)) option on the online IMS Connect command UPD IMSCON TYPE(CONFIG).

Y
RACF statistics are recorded when IMS Connect issues the RACROUTE REQUEST=VERIFY call to authenticate connections from an ODBM client to IMS DB. If the logon is successful, a message is also issued. When you specify ODRACFST=Y, the STAT=ASIS parameter is used by IMS Connect on the RACROUTE REQUEST=VERIFY call. With STAT=ASIS, the RACF messages and statistics are controlled by the installation's current options on the RACF command SETROPTS.

After you enable RACF statistics, the statistics are recorded by RACF no more than once per day to a system management facility (SMF) data set or log stream. The SMF data set or log stream that is used to record the RACF statistics is specified in the RACF configuration.

N
RACF statistics are not recorded when IMS Connect issues the RACROUTE REQUEST=VERIFY call to authenticate connections from an ODBM client to IMS DB, and if the logon is successful, no message is issued. When you specify ODRACFST=N, the STAT=NO parameter is used by IMS Connect on the RACROUTE REQUEST=VERIFY call. With STAT=NO, the options specified on the RACF command SETROPTS are ignored.

For more information about the STAT= parameter of the RACROUTE REQUEST=VERIFY macro call, see "z/OS Security Server RACROUTE Macro Reference" in the IBM® z/OS documentation.