HWS statement

The HWS statement defines characteristics specific to an instance of IMS Connect.

Specify only one HWS statement for an IMS Connect instance.

HWS statement syntax

Read syntax diagramSkip visual syntax diagram HWS ( CASCADE=NYCM0ATOQ= name,ID= name,MULTIRTP=?NY,PSWDMC=RNY,RACF=NY,RACFGENRC=NY,RRS=NY,SENDALTP=NYblank,SMEMBER= supermembername,TMRACFST=NY,UIDAGE= uid_age_value,UIDCACHE=NY,WTORCMD=YN,XIBAREA= size_xib_area )

HWS statement parameters

The HWS statement includes the following keyword parameters:

CASCADE=
Defines the IMS Connect default setting for support for cascading global, two-phase commit (synclevel=syncpoint) transactions from IMS TM Resource Adapter via a TCP/IP connection to an IMS TM or IMS DB/DC system that is on a different z/OS® image than IMS Connect. Cascading transactions that are received via a LOCAL option connection is not supported.

A CASCADE specification in the definition of a data store connection overrides the CASCADE specification in the IMS Connect system configuration. Any data store connection definition that does not specify a value for CASCADE inherits the CASCADE specification from the IMS Connect system configuration.

Until the next restart of IMS Connect, a CASCADE specification made by the UPDATE IMSCON TYPE(CONFIG) SET(CASCADE()) command overrides the CASCADE specification on the HWS configuration statement.

The CASCADE parameter applies only to the support for cascading global, RRS transactions between IMS Connect and IMS TM when they are on different z/OS images. The specification of the IMS Connect CASCADE parameter does not affect support between other components or subsystems, such as between IMS subsystems in a shared queues environment.

N
Specifies that, by default, data store connections do not support the cascading of global, two-phase commit (synclevel=syncpoint) transactions to IMS TM and IMS DB/DC systems that are running on a different z/OS image than IMS Connect.

If a synclevel=syncpoint transaction is routed to an IMS system that resides on a different LPAR than IMS Connect, IMS Connect rejects the transaction with return code 4 and reason code NCASCADE.

CASCADE=N is the default.

Y
Specifies that, by default, data store connections support the cascading of global, two-phase commit (synclevel=syncpoint transactions to IMS TM and IMS DB/DC systems that are running on different z/OS images than IMS Connect.

If IMS Connect and IMS reside on the same LPAR, the transaction is processed without using cascaded transaction support. If IMS Connect and IMS reside on different LPARs, the transaction is processed using cascaded transaction support.

CM0ATOQ=
1- to 8-character name of the OTMA CM0 ACK timeout queues. The value specified here overrides the OTMA default value of DFS$$TOQ and is used for all data stores except those that have their own CM0ATOQ value (that is, if you specify a value for CM0ATOQ on the DATASTORE statement, it overrides a value for CM0ATOQ specified on the HWS statement).
ID=
The IMS Connect name, which:
  • Consists of alphanumeric character data
  • Begins with an alphabetic character
  • Has a length between 1 and 8 characters
MULTIRTP=
Defines the IMS Connect default setting for OTMA tpipe support for parallel processing of the RESUME TPIPE requests from this IMS Connect instance.

A MULTIRTP specification in a DATASTORE statement overrides the MULTIRTP specification in the HWS statement. If a DATASTORE connection definition does not include a MULTIRTP specification, the connection inherits the MULTIRTP specification from the HWS statement.

If MULTIRTP is not specified on either the HWS statement or a DATASTORE statement, the MULTIRTP value in effect in IMS defines the default.

If left blank, or the MULTIRTP parameter is omitted, specifies that, by default, data store connection requests from this IMS Connect instance do not include any specification for MULTIRTP support. MULTIRTP support is determined by either the IMS Connect data store definition or the OTMA client descriptor in the DFSYDTx member of the IMS PROCLIB data set.
N
Specifies that IMS Connect data store connection requests indicate that IMS Connect requires an OTMA TPIPE that supports only a single active resume TPIPE request. Output messages on the TPIPE are sent serially.
Y
Specifies that IMS Connect data store connections require an OTMA TPIPE that can support multiple active resume TPIPE requests in parallel. When a TPIPE has multiple active resume TPIPE requests from multiple data store connections, OTMA sends the callout or CM0 output messages on the first available data store connection that is in a receive state.
PSWDMC=
Specifies whether IMS Connect supports mixed-case passwords. Before you enable support for mixed-case passwords, you must configure RACF® to support mixed-case passwords.
R
IMS Connect uses whatever is defined for mixed-case passwords in RACF. If mixed-case passwords are active in RACF (which is done through the SETROPTS command) then IMS uses it. If mixed-case passwords are not active in RACF, then IMS Connect uses uppercase passwords. IMS Connect adjusts whenever there are changes to the mixed-case password definition in RACF. R is the default.
N
Disables IMS Connect support for mixed-case passwords. IMS Connect converts any lowercase characters in passwords to uppercase characters.
Y
Enables IMS Connect support for mixed-case passwords.
RACF=
Enables security support by RACF or a similar security product. When RACF=Y, IMS Connect issues a RACROUTE REQUEST=VERIFY call to authenticate the user associated with incoming messages. RACF=N is the default.

For messages from a client application, IMS Connect can use passwords and user IDs for authentication with RACF or RACF PassTickets. The user IDs, passwords, or PassTicket application names can be provided by either the client application or a user exit routine.

For messages from another IMS Connect instance, IMS Connect uses RACF PassTickets to authenticate the user with RACF. After the initial connection request, all subsequent messages received on the socket connection are considered to be from a trusted user and no further authentication is performed.

PassTickets for connections from another IMS Connect instance are generated from the values specified on the USERID and APPL parameters in the RMTIMSCON statement of the IMS Connect instance sending the messages.

Start of changePassTickets for IMS Connect client connections that use the Distributed Relational Database Architecture™ (DRDA) protocol is generated either by the SQL Batch utility or, for other DRDA clients, a service that uses the RACF PassTicket generator algorithm. For DRDA client connections, the application name that is used by IMS Connect on the RACROUTE REQUEST=VERIFY call is obtained from the value of the APPL= parameter in the ODACCESS statement.End of change

The RACF= setting can also be changed using the IMS Connect SETRACF command.

Start of changeRACFGENRC=End of change
Start of changeSpecifies whether a generic return code or message is returned if RACF is used to verify sign-ons to IMS from IMS Connect clients and the user ID or password provided is invalid.
N
IMS Connect returns normal RACF return codes. This is the default value.
Y
IMS Connect returns one of the following generic return codes or message, depending on the IMS Connect client:
  • For non-TMRA OTMA clients, RSM_RACFRC=255 for security errors (RSM_RETCODE=8, RSM_RSNCOD=40)
  • For TMRA OTMA clients, OMUSR_RACF_RC=255 for security errors (OMUSR_RETCODE=8, OMUSR_RESCODE='SECFAIL')
  • For DRDA clients:
    • SECCHKCD(codepoint x'11A4')=x'19'
    • HWSK2865E R=255, RACFRC=255, RACFRSN=0
  • For failed password change requests, message HWSC0038E PASSWORD CHANGE ERROR
End of change
RRS=
Specifies whether z/OS Resource Recovery Services (RRS) communication is to be enabled or disabled. Set RRS= to yes (Y) or no (N). No is the default.
Start of changeSENDALTP=End of change
Start of change

Defines the IMS Connect default setting for getting the ALTPCB output for this IMS Connect instance. The ALTPCB output is initiated by a commit-then-send send-receive transaction.

The SENDALTP specification in a DATASTORE statement overrides the SENDALTP specification in the HWS statement.

If a DATASTORE connection definition does not include a SENDALTP specification, the connection inherits the SENDALTP specification from the HWS statement.

If the SENDALTP parameter is not specified in either the HWS statement or a DATASTORE statement, the SENDALTP value in IMS defines the default.
N
If specified, the ALTPCB output that is initiated by an IMS Connect commit-then-send send-receive transaction is kept in a tpipe hold queue.
Y
If specified, the ALTPCB output that is initiated by an IMS Connect commit-then-send send-receive call is sent back to the origin IMS Connect client. If the ALTPCB output cannot be sent, the output is saved in a tpipe hold queue or is removed when asked.
blank
If the SENDALTP parameter is left blank or omitted, data store connection requests from this IMS Connect instance do not include any specification for the SENDALTP support. The SENDALTP support is determined by either the IMS Connect data store definition or the OTMA client descriptor in the DFSYDTx member of the IMS PROCLIB data set.
End of change
SMEMBER=
1- to 4-character field that specifies the name of the OTMA super member to which this instance of IMS Connect belongs. The super member can also be specified on the DATASTORE statement. If a value is specified on both the HWS statement and the DATASTORE statement, the value on the DATASTORE statement takes precedence.
TMRACFST=
Specifies whether RACF statistics are recorded and updated when IMS Connect issues the RACROUTE REQUEST=VERIFY call to authenticate connections from an OTMA client to IMS TM.

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(TMRACFST(ON)) or SET(TMRACFST(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 OTMA client to IMS TM. If the logon is successful, a message is also issued. When you specify TMRACFST=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 OTMA client to IMS TM, and if the logon is successful, no message is issued. When you specify TMRACFST=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.

UIDAGE=
Optional parameter that specifies the refresh interval for cached RACF user IDs in seconds. This parameter must be a decimal integer between 0 and 2147483647. If a value less than 300 seconds is specified, the refresh interval is set to 300 seconds. The default value is 2147483647 seconds. This parameter is only valid if the RACF user ID cache is enabled.
UIDCACHE=
Optional parameter that specifies whether IMS Connect caches verified RACF user IDs for reuse. This parameter is valid only if RACF support is enabled. You can also set this parameter with the SETUIDC WTOR command, the SET UIDCACHE statement of the UPDATE MEMBER z/OS Modify command, and the UPDATE IMSCON TYPE(CONFIG) SET(UIDCACHE(ON)) type-2 command.
N
The RACF user ID cache is disabled. N is the default.
Y
The RACF user ID cache is enabled.
WTORCMD
Enables or disables the WTOR command interface for IMS Connect.
Y
Enables the WTOR command interface for IMS Connect and displays the input message for WTOR commands on the system console. Y is the default.
N
Disables the WTOR command interface for IMS Connect. The input message for WTOR commands is not displayed on the system console. When the WTOR command interface is disabled, you can issue commands to IMS Connect by using either the IMS type-2 or the z/OS modify command interfaces.
XIBAREA=
Specifies the number of fullwords allocated for the XIB user area. Both the user initialization exit routine and the user message exit routines can access and modify the XIB user area. The default value is 20; the maximum value is 500. If you do not specify a value for this parameter, or you specify a value outside of the 20 to 500 range, the system uses the default value of 20.