Mainframe Gateway for OpenVMS

June 2004

This manual describes how to install, customize, and use the Mainframe Gateway for OpenVMS product, Version 1.1.

DAI

Data Access Incorporated

New Ipswich, New Hampshire

www.data-access-inc.com

CONTENTS:

1. Preface........................................................................................................................................................3
1.1 Prerequisites.........................................................................................................................................3
1.2 Data Access Incorporated.....................................................................................................................4
1.3 Who Should Use This Book.................................................................................................................4
1.4 How This Book Is Organized...............................................................................................................4
1.5 Associated Documents.........................................................................................................................5
1.6 Conventions..........................................................................................................................................5
1.7 Disclaimers...........................................................................................................................................5
1.8 Edition Notice.......................................................................................................................................5
1.9 Contact Information..............................................................................................................................6
2. Introduction................................................................................................................................................7
2.1 Required Software for OS/390 or z/OS Systems..................................................................................7
2.2 Disk Space Requirements.....................................................................................................................7
2.3 Installation Overview...........................................................................................................................7
2.4 License..................................................................................................................................................7
2.5 Post Installation Activities....................................................................................................................7
3. Software Installation Procedure..................................................................................................................9
3.1 Move Installation Material to the Mainframe.......................................................................................9
3.2 Create the Sample JOBS Library........................................................................................................10
3.3 Tailor the Installation Jobs Material...................................................................................................10
3.4 SMP Catalog Procedure......................................................................................................................12
3.5 Allocate Files Needed by SMP/E.......................................................................................................12
3.6 Run the SMP/E Jobs...........................................................................................................................12
3.7 Run the Installation Verification Procedure.......................................................................................13
4. SNA Configuration Information...............................................................................................................16
4.1 Application Major Nodes and APPL Statements................................................................................16
4.2 VTAM Activation Commands...........................................................................................................18
5. MGO Configuration File..........................................................................................................................20
5.1 Configuration File Overview..............................................................................................................20
5.2 Developing a Configuration File........................................................................................................20
5.3 Record Format....................................................................................................................................23
5.4 Detailed Description...........................................................................................................................24
6. Log File Messages....................................................................................................................................34
6.1 Log File Location...............................................................................................................................34
6.2 Log File Message Format...................................................................................................................34
6.3 Detail Description of Log File Messages...........................................................................................34
7. Console Commands..................................................................................................................................39
7.1 MGO MODIFY Command................................................................................................................39
8. Samples....................................................................................................................................................42
8.1 SAMPLE LIBRARY MEMBERS.....................................................................................................42
8.2 Sample Log File Content....................................................................................................................44
9. INDEX:....................................................................................................................................................47
1. Preface

The Mainframe Gateway for OpenVMS (MGO) can replace any other SNA Gateway for used with OpenVMS application programs. This includes CT, ST, SNA Access and SNA Access Server Gateway.

The Mainframe Gateway for OpenVMS is a software-only solution. No new or additional hardware is required. After the software is installed and configured on the IBM mainframe, the Mainframe Gateway for OpenVMS appears to the OpenVMS systems as another HP SNA gateway.

OpenVMS Application Architecture using HP SNA Gateway

OpenVMS Application Architecture using

Mainframe Gateway for OpenVMS

1.1 Prerequisites

The Mainframe Gateway for OpenVMS (MGO) may be used in place of other (HP) SNA Gateways when:

OpenVMS

SNA Access Routine

Mainframe

SNA Software

(VTAM)

Mainframe

Application

Program

OpenVMS

Application

Program

CT or ST

SNA

Gateway

OpenVMS

SNA Access Routine

Mainframe

SNA Software

(VTAM)

Mainframe

Application

Program

OpenVMS

Application

Program

Mainframe Gateway for OpenVMS

• OpenVMS systems has a TCP software stack installed and operational

• IBM mainframe has TCP software stack installed and operational

• Both OpenVMS and mainframe systems are connected by a network that supports TCP communications between the two systems

• The IBM mainframe operating system is OS/390 V2.R10 or any version of z/OS that is currently supported by IBM

No new software need be installed on the OpenVMS systems. All current versions of OpenVMS SNA products already support both DECnet and TCP communications.

No changes are needed in OpenVMS application programs.

Configuration changes are required on the OpenVMS systems. If the OpenVMS system initiates contact with the mainframe, then the gateway name must be changed to the IP name (or dotted decimal address) of the IBM mainframe. If OpenVMS system passively awaits contact from the mainframe, the 'listen' information needs to specify a TCP port number.

The Mainframe Gateway for OpenVMS must be installed on the IBM mainframe. This manual contains detailed information on the installation procedure in chapters 2 and 3. Chapters 4 and 5 describe the configuration process.

No changes are needed in IBM mainframe application programs.

1.2 Data Access Inc

Data Access Inc, and its sister company Systems & Communications Sciences (S&CSI), offer a variety of IBM mainframe related software products and services. DAI and S&CSI have worked closely with HP (and Compaq and Digital) since 1980.

In 1986, Data Access developed the mainframe portion of Digital's Data Transfer Facility for VMS product. Digital, Compaq, and HP have continued to distribute this product under a royalty agreement with DAI. Throughout this period, DAI has provided 7x24 engineering level support to the DEC/Compaq/HP support organizations.

The Mainframe Gateway for OpenVMS was developed with the knowledge and cooperation of HP. The product is designed to work with HP products, but it is the sole property of Data Access Incorporated.

For more information, please see our web site www.data-access-inc.com or send mail to info@data-access-inc.com.

1.3 Who Should Use This Book

This publication is intended for people responsible for installing, configuring, and using the Mainframe Based Gateway. The following topics are covered:

• Installation of the software on the mainframe

• Configuration of the software

• Log file messages

• Mainframe operator console commands and responses

1.4 How This Book Is Organized

Chapters two and three describe installation of the Mainframe Based Gateway software and the installation verification procedure. These chapters are intended for use by IBM mainframe system programmers. The reader is expected to have experience in installing software products on IBM mainframes using SMP/E. Some experience with mainframe TCP/IP configuration issues is also assumed. Knowledge of VTAM, OpenVMS, or OpenVMS SNA products is not required.

Chapters four and five describe the mainframe configuration process. Chapter four covers VTAM configuration. Chapter five covers development of a MGO configuration file. Since some VTAM parameters must match MGO configuration parameters, these chapters are intended to be used together.

Chapter six documents log file messages.

Chapter seven describes the console commands and responses.

Chapter eight contains sample configuration information and job control language.

1.5 Associated Documents

While installing and configuring the software, it may be helpful to refer to these IBM manuals:

• SNA Resource Definition Reference (SC31-8778)

• IP Configuration Reference (SC31-8776)

• SMP/E for z/OS and OS/390 User’s Guide (SA22-7773)

1.6 Conventions

This manual uses the following conventions:

UPPERCASE

Uppercase letters in a command represent text that you must enter as shown. You may enter the text in either upper- or lowercase.

lowercase italics

Lowercase italicized items in a command represent variables for which you must substitute specific values.

[ ]

In command syntax, square brackets enclose optional parts of the command. Do not type the brackets when you enter the command.

{}

In command syntax, braces indicate that you must choose one of the options enclosed. Do not type the braces when you enter the command.

1.7 Disclaimers

The following are trademarks or registered trademarks of Hewlett Packard:

HP, Compaq, Digital, DEC, DECnet, VAX, Alpha, and OpenVMS.

The following are trademarks or registered trademarks of International Business Machines:

IBM, OS/390, z/OS, and VTAM.

All other trademarks and registered trademarks are the property of their respective holders.

1.8 Edition Notice

This edition applies to Version 1.1 of Mainframe Gateway for OpenVMS and all subsequent releases and modifications unless otherwise noted.

DAI welcomes your comments. Please send your comments to the address shown in the next section.

By sending information to DAI, DAI is granted nonexclusive right to use or distribute the information in any way it believes appropriate without incurring any obligation to the sender.

© Copyright Data Access Incorporated (a New Hampshire, USA Corporation) 2004. All rights reserved.

1.9 Contact Information

E-mail: info@data-access-inc.com for general, sales, or account information

support@data-access-inc.com for technical information or assistance

Web site: www.data-access-inc.com

Telephone: 603-491-6270

Fax: 603-878-1929

Mail: Data Access Inc.

244 Poor Farm Rd

New Ipswich, NH 03071-3922

2. Introduction

This chapter provides an overview of the installation process for the Mainframe Gateway for OpenVMS (MGO).

2.1 Required Software for OS/390 or z/OS Systems

The Mainframe Gateway for OpenVMS software requires the following system software:

• OS/390 V2R10 or z/OS V1R4 (or later) running in 31 or 64 bit mode

• System Modification Program/Extended (SMP/E)

• Communications Server (VTAM and TCPIP)

2.2 Disk Space Requirements

Approximately 400 tracks are required.

2.3 Installation Overview

The installation process consists of these steps:

• Copy the binary ‘Install Kit’ to the IBM mainframe

• Unpack the ‘Install Kit’ using the TSO RECEIVE command

• Run a job in the unpacked version of the 'Install Kit' to create an installation library

• Customize jobs in the installation library by adding site specific information

• Create the SMP/E related files and VSAM clusters

• Initialize the MGO SMP/E environment

• Perform SMP/E RECEIVE, APPLY, and ACCEPT processing

• Run the Installation Verification Procedure

Chapter 3 contains detailed instructions for performing each step.

2.4 License

The Mainframe Gateway for OpenVMS is protected by a License. A license is included in installation kit. For information on updated licenses, please contact the Data Access.

A license IS NOT REQUIRED to install the MGO software or to execute the Installation Verification Procedure.

A license IS REQUIRED to use the MGO software to allow OpenVMS based applications to communicate with mainframe base application programs.

2.5 Post Installation Activities

After installation, configuration information needs to be created or changed to make use of the MGO. Three distinct types of configuration information must be created or modified:

• SNA (or VTAM) Application Major Node definitions

• MGO configuration file

• OpenVMS configuration changes

The SNA (or VTAM) Application Major Nodes contain parameter for each SNA logical unit that the MGO supports. Chapter four contains information on defining information for Application Major Nodes.

The MGO configuration file contains parameter values used to communicate with the mainframe TCPIP and SNA software. Chapter 5 contains information on developing the configuration file.

The OpenVMS configuration changes are usually limited to changing the Gateway name (or IP address) to a value for the IBM mainframe.

If a firewall or a SAF security package is used to restrict TCPIP operations, the firewall or security package rules may need to be modified.

Most OpenVMS access routine products initiate TCPIP connections to the MGO product. Examples include the SNA 3270 Terminal Emulator and the SNA RJE product. The firewall must allow TCP connections:

• From the OpenVMS systems using any TCP port number

• To the mainframe at TCP port number 108 (or other value specified on the TCP-PORT statement in the MGO configuration file)

• On all mainframe TCP interface addresses (or specific IP address specified on the TCP-INTERFACE statement in the MGO configuration file).

Instead of initiating TCPIP connections, some OpenVMS access routine products expect to receive TCPIP connections. The SNA 3270 Access Services product is an example. To use these products, the firewall must allow TCP connections:

• From the IBM mainframe using any mainframe TCP port number (unless a port number range is specified in the MGO configuration file on the LU-ADDRESS statement)

• From any IBM mainframe TCP interface (unless a specific interface is specified by the TCP-INTEFACE statement in the MGO configuration file)

• To the OpenVMS system using the IP addresses and TCP port numbers specified on the LU-ADDRESS statements in the MGO configuration file.

3. Software Installation Procedure

This chapter describes the installation process for the Mainframe Gateway for OpenVMS (MGO). The reader is assumed to be familiar with common IBM mainframe tools and facilities including SMP/E, TSO, FTP, and operator console commands.

3.1 Move Installation Material to the Mainframe

The MGO software is distributed in a variety of ways: email attachment, FTP, or a CD.

Regardless of the distribution method, the software consists of a single SMP/E function with a Function Modification Identifier of MGO1100.

The instructions in this section are assume that a Window PC is being used as a work station and that the PC can access the IBM mainframe via FTP.

If you have a CD containing DAI software, the 'install.kit' file is in the '/software' directory.

If you received the software as an email attachment, unzip the attached file.

Otherwise, follow the instructions to download the 'install.kit' file from the FTP site or the wet site.

Copy the 'install.kit' file to the mainframe. The mainframe file will be used as input by the TSO RECEIVE command, so the mainframe file must consist of 80 byte fixed length records.

Use any convenient method such as FTP, PC File Transfer (IND$FILE), or Data Transfer Facility. The example below illustrates the use of FTP to allocate an appropriate mainframe file and do the file transfer. Be sure to use a ‘binary’ or ‘image’ copy mode.

Example: Sample FTP session to transfer ‘install.kit’ to z/OS Mainframe

ftp your.mainframe.name

220-Connection message from mainframe.

User: user01

331 Send password please.

Password: mypasswd

230 USER01 is logged on. Working directory is “USER01.”

ftp>

ftp> quote site lrecl=80

200 SITE command was accepted

ftp> quote site blksize=6160

200 SITE command was accepted

ftp> quote site recfm=fb

200 SITE command was accepted

ftp> bin

200 Representation type is Image.

ftp> put install.kit

ftp> bye

Depending on your FTP client type, you may have to use ‘locsite’, ‘literal site’, or ‘quote site’ in place of ‘site’.

Once the data has been copied to the mainframe, use the ‘TSO RECEIVE’ to unpack the install kit into a new partitioned data set.

Example:

tso receive indsn(‘USER01.INSTALL.KIT’)

INMR901I Dataset MGO.INSTALL.KIT from DAI on NODENAME

INMR906A Enter restore parameters or 'DELETE' or 'END' +

da(‘USER01.INSTALL.KITLIB’)

If the installation kit library contains member PROGDIR, please read it. If present, it may contain installation notes or instructions that are more up to date than this manual.

3.2 Create the Sample JOBS Library

To create a library of sample SMP/E jobs, edit and execute member $UNLOAD in the install kit library. The edits required are:

• JOB card information

• Data set name on the SYSIN DD card. This should be the name of the install kit library (USER01.INSTALL.KITLIB).

• Data set name on the SYSUT2 DD card. This should be the name of the new SMP/E sample job library (USER01.INSTALL.JOBS).

Example: Edited Version of $UNLOAD from the install kit library:

//MYJOB JOB ,MYNAME,CLASS=A,MSGCLASS=X

//RESORE EXEC PGM=IEBUPDTE,PARM=NEW

//SYSPRINT DD SYSOUT=*

//SYSUT2 DD DSN=USER01.INSTALL.JOBS,DISP=(,CATLG,DELTE),

// UNIT=SYSDA,DDB=(LRECL=80,BLKSIZE=7200,RECFM=FB),

// SPACE=(7200,(150.15,10))

//SYSIN DD DSN=USER01.INSTALL.KITLIB($FILE11),DISP=SHR

//

3.3 Tailor the Installation Jobs Material

The installation jobs library contains sample jobs that can be modified and then submitted to install MGO using SMP/E. The required modifications are

• JOB card information

• High level qualifier names for various libraries

• High level qualifier for new SMP/E environment

• Disk drive UNIT types and volume serial numbers

A REXX script, MGOINIT, can used to perform the modifications. Execute the script and provide answers to the questions it asks.

Example: Sample execution of MGOINIT script:

-----------------------------MGOINIT---------------------------------

Do you need to customize the installation JCL? (Y|N) y

------------------------JCL UPDATE PROCESS--------------------------

The fully qualified name of the install dataset is USER01.INSTALL.JOBS

If you are running MGOINIT the first time, then there are no previous values are displayed in the parenthesis. Previous values will be displayed in the parenthesis during subsequent executions of MGOINIT.

If you hit enter without specifying a value then the value in parenthesis will be used. If you type in HX at any prompt you will terminate this REXX exec

You can optionally specify two lines for the jobcard statement

Enter the first line of the jobcard ()?

//MGO0001 JOB ,MYNAME,CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1)

Enter the second line of the jobcard (this is optional) ()?

The second line of the jobcard is

Enter the high level qualifier for MGO target libraries ()?

USER01.MGO1000.TLIB

Enter the high level qualifier for MGO DLIBs ()?

USER01.MGO1100.DLIB

Enter the volume serial number for MGO target libraries ()?

TSOVL1

Enter the volume serial number for MGO DLIBs ()

TSOVL1

Enter the generic unit name for MGO target libraries (3390)

SYSDA

Enter the generic unit name for MGO DLIBs (3390)

SYSDA

Enter the high level qualifier of all SMP/E work files in the MGO global, target, and DLIB zones ()

USER01.MGO1100.SMPE

Enter the high level qualifier of the MGO global CSI dataset used for

controlling the MGO target and DLIB zones ()

USER01.MGO1100.SMPECSI

Enter the high level qualifier of the MGO target zone CSI dataset ()

TYREE.MGO1100.SMPECSI2

Enter the high level qualifier of the MGO DLIB CSI dataset () USER01.MGO1100.SMPECSI3

The high level qualifier of the MGO DLIB CSI dataset is

USER01.MGO1100.SMPECSI3

Enter the high level qualifier used by SMP/E to create SMP/E temporary libraries during MGO RECEIVE processing ()

USER01.MGO1100.SMPE4

Enter the volume serial number for all SMP/E work files in the MGO global, target, and DLIB zones ()

TSOVL1

Enter the volume serial number used to allocate the MGO Global CSI dataset ()

TSOVl1

Enter the volume serial number used to allocate the MGO target CSI dataset()

TSOVL1

Enter the volume serial number used to allocate the MGO DLIB CSI dataset ()

TSOVL1

Enter the generic unit name for all SMP/E work files in the MGO global,

target, and DLIB zones (3390)

SYSDA

Enter the generic unit name used to allocate the MGO Global CSI dataset (3390)

SYSDA

Enter generic unit name used to allocate the MGO target CSI dataset (3390)

SYSDA

Enter generic unit name used to allocate the MGO DLIB CSI dataset (3390)

SYSDA

Enter the library into which you downloaded the install package ()?

USERO1.INSTALL.KITLIB

Enter the name of the library which contains the SMPMGO procedure ()?

USER01.INSTALL.JOBS

If you would like review these JCL update values from the beginning, type in Y, anything else will start the editing process

DO NOT HIT ATTENTION WHILE MGOINIT EXEC IS EDITING MEMBERS!

INPUT

USER01.INSTALL.JOBS(SMGO01) HAS BEEN EDITED FOR SUBMIT

INPUT

USER01.INSTALL.JOBS(SMGO02) HAS BEEN EDITED FOR SUBMIT

INPUT

USER01.INSTALL.JOBS(SMGO03) HAS BEEN EDITED FOR SUBMIT

INPUT

USER01.INSTALL.JOBS(SMGO04) HAS BEEN EDITED FOR SUBMIT

INPUT

USER01.INSTALL.JOBS(SMGO05) HAS BEEN EDITED FOR SUBMIT

INPUT

USER01.INSTALL.JOBS(SMGO06) HAS BEEN EDITED FOR SUBMIT

INPUT

USER01.INSTALL.JOBS(SMPMGO) HAS BEEN EDITED FOR SUBMIT

INPUT

USER01.INSTALL.JOBS(VERIFY) HAS BEEN EDITED FOR SUBMIT

END OF EDITING PROCESS

3.4 SMP Catalog Procedure

Member SMPMGO is a cataloged procedure needed by jobs SMGO03 through SMGO06. Do one of the following:

• Copy SMPMGO to one of the system procedure libraries

• Edit members SMGO03 through SMGO06 to convert the “JCLLIB” statement form a comment into a JCL statement.

• Edit members SMGO03 through SMGO06 by inserting SMPMGO into each job as an in-line procedure (be sure to add a "// PEND" statement).

3.5 Allocate Files Needed by SMP/E

Submit jobs SMGO01, SMGO02, and SMGO03 to allocate and initialize the various files needed by SMP/E.

3.6 Run the SMP/E Jobs

Submit job SMGO04 to perform SMP/E RECEIVE processing. This job moves function MGO1100 into the SMPPTS data set and places the associated data records into the temporary SMPTLIB data sets for subsequent processing.

Submit job SMGO05 to perform SMP/E APPLY processing. This job loads the target libraries. A return code of 4 is normal because a normal return code of 8 is returned during the link edit steps of the APPLY.

Submit job SMGO06 to perform SMP/E ACCEPT processing. This job loads the distribution libraries. For this job, a return code of ‘4’ is acceptable.

3.7 Run the Installation Verification Procedure

The IVP procedure verifies that the Mainframe Gateway for OpenVMS is properly installed and can communicate with the mainframe’s TCPIP software. If a Web Browser (on a PC or OpenVMS system) is available, the IVP can also verify that the MGO is reachable from the TCPIP network.

3.7.1 Start the IVP

To start the IVP, submit the VERIFY job.

The VERIFY job uses member IVPCONF of the sample library for input configuration information. IVPCONF contains nothing but comments. If problems are encountered in the IVP procedure, some of the comments may need to be converted to configuration statements (by deleting the ‘*’ in column 1).

A license is not required for execution of the IVP.

A VTAM application major node is not required for execution of the IVP.

3.7.2 Expected Results

After starting the IVP, examine the log file (defined by the SYSPRINT DD statement in MGOIVP). The MGO log file should contain two messages:

095300 ---- 01 I DATE: 040615

095300 ---- 00 I COMMENT: COPYRIGHT (C) 2004 BY DATA ACCESS …

095300 ---- 00 I DATA-ACCESS-INC-V1.1 - PTF:0000

095300 ---- 00 I COMMENT:

095301 ---- 06 I TCP: INITIALIZE API SUCESSFUL

From the mainframe operator’s console, or a TSO session enabled for console commands, issue a modify command to the MGO:

F mgoname,HELP

The MGO should respond with a list of available command in the console log and in the MGO log file.

095320 ---- 04 C INPUT: MODIFY: HELP

095320 ---- 05 C OUTPUT: SUPPORTED REQUESTS:

095320 ---- 05 C OUTPUT: HELP

095320 ---- 05 C OUTPUT: SHOW BUFFERS

095320 ---- 05 C OUTPUT: SHOW CONNECTIONS

095320 ---- 05 C OUTPUT: SHOW LOGICAL UNITS

095320 ---- 05 C OUTPUT: SET TRACE ON

095320 ---- 05 C OUTPUT: SET TRACE FULL

095320 ---- 05 C OUTPUT: SET TRACE OFF

095320 ---- 05 C OUTPUT: SET VTAM OPEN

On the address line of a Web Browser (Internet Explorer running on a PC), type the IBM mainframes IP name or dotted decimal address followed by “:108”. The “:108” tells the web browser to connect to TCP port 108 on the mainframe.

http://your.mainframe.dns.name:108

or

http://dotted.decimal.IP.address:108

The Web Browser should display a simple web page containing the product name, product version, and PTF level. The MGO log file should have one additional line:

095330 0001 23 I CLEANUP: CLEANUP INVOKED 00000:00000 00001:0033

If this output is observed, the MGO software is properly installed and communications with the mainframe TCPIP stack is operational.

3.7.3 Stop the IVP

To terminate the IVP, use the operator’s console halt command:

P mgoname

3.7.4 Quick Test with OpenVMS System

The instructions in the next two chapters contain detailed instructions for configuring MGO for operation with OpenVMS systems. Alternatively, follow these abbreviated instructions:

• Edit job MGOJCL in the sample library. The JOB card and the high level qualifier of the data set name parameters will need to be changed. After editing, the job will use the IVP configuration information plus a license and OpenVMS related information.

• Edit sample library member MGONODE to conform to your installation’s guidelines concerning VTAM application major nodes (MGONODE) and VTAM application names (MGOXX*). Then add the resulting member to your installation’s VTAMLST library.

• Activate the application major node (V NET,ACT,ID=MGONODE,SCOPE=ALL)

• If the VTAM application names (MGOXX*) were changed, make the same changes in member MGOCONF.

• Stop the IVP job (if it is still executing)

• Execute the MGOJCL job.

• From an OpenVMS system prompt, invoke the terminal emulator and connect to MGO on the mainframe: set host/sna mainframe.dns.name/wait

• From the SNA Terminal Emulator prompt: “PLEASE LOGON:” , type a logon request such as: logon applid(tso) logmode(d4c32782)

3.7.5 Trouble Shooting

If the second message in the MGO log file is “INITIALIZE API FAILED”, the MGO cannot communicate the TCPIP stack on the mainframe. If the message contains “FFFF / 03F3 - CHECK TCPIP STACK NAME”:

• Contact the person responsible for the TCPIP configuration on the mainframe to determine the name of TCPIP stack on your mainframe

• Edit the file referenced by the SYSIN DD statement in MGOIVP. Replace “TCPIPVX” with the name of the TCPIP stack on your mainframe.

• Delete the “*” before TCP-STACK (and make sure that the TCP-STACK now starts in column 1).

• Restart the IVP

If the same error recurs, please send mail to the Data Access support group at support@data-access-inc.com. Be sure to include a copy of the log file.

If the INITIALIZE API SUCCESSFUL may be followed by this message:

HHMMSS ---- 09 E TCP: BIND RC/ERRNO = FFFFFFFF/xx

TCP port 108 is not available for use by MGO. If the value of xx is ‘30’, the port is in use by some other application. If the value of xx is ‘0D’, the MGO application is not authorized to use port 108. If the value is neither ‘30’ nor ‘0D’, please contact the DAI support group for help in interpreting the error.

Either error condition can be bypassed (at least for the IVP), by changing the MGO configuration file to specify a port number other than 108:

• Edit the file referenced by the SYSIN DD statement in MGOIVP. Replace “108” in the TCP-PORT statement with some other (large) port number that is unlikely to be in use and unlikely to be restricted by firewalls/security. A value of 8108 may be a good choice.

• Delete the “*” before TCP-PORT (and make sure that the TCP-PORT now starts in column 1).

• Restart the IVP

• When accessing MGO from a Web Browser, use the same port number specified in the MGO configuration file (8108).

• To use an OpenVMS SNA application with a port number other than 108, on the OpenVMS system, specify

$DEFINE SNA_PORT_NUMBER "#8108"

If the expected page is not displayed on the Web Browser and no additional messages have been added to the MGO log file, a firewall (or other security measure) may be preventing the Web Browser request from reaching the MGO. Contact the Data Access support group, or the person responsible for you TCPIP network.

If the IVP (using a PC) is successful, but the OpenVMS SNA application cannot communicate with MGO, please generate a SNA LOG MASK trace on the OpenVMS system:

• In the OpenVMS SNA product environment, specify SNA LOG MASK trace:

$DEFINE SNA_TRANSPORT "nolocal,nodecnet,tcp"

$DEFINE SNALOG_MASK 0x7FFFFFFF

$DEFINE SNALOG_FILE disk:[dir]tracefile.txt

• Restart the OpenVMS SNA application

• Stop the OpenVMS SNA application

The trace file will contain a record of the OpenVMS SNA application's attempt's to communicate with the MGO application. Contact the Data Access support group at support@data-access-inc.com. Be sure to include a copy of the log file, the trace file, and a description of any additional symptoms.

4. SNA Configuration Information

This chapter describes the tasks you must perform to allow the Mainframe Gateway for OpenVMS (MGO) to access application programs (and 3270 terminals) on you SNA network.

Like the HP provided SNA Gateways, the Mainframe Gateway for OpenVMS is associated with a number of SNA Logical Units. Each OpenVMS application program uses one or more of these logical units to communicate with other components in the SNA network.

For other HP SNA Gateways, the logical units are defined by LU statements in Switched Major Nodes, Local SNA Major Nodes, or Channel Attached Major Nodes.

For the MGO, the logical units are defined by APPL statements in Application Major Nodes. One VTAM APPL statement is needed for each logical unit. All of the APPL statements can all be specified in a single Application Major Node, or distributed among many different nodes.

Each Application Major Node must be stored as a member of SYS1.VTAMLST (or the installation dependent equivalent). In addition, each major node must be ‘activated’ before MGO can use the APPL statements it contains (see ‘Activation of VTAM Resources’ at the end of this chapter).

Please see IBM’s SNA Resource Definition Reference (SC31-8778) manual for definitive information on all VTAM configuration issues.

4.1 Application Major Nodes and APPL Statements

The general format of VTAM Application Major Node is:

VBUILD TYPE=APPL

nodename GROUP keyword=value

luname APPL [keyword=value]

luname APPL [keyword=value]

The VBUILD statement declares that the information is an Application Major Node.

The GROUP statement provides a convenient way to specify “keyword=value” information that applies to all the APPL statements.

Each APPL statement defines one logical unit. Each APPL statement corresponds to one LU-NAME statement in the MGO configuration file. The APPL ‘luname’ value must match the SECOND parameter on the LU-NAME statement.

Some ‘keyword=value’ pairs are required for every APPL They can be coded on an APPL statement or on a preceding GROUP statement. The required parameters are:

SONSCIP=YES: This parameter controls the method that VTAM uses to notify the MGO of SNA session outages under some circumstances. The parameter is required because the VTAM provided default is “NO”

AUTH=(VPACE) or (VPACE,ACQ): The VPACE parameter indicates that the MGO is subject to the VPACING specification of secondary logical units when the MGO acts as the primary side of the SNA session. This value should always be specified to prevent excessive memory requirements within the MGO application. Use the (,ACQ) parameter for logical units that will initiate sessions with another logical unit. In general, only the OpenVMS 3270 Application Services access routine operates in this mode.

All other ‘keyword=value’ pairs are optional:

EAS=n: To conserve IBM mainframe resources, specify the estimated number of concurrent sessions using the EAS parameter. For logical units used with OpenVMS 3270 Application Services product, specify the expected number of concurrent sessions. For logical units used with all other OpenVMS applications, specify a value of 1. The value specified by the EAS is NOT critical. According to IBM’s documentation, it is used to control the amount of resources initially allocated to a logical unit. It is NOT used to enforce an upper limit on the number of concurrent sessions. The maximum number of sessions per logical unit is enforced by the MGO. Unless a larger number is specified on a MGO configuration LU-LIMIT statement, the MGO allows only one session per logical unit.

MODETAB: The name of the logmode table assigned to the logical unit. This table should contain entries appropriate for use with the OpenVMS applications.

DLOGMOD: The name of the entry in the logmode table to use as a default value when a specific entry is not specified elsewhere. If DLOGMOD is not specified, the first entry in the table becomes the default.

PRTCT: A password value that the MGO must supply in order to use the VTAM application name.

VPACING: Specifies the pacing count for data flowing from VTAM to the MGO. Valid values are 1 to 63. Large values may provide better performance but may also result in increased memory usage by MGO. A value of 16 should provide adequate performance and reasonable memory usage.

Example: A Sample Application Major Node

*

* MGONODE - VTAM APPLICATION MAJOR NODE

*

VBUILD TYPE=APPL

**

MGONODE GROUP SONSCIP=YES,AUTH=(VPACE),EAS=1

MGOXXA APPL

MGOXXB APPL

MGOXXC APPL

MGOXXD APPL

MGOXXE APPL AUTH=(VPACE,ACQ),DLOGMOD=D4C32782,EAS=50

The VTAM Application Major Node contains definitions for six logical units. Each logical unit inherits the ‘keyword=value’ parameters specified on the GROUP statement.

Logical units MGOXXA through MGOXXE would provide access to IBM mainframe application programs for most OpenVMS SNA applications.

Logical unit MGOXXF could be used with the SNA 3270 Application Server to support multiple concurrent sessions with IBM 3270 compatible terminals.

The name that precedes each VTAM APPL statements must match a parameter in the MGO configuration file statements. The next example shows a fragment of an MGO configuration file that corresponds to the VTAM Application Major Node in the previous example. The MGO configuration file requirements are covered in detail in the next section.

Example: MGO Configuration File Information

*

*

LU-NAME ABC1 MGOXXA * OpenVMS name ABC1 = VTAM name MGOXXA

LU-NAME ABC2 MGOXXB * OpenVMS name ABC2 = VTAM name MGOXXB

LU-NAME ABC3 MGOXXC * OpenVMS name ABC3 = VTAM name MGOXXC

LU-NAME ABC4 MGOXXD * OpenVMS name ABC4 = VTAM name MGOXXD

LU-NAME ABC5 MGOXXF * OpenVMS name ABC6 = VTAM name MGOXXE

*

LU-LIMIT ABC5 50 *Session Limit for LU ABC5

LU-ADDRESS ABC5 11.22.33.44 8043 *OpenVMS IP address & PORT

*

4.2 VTAM Activation Commands

Both the major node and the APPL must be activated. In a production environment, the major node names are usually included in a list of resources that are activated when VTAM starts. During installation and testing, it may be more convenient to manually activate the resources. A VARY operating system console commands could be used to activate the APPL definitions shown in the previous section:

V NET,ACT,ID=MGONODE,SCOPE=ALL

Or

V NET,ACT,ID=MGONODE,SCOPE=ONLY

V NET,ACT,ID=MGOXXA

V NET,ACT,ID=MGOXXB

V NET,ACT,ID=MGOXXE

The ‘SCOPE=ALL’ parameter indicates that all the logical units defined within MGONODE 2 are to be activated. The ‘SCOPE=ONLY’ parameter indicates that the activate request applies only to the application major node and NOT to the logical units within the node.

If the APPL statements are not defined or not activated when the MGO starts, error messages are generated for each missing or inactive logical unit. After the APPL statements are defined and activated, issue the MGO ‘SET VTAM OPEN” command to attempt to use the newly activated logical units.

F jobname,SET VTAM OPEN

A DISPLAY operating system console command can also be used to display the state of application major nodes and logical units. To display the status of an application major node:

D NET,ID=MGONODE

Possible responses:

IST453I ID PARAMETER VALUE P390.MGONODE NOT VALID

Or

IST097I DISPLAY ACCEPTED

IST075I NAME = MGONODE, TYPE = APPL SEGMENT 081

IST486I STATUS= ACTIV, DESIRED STATE= ACTIV

IST314I END

The first response (IST453I) indicates that the name MGONODE has not been defined or in not currently active.

The second response (IST486I) shows that the major node is active.

A ‘,E’ at the end of the display command indicates that the display should include every logical unit within the application major node.

D NET,ID=MGONODE,E

IST097I DISPLAY ACCEPTED

IST075I NAME = MGONODE1, TYPE = APPL SEGMENT 084

IST486I STATUS= ACTIV, DESIRED STATE= ACTIV

IST360I APPLICATIONS:

IST080I MGOXXA CONCT MGOXXB CONCT MGOXXC CONCT

IST080I MGOXXD CONCT MGOXXE CONCT

IST314I END

The value following each logical unit name (messages IST080I) indicates the state of each logical unit. The most common states and their meaning are:

VTAM Logical Unit Status and Meaning

Status

Meaning

NEVAC

Logical unit is currently inactive

INACT

Logical unit is currently inactive

CONCT

Logical unit is active (ready for use) but is not currently being used by any application program (including MGO)

ACTIV

Logical unit is in use by an application program such as MGO

ACT/S

Logical unit is in use by an application program AND at least one SNA session is in progress

The DISPLAY command can be used with logical units as well as application major nodes.

Example:

D NET,ID=MGOXXA

IST097I DISPLAY ACCEPTED

IST075I NAME = P390.MGOXXA, TYPE = APPL 169

IST486I STATUS= ACT/S, DESIRED STATE= ACTIV

IST1447I REGISTRATION TYPE = CDSERVR

IST977I MDLTAB=***NA*** ASLTAB=***NA***

IST861I MODETAB=***NA*** USSTAB=***NA*** LOGTAB=***NA***

IST934I DLOGMOD=***NA*** USS LANGTAB=***NA***

IST1632I VPACING = 7

IST597I CAPABILITY-PLU ENABLED ,SLU ENABLED ,SESSION LIMIT NONE

IST231I APPL MAJOR NODE = MGONODE

IST654I I/O TRACE = OFF, BUFFER TRACE = OFF

IST1500I STATE TRACE = OFF

IST271I JOBNAME = MGOTEST, STEPNAME = ***NA***, DSPNAME = IST94309

IST228I ENCRYPTION = OPTIONAL , TYPE = DES

IST1563I CKEYNAME = MGOXXA CKEY = PRIMARY CERTIFY = NO

IST1552I MAC = NONE MACTYPE = NONE

IST1050I MAXIMUM COMPRESSION LEVEL - INPUT = 0, OUTPUT = 0

IST1633I ASRCVLM = 1000000

IST1634I DATA SPACE USAGE: CURRENT = 0 MAXIMUM = 256

IST171I ACTIVE SESSIONS = 0000000001, SESSION REQUESTS = 0000000000

IST314I END

The preceding examples shows that Logical Unit MGOXXA is being use by job MGOTEST (message IST271I) and that one SNA session is active with some other logical unit. To see information about each active SNA session, add “,E’ to the end of the DISPLAY command.

5. MGO Configuration File

This chapter describes the format of the Mainframe Gateway for OpenVMS (MGO) configuration file.

5.1 Configuration File Overview

The primary purpose of the configuration file contains information about the SNA Logical Units that MGO provides for use by OpenVMS systems. Each OpenVMS application uses one (or more) logical units to communicate with mainframe based applications. Each logical unit is defined by a ‘LU-NAME’ statement in the configuration file (A corresponding APPL statement in a VTAM Application Major node must also exit).

Each connection between an OpenVMS systems and the MGO is assigned a logical unit. The OpenVMS system may specify a specific logical unit by name. This option is used when specific logical unit names are required for use with the IBM mainframe application. The OpenVMS SNA 3270 Printer Emulator product is often used in this manner.

Another approach is for the OpenVMS system to specify ‘any logical unit in a pool’ of logical units. These pools are called ‘access names’. For MGO, there can be any number of access names. Each must be defined by a ‘AN’ statement in the configuration file. A MGO access name can be associated with up to 256 logical units.

In addition to providing the ‘pool’ capability, access names can also be used to provide default values for the mainframe based application and for session parameters.

In addition to information about logical units and access name, the configuration file may also contain information about the IBM mainframe operating environment and MGO option settings.

The configuration file is processed during MGO initialization. If any errors are detected, error messages are added to the MGO log file.

5.2 Developing a Configuration File

The configuration file is a simple text file with fixed length 80 byte records. It can be edited on the mainframe or on another system (and copied to the mainframe). The configuration file should contain 80 byte fixed length records. All 80 bytes of each record can contain meaningful configuration information.

A good procedure for developing a configuration file is:

• Start with a copy of the configuration file used to (successfully) execute the Installation Verification Package (see the “Installing” chapter). This file will contain any configuration statements needed to allow MGO to communicate with the TCPIP software on the mainframe.

• Add one ‘LU-NAME’ statement for each logical unit to be supported by the MGO. For each statement, the first parameter is the name used to identify the logical unit to OpenVMS systems. The second parameter is the name used to identify the logical unit to VTAM. Some OpenVMS SNA applications may specify PU and SESSION values instead of logical unit names. For these applications, the MGO LU names should be the OpenVMS PU and SESSION values separated by a period.

• Add LU-LIMIT and LU-ADDRESS statements for each logical unit that will be used by an SNA 3270 Applications Services application

• Add one ‘AN’ statement for each access name to be supported by the MGO. The first parameter of the access name must match the access name value used by OpenVMS systems. On each statement, add a default mainframe application name and logmode value.

• Add ‘AN-LU’ statements to identify the logical units (if any) that are members of each access name’s pool of logical units.

• Add a ‘KEY’ statement with the value of the license key.

Example:

**

** DEFINE LOGICAL UNITS

**

LU-NAME ABC1 MGOXXA

LU-NAME ABC2 MGOXXB

LU-NAME ABC3 MGOXXC

LU-NAME ABC4 MGOXXD

LU-NAME ABC5 MGOXXE

** ==== ======

** | |

** | +---- These names must appear in a VTAM APPL

** | configuration statements

** |

** +------------ These names can be used in OpenVMS

** configuration information AND/OR be added

** to an access name’s pool of logical units

**

LU-NAME SNA-1.99 MGOXX1

LU-NAME SNA-1.100 MGOXX2

** ========= ======

** | |

** | +-- These names must appear in a VTAM APPL

** | configuration statements

** |

** +------------ Names that contain a "." consist of a

** "PU name" and session number. For example:

** set host/sna bigblue/pu=sna-1/session=100

LU-LIMIT ABC5 50

** ==== ==

** | |

** | + --- Allow no more than 50 concurrent SNA Sessions

** | between OpenVMS application and 3270 terminals

** |

** +---------- Session limitation is for ABC5 (aka MGOXXE)

**

LU-ADDRESS ABC5 11.22.33.44 8043

** ==== ================

** | |

** | +-- When the MGO receives a “logon” request from a

** | 3270 terminal for logical unit MGOXXE, start a

** | TCP connection to 11.22.33.44 and port 8043.

** |

** +---------- Address information is for ABC5 (aka MGOXXE)

**

** DEFINE AN ACCESS NAME

**

AN XYZ TSO D4C32782

** === === ========

** | | |

** | | +-- Name of entry in Logmode table. This entry

** | | is usually defined for use with an IBM 3270

** | | display with24 rows and 80 columns

** | |

** | + -------- Name of mainframe application program

** |

** +--------------- Declare name of Access Name.

**

** ADD LOGICAL UNITS TO INCLUDE IN ACCESS NAME POOL

**

AN-LU XYZ ABC1 ABC2 ABC3 ABC4

** === ===================

** | |

** | +---- One or more logical unit names to include

** | in the access name’s pool of logical units

** |

** +---------------- Name of Access Name.

**

** If any TCP-xxx statements were required to successfully execute

** the IVP, insert them anywhere in this file.

**

** If you have a license key, add the license key values anywhere

** in this file.

The VTAM APPL statements for the four logical units must also be defined and activated before (re-)starting the MGO.

Example:

*

*MGONODE - VTAM APPLICATION MAJOR NODE

*

VBUILD TYPE=APPL

**

MGONODE GROUP SONSCIP=YES,AUTH=(VPACE),EAS=1

MGOXXA APPL

MGOXXB APPL

MGOXXC APPL

MGOXXD APPL

MGOXXE APPL AUTH=(VPACE,ACQ),DLOGMOD=D4C32782,EAS=50

MGOXX1 APPL

MGOXX2 APPL

Using this configuration information, an OpenVMS SNA3270 Terminal Emulation user should be able to connect to an IBM mainframe application such as TSO. The OpenVMS command to invoke the terminal emulator is:

set host/sna mainframe.dns.name/acc=xyz

If the connection to the Mainframe Gateway is successful, one of the logical units (MGOXXA-MGOXXE) is allocated to the OpenVMS terminal emulator. Since the 'set host' command did not include a '/wait' qualifier, the Mainframe Gateway sends a connection request (a VTAM SIMLOGON) to TSO (the application specified in the access name).

Configuration Statements with Data that Matches OpenVMS Information

Statement

Usage Note

AN

OpenVMS systems sometimes use an ‘access name’ as a shorthand method of selecting a mainframe application program, SNA session parameters, initialization data, and a logical unit from a pool of logical units.

AN-LU

This statement adds one or more logical units to an access name’s logical unit pool. When an OpenVMS application specifies an access name but does not specify a logical unit name, MGO selects one of the logical units in the access name’s pool.

AN-USER-DATA

When the OpenVMS application specifies an access name but does not supply user data, the data supplied by this statement is used.

LU-NAME

This statement defines a logical unit. The first parameter is the ‘gateway logical unit’ name. This is the name used in all messages exchanged with OpenVMS systems. The second parameter is the ‘VTAM logical unit name’.

LU-LIMIT

This statement defines the number of concurrent SNA sessions allowed for a logical unit. The default limit is one.

LU-ADDRESS

This statement defines the IP address that MGO uses when requesting an outbound connection to an OpenVMS system.

Configuration Statements that Describe IBM Mainframe Environment

Statement

Usage Note

TCP-ADDRESS

Defines the interface (IP address) that the MGO will use for all communications with OpenVMS systems. If not specified, all interfaces are used.

TCP-JOBNAME

Defines the value used to identify MGO to the TCPIP software stack. If not specified, this value defaults to the job or procedure name.

TCP-PORT

Defines the TCP port number used to listen for incoming connection requests from OpenVMS systems. If not specified, port 108 is used.

TCP-STACK

Defines the TCPIP software stack name. This parameter is needed when multiple TCPIP stacks are active, or when the single active stack is not named “TCPIP”.

Configuration Statements for MGO Operating Modes and Options

Statement

Usage Note

BUFFER-CACHE

Defines the upper limit on the number of buffers that should be cached. The default is 4 for all buffer sizes.

COMMENT-CHAR

Changes the character that is to be treated as a comment. This is useful when the ‘*’ is included in a parameter value. See USS-SCREEN statement.

KEY

Supply license key for product

TRACE

Defines the amount of information to be traced in the MGO log file. The default is no tracing.

USS-COMMAND

USS-SCREEN

Some OpenVMS Access Routine products expect to receive ‘SSCP’ data from the mainframe. The SNA 3270 Terminal Emulator is an example. The MGO, like HP’s Domain CT and Domain ST Gateways, does not exchange SSCP data with the mainframe. Instead, SSCP-like data is defined in the MGO configuration file.

The USS-SCREEN statement defines data sent to the OpenVMS system.

The USS-COMMAND statement defines the way that ‘logon’ requests from the OpenVMS systems are processed.

5.3 Record Format

The configuration file record format is:

Command parameter-1 [parameter-2 [parameter-3] ] ]

The command and parameters can be separated by any number of blanks.

A comment character can appear anywhere is a record, including column 1. All columns beyond the comment character are ignored. The default comment character is an ‘*’.

The command should start in column 1.

All command names can be entered in upper, lower, or mixed case. Command parameters for all commands except USS-SCREEN are converted to upper case. The USS-SCREEN parameters are not converted to all upper case.

Configuration Statement Parameter Summary

Statement Type

Parameters

AN

Name [application [logmode] ]

AN-LU

Name lu-name [lu-name …]

AN-USER-DATA

Name user-data-text

BUFFER-CACHE

Buffer-size buffer-count-limit

COMMENT-CHAR

New-comment-character

KEY

License-Data-1 License-Data-2 License-Data-3

LU-ADDRESS

LU-name IP-address port [ port-low [port-high]]

LU-LIMIT

LU-name Concurrent-session-limit

LU-NAME

LU-name VTAM-name [VTAM-password]

TCP-ADDRESS

MGO-IP-address

TCP-JOBNAME *

MGO-job-name

TCP-PORT

MGO-listen-port-number

TCP-STACK *

Mainframe-TCPIP-stack-name

TRACE

Trace-option

USS-COMMAND

Input-from-OpenVMS access-name

USS-SCREEN

Text-for-SSCP-message-to-OpenVMS

* - These configurations statements are not supported in the Field Test version (V1.0).

5.4 Detailed Description

AN – Define an Access Name

The AN statement declares the existence of a specific access name. Optional parameters can specify a default mainframe application and SNA session parameters name.

Format:

AN name [application [logmode]]

Examples:

AN XYX * declare access name XYZ

AN CICS CICS2 * access name CICS points to the

* VTAM application CICS2

AN RJE JES2 RJE1 * access name RJE points to the

* VTAM application JES2

* and uses logmode RJE1

AN DEFAULT TSO * access name DEFALUT points to the

* VTAM application TSO

AN Parameters

Parameter

Length

Usage

Name

1-16

Name used by OpenVMS Access Routines to select this data structure.

Application

1-8

Name of Partner Logical Unit. This field is typically used to select a mainframe application program. Typical examples are TSO, CICS, and JES.

Logmode

1-8

Logmode entry. This value should match one of the entries in the VTAM table referenced by the MODETAB parameter of the APPL definition.

During initialization, MGO automatically creates a DEFAULT. Requests from OpenVMS access routines that do not specify any access name are treated as if they had specified the DEFALUT access name. Values for the DEFALUT access name can be specified in the MGO configuration file to define behavior for this default case.

Access names are also automatically created for each unique PHYSICAL UNIT indicated by AN-LU names that contain a period.

See AN-LU and AN-USER-DATA commands for other ways to modify an access name.

AN-LU – Add Logical Units to an Access Name

The AN-LU statement adds one or more logical units to an existing access name.

Format:

AN-LU name lu-name1 [lu-name2 … ]

Examples:

AN-LU CICS LU01 * add logical unit LU01 to pool of

* logical units for access name CICS

AN-LU RJE LU02 LU03 LU04 * add three logical units to pool of

* logical units for access name RJE

AN-LU Parameters

Parameter

Length

Usage

Name

1-16

Name of access-name data structure. This value should match the ‘name’ parameter of an ACCESS-NAME statement earlier in the file.

Lu-name-n

1-8

Name of logical unit to add to the pool. This value should match the ‘gateway name’ parameter of an LU-NAME statement earlier in the file.

Up to 256 logical units can be added to an access name’s pool of logical units. Both access names and logical units must be defined before they are referenced in AN-LU statements.

If the MGO configuration file does not contain any AN-LU statements that explicitly add logical units included to the DEFAULT access name, the first 256 logical units that have a session limit of one are automatically added.

AN-USER-DATA – Add USER DATA to an Access Name

The AN-USER-DATA statement adds user specified data to an existing access name. The information is used when an OpenVMS Access Routine connects to the MGO using an access name but without user data. The user data from this statement is passed to VTAM as part of the SNA session initiation request.

Format:

AN-USER-DATA name user-data

Example:

AN-USER-DATA RJE RMT10,,PASS3 * Pass RMT number and password in

* user data field of VTAM session

* activation request

AN-LU Parameters

Parameter

Length

Usage

Name

1-16

Name of access-name data structure. This value should match the ‘name’ parameter of an ACCESS-NAME statement earlier in the file.

User-data

1-64

Data to be passed in VTAM session activation request

The access names must be defined before it is referenced in AN-USER-DATA statements.

BUFFER-CACHE – Limit number of buffers in cache

The BUFFER-CACHE statement sets the upper limit on the number of unused buffers that MGO caches internally for future use. MGO product needs a buffer each time a message is passed between the TCP and VTAM interfaces. To decrease mainframe CPU overhead, the MGO can retain a number of buffers in an internal cache. This reduces CPU overhead but increases virtual storage usage.

The BUFFER-CACHE statement can adjust the maximum number of buffers in the cache for each buffer size. The default value is 4.

Format:

BUFFER-CACHE buffer-size count

Examples:

BUFFER-CACHE 0 10 * Change the default limit to 10 for

* all buffer sizes

BUFFER-CACHE 5 15 * Change the default limit to 15 for

* buffers with a size of 5K

BUFFER-CACHE Parameters

Parameter

Length

Usage

Buffer-size

1-2

Buffer Size indicator. A value of 1 to 32 means that a singe buffer cache is to be limited. A value of 0 means that the buffer count applies to all sizes.

Count

0-32767

Number of buffer-size buffers to cache.

COMMENT-CHAR – Change Comment character

The COMMENT-CHAR statement changes the character that is used as the ‘begin comment’ character. The new value takes effect for the next configuration file record.

Format:

COMMENT-CHAR character

Examples:

* This is a comment. It starts with ‘*’

COMMENT-CHAR # * Use ‘#’ to start a comment

# This is a comment. It starts with ‘#’

COMMENT-CHAR Parameter

Parameter

Length

Usage

Character

1

New comment character

KEY – License Key

The KEY statement supplies the MGO license key. If the configuration file does not contain a valid unexpired license key, the MGO terminates whenever an OpenVMS system connects to the MGO. (The Installation Verification Procedure, however, can be executed without a license key).

Format:

KEY value-1 value-2 value-3

Examples:

KEY :Sample-License-Key-Value-1-2-3: 111 222

KEY Parameter

Parameter

Length

Usage

Value-*

1-60

License key data supplied by Data Access Inc. If you do not have license key, contact the DAI support group.

LU-ADDRESS – Define TCP Values for OpenVMS System

The LU-ADDRESS statement defines the IP address used by the MGO to start a connection with the OpenVMS system.

The statement can also restrict the MGO to a range of mainframe port number the character that is used as the ‘begin comment’ character. If no port number range is specified, a port number is assigned by the mainframe TCPIP stack software.

Format:

LU-ADDRESS lu-name ip-address port [ port-low port-high]

Examples:

LU-ADDRESS GWLU4 1.2.3.1 4044 * OpenVMS IP address and port

*

LU-ADDRESS GWLU6 1.2.3.4 4046 9001 9005 * OpenVMS IP address and port

* * MGO must use port 9001-9005

LU-ADDRESS Parameters

Parameter

Length

Usage

Lu-name

1-16

Gateway LU Name - name used by OpenVMS Access Routines to select this logical unit

Ip-address

7-15

OpenVMS system IP address in dotted decimal format

Port

1-5

Port number associated with SNA Access Routine product executing on OpenVMS system

Port-low

1-5

Lowest port number that MGO should use

Port-high

1-5

Highest port number that MGO should use

The logical unit must be defined with a LU-NAME statement before it is referenced in LU-ADDRESS statement.

LU-LIMIT – Set Limit on Number of Concurrent Sessions

The LU-LIMIT statement changes a logical unit’s limit on number of concurrent SNA sessions. The default value is one. The maximum value is 2000.

Most OpenVMS access routines and applications are designed to support only one session per logical unit. Only the 3270 Applications Services Access routine supports multiple sessions per logical unit.

Format:

LU-LIMIT lu-name session-limit

Example:

LU-NAME LUABC XYZ123 * Gateway and VTAM names

LU-LIMIT LUABC 64 * Allow up to 64 concurrent sessions

LU-LIMIT Parameters

Parameter

Length

Usage

Lu-name

1-16

Gateway LU Name - name used by OpenVMS Access Routines to select this logical unit

Session-limit

1-4

Number of concurrent sessions

The logical unit must be defined with a LU-NAME statement before it is referenced in LU-ADDRESS statement.

LU-NAME – Define a Gateway Logical Unit

The LU-NAME statement defines a logical unit and declares both of its names. The gateway logical unit name is defined by the first parameter and is used in messages exchanged with OpenVMS Access Routines. The VTAM name is defined by the second parameter and is used when interacting with the mainframe’s SNA software. If present, the third parameter defines a password that is used when interacting with the SNA software.

Some OpenVMS applications use CIRCUIT, PU, and SESSION parameters instead of LU NAMES and ACCESS NAMES. The CIRCUIT value is not used by MGO. The OpenVMS based SNA access routines often combine the PU and SESSION values (separated by a period) and use the result as a gateway logical unit name. For example, an OpenVMS command to invoke the 3270 Terminal Emulator might be:

SET HOST/SNA BIGBLUE/circ=sdlc=1/pu=sna-1/session=9/wait

The Mainframe Gateway for OpenVMS configuration file should contain a LU-NAME statement similar to:

LU-NAME SNA-1.99 XZ33

And 'XZ33' should be defined to VTAM on the mainframe with an "APPL" statement similar to:

VBUILD TYPE=APPL

XZ33 APPL SONSCIP=YES,AUTH=(VPACE),EAS=1

The gateway and VTAM names can be the same or different. The gateway name must match any OpenVMS configuration information that includes a logical unit name.

During field test, the maximum length of the LU NAME value is 8. This means that session values greater than 99 are not supported. This restriction will be removed in the general release version of the product.

VTAM names must match a value in the IBM mainframe configuration (an APPL statement on a VTAM application major node). If the gateway name and VTAM names are the same (and if a VTAM password is not used), the gateway name can be omitted from the LU-NAME statement.

Format:

LU-NAME gateway-name [ VTAM-name [ VTAM-password ]]

Examples:

LU-NAME GWLU1 XYZ1 * OpenVMS and VTAM names differ

LU-NAME XYZ2 * OpenVMS and VTAM names are the same

LU-NAME GWLU3 XYZ3 ABC * OpenVMS and VTAM names differ, password

LU-NAME SNA-1.99 XZ33 * OpenVMS PU=SNA-1/SESSION=99

LU-NAME Parameters

Parameter

Length

Usage

Lu-name

1-16

Gateway LU Name - name used by OpenVMS Access Routines to select this logical unit (Maximum length of 8 during field test)

VTAM-name

1-8

VTAM LU name – name used in VTAM configuration statement and with IBM mainframe console commands

Password

1-8

Option VTAM password value

The logical unit must be defined with a LU-NAME statement before it is referenced in AN-LU, LU-LIMIT, or LU-ADDRESS statement.

TCP-INTERFACE – Mainframe IP Interface address

The TCP-INTERFACE statement specifies which IP interfaces will be used by the MGO. IBM mainframes may support multiple IP interfaces. Each interface is identified by an IP address. The MGO can be restricted to a specific interface or may use all interfaces. A value of 0.0.0.0 means to use all interfaces. Any other value means to use only the specified address (or interface) for both inbound and outbound connections. The default value is 0.0.0.0.

Format:

TCP-INTERFACE ip-address

Examples:

TCP-INTERFACE 111.222.33.4 * MGO IP address is 111.222.33.4

TCP-INTERFACE Parameters

Parameter

Length

Usage

IP-address

7-15

IP address of mainframe

TCP-JOBNAME – Job name override

The TCP-JOBNAME statement specifies which a value to use when initially connecting to the mainframe TCPIP software stack. Some mainframe installations may have security measures in force which require a value different than the default job or procedure name.

Format:

TCP-JOBNAME jobname

Examples:

TCP-JOBNAME MGO4433A * Use this character string value

TCP-JOBNAME Parameters

Parameter

Length

Usage

jobname

1-8

Value to use when connecting to TCPIP software stack

NOTE: The TCP-JOBNAME statement is NOT SUPPORTED in version 1.1 of the product. Instead of using this statement, change the job name or procedure name to the value required by the security system.

TCP-PORT – Mainframe Port Number for Listener

The TCP-PORT statement specifies the port used by the MGO software to listen for inbound connections from OpenVMS systems. By default, the MGO listens on port 108. Any other port number can be specified. If a value other than 108 is used, the OpenVMS systems must be configured to use the new port number.

Format:

TCP-PORT port-number

Examples:

TCP-PORT 16108 * Use port 16,108 instead of port 108

TCP-PORT Parameter

Parameter

Length

Usage

Port-number

1-5

Port number to use when listening for connections from OpenVMS systems

If a value other than 108 is specified, the new value must also be specified on the OpenVMS SNA system. In the OpenVMS environment that invokes the product, specify:

$define SNA_PORT_NUBMER "#16108"

TCP-STACK – Mainframe TCPIP Software Stack Name

The TCP-STACK statement specifies the name of the TCPIP Software Stack. IBM mainframes can execute multiple TCP software stacks concurrently. This is sometimes done when testing new versions of software while running production work on an older version.

If not specified, the default value is “TCPIP”.

Format:

TCP-STACK name

Examples:

TCP-STACK TCPIP43 * Use TCPIP stack named TCPIP43

TCP-STACK Parameter

Parameter

Length

Usage

name

1-8

Name of TCPIP stack

TRACE – Set Trace Level

The TRACE statement specifies the type of trace records that MGO adds to the MGO log file. The trace level specified in the configuration file takes effect immediately. The trace level can be changed using a console command.

The trace levels are OFF, ON, and FULL. The value ‘OFF’ indicates that no trace data is added to the MGO log. The value of ‘ON’ indicates that the first 32 bytes of each TCP and VTAM message are traced in the log file. A value of ‘FULL’ indicates that the entire content of all TCP and VTAM messages are traced.

Format:

TRACE value

Examples:

TRACE ON * Trace 32 bytes of each TCP and VTAM message

TRACE Parameter

Parameter

Length

Usage

Value

2-4

OFF (default), ON, or FULL

USS-COMMAND – Map SSCP Input to Access Name

The USS-COMMAND defines the way that messages received on the SSCP-LU session are interpreted by the MGO.

Some OpenVMS Access Routines, especially the SNA 3270 Terminal Emulator, support data exchange on two sessions: SSCP-LU and LU-LU. Like the Domain CT and Domain ST gateways, the MGO does NOT support SSCP-LU data exchange with the mainframe SNA system. Instead, all SSCP-LU data exchanges are handled entirely within the MGO product.

The USS-COMMAND statements define the way that SSCP-LU input from OpenVMS systems is handled. The USS-SCREEN statements define output to the OpenVMS system.

When an SSCP-LU message is received from an OpenVMS system, the MGO compares the message to the ‘input-string’ parameter of the USS-COMMAND statements. If there is a match, the MGO uses the information in the associated ‘access-name’ to request a SNA.

Format:

USS-COMMAND input-string access-name

Examples:

*

* Define ACCESSS NAMES to be used with USS-COMMAND statements

*

AM T2 TSO D4C32782 *Access name / Application / Logmode

AN T4 TSO D4C32784 *Access name / Application / Logmode

*

* Define rules for SSCP-LU input from OpenVMS systems

*

USS-COMMAND T T2 * If input is “T”:

* * Use Access name “T2”:

* * Mainframe Application = TSO

* * Session Parameters = D4C32782

* * (3270 terminal, 80 x 24 screen)

*

USS-COMMAND TX T4 * If input is “TX”:

* * Use Access name “T4”:

* * Mainframe Application = TSO

* * Session Parameters = D4C32784

* * (3270 terminal, 80 x 43 screen)

USS-COMMAND Parameters

Parameter

Length

Usage

Input-string

1-8

Value to compare to input from OpenVMS system

Access-name

1-8

Name of access name which has an application name defined. The access name may also define a logmode name and user data.

The access name must be defined before it is referenced in a USS-COMMAND statement.

In addition to input-strings defined in USS-COMMAND statements, the MGO supports three built in command: IBMTEST, LOGON, and LOGOFF.

Format:

IBMTEST

LOGON APPLID(X) [ LOGMODE(Y) ] [ DATA(Z) ]

LOGOFF

The MGO responds to an IBMTEST command with a one line test pattern consisting of “IBMTEST” followed by the letters of the alphabet and numbers zero through nine. This command can be used to verify proper communications between OpenVMS systems and the MGO without requiring any contact with the mainframe application programs such as CICS or TSO.

By using the LOGON command, the OpenVMS user can specify a mainframe application name (‘X’), a set of session parameters (‘Y’) and user data (‘Z’). When using the LOGON command, USS-COMMAND and ACCESS-NAME statements are not required.

The LOGOFF command causes MGO to terminate any SNA sessions with mainframe.

USS-SCREEN – Define One Line of SSCP-LU Message Text

Some OpenVMS Access Routines, especially the SNA 3270 Terminal Emulator, support data exchange on two sessions: SSCP-LU and LU-LU. Like the Domain CT and Domain ST gateways, the MGO does NOT support SSCP-LU data exchange with the mainframe SNA system. Instead, all SSCP-LU data exchanges are handled entirely within the MGO product.

The USS-SCREEN statement adds one line of output to the message sent to OpenVMS systems when it is first connected to MGO and after a session has terminated. If no USS-SCREEN statements are included in the configuration file, a default USS-SCREEN is used. The default USS-SCREEN value is a single line consisting of “PLEASE LOGON:”.

The USS-SCREEN statements define output to the OpenVMS system. If no USS-SCREEN statements are provided, MGO uses a default message. If USS-SCREEN statements are provided, the specified data replaces the MGO default message.

Format:

USS-SCREEN [message-text] [%LU%] [%APPL%] comment-character

Examples:

COMMENT-CHAR # * use ‘#’ as comment character

USS-SCREEN #

USS-SCREEN **************************************************** #

USS-SCREEN *** W E L C O M E *** #

USS-SCREEN **************************************************** #

USS-SCREEN #

USS-SCREEN LU-NAME: %LU% APPLID : %APPL% #

USS-SCREEN #

USS-SCREEN COMMAND: ACTION: #

USS-SCREEN ------------------------ --------------------- #

USS-SCREEN TSO LOGON TO TSO #

USS-SCREEN TSO4 LOGON TO TSO, 43 ROWS #

USS-SCREEN ------------------------ --------------------- #

USS-SCREEN #

USS-SCREEN # Please type command

USS-SCREEN # and then press return: #

As shown in the example, the parameters for the USS-SCREEN statement consist of text to send to the OpenVMS system, tags which indicate places insert connection dependent data, and a comment character. In the message sent to the OpenVMS system:

• The ‘#’ at the end of each USS-SCREEN command is suppressed

• The %LU% is replaced by the gateway logical unit name (the 1st parameter of the LU-NAME statement) of the LU associated with the OpenVMS system.

• The %APPL% is replaced by the logical unit name as understood by VTAM (the 2nd parameter of the LU-NAME statement).

• If the OpenVMS application is the 3270 Terminal Emulator, the cursor is positioned following “…press return: “.

USS-SCREEN Embedded Parameters

Parameter

Length

Usage

Message-text

1-68

Upper and lower case text to add to message

%APPL%

8

Place to insert VTAM logical unit name. VTAM logical unit names can be up to eight bytes long. Always add two spaces after the %APPL% tag to allow for the maximum length name.

%LU%

16

Place to insert the gateway logical unit name. Gateway logical unit names can be up to sixteen bytes long. Always add twelve spaces after the %LU% tag to allow for the maximum length name.

Comment-char

1

The comment character is used to indicate the end of the USS-SCREEN text and tag. Each comment character (except the last one) is replaced with a ‘new line’ in the message sent to the OpenVMS system.

6. Log File Messages

This chapter describes the messages that may appear in the file associated with the SYSPRINT DD card.

6.1 Log File Location

Log File messages are written to the file specified by the SYSOUT DD card.

6.2 Log File Message Format

Each message contains a timestamp, a connection identifier, a message id, a message type indicator, and message text.

Log File Message Format

Section

Meaning

Comment

Timestamp

Time of Day in HHMMSS format

The date is documented in the first message added to the log file, and as the first message of each new day

Connection ID

Unique number assigned to each TCPIP connection

All messages associated with a single OpenVMS TCPIP connection share the same connection id. Messages not associated with a TCPIP connection use “----“.

Message ID

Message number

Messages are documented later in this chapter

Message Type

Indicator or message severity or purpose

See the table below for the meaning of the one character message types.

Message Text

Varies by message number

Messages are documented later in this chapter.

Log File Message Type Abbreviation and Meaning

Abbreviation

Type

Usage

I

Information

Documents a normal operational event such as the start of a TCPIP connection

W

Warning

Documents an unusual event that may need to be examined in more detail.

E

Error

Documents an error condition. The description of the Message ID describes the actions that should be taken

C

Console

Documents a console (operator) command or response.

T

TCP Trace

Trace data for a TCPIP connection.

V

VTAM Trace

Trace data for a VTAM session

6.3 Detail Description of Log File Messages

00 I COMMENT: text

Informational message generated by MGO. This message number is used to document the MGO version, PTF level, as well as summarizing the information associated with each access name.

01 I DATE: YYMMDD = yymmdd

The current date is shown in year, month, and day format.

02 I SYSIN: configuration-file-data

Each record in the configuration file is copied to the log file during MGO initialization.

03 E SYSIN: error-description

The ‘error-description’ documents the error encountered while processing a configuration file record. The preceding ’02 I’ message contains the configuration file record.

This error message indicates a syntax error, an out of range value, or a reference to an undefined resource.

The error in the configuration file should be corrected and MGO should be restarted.

04 C INPUT: MODIFY: text

A console command has been received from the operating system console or an authorized TSO user. The ‘text’ is a copy of the operator input.

05 C OUTPUT: response

The ‘response’ is the reply to the console command. Multiple ’05 C’ messages are used for multi-line responses.

06 I TCP: INITIALZE API SUCCESSFUL

The MGO has established contact with the mainframe TCPIP communications stack.

07 E TCP: INITIALIZE API FAILED error-information

The MGO has failed to established contact with the mainframe TCPIP communications stack.

The ‘error-information’ portion of the message documents the reason for the failure.

08 E TCP: NO PORT AVAILABLE

An attempt to initiate a TCPIP connection with on OpenVMS system failed because none of the ports specified on the configuration file LU-ADDRESS statement are available.

The LU-ADDRESS statement associated with the OpenVMS system can optionally specify a range of mainframe TCP port numbers to use for connections.

Increase the range of port numbers (and restart MGO), or try the connection later.

09 E TCP: operation RC/ERRNO = xx/xxxx

A TCP request has failed. The ‘operation’ indicates the TCP request type. The value following the equal sign provides diagnostic information. To interpret the diagnostic data, refer to IBM’s IP Programmer’s Reference – SC31-8787-03.

This error usually indicates a transient error related to IP network outage, OpenVMS node failure, or by an OpenVMS application program terminating unexpectedly.

If the error persists, please report the error to Data Access support organization.

10 E TCP: INVALID RH

10 E TCP: UNSUPPORTED MSG

A message received from the TCPIP stack contains inconsistent or invalid data. This message may indicate that the connected system is not an OpenVMS system using an up to date SNA access routine.

If the error is reproducible, please enable traces, repeat the failing sequence, and contact Data Access support organization.

11 I VTAM: OPEN APPLICATION ID: name

The MGO is contacting VTAM to connect to the Logical Unit ‘name’. The value of ‘name’ is the VTAM application name.

The VTAM application name was specified as the second parameter of a LU-NAME configuration file statement. The same name should also be specified in a VTAM Application Major Node.

12 E VTAM: OPEN FAILED: RC/FLAG= xx/xx text

The contact with VTAM documented in the preceding message failed. The ‘xx/xx’ contains diagnostic information. To interpret the diagnostic data, refer to IBM’s SNA Programming – SC31-8829-00, Appendix B. The two most common values for xx/xx text are:

08 / 5A : APPL NOT DEFINED OR INACTIVE

08 / 58 : APPL IN USE BY OTHER PROGRAM

The 08/5A value means that the APPL name is not defined in any VTAM application major node, that the application major node is inactive, or that the APPL within the major node is inactive. If defined, activate the application major node and APPL (see ‘Activation of VTAM Resources’ in chapter 3).

The 08/58 value means that the APPL name is already being used by some other application program (possibly another instance of MGO using the same configuration file). To determine the job using the APPL, issue a VTAM display command (D NET,ID=appl) and look for message “IST271I JOBNAME =”.

13 I VTAM: CLOSE APPLICATION ID: name

The MGO has terminated contact with the LU ‘name’.

Contact with an LU is terminated when a ‘stop’ console command is causing MGO to terminate or when VTAM signals a TPEND condition.

14 I VTAM: TPEND EXIT: LU NAME = name / xx

VTAM has requested that MGO stop using the Logical Unit ‘name’. The ‘xx’ contains a reason code. This message happens when VTAM is being terminated and when the logical unit has been ‘inactivated’ (as a result of a VTAM operator command).

15 E VTAM: operation RC/FDBK/SENSE = xx/xx/xxxxxxxx text

A VTAM request has failed. The ‘operation’ indicates the VTAM request type. The value following the equal sign provides diagnostic information. To interpret the diagnostic data, refer to IBM’s SNA Programming – SC31-8829-00, Appendix B.

.

If the error persists, please report the error to Data Access support organization.

21 I TCP: SERVER CONNECTION ip-address port lu-name

An OpenVMS node has requested a TCPIP connection to MGO. The message contains IP address and port number used by the OpenVMS system.

The ‘lu-name’ field contains the gateway logical unit name associated with the connection. The gateway logical name is specified the first parameter on an LU-NAME statement.

22 I TCP: CLIENT CONNECTION: ip-address port lu-name

An OpenVMS node has accepted a TCPIP connection from MGO. The message contains the OpenVMS nodes IP address and port number. The message also contains the gateway logical unit name.

MGO initiates a connection to an OpenVMS system when VTAM contacts MGO because some other application in the SNA network is attempting to establish an SNA session.

23 I CLEANUP: messages:bytes messages:bytes

A TCPIP connection is being terminated. The counters in the messages document the number of messages and bytes received and transmitted.

24 W CLEANUP: messages:bytes messages:bytes name

A TCPIP connection is being terminated abnormally. The counters in the messages document the number of messages and bytes received and transmitted. The name field documents the MGO internal module name that initiated the cleanup sequence.

41 W License: A new license is needed within xxxxx

A new license is needed before the end of the xxxxx time period. If the license expires, OpenVMS systems will not be able to access the IBM mainframe applications using the MBO. After obtaining a new license, replace the old license information (if any) in the MGO configuration file with the new license, and restart MGO.

42 E License: The license in the configuration file is invalid

A new license is needed immediately. Contact the Data Access support group. Please provide a copy of the license which MGO is rejecting as invalid.

43 E License: The license has expired

A new license is needed immediately. Contact the Data Access support group.

44 E License: License if invalid for CPU ID : serial-number

The license is not valid for the IBM CPU where MGO is executing. Contact the Data Access support group. Be sure to provide a copy of the license you are using and the 'serial-number' portion of the message.

81 T GAP RCV: message-type data

82 T GAP SND U: message-type data

83 T GAP SND P: message-type data

84 T GAP SND S: message-type data

85 T GAP CONNECT PARAMTER – name value

86 T GAP CONNECT REJECTED – reason

91 V RPL DONE: operation data

92 V EXIT - exit-name

These messages document TCPIP trace data. This information is primarily intended for use by the Data Access support group. The exact message format is not documented in this manual.

7. Console Commands

This chapter describes how to use the IBM operating system console interfaces to interact with the Mainframe Gateway for OpenVMS (MGO) software.

The commands can be used at the operating system consoles and by authorized TSO terminals. For each console command, the MGO responds with output on the console. Each console command and response is also logged in the MGO log file.

The MGO reacts to the MODIFY and STOP operator commands. The command format is

MODIFY jobname,mgo-command [mgo-parameter [mgo-parameter]]

STOP jobname

The STOP command is the normal method of terminating the MGO. No parameters are required.

The MODIFY command has a variety of sub-commands and parameters. The remainder of this chapter describes the MODIFY command in more detail.

7.1 MGO MODIFY Command

The functions available with the MODIFY command enable the operator to display information about the MGO or to change the MGO operating modes.

HELP Function

f jobname,help

SUPPORTED REQUESTS:

HELP

SHOW BUFFERS

SHOW CONNECTIONS

SHOW LOGICAL UNITS

SET TRACE ON

SET TRACE FULL

SET TRACE OFF

SET VTAM OPEN

SHOW BUFFERS Function

The response to the command shows information about the MGO buffer pools. If not prohibited in the MGO configuration file, a pool of free buffers is maintained for each buffer size from 1K to 32K bytes.

A MGO buffer is required for each SNA Request Unit exchanged between the IBM mainframe and the OpenVMS based application. The size of the required buffer is slightly larger than the SNA RU size. For example, a 5K MGO buffer would be used to contain an SNA request unit containing 4,096 bytes of data.

When a buffer is required (and the corresponding buffer pool is not empty), a buffer is claimed from the pool instead of being created. Use of the buffer pools tends to increases the amount of virtual memory that MGO uses, but decreases the amount of CPU time.

Sample command and response:

f jobname,show buffers

SIZE LIMIT COUNT IN-USE

00001 00003 00000 00005

00002 00000 00001 00000

00003 00003 00000 00000

00004 00003 00002 00005

….

00032 00003 00000 00000

>32K 00000

Description:

The ‘SIZE’ column shows size (in K bytes) of the buffers in the pool. The last line is the combined count for all buffers with sizes larger than 32K.

The ‘LIMIT’ column shows the upper limit on the number of buffers that can be cached in the sub-pool instead of released when the buffer are no longer needed. Since there is no buffer pool for buffers larger than 32K, the 'LIMIT' value for '>32K' is always blank.

The ‘COUNT’ column shows the number buffers in the sub-pool. This number should never be larger than the corresponding ‘LIMIT’ value. Since there is no buffer pool for buffers larger than 32K, the 'COUNT' value for '>32K' is always blank.

The ‘IN-USE’ column shows the number of buffers actually being used by the MGO. When one of these buffers is no longer needed, the MGO either releases the buffer’s memory or adds the buffer to the pool (and increases the count).

CONNECTIONS Function

The response to the command shows information about current TCPIP connections.

Sample command and response:

F jobname,show connections

-ID- T ----LU---- IP ADDRESS PORT RECV-CNT SEND-CNT

0005 C LUNAME1 1.2.3.4 4056 00004 00008

0091 S AS3270S 111.222.3.44 8088 01005 00404

Description:

The ‘Id’ column contains a connection identifier used to correlate all of the log file messages for a single connection. Each time a TCP connection is established an identifier is assigned. The identifier is included in every log file message associated with the connection.

The ‘T’ column contains an indicator or the type of TCP connection. A value of ‘C’ indicates that the OpenVMS system initiated the TCP connection. A value of ‘S’ indicates that the MGO initiated the connection.

The ‘LU’ column contains the gateway logical unit name. The gateway logical unit name immediately follows the LU-NAME keyword on MGO configuration file statements (the 2nd parameter is the VTAM LU name which may differ from the gateway logical unit name)

The ‘IP ADDRESS’ column contains the OpenVMS IP address.

The ‘PORT’ column contains the OpenVMS TCP port number used for the connection.

The ‘RECV-CNT’ contains the number of messages received by the MGO on this connection.

The ‘SEND-CNT’ contains the number of messages sent by the MGO on this connection.

SHOW LOGICAL UNITS Function

The response to the command shows information about each The SHOW LOGICAL UNITS command displays a list VTAM logical unit names and their status.

Sample command and response

F jobname,SHOW LOGICAL UNITS

LU NAME VTAM NAME S LIMIT COUNT

GW2 XYZLU2 O 1 1

GW3 XYZLU3 C 1 0

GWAS3270 XYZLU4 O 50 23

Description:

The ‘LOCAL LU NAME’ column contains the gateway logical unit name. This name is specified as the first parameter of the LU-NAME configuration file command.

The ‘VTAM NAME’ column contains the VTAM application name for the gateway logical unit. This name is specified as the second parameter of the LU-NAME configuration file command. This value must match the name of a VTAM APPL statement.

The ‘S’ column contains an indicator of the status of VTAM communication. A value of ‘O’ indicates that the path is open and ready for use. A value of ‘C’ means the path is closed and cannot be used.

The ‘LIMIT’ column contains the maximum number of SNA sessions allowed.

The ‘COUNT’ column contains the number of SNA sessions currently active.

SET TRACE Function

This command changes the amount of data traced in the MGO log file.

The trace levels are:

• ON : The first 32 bytes of each TCP and VTAM message is traced.

• FULL: The entire content each TCP and VTAM message is traced.

• OFF: Messages are not traced.

The ON and FULL trace settings can have a severe impact on performance and log file size.

SET VTAM Function

This command causes the MGO to attempt to connect to all logical units that are not already active. It can be used after defining or activating VTAM application major nodes.

8. Samples

8.1 SAMPLE LIBRARY MEMBERS

The sample library contains six members that are used by the Installation Verification Procedure (IVP) and as samples for later configuration steps.

8.1.1 IVPJCL

The Mainframe Gateway for OpenVMS reads configuration information from SYSIN. Status and error messages are recorded in the SYSPRINT file.

//JOBNAME JOB ,installation-dependent-data

//JOBLIB DD DISP=SHR,DSN=hlq.MGO.LIB

//STEPONLY EXEC PGM=GW

//SYSPRINT DD SYSOUT=*

//SYSABEND DD SYSOUT=*

//SYSIN DD DISP=SHR,DSN=hlq.MGO.SAMPLIB(IVPCONF)

//

8.1.2 IVPCONF

This configuration file consists of nothing but ‘comments’. If problems are encountered communicating with the TCPIP stack, it may be necessary to use one or more statements by deleting the ‘*’ in column one and supplying a non-default value.

A license (KEY statement) is not required for successful execution of the IVP.

*

* CONFIGURATION FILE FOR IVP PROCEDURE

*

*TCP-STACK TCPIP * USE THIS TCPIP STACK

*TCP-JOBNAME MGOIVP * CLAIM TO BE THIS JOB

*TCP-INTERFACE 0.0.0.0 * USE ALL IP INTERFACES

*TCP-PORT 108 * LISTEN ON PORT 108

*

*TRACE OFF * CHANGE OFF to ON FOR TRACES

* * Note: no ‘KEY’ statement required for IVP

*

8.1.3 MGOJCL

This JCL can be used as a basis for executing MGO in production mode. It is identical to IVPJCL except for the concatenated SYSIN DD statements.

//JOBNAME JOB ,installation-dependent-data

//JOBLIB DD DISP=SHR,DSN=hlq.MGO.LIB

//STEPONLY EXEC PGM=GW

//SYSPRINT DD SYSOUT=*

//SYSABEND DD SYSOUT=*

//SYSIN DD DISP=SHR,DSN=hlq.MGO.SAMPLIB(IVPCONF)

// DD DISP=SHR,DSN=hlq.MGO.SAMPLIB(LICENSE)

// DD DISP=SHR,DSN=hlq.MGO.SMAPLIB(MGOCONF)

//

8.1.4 LICENSE

The license in the sample library may have expired by the time the product is actually installed. Problems related to licenses will be documented via error message number 42, 43, or 44.

8.1.5 MGOCONF

The configuration file provides a link between parameters specified on OpenVMS systems and parameters specified to the mainframes VTAM environment.

**

** DEFINE LOGICAL UNITS

**

LU-NAME ABC1 MGOXXA

LU-NAME ABC2 MGOXXB

LU-NAME ABC3 MGOXXC

LU-NAME ABC4 MGOXXD

LU-NAME ABC5 MGOXXE

** ==== ======

** | |

** | +---- These names must appear in a VTAM

** | configuration statements

** |

** +------------ These names can be used in OpenVMS

** configuration information AND/OR be added

** to an access name’s pool of logical units

**

LU-NAME SNA-1.99 MGOXX1

LU-NAME SNA-1.100 MGOXX2

** ========= ======

** | |

** | +-- These names must appear in a VTAM APPL

** | configuration statements

** |

** +------------ Names that contain a "." consist of a

** "PU name" and session number. For example:

** set host/sna bigblue/pu=sna-1/session=100

LU-LIMIT ABC5 50

** ==== ==

** | |

** | + --- Allow no more than 50 concurrent SNA Sessions

** | between OpenVMS application and 3270 terminals

** |

** +---------- Session limitation is for ABC5 (aka MGOXXE)

**

LU-ADDRESS ABC5 11.22.33.44 8043

** ==== ================

** | |

** | +-- When the MGO receives a “logon” request from a

** | 3270 terminal for logical unit MGOXXE, start a

** | TCP connection to 11.22.33.44 and port 8043.

** |

** +---------- Address information is for ABC5 (aka MGOXXE)

**

** DEFINE AN ACCESS NAME

**

AN XYZ TSO D4C32782

** === === ========

** | | |

** | | +-- Name of entry in Logmode table. This entry

** | | is usually defined for use with an IBM 3270

** | | display with24 rows and 80 columns

** | |

** | + -------- Name of mainframe application program

** |

** +--------------- Declare name of Access Name.

**

** ADD LOGICAL UNITS TO INCLUDE IN ACCESS NAME POOL

**

AN-LU XYZ ABC1 ABC2 ABC3 ABC4

** === ===================

** | |

** | +---- One or more logical unit names to include

** | in the access name’s pool of logical units

** |

** +---------------- Name of Access Name.

**

8.1.6 MGONODE

This VTAM application major node declares MGOXXA-MGOXXE as VTAM application identifiers. Each name, when used by MGO, becomes a gateway logical unit that can be used by OpenVMS applications. The MGOXXA-MGOXXE names in this file match names in the MGOCONF file.

**

** VTAM APPLICATION MAJOR NODE

**

**

** MGONODE - VTAM APPLICATION MAJOR NODE

**

VBUILD TYPE=APPL

**

MGONODE GROUP SONSCIP=YES,AUTH=(VPACE),EAS=1

MGOXXA APPL

MGOXXB APPL

MGOXXC APPL

MGOXXD APPL

MGOXXE APPL AUTH=(VPACE,ACQ),DLOGMOD=D4C32782,EAS=50

MGOXX1 APPL

MGOXX2 APPL

**

8.2 Sample Log File Content

The Mainframe Gateway for OpenVMS adds status and error messages to the SYSPRINT file.

8.2.1 Successful IVP Execution

095056 ---- 01 I DATE: YYMMDD = 040615

095056 ---- 00 I COMMENT: COPYRIGHT (C) 2004 BY DATA ACCESS, INC.

095056 ---- 00 I COMMENT: DATA-ACCESS-INC-V1.1 - PTF:0000

095056 ---- 06 I TCP: INITIALIZE API SUCCESSFUL

095320 ---- 04 C INPUT: MODIFY: HELP

095320 ---- 05 C OUTPUT: SUPPORTED REQUESTS:

095320 ---- 05 C OUTPUT: HELP

095320 ---- 05 C OUTPUT: SHOW BUFFERS

095320 ---- 05 C OUTPUT: SHOW CONNECTIONS

095320 ---- 05 C OUTPUT: SHOW LOGICAL UNITS

095320 ---- 05 C OUTPUT: SET TRACE ON

095320 ---- 05 C OUTPUT: SET TRACE FULL

095320 ---- 05 C OUTPUT: SET TRACE OFF

095320 ---- 05 C OUTPUT: SET VTAM OPEN

095330 0001 23 I CLEANUP: CLEANUP INVOKED 00000:00000 00001:0033

095438 ---- 04 C INPUT: STOP

095438 ---- 05 C OUTPUT: STOP COMMAND ACCEPTED

8.2.2 Successful MGOJCL Startup

160134 ---- 01 I DATE: YYMMDD = 040615

160134 ---- 00 I COMMENT: COPYRIGHT (C) 2004 BY DATA ACCESS, INC.

160134 ---- 00 I COMMENT: DATA-ACCESS-INC-V1.1 - PTF:0000

160134 ---- 06 I TCP: INITIALIZE API SUCCESSFUL

160134 ---- 02 I SYSIN: *

160134 ---- 02 I SYSIN: * Logical Units for use with

160134 ---- 02 I SYSIN: * NETVIEW, TSO, CICS, DTF, AND JES2

160134 ---- 02 I SYSIN: *

160134 ---- 02 I SYSIN: LU-NAME ABC1 MGOXXA

160134 ---- 02 I SYSIN: LU-NAME ABC2 MGOXXB

160134 ---- 02 I SYSIN: LU-NAME ABC3 MGOXXC

160134 ---- 02 I SYSIN: LU-NAME ABC4 MGOXXD

160134 ---- 02 I SYSIN: LU-NAME ABC5 MGOXXE

160134 ---- 02 I SYSIN: LU-LIMIT ABC5 50

160134 ---- 02 I SYSIN: LU-ADDRESS 11.22.33.44 8043

160134 ---- 02 I SYSIN: AN XYZ TSO D4C32782

160134 ---- 02 I SYSIN: AN-LU XYZ ABC1 ABC2 ABC3 ABC4

160134 ---- 02 I SYSIN: *

160134 ---- 00 I COMMENT:

160134 ---- 00 I COMMENT: NAME: XYZ APPL: TSO LOGMODE: D4C32782

160134 ---- 00 I COMMENT: LU: NAME: ABC1 VTAM APPL: MGOXXA

160134 ---- 00 I COMMENT: LU: NAME: ABC2 VTAM APPL: MGOXXB

160134 ---- 00 I COMMENT: LU: NAME: ABC3 VTAM APPL: MGOXXC

160134 ---- 00 I COMMENT: LU: NAME: ABC4 VTAM APPL: MGOXXD

160134 ---- 00 I COMMENT:

160134 ---- 00 I COMMENT: NAME: DEFAULT APPL: LOGMODE:

160134 ---- 00 I COMMENT: LU: NAME: ABC1 VTAM APPL: MGOXXA

160134 ---- 00 I COMMENT: LU: NAME: ABC2 VTAM APPL: MGOXXB

160134 ---- 00 I COMMENT: LU: NAME: ABC3 VTAM APPL: MGOXXC

160134 ---- 00 I COMMENT: LU: NAME: ABC4 VTAM APPL: MGOXXD

160134 ---- 00 I COMMENT: LU: NAME: SNA-1.99 VTAM APPL: MGOXX1

160134 ---- 00 I COMMENT: LU: NAME: SNA-1.100 VTAM APPL: MGOXX2

160134 ---- 00 I COMMENT:

160134 ---- 00 I COMMENT: NAME: SNA-1. APPL: LOGMODE:

160134 ---- 00 I COMMENT: LU: NAME: SNA-1.99 VTAM APPL: MGOXX1

160134 ---- 00 I COMMENT: LU: NAME: SNA-1.100 VTAM APPL: MGOXX2 160134 ---- 11 I VTAM: OPEN APPLICATION ID : MGOXXA

160134 ---- 11 I VTAM: OPEN APPLICATION ID : MGOXXB

160134 ---- 11 I VTAM: OPEN APPLICATION ID : MGOXXC

160134 ---- 11 I VTAM: OPEN APPLICATION ID : MGOXXD

160134 ---- 11 I VTAM: OPEN APPLICATION ID : MGOXXE

160134 ---- 11 I VTAM: OPEN APPLICATION ID : MGOXX1

160134 ---- 11 I VTAM: OPEN APPLICATION ID : MGOXX2

160134 ---- 06 I TCP: INITIALIZE API SUCCESSFUL

8.2.3 OpenVMS Connection Sequence (TRACE OFF)

160222 0001 21 I TCP: SERVER CONNECTION 1.2.3.6:4650 / LUL21

160222 0001 23 I CLEANUP: CLEANUP INVOKED 0007:0218 0008:0003

8.2.4 OpenVMS Connection Sequence (TRACE ON)

160249 ---- 04 C INPUT: MODIFY: SET TRACE ON

160249 ---- 05 C OUTPUT: VTAM AND TCP TRACES ENABLED

160300 0002 81 T GAP RCV VERSION 00051001030000

160300 0002 82 T GAP SND U VERSION 00051000030000

160300 0002 81 T GAP RCV CONNECT 00360C00090000003FAE …

160300 0002 85 T GAP: CONNECT PARAMETER - ORIG UNIT NONE

160300 0002 85 T GAP: CONNECT PARAMETER - ORIG MOD NONE

160300 0002 85 T GAP: CONNECT PARAMETER - DEST MOD NONE

160300 0002 85 T GAP: CONNECT PARAMETER - DEST UNIT MDU64

160300 0002 85 T GAP: CONNECT PARAMETER - ACC NAME NONE

160300 0002 85 T GAP: CONNECT PARAMETER - LOGMODE FT819210

160300 0002 85 T GAP: CONNECT PARAMETER - COS NONE

160300 0002 85 T GAP: CONNECT PARAMETER - USER DATA

160300 0002 85 T GAP: CONNECT PARAMETER - AUTH TERMINAL 1

160300 0002 85 T GAP: CONNECT PARAMETER - AUTH USER USERID

160300 0002 85 T GAP: CONNECT PARAMETER - AUTH PWD NONE

160300 0002 85 T GAP: CONNECT PARAMETER - PROG NAME DTFLS

160300 0002 21 I TCP: SERVER CONNECTION 1.2.3.6:4655 / LUL22

8.2.5 OpenVMS Connection: No Logical Units Available

100600 ---- 01 I DATE: YYMMDD = 040615

100600 ---- 06 I TCP: INITIALIZE API SUCCESSFUL

100659 0001 23 W CLEANUP: CLEANUP INVOKED 0002:0086 0002:0001

8.2.6 OpenVMS Connection: No Logical Units Available (TRACE ON)

100800 ---- 01 I DATE: YYMMDD = 040615

100800 ---- 06 I TCP: INITIALIZE API SUCCESSFUL

100836 ---- 04 C INPUT: MODIFY: SET TRACE ON

100836 ---- 05 C OUTPUT: VTAM AND TCP TRACES ENABLED

100959 0001 81 T GAP RCV VERSION 00051001030000

100959 0001 82 T GAP SND U VERSION 00051000030000

100959 0001 81 T GAP RCV CONNECT 00510C00050000 …

100959 0001 85 T GAP: CONNECT PARAMETER - ORIG UNIT NONE

100959 0001 85 T GAP: CONNECT PARAMETER - ORIG MOD NONE

100959 0001 85 T GAP: CONNECT PARAMETER - DEST MOD NONE

100959 0001 85 T GAP: CONNECT PARAMETER - DEST UNIT NONE

100959 0001 85 T GAP: CONNECT PARAMETER - ACC NAME NONE

100959 0001 85 T GAP: CONNECT PARAMETER - LOGMODE NONE

100959 0001 85 T GAP: CONNECT PARAMETER - COS NONE

100959 0001 85 T GAP: CONNECT PARAMETER - USER DATA NONE

100959 0001 85 T GAP: CONNECT PARAMETER - AUTH TERMINAL NODE X

100959 0001 85 T GAP: CONNECT PARAMETER - AUTH USER USERID

100959 0001 85 T GAP: CONNECT PARAMETER - AUTH PWD NONE

100959 0001 85 T GAP: CONNECT PARAMETER - PROG NAME 1 DKC0

100959 0001 86 T GAP: CONNECT REJECTED - LU NOT AVAILABLE …

100959 0001 82 T GAP SND U ABORT 0009116E00000000000000

100959 0001 23 W CLEANUP: CLEANUP INVOKED 0002:0086 0002:0001

9. INDEX:

configuration file statements

AN (access name), 23

AN-LU, 24

AN-USER-DATA, 24

BUFFER-CACHE, 24

COMMENT-CHAR, 25

developing a configuration file, 19

format, 22

KEY, 25

LU-ADDRESS, 26

LU-LIMIT, 26

LU-NAME, 27

overview, 19

simple example, 20

TCP-INTERFACE, 27

TCP-JOBNAME, 28

TCP-PORT, 28

TCP-STACK, 28

TRACE, 28

USS-COMMAND, 29

USS-SCREEN, 30

console command

introduction, 37

MODIFY, 37

STOP, 37

Installation Verification Procedure, 12

license

configuration file statement, 25

log file messages, 36

operation without license, 6

log file messages, 32

format, 32

individual message descriptions, 32

license, 36

messages. See log file messages

SMP/E

files, 11

jobs, 11

tailoring JCL, 9

USS-SCREEN

parameters, 31

VTAM Application Major Node

After activating, MGO console command, 17

APPL statement, 15

GROUP statement, 15

Optional Parameters, 16

Required Parameters, 15

Simple Example, 15

VBUILD statement, 15