Chapter 9: CICS Communications Using Microsoft Host Integration Server

This chapter describes how to configure CICS Option communication links using Microsoft Host Integration Server (HIS) as the communications manager. This architecture uses an SNA link between CICS applications running on a mainframe and CICS Option running on one or more Microsoft Windows PCs. HIS is a part of the BizTalk software suite.

In order to use these instructions, you should be familiar with:

For information on communication between IBM CICS products, see the IBM publication CICS Family: Interproduct Communication, SC33-0824.

For information on installing and configuring Microsoft HIS, see the Host Integration Server 2006 Help.

Process Overview

To set up an SNA link between a mainframe CICS environment and CICS Option environments running on a local server and client PCs, follow the procedures outlined in the following four stages. The procedures describe how to configure an 802.2 DLC connection:

This chapter provides an overview of the procedures in each stage. For detailed information on each procedure, refer to the documentation delivered with the Microsoft HIS software.

Each procedure includes a list of the information you need to configure an 802.2 DLC connection. You can collect this information from your mainframe system administrator. An example value is included for each setting required. These example values are used consistently across the procedures described in this chapter, to help clarify situations where different procedures use the same values.

System Architecture

A system that uses Microsoft HIS to manage SNA communications typically consists of:

HIS rchitecture

Figure 9-1: HIS rchitecture

For details of a Microsoft HIS installation's hardware and software requirements, refer to the Host Integration Server 2006 Help.

Configuration Definitions

The terminology used often varies between environments and communications service managers used. The following table details the terminology that is used in this chapter. Alternative names are shown in parentheses.

Generic Term Description
ClientA machine, running CICS option, where you install Microsoft HIS Client software. This machine accesses a host CICS environment via a local server.
Data Link Control (DLC) link The interface to the network. The attributes of a link can be divided into two parts:
  • Characteristics of the port (logical and physical)
  • Control characteristics of the link
Control Point (CP, CP Name) Identifies the local node manager that provides services to the local logical units.
Link station The part of data link control (DLC) that is responsible for the transfer of data between two communications services managers connected by a link.
Local serverThe machine with the SNA link to the host, where you install Microsoft HIS Server software, to provide access to CICS Option running on client PCs.
Network name (NETID) The name of the network to which the system is connected.
Logical Unit (LU) A network accessible unit (NAU). In SNA there are a number of logical unit types that identify the protocols supported by that logical unit. For APPC the LU type is 6.2 referred to as LU 6.2.
Partner LU The logical unit with which to communicate.
Transaction Program (TP) The program to be executed at one end of a conversation.
Session The logical connection between two network accessible units.
Inter Systems Communications (ISC) Two or more regions running on different processor complexes that are able to communicate with each other.
Mode The connection characteristics of a session.

Configuring HIS Local Server to Mainframe Communication

This section provides overviews of the configuration tasks, and information on the settings each the task configures. For specific details on performing each task, refer to your Microsoft Host Integration Software documentation.

To enable a mainframe CICS environment to communicate with CICS Option running on a HIS local server, an LU 6.2 link is required between the local server and the mainframe. The LU 6.2 link is separated into SNA Server (PC) and VTAM (mainframe) components.

Mainframe connection information requirements for 802.2 DLC

For an 802.2 DLC connection, you require, from your mainframe system administrator, the information detailed in the table below. For each item, the table lists the configuration task that requires the information, and an example value. For details of the local information required, refer to each task.

Parameter from the VTAM System Administrator Task and Example Value Description
Remote Network Name (NETID) Configuring the Local Server: HSTNET1 The network name of the VTAM domain. All resources that comprise this VTAM domain are in this VTAM domain.
Local Control Point (CP) name assigned to the local server Configuring the Local Server: MCOPU020The unique PU identifier created by the mainframe administrator for the local server. This is specified in the VTAM PU definition for this machine. That is, the CP name matches the PU identifier.
Remote Network AddressConfiguring the Connection Address: 40000000404412-digit hexadecimal network address of the remote host system's network controller.
Remote Control Point (CP) Name (also known as SSCPNAME) Configuring the System Identification: HSTMVS The name of the remote system
The XID format used by the host system Configuring the System Identification: 3 (default) The XID format can be either 0 or 3. A format of 3 is generally used for APPC (and must be used for independent APPC LUs). The older format, 0, tends to be used for 3270 devices.
Remote Node ID Configuring the System Identification: None An 8-digit hexadecimal number used to identify the host system on the SNA network. Your mainframe system administrator will advise whether or not you need to use this.
Local Node ID Configuring the System Identification: 05D,22222 An 8-digit hexadecimal number used to identify the local system on the SNA network. The first three digits are the IDBLK and the last five are the IDNUM. These must correspond with the IDBLK and IDNUM fields of the VTAM PU definition for this machine, as defined on the host system.
Maximum Basic Transmission Unit (BTU) Length (also known as I-Frame) Configuring 802.2 DLC Properties: 1493 The number of bytes that can be transmitted in a single data link control frame. This is calculated by subtracting 9 from the MAXDATA parameter of the PU definition for this machine (that is, maximum BTU length = MAXDATA - 9). This is a maximum value. The actual value used is negotiated to the highest value below this figure that is acceptable to both partners.
List of independent LUs for your PU definition. Configuring Local APPC LUs: MCOLU021 These LUs are required for APPC and are defined in the list of LUs defined for your PU on VTAM. You can have multiple independent LUs per PU. All independent LUs for your PU have LOCADDR set to zero under the PU definition on VTAM.
Target LU NameConfiguring Remote LUs: HSTCICS1This should match the LU definition as it exists on the remote system, in this case, a VTAM APPLID definition on the host system. To communicate with a host CICS system, this is the APPLID of the host CICS environment .
List of the dependent LUs defined as terminals with their associated LU number for your VTAM definition. Configuring a 3270 LU for the 3270 Applet:
  • MCOTRM22,2
  • MCOTRM23,3
  • MCOTRM24,4
These LUs are used for terminals to the host. They are not required for APPC, but are very useful for the host CICS configuration. They are found under your PU definition on VTAM. The LU number must match the associated LOCADDR number for this named LU.
The Mode Table defining the session limits for the connection Configuring Remote LUs: #INTER This is used to negotiate the session limits with the host. Normally the host would use the default mode of #INTER. If #INTER is not appropriate, you can define and use another mode. If you need to define another mode, your VTAM system administrator should be able to supply the parameters required, and the Host Integration Server 2006 Helpthe Host.

Installing the Microsoft HIS software on the local server

In this procedure, you install the Microsoft HIS server software onto the local server, and add the configuration details required to define the local server.

When you run the Microsoft Host Integration Server Installation Wizard, select the Server and the Documentation options.

ParameterExample valueOrigin and description
Remote network name (NETID)HSTNET1Mainframe administrator: the VTAM domain's network name.
Local control point (CP) name assigned to the local machine MCOPU020Mainframe administrator: the VTAM PU assigned to the local Microsoft HIS server.

Installing the Microsoft HIS software on each of the local clients

In this procedure, you install the Microsoft HIS client software onto each of the local clients.

When you run the Microsoft Host Integration Server Installation Wizard, select the Client and the Documentation options

ParameterExample valueOrigin and description
Sponsor serverNY-HOST-5The network name of the host system.
SNA Service AccountNYDOMAIN\MCOUA valid user ID for the system

Configuring the Link Service for the local server

In this procedure, you create a new DLC 802.2 Link Service and specify the network adaptor that the link service uses.

ParameterExample valueOrigin and description
Link service nameSNADLC1User-assigned
Adapter 4User-assigned

If the local server has more than one PU to the mainframe, you will need more than one link service. Each PU to a host requires a unique Local Service Access Point (SAP) address. If you are defining your first link service, use the default of 4. For a host with multiple PUs, the link service adapter number must be a hexadecimal number that is a multiple of 4, and is in the range of 04 to EC.

Configuring the connection

In this procedure, you define the 802.2 connection for the local server.

ParameterExample valueOrigin and description
Connection nameMVSHOST1User-assigned
Link service SNADLC1Defined when you configure the local server
Remote EndHost SystemDefines the mainframe as the remote system
Allowed DirectionsBoth DirectionsAllows communications in both directions
ActivationBy AdministratorCan change this after testing to either On Demand, or At Server Startup

Configuring the remote system's network address

In this procedure, you configure the remote system's network address.

ParameterExample valueOrigin and description
Remote Network Address400000004044Mainframe system administrator: Network address of the remote host system's network controller

Configuring the System Identification

In this procedure, you configure the remote network system identification details.

ParameterExample valueOrigin and description
Remote Network NameHSTNET1Mainframe system administrator: The network name of the VTAM domain.
Local Control Point NameMCOPU020Mainframe system administrator: the VTAM PU identifier assigned to the local machine.
Local Node ID05D,22222Mainframe system administrator: identifies the local system on the SNA network.
XID TypeFormat 3Mainframe system administrator: can be either 0 or 3, generally 3.
Remote Network NameHSTNET1Mainframe system administrator: The network name of the VTAM domain.
Remote Control Point NameHSTMVSMainframe system administrator: The name of the remote system
Remote Node IDMainframe system administrator will advise whether you need to use this. Identifies the host system on the SNA network.

Configuring 802.2 DLC Properties

In this procedure, you configure the maximum Basic Transmission Unit (BTU) length for the connection.

ParameterExample valueOrigin and description
Max BTU Length1493The maximum number of bytes that can be transmitted in a single data link control frame. The actual value is the maximum value acceptable to both partners, up to the maximum value.

Before attempting to communicate to the host you must define the local and remote LUs that will be used to communicate over the SNA connection you have configured.

Configuring Local APPC LUs

In this procedure, you configure the Local APPC Logical Units (LUs). Independent LUs are used to communicate over the host connection. You need to configure:

ParameterExample valueOrigin and description
LU AliasMCOLU021Mainframe system administrator: defined in the list of LUs configured for your PU on VTAM.
LU 6.2 typeIndependent
Network NameHSTNET1Mainframe system administrator: The network name of the VTAM domain.

If you are using multiple APPC LUs, you can configure each of them as follows:

Configuring Remote LUs

In this procedure, you configure a remote Logical Unit ( LU) that is assigned to a connection.

Independent LUs are used to communicate over the host connection. You need to configure:

ParameterExample valueOrigin and description
ConnectionMVSHOST1Defined in the Configuring the Connection task.
LU AliasHSTCICS1Mainframe system administrator: This LU name should match the definition of the LU as it exists on the remote system, in this case in the form of a VTAM APPLID definition on the host system. To communicate with a host CICS system, this is the host CICS APPLID.
Implicit Incoming Mode#INTERMainframe system administrator: Used to negotiate the session limits with the host.
Network NameHSTCICS1Defaults to the value specified for the connection

Notes:

Adding a User

Before you can use a connection you need to be defined to the Microsoft HIS SNA server as a user.

ParameterExample valueOrigin and description
UserMCOUUser-defined. A user name.

Configuring a 3270 LU for the 3270 Applet

In order to use the Microsoft HIS Server 3270 Applet for 3270 terminal access to the host system, a 3270 LU must be configured for use by each terminal session.

This operation can be repeated for other 3270 dependent LUs for your PU. With a 3270 LU configured with the values below, the operation could be repeated for LU MCOTRM23 with an LU number of 3, and MCOTRM24 with an LU number of 4.

ParameterExample valueOrigin and description
LU number2Mainframe system administrator: LUs used for terminals to the host.
LU nameMCOTRM22Mainframe system administrator: LUs used for terminals to the host.

Associating a 3270 LU with a User

When a user runs the Microsoft HIS Server 3270 applet, a 3270 LU is required in order to establish a 3270 session with the host system. This LU may come from a pool of 3270 LUs or it may be associated with the user. The example values define a pool and associate a user to this pool.

ParameterExample valueOrigin and description
PoolDevPoolUser-defined
Display Model Attributes2 (25x80)
Assign to userMCOUA user that you have configured

Saving the Configuration

To save the configuration, from the File menu, click Save.

Activating the Configuration

To activate the configuration, you must stop and restart the Microsoft HIS Server service.

Provided the 'Activation Type' was defined as 'On Server Startup' or 'On Demand', when the server is active, the underlying connections activate.

When configured for Incoming and Outgoing calls, the status for Connections becomes 'On Demand/Incoming' when successfully activated. The connection status becomes 'Active' when the first session is established, or if the connection is activated manually by the administrator.

Connecting a Client CICS Option to the Host CICS Region

Once you have configured Microsoft HIS on the server, you can configure CICS Option on each client to communicate with the host CICS region. Once you have the Microsoft HIS SNA Server to host connection working as described in the previous section, the configuration of CICS Option and the host CICS region should be simple.

The parameters that you require for configuring CICS Option to the host are:

CICS Option Name From your VTAM Administrator Host CICS Name as in CEDA Example Value Matching Microsoft HIS SNA Server Parameter
LU alias Independent LU for the connection's PU that you are going to use   MCOLU021 SNA Server value for 'LU Alias' in the 'Local APPC LU' definition for the APPC LU that you are going to use
Partner alias Target LU name for your connection   HSTCICS1 SNA Server value for 'LU Alias' in the 'Remote APPC LU'; the host CICS system's APPLID
Alias applid The APPLID of the local CICS Option as defined to the host. This is not in the list above because it takes a default value.   MCOLU021 SNA Server value for 'LU Name' in the 'Local APPC LU' definition for the APPC LU that you are going to use. Normally the same as 'LU Alias'.
Mode table The mode table defining the session limits for the connection 'MOdename' under 'Session Identifiers' #INTER SNA Server value for 'Implicit Incoming Mode' in the 'Remote APPC LU'
Net name Your local CICS system's network name. This is the same as Alias APPLID. 'Netname' under 'Connection Identifiers' MCOLU021 SNA Server value for 'LU Name' in the 'Local APPC LU' definition for the APPC LU that you are going to use. Normally the same as 'LU Alias'.

Defining a CICS Option Connection to a Host CICS System

To define a CICS Option running on a client's connection to the host, use the steps below:

  1. Start Mainframe Express.
  2. Load or define the project for the region that you want to communicate with the host.
  3. On the Tools menu, click CICS and then Resource Definition.
  4. Press F7, group resources.
  5. Add or select a group to add your connection definition to.
  6. When the group has been selected, press F9 =terminal/connection. Then press F3 =connection. The example value is HST1.
  7. Enter the Connect id by which the host will be known to your local system That is, either of the following:
  8. Press F3 =add, and configure the following values:
  9. Press F10 to save the record.

Definition of Host Connection

Figure 9-2: Definition of Host Connection

Including the Resource Group in the Startup List

You need to ensure that the resource group with the host CICS system's definitions is included in the startup list, as follows:

  1. In Mainframe Express on the Project View, select the CICS tab.
  2. Right-click on CICS System, and from the list, select Startup List to display the Startup List Configuration dialog box.
  3. Check whether the group containing the host CICS system's definitions is in the left-hand list of Groups in Startup List. If not:
    1. Select the group from the right-hand list.
    2. Click << Add to move it to the left-hand list.
    3. Click OK to confirm the move.

Defining a CICS Connection from the Host to the Local CICS Option System

In order for the host CICS region to recognize CICS Option running on a local client, you need to define a connection definition and an associated session on the host. On most host systems, a CICS region change such as this is usually applied by the system administrator. Liaise with your system administrator to perform this process.

You need to have a resource group for the connection and session definitions. The example group value is HSTTOSNA. The example connection name is LU21 and the session name is LU21SESS.

You can use an SNA Server 3270 applet to configure the host CICS system by entering the VTAM ID of your host CICS region when the terminal has a connection to the host VTAM system.

This procedure describes how to use the IBM-supplied transaction CEDA to configure the host CICS regions. For more information on the CEDA transaction, see the IBM publication CICS/ESA 3.3 Resource Definition.

In the following procedures, accept the default values for the fields that are not described. When you have defined your connection and sessions, and have tested them, you can configure the connections and settings to be installed automatically on the host CICS region at startup. You can do this by adding the group to your CICS startup list.

  1. In CICS, on the host system, enter the following transaction:

    transaction 'CEDA DEFINE GROUP(group_name) CONNECTION(connection_name)

    where group_name is the name of the group containing the connection connection_name. A transaction using the example values in this chapter is:

    CEDA DEFINE GROUP(HSTTOSNA) CONNECTION(LU21)

  2. In the Netname field, under Connection Identifiers, type the netname of you local CICS Option system and press Enter. The example value is MCOLU021. You should receive the message Define Successful near the bottom of the screen.
  3. Press PF3 to end CEDA, followed by Clear.
  4. Enter the transaction:

    CEDA DEFINE GROUP(group_name) SESSION(session_name)

    where group_name is the name of the group containing the session session_name. A transaction using the example values in this chapter is:

    CEDA DEFINE GROUP(HSTTOSNA) SESSION(LU21SESS)

  5. In the Connection field, under Session Identifiers, type the name of the connection you have defined. The example value is LU21.
  6. In the MOdename field, under Session Identifiers, type the name of the mode table that you are using. The example value is #INTER.
  7. In Session Properties you need to enter the maximum number of sessions in the group and the maximum number of contention winners. Example values are 8 and 4 respectively.
  8. If required, change send size and receive size default values. This will depend on your mode table.
  9. Press Enter and you should receive the message Define Successful near the bottom of the screen.
  10. Press PF3 to end CEDA, followed by Clear.

Defining a Terminal for Transaction Routing

On some versions of VTAM you might need to define a terminal so that you can perform transaction routing to the host CICS region from the local CICS Option.

This requirement is indicated by the error message TXCS1012E Comms error x'0006' during route of TRAN to system HST1 when you enter the first transaction ID to be run on the host CICS region.

If you define a transaction routing terminal, you also need to change the default terminal configuration as described in the section Configuring a Default Terminal. The example transaction routing terminal is: L21A.

  1. Enter the transaction:

    CEDA DEFINE GROUP(group_name) TERMINAL(terminal_id)

    where group_name is the name of the group containing the terminal_id terminal definition. With the example values, the command is

    CEDA DEFINE GROUP(HSTTOSNA) TERMINAL(L21A)

  2. Enter the following details under Terminal Identifiers:
  3. Press Enter and you should receive the message 'Define Successful' near the bottom of the screen.
  4. Press PF3 to end CEDA, followed by Clear.

Installing the Definitions

After you have defined the connection, the session, and, if required, the terminal, you need to install the terminal definitions. As a connection and a session are paired, you need to install the group that they are contained in rather than the individual entries.

Configuring a Default Terminal

You only need to do this if you receive the following message when you enter the first transaction ID to be run on the host CICS region:

TXCS1012E Comms error x'0006' during route of TRAN to system HST1

See the section Defining a Terminal for Transaction Routing for more information.

  1. On the Mainframe Express Tools menu, click CICS, then Region Management, and then Configure Default Terminal. This displays the Configure Default 3270 Terminal dialog box.
  2. Under Terminal definition, set Based on to 'Netname' and Name to XXXXaaaa, where aaaa is the name of the terminal defined on the host CICS region. The example value is XXXXL21A. The last four characters of the netname are used as the terminal identifier. See the section Terminal Installation Parameters in the chapter Configuring CICS Terminals and Printers for more information on the setting of netname.

Testing the Connection to the Host CICS System

To test your connection to the host CICS system you need to ensure that:

  1. The HIS local server has an active link to the host.
  2. The host CICS region is running. In most installations this is the case, but sometimes you may need to ask your host system administrator to start the host CICS region that you are going to connect with. It can usually be tested by using an SNA Server 3270 applet and entering the VTAM ID of your host CICS region when the terminal has a connection to the host VTAM.

Starting the Local CICS Option

To start CICS Option on the client, use the following instructions:

  1. On the Mainframe Express Tools menu, click CICS and then Start Region. In the console window, wait until both initialization phases have been run.
  2. Click CICS and then Start 3270 terminal. This starts the 3270 terminal emulator for CICS Option, not the SNA server.
  3. Complete any sign-on procedure required by your system.
  4. Enter the transaction:

    CRTE SYSID=HST1

    where HST1 is your connection definition name. You should receive the following message:

    DFH4409 The routing session to system HST1 has been started

    This initiates transaction routing for this terminal without acquiring any resources. It does not test the connection.
  5. To test the connection, enter a transaction that you know exists on the host CICS system. A suitable transaction is:

    CEMT INQUIRE CONNECTION

    This should return the following information:
    IN CONN
    STATUS:  RESULTS - OVERTYPE TO MODIFY 
    Con(COA1) Net(COA1REMT)  Ins Rel  Vta Appc
    Con(LU21) Net(MCOLU021)  Ins Acq  Vta Appc

    In the list of connections, you should see the connection that you have defined, and the netname associated with it. It should also have the acquired status (Acq).

Setting Up Communications from Host to Local CICS Options

At this stage, you are not able to use transaction routing, function shipping, or DPL from the host CICS region. Also, distributed transaction processing (DTP) does not work because the host CICS region is currently unable to initiate tasks on the local CICS Option.

If you have reached this point successfully, you should now have the HIS software on the local server configured and connected to the VTAM host system. CICS Option should be able to use transaction routing, function shipping, and distributed program linking (DPL) to the host system.

Defining Transaction Programs

In this procedure, you define transaction programs (TPs) to the HIS local server (or client connected to an SNA Server) so that it knows how to invoke CICS Option.

For inbound communications, the HIS SNA Server requires registry entries to be created for each CICS Option transaction on the local server or a client. These entries are used by the HIS SNA Server to start the CICS Option program dfhgatch.exe, which routes the request to the correct CICS Option region and transaction.

The Micro Focus CICS Option registry entries for the transaction programs can be found in the following location:

/HKEY_LOCAL_MACHINE/SYSTEM/CurrentControlSet/Services/SnaBase/Parameters/TP's/tpname/Parameters

You can use the supplied program mftpset.exe to add inbound transaction program information to the registry:

  1. Start a Mainframe Express command prompt.
  2. Run mftpset.exe. This displays a dialog box that enables you to add or overwrite the registry entry for the inbound transaction program.
  3. Specify the TP Name. This is used to identify the transaction program to the HIS SNA Server. This TP name should correspond to the transaction that the host system attempts to run on the local CICS Option (for example, CRTE).
  4. Specify the Command line that starts the transaction on the local CICS Option.
  5. Specify the name of the Local LU Alias as defined to the HIS SNA server for the inbound request. This is the independent LU that you are going to use for your PU as defined to VTAM. The example value is: MCOLU021
  6. Click OK.

For more information on adding and editing transaction programs, see the Host Integration Server 2006 Help.

An important point about tpstart.exe is that it only reads the registry when it is started. So, if you have updated the registry by adding or changing a TP, you need to stop and restart tpstart.exe to pick up any updates.

The following TPs must be defined for inbound function shipping, transaction routing, and distributed program linking:

TP Name CICS Option Transaction Purpose
CPMI CPMI Function shipping mirror transaction for ANSI
CSMI CSMI Function shipping mirror transaction, general
CVMI CVMI Function shipping mirror transaction for EBCDIC
CRTE CRTE Transaction routing transaction
CRSR CRSR Internal CICS housekeeping transaction

For inbound function shipping, transaction routing, or distributed program linking, you must add the resource group DFHISC to the startup list in the SIT that contains the PCT definitions for the above transactions.

Testing Inbound Transaction Routing from the Host

When you have added the required TP definitions to the registry, you are able to perform inbound transaction routing from the host.

This test completes the configuration. To test your connection to the host ensure that:

  1. The Microsoft HIS SNA server has an active link to the host.
  2. The host CICS region is running. In most installations this is normally the case, but sometimes you may need to ask your host system administrator to start the host CICS region that you are going to connect with. It can usually be tested by using an SNA Server 3270 applet and entering the VTAM ID of your host CICS region when the terminal has a connection to the host VTAM.
  3. You have restarted the region as described in the section Starting the Local CICS Option.

When the previous steps have been done:

  1. Start a Microsoft HIS SNA Server 3270 applet to the host VTAM, as described earlier, and connect to the host CICS region.
  2. When you have a session on the host CICS region, run the supplied transaction:

    CRTE SYSID=localwhere local is the name of the connection that you defined earlier. With the supplied example values, it is:

    CRTE SYSID=LU21

    .
  3. You should now be able to use the SNA Server 3270 applet as if it was a terminal on your local CICS system. To test the connection, run the transaction CENV supplied with CICS Option. This should give you information about your local CICS system. When you have completed transaction routing, enter the CANCEL command.

Note: When transaction routing is active in one direction, you cannot then route back to your terminal. This is because when you attempt to route back, the original terminal-id is passed back and is rejected because it is not unique. All terminal-ids must be unique within a CICS region, both on the host and the local CICS Option.


Copyright © 2009 Micro Focus (IP) Ltd. All rights reserved.