MainframeConnect™ for DB2/MVS-CICS Installation and ...

274
MainframeConnect™ for DB2/MVS-CICS Installation and Administration Guide MainframeConnect for DB2/MVS-CICS version 11.1.1 Document ID: 36525-01-1111-01 Last Revised: September 30, 1997
  • date post

    21-Oct-2014
  • Category

    Documents

  • view

    1.451
  • download

    6

description

 

Transcript of MainframeConnect™ for DB2/MVS-CICS Installation and ...

Page 1: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect™for DB2/MVS-CICS

Installation and Administration Guide

MainframeConnect for DB2/MVS-CICSversion 11.1.1

Document ID: 36525-01-1111-01

Last Revised: September 30, 1997

Page 2: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Document ID: 36525-01-1111

This publication pertains to MainframeConnect for DB2/MVS-CICS version 11.1.1of the Sybase database management software and to any subsequent release untilotherwise indicated in new editions or technical notes. Information in thisdocument is subject to change without notice. The software described herein isfurnished under a license agreement, and it may be used or copied only inaccordance with the terms of that agreement.

Document Orders

To order additional documents, U.S. and Canadian customers should callCustomer Fulfillment at (800) 685-8225, fax (617) 229-9845.

Customers in other countries with a U.S. license agreement may contact CustomerFulfillment via the above fax number. All other international customers shouldcontact their Sybase subsidiary or local distributor.

Upgrades are provided only at regularly scheduled software release dates.

Copyright © 1989–1997 by Sybase, Inc. All rights reserved.

No part of this publication may be reproduced, transmitted, or translated in anyform or by any means, electronic, mechanical, manual, optical, or otherwise,without the prior written permission of Sybase, Inc.

Sybase Trademarks

Sybase, the Sybase logo, APT-FORMS, Certified SYBASE Professional, DataWorkbench, First Impression, InfoMaker, PowerBuilder, Powersoft, ReplicationServer, S-Designor, SQL Advantage, SQL Debug, SQL SMART, SQL Solutions,Transact-SQL, VisualWriter, and VQL are registered trademarks of Sybase, Inc.Adaptable Windowing Environment, Adaptive Component Architecture,Adaptive Server, Adaptive Server Monitor, ADA Workbench, AnswerBase,Application Manager, AppModeler, APT-Build, APT-Edit, APT-Execute,APT-Library, APT-Translator, APT Workbench, Backup Server, BayCam, Bit-Wise,ClearConnect, Client-Library, Client Services, CodeBank, Column Design,Connection Manager, DataArchitect, Database Analyzer, DataExpress, DataPipeline, DataWindow, DB-Library, dbQ, Developers Workbench, DirectConnect,Distribution Agent, Distribution Director, Dynamo, Embedded SQL, EMS,Enterprise Client/Server, Enterprise Connect, Enterprise Manager, Enterprise SQLServer Manager, Enterprise Work Architecture, Enterprise Work Designer,Enterprise Work Modeler, EWA, Formula One, Gateway Manager, GeoPoint,ImpactNow, InformationConnect, InstaHelp, InternetBuilder, iScript, Jaguar CTS,jConnect for JDBC, KnowledgeBase, Logical Memory Manager,MainframeConnect, Maintenance Express, MAP, MDI Access Server, MDIDatabase Gateway, media.splash, MetaWorks, MethodSet, Net-Gateway,NetImpact, Net-Library, ObjectConnect, ObjectCycle, OmniConnect, OmniSQLAccess Module, OmniSQL Toolkit, Open Client, Open ClientConnect, OpenClient/Server, Open Client/Server Interfaces, Open Gateway, Open Server, OpenServerConnect, Open Solutions, Optima++, PB-Gen, PC APT-Execute, PC DB-Net,PC Net Library, Power++, Power AMC, PowerBuilt, PowerBuilt with

Page 3: MainframeConnect™ for DB2/MVS-CICS Installation and ...

PowerBuilder, PowerDesigner, Power J, PowerScript, PowerSite, PowerSocket,Powersoft Portfolio, Power Through Knowledge, PowerWare Desktop,PowerWare Enterprise, ProcessAnalyst, Quickstart Datamart, Replication Agent,Replication Driver, Replication Server Manager, Report-Execute, ReportWorkbench, Resource Manager, RW-DisplayLib, RW-Library, SAFE, SDF, SecureSQL Server, Secure SQL Toolset, Security Guardian, SKILS, smart.partners,smart.parts, smart.script, SQL Anywhere, SQL Central, SQL Code Checker, SQLEdit, SQL Edit/TPU, SQL Modeler, SQL Remote, SQL Server, SQL Server/CFT,SQL Server/DBM, SQL Server Manager, SQL Server SNMP SubAgent, SQLStation, SQL Toolset, Sybase Client/Server Interfaces, Sybase DevelopmentFramework, Sybase Gateways, Sybase IQ, Sybase MPP, Sybase SQL Desktop,Sybase SQL Lifecycle, Sybase SQL Workgroup, Sybase Synergy Program, SybaseVirtual Server Architecture, Sybase User Workbench, SybaseWare, SyBooks,System 10, System 11, the System XI logo, SystemTools, Tabular Data Stream, TheArchitecture for Change, The Enterprise Client/Server Company, The Model forClient/Server Solutions, The Online Information Center, Translation Toolkit,Turning Imagination Into Reality, Unibom, Unilib, Uninull, Unisep, Unistring,Viewer, Visual Components, VisualSpeller, WarehouseArchitect, WarehouseNow,Warehouse WORKS, Watcom, Watcom SQL, Watcom SQL Server, Web.SQL,WebSights, WebViewer, WorkGroup SQL Server, XA-Library, and XA-Server aretrademarks of Sybase, Inc. 6/97

All other company and product names used herein may be trademarks orregistered trademarks of their respective companies.

Restricted Rights

Use, duplication, or disclosure by the government is subject to the restrictions setforth in subparagraph (c)(1)(ii) of DFARS 52.227-7013 for the DOD and as set forthin FAR 52.227-19(a)-(d) for civilian agencies.

Sybase, Inc., 6475 Christie Avenue, Emeryville, CA 94608.

Page 4: MainframeConnect™ for DB2/MVS-CICS Installation and ...
Page 5: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide v

Table of Contents

About this BookWho Should Read This Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvHow to Use This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvRelated Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviiSyntax and Style Conventions in this Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii

Syntax Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviiStyle Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii

How to Get Help Using Sybase Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xixSybase Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix

Contacting Sybase Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . xixSending Log and Trace Files to Sybase Technical Support. . . . . . . . . . xx

Sybase Professional Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiOther Sources of Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxi

Online Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiiSybase Certifications and EBFs on the Web . . . . . . . . . . . . . . . . . . . . . . . xxiiSybase OpenLine and PrivateLine on CompuServe . . . . . . . . . . . . . . . . xxiiiFax-on-Demand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiv

If You Have Questions About this Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiv

Planning

1. Understanding Enterprise ConnectWhat is Enterprise Connect? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1Enterprise Connect and Previous Sybase Products. . . . . . . . . . . . . . . . . . . . . . . . . . 1-1Enterprise Connect Product Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

MainframeConnect. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2DirectConnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

DirectConnect Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4DirectConnect Configuration Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6Open ServerConnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6Open ClientConnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7ClearConnect. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8

Enterprise Connect Processing Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10Products Used with Enterprise Connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11

Related Sybase Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-11Related IBM Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12

Page 6: MainframeConnect™ for DB2/MVS-CICS Installation and ...

vi Table of Contents

MainframeConnect for DB2/MVS-CICS version 11.1.1

2. Understanding MainframeConnectMainframeConnect Functionality. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1MainframeConnect Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3

Components of MainframeConnect. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3Transaction Processor AMD2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4Host Request Library DB2 Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4

Communication with Other Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4Other Mainframe Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4DirectConnect for MVS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5Client Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5Other Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5

MainframeConnect Communication Path . . . . . . . . . . . . . . . . . . . . . . . . . 2-5

3. Planning Your InstallationWhat Can You Install with This Product? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1Installation Task Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1Preinstallation Checklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2

Checking the Personnel Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3Checking the System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3Checking Special System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4Considering Performance Upgrades . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5

Using SDLC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5Using Token Ring. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5RU Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5

Checking the Mainframe Access Components. . . . . . . . . . . . . . . . . . . . . . 3-6Checking the Space Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6Checking Connectivity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6Checking the VTAM and NCP Definitions . . . . . . . . . . . . . . . . . . . . . . . . . 3-7Checking the CICS Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7

4. Migrating from Previous InstallationsUnderstanding Migration Considerations with MainframeConnect . . . . . . . . . . . . . . 4-1

New Default Transaction Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1CSAs and RSPs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Preparing to Upgrade to MainframeConnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2Removing a Prior Product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2Assigning Library Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3Preserving Customized Messages on AMD2CAMX. . . . . . . . . . . . . . . . . 4-3

Page 7: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide vii

MainframeConnect for DB2/MVS-CICS version 11.1.1

Installing

5. Installing the MainframeConnect TapeInstallation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1Post-Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4

Authorizing Users for the Application Plan. . . . . . . . . . . . . . . . . . . . . . . . 5-4Authorizing Users for DB2 Packages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4Authorizing Users for System Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5Verifying Your Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5

Contents of the MainframeConnect Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6COPY Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6CTRL Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6DBRM Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7JCL Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7LOADLIB Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7MACLIB Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8SOURCE Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9

What’s Next? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9

6. Installing Catalog Stored Procedures for Transaction Router ServiceInstallation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1Contents of the MainframeConnect TRS Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3

TRS.CTRL Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3TRS.DBRM Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4TRS.JCL Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5TRS.LOAD Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5

What’s Next? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5

Configuring & Customizing

7. Configuring MainframeConnectChanging the MainframeConnect Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1Understanding the Configuration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3

Transaction ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3Request exit name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4Result exit name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4Parse exit name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4Group ID exit name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4

Page 8: MainframeConnect™ for DB2/MVS-CICS Installation and ...

viii Table of Contents

MainframeConnect for DB2/MVS-CICS version 11.1.1

Host request library ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5Temp storage queue type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5DateTime results type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7

What’s Next? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7

8. Customizing MainframeConnect MessagesUnderstanding the AMD2 Message Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

Translate Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2Example of Translate Table Source Code . . . . . . . . . . . . . . . . . . . . . . . 8-2Translate Table Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3

Text Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4Example of Text Table Source Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5National Languages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5Message Variable Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6

Changing the AMD2 Message Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-7Adding Entries for New SQLCODEs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-7Adding or Changing Messages for a Parse Exit Routine . . . . . . . . . . . . . 8-8Customizing Message Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9Eliminating Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10Changing Message Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10

Coding AMD2 Message Table Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11Changing the Translate Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11

Adding a Translate Table Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11Modifying a Translate Table Entry. . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11

Changing the Text Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-12Rules for Text Table Entries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-12Modifying a Message in the Text Table . . . . . . . . . . . . . . . . . . . . . . . . 8-13Adding a Message to the Text Table . . . . . . . . . . . . . . . . . . . . . . . . . . 8-13Adding a Language to the Text Table . . . . . . . . . . . . . . . . . . . . . . . . . 8-13

9. User ExitsUser Exits in MainframeConnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1Request/Result Validation Exits. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

Understanding Exit Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2Enabling Request/Result Validation Exits . . . . . . . . . . . . . . . . . . . . . . . . . 9-3Using the Sample Validation Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3Understanding the Exit Communication Area. . . . . . . . . . . . . . . . . . . . . . 9-5

Common Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-6Writing a Request Validation Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-7Writing a Result Validation Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-8

Page 9: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide ix

MainframeConnect for DB2/MVS-CICS version 11.1.1

Using the Group ID Exit Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10Understanding Group ID Exit Name Processing. . . . . . . . . . . . . . . . . . . 9-10

Parse Exit Routine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-11Understanding the Parse Exit Routine . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-12

Calling the Parse Exit from AMD2 . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-12Processing Batched SQL Statements . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13Processing User-Defined Transactions . . . . . . . . . . . . . . . . . . . . . . . . 9-13Returning to AMD2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13

The Parse Exit Common Area. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13Layout of the AMD2XCOB Copy Book . . . . . . . . . . . . . . . . . . . . . . . 9-14CICS Common Area Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-15

Getting Ready to Code Your Routine . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-16Programming Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-16Sample Parse Exit Routine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-16

Coding Your Routine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-16Altering the SQL Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-17Acquiring Additional Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-17Handling Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-18Assigning a Return Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-19Selecting an Error Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-19

Compiling and Link-Editing Your Routine . . . . . . . . . . . . . . . . . . . . . . . 9-20Enabling Your Routine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-20

Troubleshooting

10. TroubleshootingVerifying Connectivity After Installing MainframeConnect . . . . . . . . . . . . . . . . . . . . 10-1Where to Start Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2Common Problems and Suggested Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3

Configuration Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3Cannot Establish a Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3Session Established, but the Transaction Does Not Run . . . . . . . . . 10-4SDLC Line or Token Ring is Not Up . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4SDLC Link and PU are Active, but the LU Is Not Active. . . . . . . . . 10-4

Mainframe Network Operational Failure . . . . . . . . . . . . . . . . . . . . . . . . . 10-5Network Session or Line Failures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-5

Preventative Measures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-5Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6

DirectConnect Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7DirectConnect Communications with MainframeConnect . . . . . . . . . . 10-8

Page 10: MainframeConnect™ for DB2/MVS-CICS Installation and ...

x Table of Contents

MainframeConnect for DB2/MVS-CICS version 11.1.1

SNA LU 6.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8TCP/IP Uplink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8

Mainframe Communications with DirectConnect. . . . . . . . . . . . . . . . . . 10-9VTAM/NCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9TCP/IP for MVS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9TCP/IP Sockets Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9CICS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-9

MainframeConnect for DB2/MVS-CICS. . . . . . . . . . . . . . . . . . . . . . . . . 10-10Tracing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11

Coordination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-14Processing Flow and Enterprise Connect Requirements . . . . . . . . . . . 10-14Process Flow During Attention Sequences . . . . . . . . . . . . . . . . . . . . . . . 10-17

Appendixes

A. Error MessagesUnderstanding the Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Message Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1MainframeConnect Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1Messages Mapped to SQL Server Messages . . . . . . . . . . . . . . . . . . . A-2

How Errors are Logged . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2Defining Log Files to CICS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2Interpreting the Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3

MainframeConnect Error Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-5

B. DB2 Database Administrator Information for TRSStored Procedures and DBMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1Keeping Server and Stored Procedure Information Current . . . . . . . . . . . . . . . . . . . . B-1

New Stored Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-2Stored Procedure Names on DirectCONNECT . . . . . . . . . . . . . . . . . . . . . B-2

Glossary

Index

Page 11: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide xi

List of Figures

Figure 2-1: MainframeConnect communication path ..................................................................2-7Figure 7-1: Mainframe Connect Configuration Tran ID Selection screen .................................7-2Figure 7-2: Mainframe Connect Configuration screen.................................................................7-3Figure 10-1: Open ServerConnect and DirectConnect support components ...........................10-7Figure 10-2: MainframeConnect and DirectConnect support components ............................10-11Figure 10-3: Processing flow: client-to-DirectConnect-to-mainframe......................................10-14

Page 12: MainframeConnect™ for DB2/MVS-CICS Installation and ...

xii List of Figures

MainframeConnect for DB2/MVS-CICS version 11.1.1

Page 13: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide xiii

List of Tables

Table 1: Syntax conventions..................................................................................................... xviiiTable 2: Style Conventions....................................................................................................... xviiiTable 1-1: Enterprise Connect and corresponding predecessors..............................................1-1Table 1-2: MainframeConnect predecessors ................................................................................1-3Table 1-3: DirectConnect predecessors .........................................................................................1-4Table 1-4: TRS predecessor.............................................................................................................1-5Table 1-5: MCC predecessors .........................................................................................................1-6Table 1-6: Open ServerConnect predecessor ...............................................................................1-7Table 1-7: Open ClientConnect predecessor ................................................................................1-8Table 1-8: Related Sybase products.............................................................................................1-11Table 1-9: Related IBM products .................................................................................................1-12Table 3-1: Installation process ........................................................................................................3-1Table 3-2: Mainframe Access components...................................................................................3-6Table 4-1: Sybase resources ............................................................................................................4-3Table 5-1: COPY library ..................................................................................................................5-6Table 5-2: CTRL library...................................................................................................................5-6Table 5-3: DBRM library .................................................................................................................5-7Table 5-4: JCL library.......................................................................................................................5-7Table 5-5: LOADLIB library ...........................................................................................................5-7Table 5-6: MACLIB library .............................................................................................................5-8Table 5-7: SOURCE library.............................................................................................................5-9Table 6-1: TRSCTRL library............................................................................................................6-3Table 6-2: TRS.DBRM library .........................................................................................................6-4Table 6-3: TRS.JCL library ..............................................................................................................6-5Table 6-4: TRS.LOAD library .........................................................................................................6-5Table 7-1: Types of temporary storage queues ............................................................................7-5Table 8-1: Message table members ................................................................................................8-2Table 8-2: Message variable indicators and values.....................................................................8-6Table 8-3: Adding entries for new SQLCODEs...........................................................................8-7Table 8-4: Adding or changing messages for a parse exit routine............................................8-8Table 8-5: Customizing message text............................................................................................8-9Table 8-6: Eliminating messages..................................................................................................8-10Table 8-7: Changing message logging ........................................................................................8-10Table 8-8: Changing the AMD2 message table..........................................................................8-11Table 9-1: Common Exit Communication Area Fields...............................................................9-7Table 9-2: Request Validation Communication Area Fields......................................................9-7Table 9-3: Result Validation Communication Area Fields.........................................................9-9Table 9-4: Altering values in common area fields.....................................................................9-12

Page 14: MainframeConnect™ for DB2/MVS-CICS Installation and ...

xiv List of Tables

MainframeConnect for DB2/MVS-CICS version 11.1.1

Table 9-5: CICS Common Area Fields ........................................................................................9-15Table A-1: Abbreviations for message text ................................................................................. A-4Table B-1: DB2 Database administrator-maintained tables ...................................................... B-1

Page 15: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide xv

About this Book

This book describes how to install and configure MainframeConnectfor DB2/MVS-CICS version 11.1.1 (also referred to asMainframeConnect). It includes planning considerations,installation instructions, configuration instructions, andtroubleshooting information.

This preface includes the following topics:

• “Who Should Read This Book” on page xv

• “How to Use This Guide” on page xv

• “Related Documents” on page xvii

• “Syntax and Style Conventions in this Book” on page xvii

• “How to Get Help Using Sybase Products” on page xix

• “Other Sources of Information” on page xxi

• “If You Have Questions About this Book” on page xxiv

Who Should Read This Book

These specific guidelines and step-by-step instructions are intendedfor those who install, configure, and maintain Sybase mainframeclient/server components on an IBM System/390 mainframe. Thisguide is for anyone who performs tasks, such as a:

• CICS system programmer

• DB2 database administrator

• DirectConnect administrator

This guide assumes you have a working knowledge of systemadministration for your environment. For an MVS-CICSenvironment, for example, you should be familiar with MVS andCICS system administrative procedures, such as defining CICSresources and VTAM definitions.

How to Use This Guide

This guide consists of five sections: planning, installing, configuring,troubleshooting, and appendixes. The first four sections contain

Page 16: MainframeConnect™ for DB2/MVS-CICS Installation and ...

xvi About this Book

How to Use This Guide MainframeConnect for DB2/MVS-CICS version 11.1.1

chapters that describe sets of tasks. The last section contains usefulreference information.

MainframeConnect requires the Open ServerConnect for CICS/MVSbase tape to be installed. Therefore, the Open ServerConnect forCICS/MVS base tape is shipped with MainframeConnect. You willfind instructions for installing the Open ServerConnect forCICS/MVS base tape in the Open ServerConnect Installation andAdministration Guide for IBM CICS/MVS, which is also shipped withMainframeConnect.

The following table shows tasks you perform using this guide andthe Open ServerConnect Installation and Administration Guide for IBMCICS/MVS. The Open ServerConnect Installation and AdministrationGuide for IBM CICS/MVS is abbreviated in the following table as“OSC guide.”

To See

Understand Enterprise Connect products

MainframeConnect components

Chapter 1

Chapter 2

Plan Installation and configuration

Migration from OmniSQL Access Module Version 10.1 or MDIAccess Server for MVS-CICS Version 2.3 or later

Chapter 3

Chapter 4

Install Libraries from the Open ServerConnect CICS/MVS base tape

Libraries from the MainframeConnect tape

CSP libraries for TRS from the MainframeConnect tape

Libraries from the Japanese Conversion Module tape

OSC Guide

Chapter 5

Chapter 6

OSC Guide

Configure MainframeConnect to communicate with DirectConnect

AMD2 messages for MainframeConnect

Understand and write user exit routines

Chapter 7

Chapter 8

Chapter 9

Troubleshoot Problems with client access to data on the mainframe Chapter 10

Compile and Link Sample programs OSC Guide

Customize Global and single byte character set (SBCS) options

DB2 database administrator-maintained tables

OSC Guide

Appendix B

Reference MainframeConnect-specific messages

Security information

Default translation tables to customize SBCSs

Unfamiliar terms and acronyms

Appendix A

OSC Guide

OSC Guide

Glossary

Page 17: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide xvii

MainframeConnect for DB2/MVS-CICS version 11.1.1 Related Documents

Related Documents

To install and administer MainframeConnect, in addition to thisbook, you need the Open ServerConnect Installation and AdministrationGuide for IBM CICS/MVS, which ships with MainframeConnect.

For the latest product information, refer to the release bulletins forMainframeConnect and Open ServerConnect.

You may also need to refer to the following related documentation:

• DirectConnect for MVS Connectivity Guide

• DirectConnect for MVS Installation Guide

• DirectConnect for MVS Access Service User’s Guide

• DirectConnect Transaction Router Service User’s Guide

• DirectConnect Server Administration Guide

• DirectConnect Error Message Guide

• DirectConnect Configuration Tool User Guide

• DirectConnect Configuration Tool Installation Guide

• Open ServerConnect Programmer’s Reference for Remote StoredProcedures

• Open ClientConnect Programmer’s Reference for Client ServicesApplications

• Open ClientConnect and Open ServerConnect Messages and Codes

Syntax and Style Conventions in this Book

This section describes the syntax and style conventions used in thisbook.

➤ NoteAll references to SQL Server in this book also apply to Adaptive Server.

Syntax Conventions

Syntax statements that display options for a command look like this:

COMMAND [object_name , [ {TRUE | FALSE} ] ]

Page 18: MainframeConnect™ for DB2/MVS-CICS Installation and ...

xviii About this Book

Syntax and Style Conventions in this Book MainframeConnect for DB2/MVS-CICS version 11.1.1

The following table explains the syntax conventions used in thisguide.

Style Conventions

The following style conventions are used in this book:

All other names and terms are in regular typeface.

Table 1: Syntax conventions

Symbol

( ) Parentheses indicate that parentheses are included as part of thecommand.

{ } Braces indicate that you must choose at least one of the enclosedoptions. Do not type the braces when you type the option.

[ ] Brackets indicate that you can choose one or more of the enclosedoptions, or none. Do not type the brackets when you type theoptions.

| The vertical bar indicates that you can select only one of theoptions shown. Do not type the bar in your command.

, The comma indicates that you can choose one or more of theoptions shown. Separate each choice by using a comma as part ofthe command.

Table 2: Style Conventions

This type of information Looks like this

Directories and files econnect\ServerName\cfg

Programs, utilities, procedures, andcommands

snrfck

Properties Allocate

Options connect

Code examples and text on screen this font

Commands you should enter this font

Variables you should replace with theappropriate value for your system whenentering a command

this font

Page 19: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide xix

MainframeConnect for DB2/MVS-CICS version 11.1.1 How to Get Help Using Sybase Products

How to Get Help Using Sybase Products

Each Sybase installation that has purchased a support contract hasone or more designated people who are authorized to contact SybaseTechnical Support. If you cannot resolve a problem using themanuals or online help, please have the designated person contactSybase Technical Support or the Sybase subsidiary in your area.

If you need help using a Sybase product, the following resources areavailable:

• Sybase Technical Support

• Sybase Professional Services

• Other sources of information

Sybase Technical Support

Sybase Technical Support provides various forms of customerassistance, including the following services:

• Identifying problems.

• Offering a fix, if available.

• Documenting software problems and enhancement suggestionsin our customer support database.

• Communicating status information on open problems.

• Sharing information on new products or releases of existingproducts.

In addition, Sybase system engineers are available for technicalassistance in various geographical territories.

The following subsections explain how to contact Sybase TechnicalSupport and how to send log and trace files, if necessary.

Contacting Sybase Technical Support

You can contact Sybase Technical Support by phone or electronicmail (e-mail). Before you contact Sybase Technical Support, completethese steps:

1. Thoroughly review the documentation, especially alltroubleshooting sections.

2. Be prepared to generate a trace, if requested to do so byTechnical Support.

Page 20: MainframeConnect™ for DB2/MVS-CICS Installation and ...

xx About this Book

How to Get Help Using Sybase Products MainframeConnect for DB2/MVS-CICS version 11.1.1

Contacting by Phone

You can reach Sybase Technical Support by calling (800) 8SYBASE.Hours are 5:00 AM to 6:30 PM, Monday through Friday, MountainStandard or Daylight Savings Time (MST or MDT), except holidays.

➤ NoteOutside the continental United States and Canada, obtain the correct

telephone numbers from your sales representative and record them here

for future reference:______________________________.

Contacting by E-Mail

Send an e-mail to Sybase Technical Support in the followingcircumstances:

• If you have a general question that is not urgent, for instance, aquestion about configuration planning.

• If you need help with a product outside of the working hours ofSybase Technical Support, you can send an e-mail to be receivedas soon as personnel become available.

Use this address to send e-mail to Sybase Technical Support:

[email protected]

Sending Log and Trace Files to Sybase Technical Support

You can send log and trace files or other documents to SybaseTechnical Support using the Sybase file transfer protocol or theBulletin Board Service.

Using File Transfer Protocol (ftp)

To place trace output or other documents on the Sybase ftp server:

1. Save your trace output as an ASCII file.

2. In the directory where the file resides, type ftp at the commandline.

3. When prompted, provide the following information:

- Sybase server = ftp.sybase.com

- ID = anonymous

- Password = your e-mail address

Page 21: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide xxi

MainframeConnect for DB2/MVS-CICS version 11.1.1 Other Sources of Information

4. Type:

cd /pub/incoming/wcss

5. To change to binary mode, type:

bin

6. Place one or more files into the directory.

- To place one file in the directory, type:

put filename

- To place multiple files in the directory, type

mput filename filename filename

When prompted, type Y and press Enter to transfer each file.

7. Notify Sybase Technical Support of the exact name of the file(s)you sent to the server. (Remember that the Unix system is case-sensitive.)

Using the Bulletin Board Service (BBS)

To send log and trace files to Sybase Technical Support or to receivesoftware fixes using the BBS:

1. Call (303) 413-4285.

2. Use parameters 8-1-N and a baud rate of 300-14400.

Sybase Professional Services

Sybase Professional Services offers on-site consulting and trainingprograms to help you maximize the benefits of our products. Formore information, call (303) 486-7700.

➤ NoteOutside the continental United States and Canada, obtain the correct

telephone numbers from your sales representative and record them here

for future reference:______________________________.

Other Sources of Information

Other sources of information include:

• Online documentation

Page 22: MainframeConnect™ for DB2/MVS-CICS Installation and ...

xxii About this Book

Other Sources of Information MainframeConnect for DB2/MVS-CICS version 11.1.1

• Sybase certifications and Emergency Bug Fixes (EBFs) on the Web

• Sybase OpenLine and PrivateLine on Compuserve

• Fax-on-Demand

Online Documentation

Use the SyBooks™ and SyBooks-on-the-Web online resources tolearn more about your product.

Accessing SyBooks

SyBooks documentation is on the CD that comes with your software.The DynaText browser, also included on the CD, allows you to accesstechnical information about your product in an easy-to-use format.

Refer to Installing SyBooks in your documentation package forinstructions on installing and starting SyBooks.

Accessing SyBooks-on-the-Web

SyBooks-on-the-Web is an HTML version of SyBooks that you canaccess using a standard Web browser. To use SyBooks-on-the-Web,go to http://www.sybase.com and choose Documentation.

Sybase Certifications and EBFs on the Web

Sybase certifications and EBFs are available through the SybaseTechnical Information Library.

Accessing Product Certifications

1. Point your Web browser to the Technical Information Library atthe following URL:

http://techinfo.sybase.com

2. In the Browse section, choose the Hot entry.

3. Choose the topic that interests you.

Page 23: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide xxiii

MainframeConnect for DB2/MVS-CICS version 11.1.1 Other Sources of Information

Accessing EBFs through SupportPlus

➤ NoteTo access EBFs, you must be a registered SupportPlus user. See

“Registering as a SupportPlus User” on page xxiii for registration

instructions.

1. Go to the following URL:

http://techinfo.sybase.com

2. In the Browse section, choose the Hot entry.

3. Choose the EBF Rollups entry.

You can research EBFs using the Technical Information Library,and you can download EBFs using Electronic SoftwareDistribution (ESD).

4. Follow the instructions associated with the SupportPlusSM

Online Services entries.

Registering as a SupportPlus User

To use SupportPlus, you need:

• A Web browser that supports the Secure Sockets Layer (SSL),such as Netscape Navigator 1.2 or later

• An active support license

• A named technical support contact

• Your user ID and password

To register as a SupportPlus user:

1. Go to the Sybase home page at the following URL:

www.sybase.com

2. Choose Technical Support.

3. Choose Enterprise Technical Support.

4. Choose register for SupportPlus.

Sybase OpenLine and PrivateLine on CompuServe

Sybase OpenLine and PrivateLine are the Sybase question andanswer forums on CompuServe. To access Sybase OpenLine:

Page 24: MainframeConnect™ for DB2/MVS-CICS Installation and ...

xxiv About this Book

If You Have Questions About this Book MainframeConnect for DB2/MVS-CICS version 11.1.1

1. Connect to CompuServe using the normal procedures for yoursite.

2. At any menu prompt, type:

go sybase

Fax-on-Demand

Use Fax-on-Demand to receive Certification Reports, ReleaseSummaries, Sample Programs, Technical News Letters (TNL), andTechnical White Papers.

To use Fax-on-Demand:

1. Call (800) 423-8737. Outside the United States and Canada, call(303) 575-6132.

2. Choose option 2 and follow the recorded instructions.

If You Have Questions About this Book

If you have questions, comments, or suggestions about this book,contact the Sybase documentation group directly by e-mail at:

[email protected]

Feel free to forward any information, comments, or questions about:

• Missing, incorrect, or unclear information

• Information you found particularly useful

• Organization or style

We will respond as promptly as possible by e-mail. Your feedbackhelps us provide more accurate, detailed, and easy-to-usedocumentation.

➤ NotePlease send comments about product features, functionality, or problems to

your system engineer or Sybase Technical Support.

To order additional copies of Enterprise Connect documentation, see“Document Orders” on the disclaimer page following the title page.

Page 25: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Planning

Page 26: MainframeConnect™ for DB2/MVS-CICS Installation and ...
Page 27: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 1-1

1 Understanding Enterprise Connect 1.

This chapter provides an overview of the Enterprise Connect™products, including how MainframeConnect™ relates to otherEnterprise Connect products. It includes the following topics:

• What is Enterprise Connect? 1-1

• Enterprise Connect and Previous Sybase Products 1-1

• Enterprise Connect Product Overview 1-2

• Enterprise Connect Processing Environment 1-10

• Products Used with Enterprise Connect 1-11

What is Enterprise Connect?

Enterprise Connect is a set of Sybase® products that provides acommon, enterprise-wide architecture that supports thedevelopment of distributed computing applications. EnterpriseConnect provides the following services:

• Access to distributed databases

• Mainframe integration

• Batch and real-time information delivery

• Object interfaces

• Transaction services

• Internet services

Enterprise Connect and Previous Sybase Products

Enterprise Connect refers to the new generation of Sybasemiddleware, as well as its predecessors. The following table mapsEnterprise Connect products to their corresponding predecessors:

Table 1-1: Enterprise Connect and corresponding predecessors

Enterprise Connect Sybase Net-Gateway MDI Database Gateway

DirectConnect™ Net-Gateway™ Database Gateway

• Access Services • (dynamic SQL access withinNet-Gateway)

• (dynamic SQL access withinDatabase Gateway)

Page 28: MainframeConnect™ for DB2/MVS-CICS Installation and ...

1-2 Understanding Enterprise Connect

Enterprise Connect Product Overview MainframeConnect for DB2/MVS-CICS version 11.1.1

Enterprise Connect Product Overview

This section explains the following products and their components,as well as their predecessor products:

• MainframeConnect

• DirectConnect

• DirectConnect Configuration Tool

• Open ServerConnect

• Open ClientConnect

• ClearConnect

MainframeConnect

MainframeConnect is mainframe software that works withDirectConnect or Net-Gateway 3.0 or later to provide access tomainframe data. It performs the following functions:

• Supports full read-write, dynamic SQL access to data

• Allows applications to use cursors for flexible and efficient resultset processing

• Permits the use of long-running transactions against mainframedatabases

• Allows applications to use dynamic events to map SQL to a staticplan

• Transaction Router Service(TRS)

• Mainframe Server Gateway(MSG)

• n/a

• Mainframe Client Connect(MCC)

• Mainframe Client Gateway(MCG)

• Database Gateway AccessServer

• DirectConnect ConfigurationTool

• n/a • Gateway Manager

Open ServerConnect™ Open Server/Mainframe MDI Access Server (RSPs)

Open ClientConnect™ Open Client/Mainframe MDI Access Server (CSAs)

MainframeConnect forDB2/MVS-CICS

OmniSQL Access Module™ forDB2-CICS

MDI Access Server (DB2)

Table 1-1: Enterprise Connect and corresponding predecessors

Enterprise Connect Sybase Net-Gateway MDI Database Gateway

Page 29: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 1-3

MainframeConnect for DB2/MVS-CICS version 11.1.1 Enterprise Connect Product Overview

Client applications access MainframeConnect directly through aDirectConnect Access Service or DirectConnect TRS.

Client applications access MainframeConnect indirectly throughOmniConnect™ or a Sybase SQL Server™ remote procedure call(RPC).

➤ NoteMainframeConnect is available only for Multiple Virtual Storage

(MVS)/Customer Information Control System (CICS) environments. For

IMS TM and native MVS environments, use OmniSQL Access Module

for DB2-IMS TM and MVS.

The following table provides migration information about theMainframeConnect predecessor products.

DirectConnect

DirectConnect is Open Server™-based software that supportsDatabase Library (DB-Library), Client Library (CT-Library), andOpen Database Connectivity (ODBC) application programminginterfaces (APIs).

DirectConnect serves as a fundamental building block for databasemiddleware applications. DirectConnect products are local areanetwork (LAN)-based middleware gateways and servers thatprovide access to non-Sybase data and applications.

Table 1-2: MainframeConnect predecessors

Product Migration information

OmniSQLAccess Modulefor DB2-CICS

MainframeConnect for DB2/MVS-CICS replacesOmniSQL Access Module for DB2-CICS. It does notreplace OmniSQL Access Module for DB2-IMS TM andMVS.

You can use either Net-Gateway MSG 3.0 or later orDirectConnect TRS with MainframeConnect forDB2/MVS-CICS.

MDI AccessServer

MainframeConnect for DB2/MVS-CICS replaces MDIAccess Server.

Page 30: MainframeConnect™ for DB2/MVS-CICS Installation and ...

1-4 Understanding Enterprise Connect

Enterprise Connect Product Overview MainframeConnect for DB2/MVS-CICS version 11.1.1

DirectConnect provides the following middleware services fordecision support and online transaction processing (OLTP)applications:

• Access Services, which provide access to non-Sybase datasources. The Access Service for MVS is the recommended path foraccessing MVS data using SQL. (Access Services useMainframeConnect.)

• Transaction Router Service (TRS), which is used when themainframe acts as a server and provides access from the LAN tothe mainframe over a Systems Network Architecture (SNA) orTransmission Control Protocol/Internet Protocol (TCP/IP)network. (TRS uses Open ServerConnect.)

• Mainframe Client Connect (MCC), which is used when themainframe acts as a client and supports access from themainframe to the LAN over an SNA or TCP/IP network. OpenClientConnect uses MCC.

The following table provides migration information about theDirectConnect predecessor products.

DirectConnect Components

This section explains the components of DirectConnect: AccessServices, Transaction Router Service, and Mainframe Client Connect.

Table 1-3: DirectConnect predecessors

Product Migration information

Net-Gateway DirectConnect and its TRS and MCC components replaceNet-Gateway and its MSG and MCG components.

Net-Gateway 3.0 or later provides the same functionalityas DirectConnect using TRS and MCC if OpenServerConnect (or Open Server/Mainframe) and OpenClientConnect (or Open Client/Mainframe) reside on themainframe. Specifically, Net-Gateway 3.0 or later routesrequests:

• from the LAN to the mainframe (using MSG)

• from the mainframe to the LAN (using MCG)

DatabaseGateway

DirectConnect replaces the Database Gateway.

Page 31: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 1-5

MainframeConnect for DB2/MVS-CICS version 11.1.1 Enterprise Connect Product Overview

Access Services

An access service is a logical server application, used with an accessservice library, to which clients connect. Each DirectConnect servercan have multiple access services.

For more information about access services and access servicelibraries, see the DirectConnect for MVS Access Service User’s Guide.

Transaction Router Service (TRS)

TRS is used when the mainframe acts as a transaction server. It routesrequests from remote clients to Open ServerConnect transactions.Optionally, it can also route requests to MainframeConnect forDB2/MVS-CICS (or OmniSQL Access Module for DB2-CICS), andreturn results to the clients.

The following table provides migration information about the TRSpredecessor product.

Mainframe Client Connect (MCC)

MCC, a component of DirectConnect, is used when the mainframeacts as a client. It is a LAN-based program that lets mainframe OpenClientConnect applications connect to LAN servers. It performs dataand protocol translation between SNA/LU 6.2 (APPC) and TCP/IPwith the LAN network protocols. When accessing LAN-based datafrom the mainframe through SNA, MCC is required.

Table 1-4: TRS predecessor

Product Migration information

MainframeServer Gateway(MSG)

DirectConnect and its TRS component replaceNet-Gateway and its MSG component.

Net-Gateway 3.0 or later and MSG provide the samefunctionality as TRS. Specifically, MSG is available to routerequests from the LAN using Open ServerConnect (orOpen Server/Mainframe) to the mainframe.

Page 32: MainframeConnect™ for DB2/MVS-CICS Installation and ...

1-6 Understanding Enterprise Connect

Enterprise Connect Product Overview MainframeConnect for DB2/MVS-CICS version 11.1.1

The following table provides migration information about the MCCpredecessor products.

DirectConnect Configuration Tool

DirectConnect Configuration Tool is an Open Client™-basedgraphical user interface (GUI) systems management tool foradministering data access through DirectConnect. DirectConnectConfiguration Tool runs on Windows 3.1, Windows 95, or WindowsNT. It provides the following capabilities:

• Remote start, stop, and configuration of DirectConnect

• Dynamic configuration of services

• Drag-and-drop service creation and copying

• Remote log filtering and downloading

• Heartbeat services

➤ NoteDirectConnect Configuration Tool is not currently available for use with

Mainframe Client Connect.

Open ServerConnect

Open ServerConnect is a programming environment that lets youcreate mainframe transactions that are accessible to Sybase clientapplications. To provide this access, Open ServerConnect uses thefollowing basic interfaces:

Table 1-5: MCC predecessors

Product Migration information

MainframeClient Gateway(MCG)

DirectConnect and its MCC component replaceNet-Gateway and its MCG component.

Net-Gateway 3.0 or later and MCG provide the samefunctionality as MCC. Specifically, MCG is available toroute requests from the mainframe using OpenClientConnect (or Open Client/Mainframe) to the LAN.

DatabaseGateway AccessServer

DirectConnect and MCC replace the Database GatewayAccess Server.

Page 33: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 1-7

MainframeConnect for DB2/MVS-CICS version 11.1.1 Enterprise Connect Product Overview

• The traditional Open Server programming environment (for newcustomers and Sybase-heritage customers using newapplications)

• The Remote Stored Procedure (RSP) programming environment(only for MDI-heritage customers using their old applications)

These transactions provide access to virtually any MVS data sourceand are used for a variety of functions, including:

• Accessing existing mainframe applications

• Initiating mainframe batch jobs

• Providing source data for data transfer operations

• Providing data mapped to a table within OmniConnect, thusallowing results to be accessed or joined with data from othertargets

LAN-side client applications access Open ServerConnecttransactions directly through DirectConnect or indirectly throughOmniConnect or a Sybase SQL Server remote procedure call (RPC).

The following table provides migration information about the OpenServerConnect predecessor products.

Open ClientConnect

Open ClientConnect is a programming environment that lets youcreate mainframe applications that access LAN data residing on aSybase SQL Server or any other supported data source. It allows youto treat the mainframe as just another node on a LAN.

Open ClientConnect uses the following APIs:

Table 1-6: Open ServerConnect predecessor

Product Migration information

Open Server/Mainframe

Open ServerConnect replaces Open Server/Mainframe.

Note: If you still use Open Server/Mainframe at your site,cursor processing is unavailable. Cursor processing isavailable only with Open ServerConnect, releases 3.1and later.

MDI AccessServer

Open ServerConnect replaces MDI Access Server (RSPs)

Page 34: MainframeConnect™ for DB2/MVS-CICS Installation and ...

1-8 Understanding Enterprise Connect

Enterprise Connect Product Overview MainframeConnect for DB2/MVS-CICS version 11.1.1

• The traditional Open Client programming environment (for newcustomers and Sybase-heritage customers using newapplications)

• The Client Services Application (CSA) programmingenvironment (only for MDI-heritage customers using their oldapplications)

The following table provides migration information about the OpenClientConnect predecessor products.

ClearConnect

ClearConnect is a Windows-based ODBC driver that supports directclient-to-host access to IBM Database2 (DB2) data.

ClearConnect uses Distributed Relational Database Architecture(DRDA) for connectivity and runs on the client, allowing clientapplications to connect to any DRDA-enabled DB2. ClearConnectaccesses the following data:

• IBM mainframe data residing in DB2

• LAN data residing on AS/400, DB2/NT, DB2/AIX, DB2/Solaris,and DB2/HPUX

• IBM mainframe legacy data (VSAM, IDMS, ADABAS, IMS)when used with Platinum InfoHub release

With ClearConnect, client applications such as Powerbuilder,Microsoft Access, Visual Basic, and other ODBC applications candirectly query and update DB2 databases.

ClearConnect has the following capabilities:

• Allows ODBC applications and 4GL tools to access DB2-DRDAdatabases

Table 1-7: Open ClientConnect predecessor

Product Migration information

Open Client/Mainframe

Open ClientConnect replaces Open Client/Mainframe.

Note: If you still use Open Client/Mainframe at your site,you cannot customize the code pages; that functionalityis available only with Open ClientConnect, releases 3.1and later.

MDI AccessServer

Open ClientConnect replaces MDI Access Server (CSAs)

Page 35: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 1-9

MainframeConnect for DB2/MVS-CICS version 11.1.1 Enterprise Connect Product Overview

• Supports the latest IBM DRDA database interoperabilitystandard (DRDA Level 3)

• Supports the ODBC 2.0 and 2.5 APIs

• Supports both 16-bit and 32-bit Wintel clients

• Provides fast, easy installation using standard ODBCadministrator GUI tools

ClearConnect provides a point-to-point solution for project teamsand workgroups requiring access to DB2 data. As projects grow andclient volume increases, ClearConnect provides an easy migration toa larger-scale solution, such as DirectConnect for MVS.

Page 36: MainframeConnect™ for DB2/MVS-CICS Installation and ...

1-10 Understanding Enterprise Connect

Enterprise Connect Processing Environment MainframeConnect for DB2/MVS-CICS version 11.1.1

Enterprise Connect Processing Environment

The Enterprise Connect products enable desktop computer andworkstation users to communicate with mainframes in aclient/server environment. The Enterprise Connect processingenvironment consists of several hardware and software components,such as the following:

➤ NoteNot all these software products are required at your site.

Hardware/software Components

Hardware • One or more SQL Server or Open Server platforms

• One or more platforms running DirectConnect

• One or more IBM mainframes

Softwarefrom othervendors

• Communications software

• LU 6.2 support

• IBM TCP/IP support

• Interlink TCP/IP support

• MQ series support

• CICS/MVS

• IMS TM

• VTAM and NCP

• Database management systems on remote servers

• MVS

Sybasesoftware

• Open ClientConnect (or Open Client/Mainframe)

• SQL Server

• DirectConnect (or Net-Gateway)

• Open Server

• Open ServerConnect (or Open Server/Mainframe)

• MainframeConnect for DB2/MVS-CICS (or OmniSQLAccess Module for DB2-CICS)

Page 37: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 1-11

MainframeConnect for DB2/MVS-CICS version 11.1.1 Products Used with Enterprise Connect

Products Used with Enterprise Connect

This section lists and briefly explains the related Sybase and IBMproducts.

Related Sybase Products

Enterprise Connect can be used with most Sybase products toconnect mainframe applications with remote clients and servers. Theproducts in Table 1-8: Related Sybase products are frequently used asclients and/or servers with the Enterprise Connect set.

You need Sybase, IBM, and vendor communications documentationto configure, install, and manage Enterprise Connect products. Youmay need additional IBM and vendor manuals for your particularconfiguration. Be sure you have the necessary IBM manuals on handbefore you begin to configure , as well as the Open ClientConnect andOpen ServerConnect Messages and Codes guide for your mainframeproducts.

Table 1-8: Related Sybase products

Product Description

SQL Server With SQL Server acting as a server, clients using Open ClientConnect cansend requests to a named SQL Server through Mainframe Client Connect.

SQL Server, the Sybase relational database management system (RDBMS),can act as a client or server. Networked clients can call SQL Server storedprocedures that send requests to Open ServerConnect orMainframeConnect for DB2/MVS-CICS (or OmniSQL Access Modulefor DB2-CICS) on the mainframe. The DirectConnect administrator canconfigure the TRS to require all client requests to be routed through SQLServer.

Note: All references to SQL Server also apply to Adaptive Server.

OmniConnect OmniConnect translates Sybase SQL syntax into statements that DB2 canprocess. MainframeConnect for DB2-MVS/CICS applies the request fromOmniConnect to DB2 and returns results. Sites that need to run the sameapplications without modifications against both SQL Server and DB2 canuse OmniConnect as a server.

Open Client Open Client is a Sybase connectivity product that provides customerclient applications, third-party products, and other Sybase products withthe interfaces needed to communicate with Sybase servers and OpenServer applications, including Open ServerConnect, OmniSQL AccessModule for DB2-CICS, MainframeConnect for DB2/MVS-CICS,DirectConnect Access Service, and DirectConnect TRS.

Page 38: MainframeConnect™ for DB2/MVS-CICS Installation and ...

1-12 Understanding Enterprise Connect

Products Used with Enterprise Connect MainframeConnect for DB2/MVS-CICS version 11.1.1

Related IBM Products

Enterprise Connect uses a number of IBM mainframe softwareproducts to allow mainframes to act as clients and servers. The mostimportant of these products are listed in Table 1-9: Related IBMproducts.

Open Server Open Server provides the tools and interfaces needed to create a customserver (called an Open Server application).

Open ServerConnect uses Open Server architecture to allow themainframe to act as a server.

Open ClientConnect clients can send requests to Open Server applicationson the local area network (LAN) through Mainframe Client Connect, ordirectly through Intersystem Communication (ISC) if requests are beingsent to Open ServerConnect in a separate region.

Note: Open ServerConnect and Open ClientConnect are available forCICS, IMS TM, and native MVS.

Replication Server® Replication Server keeps copies of data up-to-date at multiple sites so thatclients can access local data instead of remote, centralized databases.

Replication Agent™ Replication Agent is a functional component of the replication model thatconveys updates made to primary data sources to a Replication Server.

Table 1-9: Related IBM products

Product Description

APPC/LU 6.2(Advanced Program-to-ProgramCommunication facility/Logical Unit Type6.2.)

A program-to-program communication protocol. OpenServerConnect, Open ClientConnect,DB2 Access Module, and MainframeConnect forDB2/MVS-CICS can all use APPC to communicatethrough DirectConnect.

C/370 An application programming language. Open ClientClient-Library is available for C.

CICS(Customer Information Control System)

A transaction monitor on the mainframe. OpenServerConnect, Open ClientConnect, andMainframeConnect for DB2/MVS-CICS are allavailable for CICS.

DB2 (Database 2) A relational database on the mainframe that uses SQL.Enterprise Connect clients can send requests to DB2.

Table 1-8: Related Sybase products (continued)

Product Description

Page 39: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 1-13

MainframeConnect for DB2/MVS-CICS version 11.1.1 Products Used with Enterprise Connect

IMS TM(Information Management SystemTransaction Manager)

A transaction monitor and data communication systemon the mainframe. Open ServerConnect, OpenClientConnect, and the OmniSQL Access Modulefor DB2-CICS are all available for IMS TM.

OS PL/I Version II An application programming language. Open ClientClient-Library and Open Server Gateway-Library areboth available for PL/I.

TCP/IP(Transmission Control Protocol/InternetProtocol)

A communication protocol in general use. OpenServerConnect, Open ClientConnect, the OmniSQLAccess Module for DB2-CICS, and MainframeConnectfor DB2/MVS-CICS, can all use TCP/IP tocommunicate through DirectConnect.

VS COBOL II An application programming language. Open ClientClient-Library and Open Server Gateway-Library areboth available for COBOL.

VTAM(Virtual Telecommunications Access Method)

A mainframe access method used with SNA.Mainframe-based Enterprise Connect products run in aVTAM environment.

Table 1-9: Related IBM products (continued)

Product Description

Page 40: MainframeConnect™ for DB2/MVS-CICS Installation and ...

1-14 Understanding Enterprise Connect

Products Used with Enterprise Connect MainframeConnect for DB2/MVS-CICS version 11.1.1

Page 41: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 2-1

2 Understanding MainframeConnect 2.

MainframeConnect is part of the Sybase Enterprise Connect productset, which consists of mainframe and non-mainframe products.MainframeConnect software provides client applications access toDB2 and other data sources on an IBM mainframe runningMVS/CICS.

MainframeConnect is a unified version of two previous products:

• MDI Access Server for MVS-CICS Version 2.5

• OmniSQL Access Module Version 10.1

This chapter provides an overview of MainframeConnect andcontains the following sections:

• MainframeConnect Functionality 2-1

• MainframeConnect Communication 2-3

MainframeConnect Functionality

MainframeConnect works with DirectConnect, which is a separateSybase product that provides the communication link between amainframe and a remote network of clients. Together, they supportthe features described in the following subsections.

Multiple Connectivity and Protocols

MainframeConnect supports multiple protocols:

• SNA LU 6.2 Connectivity

• TCP/IP Connectivity (for Open Server and DB2), which issupported using the CICS Sockets Interface with the IBM MVSTCP/IP product

Long-Running Transactions

MainframeConnect supports user-defined, long-runningtransactions. Because transactions can remain active after all resultsare sent, multiple requests can participate in the same unit of work.Therefore, you have more control over individual or group commitsor rollbacks on mainframe databases.

Page 42: MainframeConnect™ for DB2/MVS-CICS Installation and ...

2-2 Understanding MainframeConnect

MainframeConnect Functionality MainframeConnect for DB2/MVS-CICS version 11.1.1

Internationalization

MainframeConnect supports the following character sets:

• ascii_8, iso-1

• cp-850

• cp-437, eucjis

• SJIS

• dec-kanji

• roman8 (for HP)

• mac

• cp819 (UNIX ascii iso_1)

• cp500 (mainframe ebcdic iso_1)

In addition, messages are provided in multiple languages. You canspecify a national language, such as U.S. English, French, or German,for messages.

Character Set Customization

MainframeConnect provides character sets that you can customize ifyou want to change languages. You can create up to 99 new charactersets by modifying the shipped base tables.

Access to Relational and Non-Relational Data

In addition to relational data support, MainframeConnect providesaccess to non-relational data through RSPs and RPCs. RSPs requireOpen ServerConnect API. For more information, see the OpenServerConnect Programmer’s Reference. RSP, PL/1, and COBALversions of this guide are available.

Dynamic SQL DB2 Data Access

MainframeConnect supports the following:

• Cursor events and dynamic events

• Updates and inquiries against DB2 data using DB2 dynamic SQL

• Dynamic access to DB2 data and CICS programs

Page 43: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 2-3

MainframeConnect for DB2/MVS-CICS version 11.1.1 MainframeConnect Communication

Non-Truncated Columns

MainframeConnect supports columns for LONG VARCHAR andLONG VARBINARY without truncation. In addition, truncation is notrequired for data returned from datatypes LONG VARCHAR andLONG VARBINARY, if the LONG VARCHAR is greater than 255 bytes.

User Datatypes

Client applications can process user datatypes that returndescriptive information about DB2 columns.

Exit Routines

MainframeConnect provides request exit, result exit, and parse exitroutines.

Other Features

MainframeConnect also supports the following features:

• Translation between DB2 and Sybase datatypes and error codes

• DB2 catalog queries

• 31-digit decimals; MainframeConnect supports the DB2extension to its decimal datatype, DECIMAL(31,31)

• LONG VARCHARs (literal strings greater than 254 bytes) can beembedded in an insert or update language statement

MainframeConnect Communication

This section lists the products MainframeConnect communicateswith and explains the communication path.

Components of MainframeConnect

The MainframeConnect product consists of the transaction AMD2 anduses the Host Request Library DB2 Table, both of which reside on themainframe.

➤ NoteAMD2 was formerly SYRT (Sybase Request Tool) or MDI.

Page 44: MainframeConnect™ for DB2/MVS-CICS Installation and ...

2-4 Understanding MainframeConnect

MainframeConnect Communication MainframeConnect for DB2/MVS-CICS version 11.1.1

Transaction Processor AMD2

AMD2 is the default name of the CICS transaction inMainframeConnect that allows clients to submit SQL statements toDB2.

➤ NoteA separate CICS region with AMD2 installed is required for each DB2

subsystem accessed.

DirectConnect invokes AMD2 when it sends a client SQL request to themainframe. AMD2 then submits the SQL request to DB2, using theDB2 dynamic SQL facility.

AMD2 returns DB2 results and messages to DirectConnect and thenterminates. However, in the case of long transactions or allocate onconnect, AMD2 terminates only after the client explicitly ends thetransaction.

Host Request Library DB2 Table

The host request library is a DB2 table for centrally storing SQLstatements. This library makes the requests available to allDirectConnect users.

MainframeConnect retrieves the specified SQL request from the hostrequest library and submits the request to DB2 for processing.MainframeConnect returns the results of the request to the clientapplication.

Communication with Other Products

MainframeConnect and DirectConnect handle the communicationsbetween the client application, DB2, and other products.

The products discussed in the following sections comprise the majorparts of the communication path from a client to DB2. They affecteither the processing or the content of client requests.

Other Mainframe Products

MainframeConnect interacts with these mainframe products:

• DB2

Page 45: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 2-5

MainframeConnect for DB2/MVS-CICS version 11.1.1 MainframeConnect Communication

• CICS

• MVS

• VTAM and Network Control Program (NCP)

• TCP/IP for MVS

• Resource Access Control Facility (RACF), AdvancedCommunications Function 2 (ACF2), or TopSecret

• SNA LU 6.2

DirectConnect for MVS

Client application requests use DirectConnect to accessMainframeConnect on the mainframe. Client application requestsare initiated by Sybase and third-party, client applications.

Connectivity between DirectConnect and MainframeConnect isachieved using SNA LU 6.2 or TCP/IP connectivity and the TabularData Stream (TDS) protocol. See the DirectConnect for MVSConnectivity Guide for more information.

Client Applications

Client applications send requests to DirectConnect (or to otherservers for forwarding to DirectConnect). Client requests can be sentthrough ODBC, DB-Library, CT-Library, or Open Client applications;for example, isql, Data Workbench, APT Workbench, and front-endproducts from independent software vendors.

DirectConnect provides the link between MainframeConnect andthe clients. Thus, after MainframeConnect is installed andconfigured, the clients do not need to consider communication issueswith MainframeConnect.

Other Servers

OmniConnect, SQL Server, and Replication Server are separateSybase products that work with DirectConnect and can be optionalparts of the MainframeConnect communication path.

MainframeConnect Communication Path

For client access to DB2 data, MainframeConnect must be installedon the mainframe and DirectConnect must be installed on a LAN

Page 46: MainframeConnect™ for DB2/MVS-CICS Installation and ...

2-6 Understanding MainframeConnect

MainframeConnect Communication MainframeConnect for DB2/MVS-CICS version 11.1.1

server. MainframeConnect and DirectConnect work together toprovide DB2 data to clients as follows:

1. A client sends SQL requests to DirectConnect.

2. DirectConnect forwards the requests to the CICS transaction(AMD2) on the mainframe (using SNA or TCP/IP connectivity onthe LAN server).

3. AMD2 processes the client SQL requests using the dynamic SQLcapabilities of DB2.

4. AMD2 returns the DB2 result sets and messages to DirectConnect(using SNA or TCP/IP connectivity on the LAN server).

5. DirectConnect returns the results and messages to the client.

See the following figure for an illustration of this process.

Page 47: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 2-7

MainframeConnect for DB2/MVS-CICS version 11.1.1 MainframeConnect Communication

Figure 2-1: MainframeConnect communication path

Page 48: MainframeConnect™ for DB2/MVS-CICS Installation and ...

2-8 Understanding MainframeConnect

MainframeConnect Communication MainframeConnect for DB2/MVS-CICS version 11.1.1

Page 49: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 3-1

3 Planning Your Installation 3.

Before you install MainframeConnect, you should know what youwill install, understand the installation tasks, and complete apreinstallation checklist. This chapter provides this information inthe following sections:

• What Can You Install with This Product? 3-1

• Installation Task Summary 3-1

• Preinstallation Checklist 3-2

What Can You Install with This Product?

MainframeConnect ships with the following tapes:

• The MainframeConnect tape

• Open ServerConnect for CICS/MVS base tape, which containsfiles for LU 6.2 and TCP/IP environment connections

• The optional Japanese Conversion Module tape

➤ NoteInstructions for installing the Open ServerConnect for CICS/MVS base tape

and the Japanese Conversion Module tape are in the Open ServerConnectfor IBM CICS/MVS Installation and Administration Guide, which ships with

MainframeConnect.

Installation Task Summary

The following table shows the tasks you perform to plan, install, andconfigure MainframeConnect. It also includes the location in thisguide of specific information about each task.

Table 3-1: Installation process

Task Described In

Review the installation tasks and completethe preinstallation checklist.

This chapter

Page 50: MainframeConnect™ for DB2/MVS-CICS Installation and ...

3-2 Planning Your Installation

Preinstallation Checklist MainframeConnect for DB2/MVS-CICS version 11.1.1

Preinstallation Checklist

Before you install any of the MainframeConnect tapes, complete thepreinstallation checklist, which instructs you to check:

1. Personnel requirements

2. System requirements

3. Special system requirements

4. Performance upgrades

5. Mainframe Access Product components

6. Space requirements

7. Connectivity

8. VTAM and NCP definitions

9. CICS configuration

Migrate from OmniSQL Access ModuleVersion 10.1 or MDI Access Server for MVS-CICS Version 2.3 or later.

Chapter 4, “Migrating fromPrevious Installations”

Install the Open ServerConnect forCICS/MVS base tape.

Open ServerConnect for IBMCICS/MVS Installation andAdministration Guide

Install the MainframeConnect tape. Chapter 5, “Installing theMainframeConnect Tape”

Optionally, install the Catalog StoredProcedures (CSPs) for Transaction RouterService Library (TRS).

Chapter 6, “Installing CatalogStored Procedures forTransaction Router Service”

Optionally, install the Japanese ConversionModule.

Open ServerConnect for IBMCICS/MVS Installation andAdministration Guide

Configure MainframeConnect tocommunicate with DirectConnect.

Chapter 7, “ConfiguringMainframeConnect”

Optionally, set up the levels of security withwhich you want to work and coordinatethem with the DirectConnect administrator.

Open ServerConnect for IBMCICS/MVS Installation andAdministration Guide

Table 3-1: Installation process (continued)

Task Described In

Page 51: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 3-3

MainframeConnect for DB2/MVS-CICS version 11.1.1 Preinstallation Checklist

➤ NoteTo determine whether any new release levels or bug fixes of vendor or

Sybase products are required, call Sybase Technical Support (see

“Contacting Sybase Technical Support” on page xix). In addition, you

should consult the latest Release Bulletin for the current information.

The following sections describe each item in the preinstallationchecklist in detail.

Checking the Personnel Requirements

You need the following persons to install the MainframeConnectbase tape.

• A VTAM-knowledgeable person, with the correct authority tomake system changes, who can spend a minimum of an hourduring the installation.

• A DB2 database administrator, with the correct authority to makesystem changes, who can spend a minimum of an hour duringthe installation.

• A security administrator, who may be required if an externalsecurity product inhibits MainframeConnect installation.

• A CICS system programmer, who can perform any necessaryCICS programming tasks.

Checking the System Requirements

Verify that you have the following compatible platform andoperating system components before you install MainframeConnect:

• An OS/390 or MVS/ESA environment running on an IBMSystem/390 mainframe adequate to support CICS and DB2.

• A CICS/VS or CICS/ESA system running on an IBM System/390mainframe.

• A DB2 application running on an IBM System/390 mainframe.

• VTAM running on an IBM System/390 mainframe.

• One of the following versions of NCP:

- NCP, Version 4.5 for 3725 and parallel session support

- NCP, Version 5.2 for 3745 and parallel session support

Page 52: MainframeConnect™ for DB2/MVS-CICS Installation and ...

3-4 Planning Your Installation

Preinstallation Checklist MainframeConnect for DB2/MVS-CICS version 11.1.1

• For DB2 access, DSNC (an IBM transaction that provides DB2access for CICS transactions) must be running in the CICS region.

• For APPC connections, no additional host software is required.

• Up-to-date vendor products.

Checking Special System Requirements

The following may also be required, depending on your systemconfiguration:

• If you are using a channel-attached 3174 model 11L (clustercontroller) and want to use parallel sessions, the following specialrequirements apply:

- VTAM, Version 3.4 or later.

- MVS/ESA.

- Appropriate applied RPQs. Contact IBM for details on thisconfiguration.

- Microcode Level “C”.

- APPN LIC Feature. Contact IBM for appropriate details on thisconfiguration.

➤ NoteIf the channel-attached control unit is not an IBM product (but is a Harris,

McData, or other brand product instead), contact the appropriate vendor for

any special requirements for the unit.

• If your site uses IBM RACF, make sure you have the appropriateupdates to support APPC.

• If your site uses ACF2 or Top Secret security packages fromComputer Associates, we strongly suggest that you contact thevendor before proceeding with your LU 6.2 installation (see theOpen ServerConnect Installation and Administration Guide for IBMCICS/MVS to ensure that you have the release, usermodifications, and fixes necessary to support APPC processing.

• If you are using ACF2 Release 5.2, you need to obtain and applyAPAR UM87688 from Computer Associates.

Page 53: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 3-5

MainframeConnect for DB2/MVS-CICS version 11.1.1 Preinstallation Checklist

Considering Performance Upgrades

On the mainframe, you should run subsystem versions that offer thebest performance. You should upgrade to the latest versions of MVSand CICS. Check with IBM for the latest performance modifications.

Communications can slow down when the mainframe sends largevolumes of data back to the DirectConnect server. The line speedbetween DirectConnect and the mainframe is critical in determiningthe overall transaction throughput.

Using SDLC

Slow and moderate SDLC lines yield low-to-moderate transactionrates. For short and simple queries, SDLC lines of 9.6K, 19.2K, and56K bytes per second typically yield 2–15 concurrent transactions persecond. If you are using SDLC, consider upgrading the SDLC linkspeed or adding more SDLC links.

Using Token Ring

If you need to send large volumes of data or run large numbers ofconcurrent transactions, use a higher speed connection, such as aToken Ring. For example, when you transfer very large amounts ofdata (over 10,000 bps), install a Token Ring LAN connection, througha 3172, 3174, or 3745, to the clients and servers. Before doing this,verify that the vendor’s hardware provides this type of LANsupport.

RU Size

For short transactions, a smaller RU size is more resourceful. Whenyou set the RU size in the CICS Session Definition, make sure youspecify the same size in the VTAM network definition for your TokenRing or in the NCP group definition for your SDLC line.

For controllers such as 3174s, you must set the MAXDATA or the PUand the IFIELD or IFRAME size to be at least as large as the RUSIZEplus the number of bytes needed for headers, such as 1024(RUSIZE) + 9. Using this example, you would set MAXDATA=1033and IFRAME=1033.

If you are usingTCP/IP, skip

this section

If you are usingSDLC, skipthis section

Page 54: MainframeConnect™ for DB2/MVS-CICS Installation and ...

3-6 Planning Your Installation

Preinstallation Checklist MainframeConnect for DB2/MVS-CICS version 11.1.1

Checking the Mainframe Access Components

Verify that you have the compatible mainframe access componentsshown in the following table before you install MainframeConnectfor DB2/MVS-CICS release 11.1.1.

Checking the Space Requirements

Verify that you have the Direct Access Storage Device (DASD)requirement before you install the MainframeConnect tape. ForMainframeConnect, you need 37 tracks on a 3390 disk driver.

Checking Connectivity

This guide assumes the following tasks to check connectivitybetween the mainframe, server, and LAN are complete:

1. For the LAN connection, the server was defined and itsconnectivity was validated on the LAN. The LAN is up andrunning.

2. For the mainframe connection, the SNA LU 6.2 or TCP/IPconnection to the mainframe was defined and tested.

3. For server communications, the communications on the serverside were defined and configured.

4. For LAN communications, the communications on the LAN sidewere defined and tested.

The DirectConnect for MVS Connectivity Guide contains instructionsfor the preceding connectivity steps.

Table 3-2: Mainframe Access components

Component Release Level

Open ServerConnect for CICS/MVS 3.1 or above

Japanese Conversion Module(which is only available upon request)

3.1 or above

DirectConnect for MVS 11.1 or above

Page 55: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 3-7

MainframeConnect for DB2/MVS-CICS version 11.1.1 Preinstallation Checklist

Checking the VTAM and NCP Definitions

This guide assumes the appropriate definitions are included in theVTAM and NCP installations. For details, see the DirectConnect forMVS Connectivity Guide.

Checking the CICS Configuration

Make sure the CICS environmental values are appropriate and theconnection session pairs are set up. For details, see the DirectConnectfor MVS Connectivity Guide.

Page 56: MainframeConnect™ for DB2/MVS-CICS Installation and ...

3-8 Planning Your Installation

Preinstallation Checklist MainframeConnect for DB2/MVS-CICS version 11.1.1

Page 57: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 4-1

4 Migrating from PreviousInstallations 4.

Review this chapter if you are migrating to MainframeConnect fromone of the following products:

• MDI Access Server for MVS-CICS Version 2.3 or later

• OmniSQL Access Module for DB2-CICS Version 10.1

This chapter contains the following sections, which includeinformation about migrating from either of these products:

• Understanding Migration Considerations withMainframeConnect 4-1

• Preparing to Upgrade to MainframeConnect 4-2

Understanding Migration Considerations with MainframeConnect

If you upgrade from MDI Access Server for MVS-CICS or OmniSQLAccess Module for DB2-CICS, you will find the following differencesin MainframeConnect.

New Default Transaction Name

The default transaction name for MainframeConnect for DB2/MVS-CICS release 11.1.1 is AMD2, which replaces the following names:

• MDI for MDI Access Server for MVS-CICS

• SYRT for OmniSQL Access Module for DB2-CICS.

CSAs and RSPs

If you have existing CSAs or RSPs, you must link-edit them with thenew program stubs distributed with Open ClientConnect or OpenServerConnect. See the following guides for more information:

• Open ClientConnect Programmer’s Reference for Client ServicesApplications

• Open ServerConnect Programmer’s Reference for Remote StoredProcedures

Page 58: MainframeConnect™ for DB2/MVS-CICS Installation and ...

4-2 Migrating from Previous Installations

Preparing to Upgrade to MainframeConnect MainframeConnect for DB2/MVS-CICS version 11.1.1

Preparing to Upgrade to MainframeConnect

If your site has a prior release of OmniSQL Access Module for DB2-CICS or MDI Access Server for MVS-CICS, consider removing theold groups and deleting old library members.

➤ NoteOmniSQL Access Module for DB2-CICS or MDI Access Server for MVS-

CICS can run in the same CICS region.

You may also want to add customized messages to the AMD2 messagemodule AMD2CAMX. See Chapter 8, “CustomizingMainframeConnect Messages,” for more information.

➤ NoteThe documentation for each MainframeConnect component is listed in

“Related Documents” on page xvii.

Removing a Prior Product

The Sybase resources defined to CICS during MainframeConnectinstallation are contained in a group. If you want to remove a priorproduct, you can use CEDA (the IBM-supplied transaction forperforming resource definition online) to delete the group, and thenremove the group from your list. Keep the following in mind:

• If you install MainframeConnect on top of an existing product,you do not need to delete groups from a previous release prior toinstallation.

• If previous versions of Open Client/Open Server are installed,you must delete these prior versions before you install the newversions. For more information, see the following guides:

- Open ClientConnect Installation and Administration Guide for IBMCICS/MVS

- Open ServerConnect Installation and Administration for IBMCICS/MVS

Page 59: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 4-3

MainframeConnect for DB2/MVS-CICS version 11.1.1 Preparing to Upgrade to MainframeConnect

The following table lists group names and corresponding productnames from this release and prior releases.

Assigning Library Names

The shipped library names are unique for this release. If youupgrade, determine whether you want to use the existing librarynames at your site. Then, do one of the following:

• To keep old names, back up all files from the prior release of theproduct. If you plan to continue to use the old Sybase librarynames, delete all members after backing them up, and then installthe new members with the new version using the new names.

• To use new names, you do not have to remove previous releasesfrom your Sybase libraries because the default names shippedwith this release are unique. However, you can change the namesto follow naming standards at your site as long as you avoidusing any existing names.

Preserving Customized Messages on AMD2CAMX

Customized messages are a part of the AMD2 message module,AMD2CAMX. Previous mainframe access product releases suppliedmessages through DB2 Version 1.3. Depending on the DB2 version atyour site, consider the following:

Table 4-1: Sybase resources

To Remove this Product Release Delete this Group

Open Server for CICS-APIOpen ServerConnect-API

2.x3.x

SYAPGRP

Open Gateway for DB2 1.0, 2.0 SYCAGRP

Open Client for CICSOpen ClientConnect

1.0, 2.x2.0.x

SYCTGRP

Japanese Conversion Module 2.1, 3.x SYKAGRP

Open Server for CICSOpen ServerConnect for CICS

1.0, 2.x3.x

SYOSGRP

SQL Gateway for DB2 1.0, 2.0 SYRTGRP

Open ServerConnect for TCP/IP 3.x SYTSGRP

Page 60: MainframeConnect™ for DB2/MVS-CICS Installation and ...

4-4 Migrating from Previous Installations

Preparing to Upgrade to MainframeConnect MainframeConnect for DB2/MVS-CICS version 11.1.1

• If your site has not added customized messages (other thanupdating those supplied as standard for DB2 Version 3.1), youcan install MainframeConnect release 11.1.1 without firstpreserving your customized messages.

The MainframeConnect message table includes messagessupplied through DB2 Version 4.1. Customized messages arealways added to the messages supplied by MainframeConnect;they usually do not replace them.

• If your site added customized messages that are not just DB2standard messages, preserve them now if you do not want theinstallation process to overwrite them. You can then add yourcustomized messages to AMD2CAMX message table afterinstalling this release. For more information, see “Adding Entriesfor New SQLCODEs” in Chapter 8, “CustomizingMainframeConnect Messages.”

After you complete and test the upgrade, replace the old LOADLIBname with the new one in the DFHRPL concatenation, which is inthe CICS start-up procedure for that CICS region. These installationsteps are described in the following chapters:

• Base tape installation chapter in the Open ServerConnectInstallation and Administration Guide for IBM CICS/MVS.

• Step 5 in “Installation Steps” on page 5-1 in Chapter 5, “Installingthe MainframeConnect Tape.”

Page 61: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Installing

Page 62: MainframeConnect™ for DB2/MVS-CICS Installation and ...
Page 63: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 5-1

5 Installing the MainframeConnectTape 5.

This chapter contains instructions for installing theMainframeConnect tape.

◆ WARNING!You must install the Open ServerConnect for CICS/MVS base tapebefore you install MainframeConnect. See the Open ServerConnectInstallation and Administration Guide for IBM CICS/MVS forinstructions.

The sections in this chapter are:

• Installation Steps 5-1

• Post-Installation Steps 5-4

• Contents of the MainframeConnect Library 5-6

• What’s Next? 5-9

Installation Steps

A CICS system programmer, a DB2 database administrator, and aDirectConnect administrator are required to successfully install theMainframeConnect tape. Make sure that these persons are preparedto perform their respective tasks.

Before you begin this installation, read all the steps. To help youidentify who is responsible for which steps, margin captions indicatethe type of system programmer or administrator who performs thesteps that follow.

1. Retrieve the JCL that copies the MainframeConnect librariesfrom the tape by entering the following JCL and submitting thejob. You can use the default values or change them to be specific

This is a margincaption

CICS SystemProgrammer

Page 64: MainframeConnect™ for DB2/MVS-CICS Installation and ...

5-2 Installing the MainframeConnect Tape

Installation Steps MainframeConnect for DB2/MVS-CICS version 11.1.1

to your site. A reminder to verify the defaults appears on theright.

//JOBNAME JOB (ACCTNR,ACCTINFO),‘UNLOAD MC’ <== VERIFY//*//* Retrieve the JCL that copies the Sybase libraries from//* the installation tape, MFC111, to disk.//*//GENER EXEC PGM=IEBGENER//SYSPRINT DD SYSOUT=*//SYSIN DD DUMMY//SYSUT1 DD DSN=SYBASE.AMD2111.TAPEJCL,// DISP=(OLD,KEEP),// UNIT=3480, <== VERIFY// LABEL=(1,SL),VOL=SER=MFC111//SYSUT2 DD DSN=SYBASE.AMD2111.CICSDB2.TAPEJCL, <== VERIFY// UNIT=SYSDA,VOL=SER=SYB001, <== VERIFY// DISP=(,CATLG,DELETE),// SPACE=(3120,(10,3))

2. Retrieve MainframeConnect from the tape into DASD by editingand submitting the JCL from the TAPEJCL file you unloaded instep 1. Editing instructions are in the JCL.

3. If the VSAM log files are not defined, define the AMD2 transactionVSAM logfiles by editing and submitting JCL memberAMD2LOG.

◆ WARNING!If you change the logfile default names in step 3, be sure you alsochange the default names in step 4.

4. If you use RDO (Resource Definition Online) to define resourcesat your site, edit and submit CTRL member AMD2RDO3 (forCICS Version 3) or AMD2RDO (for CICS Version 4 or later)according to the instructions contained in the CTRL library. Thisjob defines all Sybase resources to CICS through RDO using theDFHCSDUB utility.

If you do not use RDO to define resources, create the appropriateFCT, PCT, and PPT definitions based on the information in themember AMD2RDO or AMD2RDO3.

5. Edit your CICS start-up procedure, including theMainframeConnect LOADLIB library in the DFHRPL

Page 65: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 5-3

MainframeConnect for DB2/MVS-CICS version 11.1.1 Installation Steps

concatenation. Coordinate with the DB2 database administrator(step 6) before recycling the CICS region (step 12).

➤ NoteIf you plan to install the MainframeConnect Catalog Stored Procedures

(CSPs) for use with TRS, use the installation steps in Chapter 6, ‘‘Installing

Catalog Stored Procedures for Transaction Router Service.’’

➤ NoteThe following steps pertain to DB2 database administration. If you change

default names, be sure the new names conform to your site’s conventions,

particularly for plan names and authorizations.

6. Include AMD2HRCT macro entries from the CTRL library in yourRCT table, generate the table, and stop and start DSNC toactivate these changes

➤ NoteIf you change the default plan names in this step, be sure to use the new

names in step 7.

7. Create a collection ID by issuing the following SQL to DB2 in autility, such as TSO batch or SPUFI:

GRANT PACKADM ON COLLECTION SYAMD2 TOuserid

8. Bind the application plan by running job BINDPLAN in the JCLlibrary, adding a CACHE SIZE of 0 for performance.

➤ NoteThe asterisk and period (*.) before SYAMD2.* in the PKLIST parameter of

the BINDPLAN job may not be required.

9. Bind the AMD2 package by running job BINDPKG in the JCL library.

10. Create a permanent VSAM configuration dataset by modifyingand running job AMD2CFG in the JCL library.

11. Optional. Alter the message table using AMD2CAMX in theSOURCE library as a prototype. Then, assemble and link themessage table using AMD2CAMX from the JCL library.

DB2 DatabaseAdministrator

CICS SystemProgrammer

Page 66: MainframeConnect™ for DB2/MVS-CICS Installation and ...

5-4 Installing the MainframeConnect Tape

Post-Installation Steps MainframeConnect for DB2/MVS-CICS version 11.1.1

For details on changing the message table, see Chapter 8,“Customizing MainframeConnect Messages.”

12. If necessary, recycle your CICS region.

Post-Installation Steps

After you install MainframeConnect, the DB2 data administratorshould perform the post-installation tasks listed in this chapter.These tasks includes:

• Authorizing users for the application plan

• Authorizing users for DB2 packages

• Authorizing users for system tables

• Verifying your installation

Authorizing Users for the Application Plan

All users who will use MainframeConnect to access DB2 must beauthorized to execute the DB2 application plan. This is theapplication plan you created containing all your DB2 packages.

You can grant the privilege to all DB2 users or to specific users. Toissue the GRANT statement, you can use either of the following forms:

GRANT EXECUTE ON PLANplanname TO userid

GRANT EXECUTE ON PLANplanname TO PUBLIC

where planname is the name of the DB2 application plan.

Authorizing Users for DB2 Packages

You must grant EXECUTE authority on the packages you created. Useone of the following forms:

GRANT EXECUTE ON PACKAGE AMD2.* TO userid

GRANT EXECUTE ON PACKAGE AMD2.AMD2DB2 TOuserid

GRANT EXECUTE ON PACKAGE AMD2.* TO PUBLIC

GRANT EXECUTE ON PACKAGE AMD2.AMD2DB2 TO PUBLIC

Page 67: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 5-5

MainframeConnect for DB2/MVS-CICS version 11.1.1 Post-Installation Steps

Authorizing Users for System Tables

If the DirectConnect for MVS users need to access cataloginformation from system tables and you are using catalog storedprocedures (CSPs), then you must authorize users to select from thefollowing tables:

• SYSIBM.SYSCOLAUTH

• SYSIBM.SYSCOLUMNS

• SYSIBM.SYSDATABASE

• SYSIBM.FOREIGNKEYS

• SYSIBM.SYSINDEXES

• SYSIBM.SYSKEYS

• SYSIBM.SYSRELS

• SYSIBM.SYSSYNONYMS

• SYSIBM.SYSTABAUTH

• SYSIBM.SYSTABLES

Some front-end applications access these system tables directly.See the application documentation for more information.

Additionally, all users accessing DB2 must be granted theappropriate authorizations on the tables they will use.

Verifying Your Installation

Before you configure MainframeConnect, verify that the linkbetween MainframeConnect and DB2 is functioning correctly byaccessing MainframeConnect. To do this, sign on to CICS, clear thescreen, and enter:

AMD2

You should receive a message similar to the following:

MainframeConnect for DB2/MVS-CICS/11.1.1 (CRS 50)DB2 test successful

If AMD2 cannot access DB2, a message appears showing the DB2SQLCODE; for example:

MainframeConnect for DB2/MVS-CICS/11.1.1 (CRS 50)DB2 Error was detected the SQL code is -805

See your DB2 manuals for definitions of SQL codes.

Page 68: MainframeConnect™ for DB2/MVS-CICS Installation and ...

5-6 Installing the MainframeConnect Tape

Contents of the MainframeConnect Library MainframeConnect for DB2/MVS-CICS version 11.1.1

Contents of the MainframeConnect Library

Tables 5-1 through 5-7 describe the contents of the libraries you loadfrom the MainframeConnect tape. Step numbers that appear inparentheses indicate steps in this chapter in which members from aparticular library are used.

COPY Library

The COPY library contains the COBOL copybook.

CTRL Library

The CTRL library contains macro definitions for files, transactions,programs, and plans for AMD2 to CICS. It also contains SPUFI inputstatements (step 4 in “Installation Steps” on page 5-1 and step 6 in“Installation Steps” on page 5-1).

Table 5-1: COPY library

Member Description

AMD2CCPX COBOL copybook for the parse exit routine

Table 5-2: CTRL library

Member Description

AMD2HRCT CICS macro definitions for the AMD2 plans (if youchange the plan names, you must edit this member)

AMD2RDO RDO definitions for CICS Version 4.x

AMD2RDO3 RDO definitions for CICS Version 3.x

CREATPKG DB2 statement for creating a collection ID

HOSTLIB Script for creating the host resident request library

SPPROC Script for creating the sp_proc and sp_proc_columns tablesfor the corresponding CSPs

Page 69: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 5-7

MainframeConnect for DB2/MVS-CICS version 11.1.1 Contents of the MainframeConnect Library

DBRM Library

The DBRM library contains member AMD2DB2, which the jobBINDPLAN in the JCL library binds into a package in DB2.

JCL Library

The JCL library contains JCL for performing various functions whileinstalling the MainframeConnect tape (step 3 on “Installation Steps”on page 5-1 and steps 8, 9, and 10 in “Installation Steps” on page 5-1).

LOADLIB Library

The LOADLIB library contains pregenerated tables and programsfor error messages.

Table 5-3: DBRM library

Member Description

AMD2DB2 DBRMS for AMD2

Table 5-4: JCL library

Member Description

AMD2CFG JCL for defining the configuration file

AMD2CAMX JCL to assemble the AMD2 message table

AMD2LOG JCL to define the AMD2 log files

AMD2PXIT JCL to compile and link AMD2CCPX, found in theSOURCE library

BINDPKG JCL for binding packages

BINDPLAN JCL for binding plans

CSDLOAD JCL for loading the RDO definitions

TRSJCL JCL for loading the TRS files from the tape

Table 5-5: LOADLIB library

Member Description

AMD2ACE Required for pre-CICS 3.3 for group ID support

Page 70: MainframeConnect™ for DB2/MVS-CICS Installation and ...

5-8 Installing the MainframeConnect Tape

Contents of the MainframeConnect Library MainframeConnect for DB2/MVS-CICS version 11.1.1

MACLIB Library

The MACLIB library contains macros for working with message textand SQL codes.

AMD2ACF2 ACF2 group ID support

AMD2CAMX AMD2 message table

AMD2CFG Configuration program

AMD2CHAB Abend handler

AMD2CICS AMD2 program

AMD2DSN Error handler for AMD2

AMD2M01 AMCF configuration map

AMD2RACF RACF group ID support

AMD2SPM Map for SPTEST

AMD2SPT SPTEST program for testing RSPs

AMD2TOP Top Secret group ID support

Table 5-6: MACLIB library

Member Description

EXITAREA Macro for request and result exits

SYRTMAMT AMD2 macro for message text

SYRTMAMX AMD2 macro for message attributes and SQL codes

Table 5-5: LOADLIB library

Member Description

Page 71: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 5-9

MainframeConnect for DB2/MVS-CICS version 11.1.1 What’s Next?

SOURCE Library

The SOURCE library contains a sample COBOL program and theassembler source for the AMD2 message table (step 11 in “InstallationSteps” on page 5-1).

What’s Next?

If you need to install the CSPs for use with TRS, proceed to Chapter6, ‘‘Installing Catalog Stored Procedures for Transaction RouterService.’’

If you need to install the Japanese Conversion Module, proceed tothe Open ServerConnect Installation and Administration Guide for IBMCICS/MVS.

If you are ready to configure MainframeConnect, proceed to Chapter7, ‘‘Configuring MainframeConnect.’’

Table 5-7: SOURCE library

Member Description

AMD2CAMX Assembler source for AMD2 message table

AMD2PXIT Sample COBOL program using the AMD2 parse exit

Page 72: MainframeConnect™ for DB2/MVS-CICS Installation and ...

5-10 Installing the MainframeConnect Tape

What’s Next? MainframeConnect for DB2/MVS-CICS version 11.1.1

Page 73: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 6-1

6 Installing Catalog Stored Proceduresfor Transaction Router Service 6.

Complete the steps in this chapter only if you plan to use theMainframeConnect CSPs for use with TRS. The MainframeConnectinstallation tape contains Sybase-defined tables that store requestedCSP information that is not available in the DB2 catalog.

This chapter contains the following sections:

• Installation Steps 6-1

• Contents of the MainframeConnect TRS Library 6-3

Installation Steps

A CICS systems programmer, a DB2 database administrator, and aDirectConnect administrator are required to successfully install theTRS CSPs from the MainframeConnect tape. Make sure that thesepersons are prepared to perform their respective tasks.

Before you begin this installation, read all the steps. To help youidentify who is responsible for which steps, margin captions indicatethe type of systems programmer or administrator who performs thesteps that follow.

1. Retrieve the TRS CSP libraries from the tape onto DASD byediting and submitting the TRSJCL file from the JCL youunloaded in step 1 in “Installation Steps” on page 5-1. Editinginstructions are in the JCL.

2. If you use RDO (Resource Definition Online) to define resourcesat your site, edit and submit TRSJCL member, TRSCSD, in theSYBASE.AMD2111.CICSDB2.TRS.JCL library. This job defines allTRS resources to CICS through RDO using the DFHCSDUP utility.

If you do not use RDO to define resources, create the appropriateFCT, PCT, and PPT definitions based on the information in themember TRSCSD in the TRSCTRL library.

3. Edit your CICS start-up procedure, including theMainframeConnect TRS.LOADLIB library in the DFHRPLconcatenation. Coordinate with the DB2 database administrator(step 4) before recycling the CICS region (step 8).

If you are notusing TRS, skip

to the nextchapter

This is a margincaption

CICS SystemProgrammer

Page 74: MainframeConnect™ for DB2/MVS-CICS Installation and ...

6-2 Installing Catalog Stored Procedures for Transaction Router Service

Installation Steps MainframeConnect for DB2/MVS-CICS version 11.1.1

➤ NoteThe following steps pertain to DB2 database administration. If you change

default names, be sure the new names conform to your site’s conventions,

particularly for plan names and authorizations.

4. Include TRSRCT macro entries from the TRS.CTRL library in yourRCT table, generate the table, and stop and start DSNC toactivate these changes.

➤ NoteIf you change the default plan names in this step, be sure to use the new

names in step 7.

5. Use member TRSDROP in the TRS.CTRL library as input toSPUFI to drop the tables and views (which you create in the nextstep).

6. Create tables and views for the CSPs as input to SPUFI usingmember TRSCREAT or TRSCREA2 in the TRS.CTRL library. Thefollowing helps you decide the member to use:

- TRSCREAT checks whether the current user has someprivilege on a requested object using the current sqlid. If thecurrent sqlid does not have permissions, granted eitherexplicitly or to PUBLIC, then the CSPs do not return information.

- TRSCREA2 enables faster CSP processing because it does notcheck that the current user has some privilege on a requestedobject. However, the implications are:

a) Anyone who can execute the CSP can obtain informationabout all DB2 objects, even if that user does not have privilegeson those objects.

b) accessible_table in sp_server_info is ineffective.

c) The default owner names apply. For example, if you omittable owner, the default is still the current sqlid.

If you find it necessary to rerun TRSCREAT or TRSCREA2, useTRSDROP first.

7. Bind the application plan by running job TRSBIND in the JCLlibrary, adding a CACHE SIZE of 0 for performance.

8. If necessary, recycle your CICS region.

DB2 DatabaseAdministrator

CICS SystemProgrammer

Page 75: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 6-3

MainframeConnect for DB2/MVS-CICS version 11.1.1 Contents of the MainframeConnect TRS Library

9. To test the installation on the LAN, from TRS, execute CSPs. Formore information, see the DirectConnect Transaction Router ServiceUser’s Guide.

Contents of the MainframeConnect TRS Library

Tables 6-1 through 6-4 describe the contents of the TRS libraries youload from the MainframeConnect tape. Step numbers that appear inparentheses indicate steps in this chapter in which members from aparticular library are used.

TRS.CTRL Library

The TRS.CTRL library contains macro definitions for files,transactions, programs, and plans for TRS to CICS. It also containsSPUFI input statements (steps 4, 5, and 6 on “Installation Steps” onpage 6-1).

Table 6-1: TRSCTRL library

Member Function

TRSCREAT For sites that require restricted access to the DB2 catalog,SPUFI input statements that create the views and tables thatthe CSP uses. If you do not require this restriction, useTRSCREA2.

TRSCREA2 For sites that do not require restricted access to the DB2catalog, SPUFI input statements to create the views and tablesthe that CSP program uses. If you do require restricted access,use TRSCREAT.

TRSCSD The CSD data for the TRSCSD job in TRSJCL.

TRSDROP SPUFI input statements to drop the tables and views created inmember TRSCREAT or TRSCREA2.

TRSGRANT SPUFI input statements to grant execute authority to CSPs,which use SYB1PLAN. If you change the plan names, youmust edit this member.

TRSRCT The CICS macro definitions for the CSP and AMD2 plans. If youchange the plan names, you must edit this member.

DirectConnectAdministrator

Page 76: MainframeConnect™ for DB2/MVS-CICS Installation and ...

6-4 Installing Catalog Stored Procedures for Transaction Router Service

Contents of the MainframeConnect TRS Library MainframeConnect for DB2/MVS-CICS version 11.1.1

TRS.DBRM Library

The DBRM library contains members that are bound intoSYB1PLAN, which the job TRSBIND in the TRS.JCL library(BINDTRS member in library DWM.AMD2.V043.CNTL) binds intoa package in step 5 in “Installation Steps” on page 6-1.

Table 6-2: TRS.DBRM library

Member Function

SYBACO00 A DB2 CSP DBRM

SYBACO01 A DB2 CSP DBRM

SYBACP00 A DB2 CSP DBRM

SYBADB00 A DB2 CSP DBRM

SYBADT00 A DB2 CSP DBRM

SYBAFK00 A DB2 CSP DBRM

SYBAGNAM A DB2 CSP DBRM

SYBAPK00 A DB2 CSP DBRM

SYBASC00 A DB2 CSP DBRM

SYBASI00 A DB2 CSP DBRM

SYBASL00 A DB2 CSP DBRM

SYBASP00 A DB2 CSP DBRM

SYBAST00 A DB2 CSP DBRM

SYBATB00 A DB2 CSP DBRM

SYBATB01 A DB2 CSP DBRM

SYBATB02 A DB2 CSP DBRM

SYBATP00 A DB2 CSP DBRM

Page 77: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 6-5

MainframeConnect for DB2/MVS-CICS version 11.1.1 What’s Next?

TRS.JCL Library

The TRSJCL library contains JCL for performing various functionswhile installing the MainframeConnect tape (step 2 in “InstallationSteps” on page 6-1).

TRS.LOAD Library

The TRS.LOAD library contains pregenerated tables and programsfor error messages (step 3 in “Installation Steps” on page 6-1).

What’s Next?

If you need to install the Japanese Conversion Model, proceed to theOpen ServerConnect Installation and Administration Guide for IBMCICS/MVS.

If you are ready to configure MainframeConnect, proceed to Chapter7, ‘‘Configuring MainframeConnect.’’

Table 6-3: TRS.JCL library

Member Function

TRSBIND JCL to bind the CSP and AMD2 plans

TRSCSD JCL to load the CSD with the RDO definitions

Table 6-4: TRS.LOAD library

Member Function

SYBCAPAB The sp_capabilities CSP program

SYBTHRED The sp_thread_props CSP program

SYCACERR The error handler for CSPs

SYCACPGM The CSP program

Page 78: MainframeConnect™ for DB2/MVS-CICS Installation and ...

6-6 Installing Catalog Stored Procedures for Transaction Router Service

What’s Next? MainframeConnect for DB2/MVS-CICS version 11.1.1

Page 79: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Configuring &Customizing

Page 80: MainframeConnect™ for DB2/MVS-CICS Installation and ...
Page 81: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 7-1

7 Configuring MainframeConnect 7.

After you install the MainframeConnect tapes and complete thepost-installation tasks, you are ready to configureMainframeConnect for your site. This chapter summarizes thechanges you make to enable communication betweenMainframeConnect and DirectConnect. The sections in this chapterare:

• Changing the MainframeConnect Configuration 7-1

• Understanding the Configuration Properties 7-3

• What’s Next? 7-7

Changing the MainframeConnect Configuration

Use the MainframeConnect Configuration Tran ID Selection screenand the MainframeConnect Configuration screens to alter theMainframeConnect configuration settings, as necessary. The settingsare automatically saved in the configuration dataset.

➤ NoteWhen you change configuration properties in the MainframeConnect

Configuration screen, the new values remain in effect until they are

changed again.

To change the MainframeConnect configuration settings, followthese steps:

1. From a 3270 screen, sign on to CICS, clear the screen, and enterthe following command:

AMCF

The MainframeConnect Configuration Tran ID Selection screenappears as shown in Figure 7-1. This screen enables you to selectthe transaction ID for which you want to change theconfiguration or it begins the process of configuring a newtransaction ID.

Page 82: MainframeConnect™ for DB2/MVS-CICS Installation and ...

7-2 Configuring MainframeConnect

Changing the MainframeConnect Configuration MainframeConnect for DB2/MVS-CICS version 11.1.1

Figure 7-1: MainframeConnect Configuration Tran ID Selection screen

➤ NoteThe first time the previous screen appears, no Profile Name entries appear.

2. Either select the transaction ID from the list and press Enter, orpress F4 to add a new transaction ID.

The MainframeConnect Configuration screen appears as shownin Figure 7-2:

Page 83: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 7-3

MainframeConnect for DB2/MVS-CICS version 11.1.1 Understanding the Configuration Properties

Figure 7-2: MainframeConnect Configuration screen

3. Change the settings to the values you prefer (as explained in“Understanding the Configuration Properties”), and press Enter.

➤ NoteWhen you add a new transaction ID, the Transaction ID field is blank.

You must enter a 4-character transaction ID in the Transaction ID box.

Understanding the Configuration Properties

This section describes the configuration properties you can set in theMainframeConnect Configuration screen.

Transaction ID

The Transaction ID is the tran id that you selected in theMainframeConnect Configuration Tran ID Selection screen in step 1

Page 84: MainframeConnect™ for DB2/MVS-CICS Installation and ...

7-4 Configuring MainframeConnect

Understanding the Configuration Properties MainframeConnect for DB2/MVS-CICS version 11.1.1

or, if you are adding a transaction ID, it is blank so that you can fill itin.

Request exit name

The Request exit name specifies the name of the request validation exitprogram. The name can contain up to eight characters.

If a request validation exit program does not exist, specify NONE (thedefault).

For more information, see “Request/Result Validation Exits” inChapter 9, “User Exits.”

Result exit name

The Result exit name specifies the name of the result validation exitprogram. The name can contain up to eight characters.

If a result validation exit program does not exist, specify NONE (thedefault).

For more information, see “Request/Result Validation Exits” inChapter 9, “User Exits.”

Parse exit name

The Parse exit name identifies the CICS program to be linked to fromAMD2 as a parse exit routine. The name can contain up to eightcharacters.

If a parse exit routine does not exist, specify NONE (the default).

For more information, see “Parse Exit Routine” in Chapter 9, “UserExits.”

Group ID exit name

The Group ID exit name is used by CSPs to supply them with all of theuser’s group IDs. The CSPs then reflect the true authorizations of theuser. If you are using the RACF, ACF2, or Top Secret securitypackages (see the Open ServerConnect for IBM CICS/MVS Installationand Administration Guide for information about security), use one ofthe supplied exits. If you are not using one of these security

Page 85: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 7-5

MainframeConnect for DB2/MVS-CICS version 11.1.1 Understanding the Configuration Properties

packages, you can write an exit program to build a list of group IDsas input to CSPs.

We provide the following Group ID exit names for RACF, Top Secret,and ACF2:

• AMD2RACF for RACF

• AMD2TS for Top Secret

• AMD2ACF2 for ACF2

In addition, you can specify either the name of a user-written exit orNONE (the default).

For information about building an exit program, see “Getting Readyto Code Your Routine” in Chapter 9, “User Exits.”

Host request library ID

The Host request library ID specifies the qualifier used for the AMD2-HOSTLIB table. The qualifier name can contain up to 25 characters.The default is SYBASE.

Temp storage queue type

This option indicates the temporary storage queues to be used forresults being sent to the client. Specify one of the settings shown inthe following table.

Table 7-1: Types of temporary storage queues

Setting Type ofStorage MainframeConnect for DB2 Action and Note

MAIN Main Writes all results to main temporary storagebefore sending them to the client. After the resultis sent, temporary storage queues are deletedunless the mainframe debug option is set on theLAN using the LAN set command.

AUX Auxiliary See the action and notes for the MAIN setting,except that the auxiliary temporary storage isused.

Page 86: MainframeConnect™ for DB2/MVS-CICS Installation and ...

7-6 Configuring MainframeConnect

Understanding the Configuration Properties MainframeConnect for DB2/MVS-CICS version 11.1.1

Estimating Temporary Storage

The amount of temporary storage required is determined by the sizeof the result set to be returned. For example, if 150,000 rows of1200 bytes are to be returned, 180,000,000 bytes of temporary storageare required to hold the result set.

• If Temp storage queue type is set to MAIN, this storage must beavailable in main memory.

• If Temp storage queue type is set to AUX, this storage must beavailable on DASD.

Determining Main Memory Storage

In addition, CICS keeps an 8-byte temporary storage ID in mainmemory for each temporary storage record written to either mainmemory or DASD (auxiliary storage). Use the following algorithm todetermine the number of bytes of main memory storage you need:

• The block size divided by the record size equals the number ofrecords per block.

• The number of records divided by the number of records perblock equals the number of blocks written to temporary storage.

NONE

Note:Temporarystorage isonly usedfor datagoing to aclient.

None(default)

Sends results to the client without writing them totemporary storage. This decreases the result waitand the overall transmission time, especially forlarge transfer operations. This setting also savestemporary storage space, which would be neededfor results.

This setting has the following disadvantages:

• If a processing error occurs, data has alreadybeen sent to the client.

• This setting cannot be used with a result exit.

• When accessing DB2, DB2 threads and localscan be held longer because they are allocatedfor the time required to transmit the results overthe APPC link, rather than the time required towrite the results to temporary storage.

Table 7-1: Types of temporary storage queues (continued)

Setting Type ofStorage MainframeConnect for DB2 Action and Note

Page 87: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 7-7

MainframeConnect for DB2/MVS-CICS version 11.1.1 What’s Next?

• The number of blocks written to temporary storage multiplied bythe 8-byte storage ID equals the number of bytes of main storage.

For example:

1. 4096 bytes (block size) divided by 200 bytes (record size) equals20 records per block.

2. 150,000 records divided by 20 records per block equals7500 blocks written to temporary storage.

3. 7500 blocks written to temporary storage multiplied by 8 bytesequals 60,000 bytes of main storage.

The amount of temporary storage required for each concurrent usecan be determined by the following formula:

# rows * size of each row (# bytes for results - main/aux)+ # bytes of main storage (determined in algorithm above)______________________________ # bytes required for each user

For example, if multiple users request 150,000 rows concurrently,then temporary storage and main memory requirements must bemultiplied by the number of concurrent users.

DateTime results type

The DateTime results type option specifies the format thatMainframeConnect uses to return DB2 timestamps, time, and dateresult columns to TRS only. Two values are valid:

• DB2 (the default) returns timestamps in the standard DB2timestamp format of YYYY-MM-DD-HH.MM.SS.ssssss, whereYYYY is the year, MM is the month, DD is the day, HH is the hour,MM is the minute, SS.ssssss is the number of seconds. Forexample, a DB2 value might return 1996-12-31-11.42.22.123456.

• TRO returns timestamps in a format that is compatible withOmniConnect communication with DirectConnect TransactionRouter Service (or Net-Gateway Version 3.0.1) usingOmniConnect’s Access Server Class. TRO format is YYYYMMDDHH:MM:SS:ss, where the abbreviations are similar to the DB2abbreviations. Using the example from the DB2 value, the TROvalue returns 19961231 11:42:22:12.

What’s Next?

You have finished installing and configuring MainframeConnect.

Page 88: MainframeConnect™ for DB2/MVS-CICS Installation and ...

7-8 Configuring MainframeConnect

What’s Next? MainframeConnect for DB2/MVS-CICS version 11.1.1

If you want to change the message table that was installed withMainframeConnect, see Chapter 8, “CustomizingMainframeConnect Messages.”

If you want to read more information about the request and resultexits and the parse exit routine, see Chapter 9, “User Exits.”

Page 89: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 8-1

8 Customizing MainframeConnectMessages 8.

The AMD2 message table in MainframeConnect determines themessages returned to the client application. You can modify the AMD2message table to customize messages using single-byte character sets(SBCSs) for your site or to accommodate new SQLCODEs generatedby updated versions of DB2.

➤ NoteYou cannot customize Japanese or other double-byte character set (DBCS)

languages, which are handled by the Japanese Conversion Module. For

more information, see the installation chapter for the Japanese Conversion

Module in the Open ServerConnect Installation and Administration Guidefor IBM CICS/MVS.

This chapter describes the AMD2 message table and explains how tomake changes and additions to the existing messages. It includes thefollowing sections:

• Understanding the AMD2 Message Table 8-1

• Changing the AMD2 Message Table 8-7

• Coding AMD2 Message Table Changes 8-11

Understanding the AMD2 Message Table

The AMD2 message table consists of two separate tables that share acommon property: the message number. The tables function togetherto return messages to the client.

• The translate table associates DB2 SQLCODEs with messagenumbers and sets the attributes of errors.

You can edit the translate table to add messages or to changetheir attributes. (Attributes include the message number, theerror severity, and so on.) As shipped, the AMD2 message tablecontains entries for SQLCODEs returned by version 3.1 of DB2.

• The text table associates message numbers with message text.You can edit the text table to change the text of messages. You canalso expand it to provide message text in additional languages.Message text for U.S. English, German, and French is providedwith the product.

Page 90: MainframeConnect™ for DB2/MVS-CICS Installation and ...

8-2 Customizing MainframeConnect Messages

Understanding the AMD2 Message Table MainframeConnect for DB2/MVS-CICS version 11.1.1

The AMD2 message table is generated during installation as onemodule, AMD2CAMX, which contains all the AMD2 messages andmessage attributes. AMD2CAMX is built with two macros,SYRTMAMX and SYRTMAMT, and it is composed of two CSECTS,SYRTMAMX and SYRTMAMT. The following table shows themembers of the translate and text tables.

Translate Table

The translate table is the first table used in processing AMD2 messages.When DB2 returns a SQLCODE, AMD2 searches the translate table bythe SQLCODE to determine the resulting output message number(MSGNR) and other attributes associated with the SQLCODE. Fornon-DB2 errors, AMD2 searches the translate table by MSGNR todetermine the other message attributes associated with the error.

Example of Translate Table Source Code

The editable SOURCE library member (AMD2CAMX) of thetranslate table contains a series of SYRTMAMX macro entries, such asthose shown in the following example:

SYRTMAMX TYPE=ENTRY, * SQLCODE=+802, * MSGNR=30001, * LEVEL=11, * STATEC=22, * STATESC=3, * LOG=N, * SQLFATAL=N

*

Table 8-1: Message table members

Message Table LOAD Module MACRO Library SOURCE Library

Translate table AMD2CAMX SYRTMAMX AMD2CAMX

Text table AMD2CAMX SYRTMAMT AMD2CAMX

Page 91: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 8-3

MainframeConnect for DB2/MVS-CICS version 11.1.1 Understanding the AMD2 Message Table

SYRTMAMX TYPE=ENTRY, * SQLCODE=-007, * MSGNR=102, * LEVEL=11, * STATEC=31, * STATESC=503, * LOG=N, * SQLFATAL=N

Translate Table Properties

Each SYRTMAMX macro entry in the translate table consists of thefollowing DB2 error message properties.

TYPE

The TYPE property indicates whether the SYRTMAMX macro entry isthe initial (INITIAL) or final (FINAL) entry in the translate table, or is oneof the entries in between (ENTRY). Therefore, TYPE=INITIAL occursonce at the beginning of the translate table; TYPE=FINAL occurs onceat the end of the table. Examples of the TYPE=INITIAL and TYPE=FINALare shown as follows:

SYRTMAMX TYPE=INITIAL... (additional entries not shown)

SYRTMAMX TYPE=FINAL

◆ WARNING!Do not change the INITIAL or FINAL value.

SQLCODE

The SQLCODE property contains the SQLCODE, a numeric statusindicator returned by DB2. For messages that DB2 does not generate,such as internal error messages that AMD2 generates, this value isalways 0. This property contains three digits and a plus (+) or minus(-) sign.

MSGNR

The text table uses the message number to identify the appropriatemessage to send to the client. It represents a single SQLCODE or agroup of SQLCODEs about similar situations.

Page 92: MainframeConnect™ for DB2/MVS-CICS Installation and ...

8-4 Customizing MainframeConnect Messages

Understanding the AMD2 Message Table MainframeConnect for DB2/MVS-CICS version 11.1.1

◆ WARNING!Do not change the number of non-DB2 messages (those withSQLCODE equal to 0 and MSGNR greater than or equal to 32000).

LEVEL

The LEVEL property indicates the severity of the error. Itcorresponds to the following SQL Server severity levels:

01–10 Status information11–16 Client application errors17–18 Non-fatal software or hardware errors19–24 Fatal system errors

STATEC

The STATEC class property, a 2-byte field, provides moreinformation about DB2 errors. For non-DB2 errors, the value is 0.

STATESC

The STATESC subclass property, a 3-byte field, provides moreinformation about DB2 errors. For non-DB2 errors, the value is 0.

LOG

The LOG (logging instruction) property indicates whether to log theerror in the AMD2LOG file. We recommend logging serious errors.To turn logging on, specify the Y value. To turn logging off, specifythe N value.

SQLFATAL

The SQLFATAL (fatal error) property indicates whether AMD2 acceptsmore client requests in the current invocation. Y means that yes, theerror is fatal, and therefore, no further requests are accepted from thecurrent client connection. N means that no, the error is not fatal andrequests are processed as usual.

Text Table

The text table is the part of the AMD2 message table that determinesthe text of a message by connecting message text with messagenumbers. For each language, there is a message number and

Page 93: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 8-5

MainframeConnect for DB2/MVS-CICS version 11.1.1 Understanding the AMD2 Message Table

associated text that corresponds to each message number in thetranslate table. After translate table processing, AMD2 searches thetext table by language and message number to determine themessage text to send to the client.

Example of Text Table Source Code

The editable SOURCE library member AMD2CAMX in the text tablecontains a series of SYRTMAMT entries, one for each language. EachSYRTMAMT entry contains a listing of message numbers andassociated text.

Portions of the text table are shown in the following example:

* Message text **-------------------------------------------------* SYRTMAMT TYPE=INITIAL* SYRTMAMT TYPE=ENTRY,LANG=us_english, * 102,'Incorrect syntax (DB2 %s failed: %S)', * 103,'String is too long (DB2 %s failed: %S)', * 105,'Unclosed quote (DB2 %s failed: %S)', * ... (additional entries not shown)* SYRTMAMT TYPE=ENTRY,LANG=german, * 102,'Falsche Syntax (DB2 %s * fehlgeschlagen: %S)', * 103,'Zeichenkette zu lang (DB2 %s * fehlgeschlagen:%S)', * 105,'Schlieendes Anfhrungszeichen fehlt * (DB2 %s * fehlgeschlagen:%S)', *

... (additional entries not shown)* SYRTMAMT TYPE=ENTRY,LANG=french, * 102,'Syntaxe incorrecte (chec de DB2 %s : %S)',* 103,'Chane trop longue (chec de DB2 %s : %S)', * 105,'Guillemet fermant manquant(chec de DB2 * %s :%S)', *

... (additional entries not shown)* SYRTMAMT TYPE=FINAL

National Languages

As shipped, the text table contains SYRTMAMT entries to supplymessage text in three languages: U.S. English, German, and French.

Page 94: MainframeConnect™ for DB2/MVS-CICS Installation and ...

8-6 Customizing MainframeConnect Messages

Understanding the AMD2 Message Table MainframeConnect for DB2/MVS-CICS version 11.1.1

Each SYRTMAMT entry contains a complete set of messages in thelanguage specified by the LANG= property located in the first line ofthe entry.

If the text table does not contain a LANG= property to match thelanguage identification passed to AMD2, the default is the U. S.English message set. For information about how languages aredefined, see the customization options appendix in the OpenServerConnect Installation and Administration Guide for IBM CICS/MVSand the DirectConnect documentation.

➤ NoteA default message (“Error 33231” on page A-70) returns whenever a

problem with the AMD2 message table occurs. This message is always sent

in U.S. English, regardless of the text coded in the text table.

Message Variable Indicators

The message the client application receives contains the wordsspecified in the text table and, in some cases, the contents of one ormore variable indicators: %s, %d, and %S. The words and thevariables are specified in the text table.

AMD2 supplies the content of the message variable indicators before amessage is returned to the client. Regardless of the language of themessage text, the content of the variables is always in U.S. English.

AMD2 replaces the variable indicators with the variable values shownin the following table.

Table 8-2: Message variable indicators and values

Message VariableIndicator Replaced by Message Variable Value

%s String message variable value indicating the DB2 functionlast executed, usually PREPARE.

%d Numeric message variable value used for any integervalues, such as an error number or the position of an error.

%S Messages returned by DB2 routine DSNTIAR, includingSQLCA message tokens and SQLCODEs.

Page 95: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 8-7

MainframeConnect for DB2/MVS-CICS version 11.1.1 Changing the AMD2 Message Table

Changing the AMD2 Message Table

You can customize and update AMD2 messages by changing the AMD2message table. For example, you can:

• Add entries for new SQLCODEs

• Add or change messages for a parse exit routine

• Customize message text

• Eliminate messages

• Change message logging

Adding Entries for New SQLCODEs

DB2 versions later than 4.1 return SQLCODEs withoutcorresponding entries in the translate table. In this circumstance,AMD2 assigns a generic error message (“Error 33231” on page A-70)and sends the associated text from the text table for that messagenumber. To provide clients with more than the generic message, addnew entries to the AMD2 message table for each new DB2 SQLCODE.

There are two options for translating new SQLCODEs to clientmessages. New SQLCODEs can be:

• Mapped to existing MainframeConnect messages (“Error 30000”on page A-48, “Error 30001” on page A-49, and “Error 30002” onpage A-50)

• Mapped to messages that correspond to SQL Server messages.These SQL Server messages may exist in the AMD2 message table,or you may need to create new entries for these messages.

The changes to the AMD2 message table for the preceding two optionsare shown in the following table.

Table 8-3: Adding entries for new SQLCODEs

Option Message Number(MSGNO=)

Translate TableChanges

Text TableChanges

For Coding theChanges, See

Map to existingMainframe-Connectmessages.

Assign number byseverity level:30000–Error30001–Warning30002–Confirmation.

Add anSYRTMAMX entryfor each newmessage.

No change. “Adding aTranslate TableEntry” on page8-11.

Page 96: MainframeConnect™ for DB2/MVS-CICS Installation and ...

8-8 Customizing MainframeConnect Messages

Changing the AMD2 Message Table MainframeConnect for DB2/MVS-CICS version 11.1.1

Adding or Changing Messages for a Parse Exit Routine

If you customize MainframeConnect by adding a parse exit routine,you can add additional messages to the AMD2 message table to reporton the processing of your routine. A sample parse exit routine shipswith MainframeConnect with a corresponding message number33400 (“Error 33400” on page A-86) in the AMD2 message table.

You can modify the sample routine entries in the translate and texttables or you can create new entries. The changes to the AMD2message table for these two options are shown in the following table.

Map to SQLServer messages.

Use correspondingSQL Server messagenumber.

Add anSYRTMAMX entryfor each newmessage.

• If message isalready in texttable, no changeis needed.

• If message is notin text table, addthe messagenumber and thetext of SQLServer messageto SYRTMAMTentry for eachlanguage in use.

“Adding aTranslate TableEntry” on page8-11.

“Adding aMessage to theText Table” onpage 8-13

Table 8-4: Adding or changing messages for a parse exit routine

Option Message Number(MSGNO=)

Translate TableChanges

Text TableChanges

For Coding theChanges, See

Modify thesample parseexit routinemessage.

33400. ChangeSYRTMAMXproperties asappropriate.

Replace message textas appropriate in theSYRTMAMT entry foreach language in use.

“Modifying aTranslate TableEntry” on page8-11.

“Modifying aMessage in theText Table” onpage 8-13.

Table 8-3: Adding entries for new SQLCODEs (continued)

Option Message Number(MSGNO=)

Translate TableChanges

Text TableChanges

For Coding theChanges, See

Page 97: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 8-9

MainframeConnect for DB2/MVS-CICS version 11.1.1 Changing the AMD2 Message Table

Customizing Message Text

If the existing message text does not meet your needs, you canchange the text of specific messages or translate all the messages intoa different language. However, the following messages or parts ofmessages cannot be customized or translated:

• “Error 33231” on page A-70 always returns with as-shipped U.S.English text, regardless of what is coded in the text table.

• The message variable indicator strings, %s and %S, in the texttable are always replaced with values that contain U. S. Englishtext. Many of these values are DB2 commands or messages,which are always returned in U.S. English.

The following table shows the changes to the AMD2 message table.

Create newmessages.

See “Selecting anError Message” onpage 9-19 foravailable numbers.

Add anSYRTMAMX entryfor each newmessage.

Add messages to theSYRTMAMT entry foreach language in use.

“Adding aTranslate TableEntry” on page8-11.

“Adding aMessage to theText Table” onpage 8-13.

Table 8-5: Customizing message text

Option Message Number(MSGNO=)

Translate TableChanges

Text TableChanges

For Coding theChanges, See

Modify existingmessage text.

The messagenumber is notchanged.

No change. Replace existingtext with newtext in theSYRTMAMT entryfor each languagein use.

“Modifying aMessage in theText Table” onpage 8-13.

Translatemessages.

No new numbers areassigned, but text forall numbers must betranslated.

No change. Add an SYRTMAMTentry withtranslatedmessage text.

“Adding aLanguage to theText Table” onpage 8-13.

Table 8-4: Adding or changing messages for a parse exit routine (continued)

Option Message Number(MSGNO=)

Translate TableChanges

Text TableChanges

For Coding theChanges, See

Page 98: MainframeConnect™ for DB2/MVS-CICS Installation and ...

8-10 Customizing MainframeConnect Messages

Changing the AMD2 Message Table MainframeConnect for DB2/MVS-CICS version 11.1.1

Eliminating Messages

MainframeConnect sends confirmation, warning, and errormessages from DB2 to the client application. You can change theAMD2 message table to intercept those messages before they are sent,thus reducing message traffic by eliminating some of the messages.To prevent the sending of specific messages, you can make changesto the AMD2 message table as shown in the following table.

Changing Message Logging

As shipped, MainframeConnect writes messages to the AMD2LOGfile based on the preassigned values of the translate table’s LOG=property. You can control which messages are written to the error logfile AMD2LOG by changing the value of the LOG property in thetranslate table for each message involved. To change messagelogging, make changes to the AMD2 message table as shown in thefollowing table.

Table 8-6: Eliminating messages

Option Message Number(MSGNO=)

Translate TableChanges

Text TableChanges

For Coding theChanges, See

Prevent amessage frombeing sent to aclientapplication.

Change the messagenumber to 0(MSGNO=0).

Change the valueof the MSGNOproperty to 0(MSGNO=0).

No change. “Modifying aTranslate TableEntry” on page8-11.

Table 8-7: Changing message logging

Option Message Number(MSGNO=)

Translate TableChanges

Text TableChanges

For Coding theChanges, See

Write a messageto the error logfile.

No change. Change the valueof the LOGproperty to Y.

No change. “Modifying aTranslate TableEntry” on page8-11.

Prevent amessage frombeing written tothe error log file.

No change. Change the valueof the LOGproperty to N.

No change. “Modifying aTranslate TableEntry” on page8-11

Page 99: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 8-11

MainframeConnect for DB2/MVS-CICS version 11.1.1 Coding AMD2 Message Table Changes

Coding AMD2 Message Table Changes

To code changes to the AMD2 message table, determine whether youmust change the translate table, the text table, or both, then proceedas shown in the following table.

➤ NoteAfter making the changes, assemble and link the message table.

Changing the Translate Table

Changes to the translate table are made in the SOURCE librarymember AMD2CAMX. You can modify existing SYRTMAMX entries oryou can add new ones; do not delete entries.

Adding a Translate Table Entry

To add a SYRTMAMX macro entry to the translate table, follow thesesteps:

1. Copy an existing SYRTMAMX macro entry.

2. Add the copied entry to the translate table.

3. Modify the property values as needed.

For help in determining property values, see the explanation in“Translate Table Properties” on page 8-3.

For additional information about assigning message numbers, see“Adding Entries for New SQLCODEs” on page 8-7 and “Adding orChanging Messages for a Parse Exit Routine” on page 8-8.

Modifying a Translate Table Entry

To modify an existing SYRTMAMX entry, follow these steps:

Table 8-8: Changing the AMD2 message table

To modify Follow the Instructions in

Translate table “Changing the Translate Table” on page 8-11

Text table “Changing the Text Table” on page 8-12

Page 100: MainframeConnect™ for DB2/MVS-CICS Installation and ...

8-12 Customizing MainframeConnect Messages

Coding AMD2 Message Table Changes MainframeConnect for DB2/MVS-CICS version 11.1.1

1. Locate the target entry.

2. Change the property values as necessary.

For example, if you do not want messages returned to the clientapplication for certain DB2 SQLCODEs, set the message numberproperty to 0 (MSGNO=0).

➤ NoteDeleting a SYRTMAMX entry generates default messages or errors; it does

not reduce the number of messages sent to the client application. To

prevent the sending of certain messages, modify the property values (see

“Eliminating Messages” on page 8-10) instead of removing the entry.

Changing the Text Table

Changes to the text table are made in the SOURCE library memberAMD2CAMX. You can modify existing SYRTMAMT macro entries byadding messages or changing message text, but you should notdelete messages, because then messages will not be returned for theerror codes. You can also add SYRTMAMT entries to provide messagetext in additional languages.

Rules for Text Table Entries

The following rules apply to text table messages:

• Message number—Do not change the message numbers ofexisting messages because those numbers correspond to MSGNOvalues in translate table entries. For new text table entries, be surethe message number added to the text table has a correspondingmessage added to the translate table.

• Message text string—You can replace existing text or add newtext. The text string, including message variable indicators, canbe up to 255 characters in length. After AMD2 replaces the variableindicators with variable values, the message text returned to theclient application never exceeds 512 characters.

Page 101: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 8-13

MainframeConnect for DB2/MVS-CICS version 11.1.1 Coding AMD2 Message Table Changes

Modifying a Message in the Text Table

To modify the text of existing text table messages, type over thetarget message text with your new text, following the guidelines in“Rules for Text Table Entries” on page 8-12.

Adding a Message to the Text Table

To add a message to the text table, follow the format of othermessages in the editable member AMD2CAMT and observe theguidelines in “Rules for Text Table Entries” on page 8-12.

To avoid message processing errors, be sure to add any newmessages to all the SYRTMAMT entries in use at your installation. Forexample, if both United States and German customers can useMainframeConnect, add all new messages to both the U.S. Englishand the German message sets. If a message number exists in aSYRTMAMX entry but not in the SYRTMAMT entry for the specifiedlanguage, “Error 33231” on page A-70, in U.S. English, is sent to theclient application.

Adding a Language to the Text Table

To translate message text into a different language, add an SYRTMAMTentry, containing an entire set of messages, to the SOURCE librarymember AMD2CAMX. To add the entry, copy and modify anexisting SYRTMAMT entry (U.S. English, French, or German) asfollows:

1. Place the copied SYRTMAMT entry in the text table just above thefollowing line:

SYRTMAMT TYPE=FINAL

2. Change the LANG= property to match the languageidentification passed to AMD2 for the target language.

The first line of the new entry should look like this:

SYRTMAMT TYPE=ENTRY,LANG={us_english|german|french},

3. Replace the message text with a translation in the targetlanguage.

- For information about the variable indicators, %s, %d and %S,see “Message Variable Indicators” on page 8-6.

- Be sure the translated text follows the guidelines in “Rules forText Table Entries” on page 8-12.

Page 102: MainframeConnect™ for DB2/MVS-CICS Installation and ...

8-14 Customizing MainframeConnect Messages

Coding AMD2 Message Table Changes MainframeConnect for DB2/MVS-CICS version 11.1.1

Page 103: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 9-1

9 User Exits 9.

This chapter describes how to use MainframeConnect exits andprovides examples of the kinds of programs you can write.

➤ NoteBe sure you compile and link-edit MainframeConnect sample programs so

that they run in 31-bit addressing mode. The samples are in the SOURCE

library.

This chapter contains the following sections:

• User Exits in MainframeConnect 9-1

• Request/Result Validation Exits 9-1

• Parse Exit Routine 9-11

User Exits in MainframeConnect

User exits enable you to set up your own rules with your own code.MainframeConnect provides user exits that allow you to writeprograms to:

• Validate requests and results processed by MainframeConnect

• Generate a list of group IDs for input to Catalog StoredProcedures (CSPs)

• Customize SQL commands for a particular database or a specificpurpose

➤ NoteFor information about providing security, see the Open ServerConnectInstallation and Administration Guide for IBM CICS/MVS.

Request/Result Validation Exits

When MainframeConnect passes a request to DB2 for processing, arequest/result validation exit can be called by AMD2CICS. It usesthe standard EXEC CICS LINK with a common area described in thecopy library book AMD2XCOB.

Page 104: MainframeConnect™ for DB2/MVS-CICS Installation and ...

9-2 User Exits

Request/Result Validation Exits MainframeConnect for DB2/MVS-CICS version 11.1.1

The request validation exit checks whether the request is valid byusing values in the Exit Communication Area (described in“Understanding the Exit Communication Area” on page 9-5). Afterthe request processes, a result exit can be called by AMD2CICS. Ituses the standard EXEC CICS LINK with a common area describedin the copy library book EXITAREA to validate the results anddetermine whether to give control back to MainframeConnect. It alsouses values in the Exit Communication Area to determine whether togive control back to MainframeConnect.

The MainframeConnect installation tape contains examples ofvalidation exit programs.

AMD2 calls the request and result validation exit programs when arequest comes in and a result is returned. The request and resultvalidation exits provide the CICS or DB2 system programmer withsome additional control over the MainframeConnect requestprocessing session.

This section explains how to write a request or request validationexit. It contains the following information:

• Understanding exit routines

• Enabling request and result validation exits

• Using the sample validation program

• Understanding the exit communication area

• Writing a request validation exit

• Writing a result validation exit

• Writing the Group ID Exit Name

• Understanding Group ID Exit Name processing

Understanding Exit Routines

At appropriate points in the request processing sequence,MainframeConnect issues calls to your exit program. You can writean exit program to:

• Enforce special installation security rules

• Prohibit access during certain times of the day

• Capture statistics and user information

• Examine or modify the user’s SQL statement

• Direct results to other destinations

Page 105: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 9-3

MainframeConnect for DB2/MVS-CICS version 11.1.1 Request/Result Validation Exits

The MainframeConnect INSTALL library includes a samplevalidation exit program, AMD2PXIT. You can modify this programor create an entirely new program.

Enabling Request/Result Validation Exits

You can use the MainframeConnect Configuration screen to enableor disable the request and result validation exits. For instructions onaccessing the MainframeConnect Configuration screen, see“Changing the MainframeConnect Configuration” on page 7-1.

➤ NoteIf you run a remote stored procedure (RSP), the result validation exit is not

called. If you run a USE REQUEST statement, the request validation exit is

called once for the USE REQUEST statement and once for the SQL statement

retrieved from the Host Request Library.

Be sure to add an entry to the CICS PPT for each exit program. Fordetails, see “Request exit name” and “Result exit name” on page 7-4.

Using the Sample Validation Program

The SOURCE library includes a sample validation programAMD2PXIT. It captures user information and puts it in a transientdata queue called USERINFO. You can modify this programor create an entirely new program.

TITLE 'EXITSAMP SAMPLE EXIT PROCESSING'PRINT NOGEN*–––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––** THIS SAMPLE EXIT PROGRAM IS CALLED FOR BOTH REQUEST AND RESULT ** EXITS. FOR THE REQUEST EXIT, THE REQUEST IS LOGGED TO A TEMPORARY ** STORAGE QUEUE CALLED 'USERINFO'. IN ADDITION, IF THE REQUEST NAME ** IS 'PAYROLL', THE REQUEST IS IGNORED. FOR THE RESULT EXIT, THE ** SIZE OF REPORT1 IS CHECKED. **–––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––*

Page 106: MainframeConnect™ for DB2/MVS-CICS Installation and ...

9-4 User Exits

Request/Result Validation Exits MainframeConnect for DB2/MVS-CICS version 11.1.1

R0 EQU 0R1 EQU 1R2 EQU 2R3 EQU 3R4 EQU 4R5 EQU 5R6 EQU 6R7 EQU 7R8 EQU 8R9 EQU 9R10 EQU 10R11 EQU 11

R12 EQU 12R13 EQU 13R14 EQU 14R15 EQU 15BLANK EQU X'40'EJECT

*––––––––––––––––––** INITIALIZATION **––––––––––––––––––*EXITSAMP DFHEIENT CODEREG=(12),DATAREG=(13)USING EXITAREA,R8 ESTABLISH DSECT ADDRESSABILITYL R8,DFHEICAP GET ADDRESS OF EXITAREA

*–––––––––––––––––––––––––––––––––––––** HANDLE A CALL TO THE REQUEST EXIT **–––––––––––––––––––––––––––––––––––––*

REQUEST CLC XREASON,=CL8'REQUEST' CALL TO REQUEST EXIT ?BNE RESULT NO, BRANCHCLC XREQNAME,=CL8'PAYROLL' IS THIS A PAYROLL REQUEST ?BE IGNORE YES, IGNORE THE REQUESTMVC LOGREC,BLANKS CLEAR LOG RECORDMVC LOGREC+00(08),XDATE DATEMVC LOGREC+09(08),XTIME TIMEMVC LOGREC+18(08),XUSERID USERIDMVC LOGREC+27(08),XREQNAME REQUEST NAMEMVC LOGREC+36(08),XREQFUNC REQUEST FUNCTIONEXEC CICS WRITEQ TS QUEUE('USERINFO') +FROM(LOGREC) LENGTH(44)B RETURN RETURN

Page 107: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 9-5

MainframeConnect for DB2/MVS-CICS version 11.1.1 Request/Result Validation Exits

*––––––––––––––––––––––––––––––––––––** HANDLE A CALL TO THE RESULT EXIT **––––––––––––––––––––––––––––––––––––*RESULT CLC XRESNAME,=CL8'REPORT1' IS THIS REPORT1 ?BNE RETURN NO, BRANCHL R3,XRESROWS GET RESULT ROW COUNT ?C R3,=F'3000' IS REPORT TOO LARGE ?BNH RETURN NO, BRANCHMVC XERRMSG,=CL70'REPORT TOO LARGE. CHANGE WHERE CLAUSE'B IGNORE

*–––––––––––––––––––––––––––––––––** RETURN TO THE CALLING PROGRAM **–––––––––––––––––––––––––––––––––*IGNORE MVC XACTION,=CL8'IGNORE' INDICATE IGNORERETURN DS 0HEXEC CICS RETURNEJECT

*–––––––––––––––––––––––––** MISCELLANEOUS STORAGE **–––––––––––––––––––––––––*BLANKS DC CL44' 'LTORGDFHEISTGLOGREC DS CL44COPY EXITAREAEND

Understanding the Exit Communication Area

When a call is made to the request or result validation exit, the exitcommunication area passes information to the exit program.

The Exit Communication Area contains information that is passed toeither a request or result validation exit program when a call is madeto that program.

The MACRO library includes a description of the exitcommunication area (EXITAREA), which follows:

Page 108: MainframeConnect™ for DB2/MVS-CICS Installation and ...

9-6 User Exits

Request/Result Validation Exits MainframeConnect for DB2/MVS-CICS version 11.1.1

************************************************************************ COMMUNICATION AREA PASSED TO THE REQUEST/RESULT EXITS ************************************************************************EXITAREA DSECTXHEADER DS CL8 EYE CATCHERXREASON DS CL8 REASON FOR CALLING EXITXUSERID DS CL8 USER IDENTIFICATIONXTERMID DS CL4 TERMINAL IDENTIFICATIONXDATE DS CL8 DATE IN MM/DD/YY FORMATXTIME DS CL8 TIME IN HH:MM:SS FORMATXSERVER DS CL8 NAME OF SERVERXDBSID DS CL30 DATABASE SYSTEM IDXDBUID DS CL30 DATABASE USER ID

*––––––––––––––––––––––––––––** REQUEST EXIT INFORMATION **––––––––––––––––––––––––––––*XREQINFO DS 0CL28 REQUEST INFORMATIONXREQNAME DS CL8 REQUEST NAMEXREQADDR DS F ADDRESS OF REQUEST BUFFERXREQFUNC DS CL8 REQUEST FUNCTIONXREQOPT DS CL8 REQUEST OPTION

*––––––––––––––––––––––––––––** RESULT EXIT INFORMATION **––––––––––––––––––––––––––––*XRESINFO DS 0CL36 RESULT INFORMATIONXRESNAME DS CL8 RESULT NAMEXRESOPT DS CL8 RESULT OPTIONXRESTYPE DS CL3 RESULT TYPEXRESFILL DS CL1 FILLERXRESCODE DS F DB2 RETURN CODEXRESROWS DS F NO. OF ROWS IN RESULTXRESSIZE DS F NO. OF BYTES IN RESULTXRESQNAM DS CL8 TEMPORARY STORAGE QUEUE NAME

*–––––––––––––––––––––––––––––––––––––––––––––––––––** VALUES THAT CAN BE MODIFIED BY THE EXIT PROGRAM **–––––––––––––––––––––––––––––––––––––––––––––––––––*XACTION DS CL8 ACTION TO BE TAKENXDDBNAME DS CL8 DEFAULT DATABASE NAMEXDTSNAME DS CL8 DEFAULT TABLESPACE NAMEXERRMSG DS CL70 ERROR MESSAGEXFILLER DS CL30 FILLER

Common Fields

When you call the exit program, certain fields are always passedfrom the Exit Communication Area to the exit program by

Page 109: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 9-7

MainframeConnect for DB2/MVS-CICS version 11.1.1 Request/Result Validation Exits

MainframeConnect, regardless of the validation exit that was called.These fields are as follows:

The values for these fields are shown in the example in“Understanding the Exit Communication Area” on page 9-5,following the first comment area.

Writing a Request Validation Exit

MainframeConnect calls the request validation exit before a requestis executed by MainframeConnect. The exit program examines theexit communication area that MainframeConnect passes to it. Basedon the information in the XACTION field description, the exitprogram either passes, fails, or modifies the request.

The request validation exit can be either a separate program orcombined with the result validation program. You can check theXREASON field to determine the reason for the call.

The communication area fields that pertain to the request validationexit are as follows:

Table 9-1: Common Exit Communication Area Fields

Field Description

XHEADER The eye-catcher containing the word EXITAREA.

XREASON The reason for calling the exit. REQUEST indicates a call tothe request validation exit; RESULT indicates a call to theresult validation exit.

XUSERID The user identification.

XTERMID The terminal identification.

XDATE The current date in the format MM/DD/YY.

XTIME The current time of day in the format HH:MM:SS.

XSERVER The database server name.

XDBSID The database system ID, which is not applicable for DB2.

XDBUID The database user ID, which is not applicable for DB2.

Table 9-2: Request Validation Communication Area Fields

Field Description

XREASON An eye-catcher containing the word REQUEST.

Page 110: MainframeConnect™ for DB2/MVS-CICS Installation and ...

9-8 User Exits

Request/Result Validation Exits MainframeConnect for DB2/MVS-CICS version 11.1.1

The values for the request validation exit fields are shownthroughout the example in “Understanding the Exit CommunicationArea” on page 9-5.

Writing a Result Validation Exit

The result validation exit is called after each request runs. The exitprogram can examine the exit communication area thatMainframeConnect passes to it. Based on the information in thecommunication area, the exit program can either pass or fail theresult.

XREQNAME The name of the request.

XREQFUNC The request function. Valid values are SELECT, UPDATE,USE, and so on, which are taken from the SQL statement.The first word of the SQL statement is not used anymore.

XREQOPT The request option. Valid values are PREVIEW andREPORT, which are taken from the SQL statement.

XREQADDR The address of the request buffer. The request buffer isformatted as a half-word length field followed by therequest.

XACTION This field is blank when MainframeConnect sends it on toDB2. If you specify it, the exit program can place a value inthis field to indicate what action MainframeConnect takes:

• If you leave this field blank, MainframeConnect doesnothing. Processing proceeds in the normal fashion.

• If you specify IGNORE, MainframeConnect ignores therequest, and processing continues with the next requestin the request queue. This request is not treated as anerror condition.

• If you specify REJECT, MainframeConnect rejects therequest. This request is treated as an error condition.

If a request is ignored or rejected, MainframeConnectissues an appropriate error message when the resultsreturn to the client application. If you specify it, the exitprogram can supply an additional error message in theXERRMSG field.

XERRMSG This field is blank.

Table 9-2: Request Validation Communication Area Fields

Field Description

Page 111: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 9-9

MainframeConnect for DB2/MVS-CICS version 11.1.1 Request/Result Validation Exits

The communication area fields that pertain to the result validationexit are as follows:

➤ NoteIf you use a result exit, set Temp storage queue type to AUX or MAIN at the

MainframeConnect Configuration screen (see “Temp storage queue type”

in Chapter 7, “Configuring MainframeConnect”). The result exit is not called

when Temp storage queue type is set to NONE.

The values for the result validation exit fields are shown throughoutthe example in “Understanding the Exit Communication Area” onpage 9-5.

Table 9-3: Result Validation Communication Area Fields

Field Description

XREASON An eye-catcher containing the word RESULT.

XRESNAME The name of the result.

XRESOPT The result option. The valid value is PREVIEW.

XRESTYPE The result type. The valid value is OUT.

XRESCODE The DB2 return code.

XRESROWS The size of the result in rows.

XRESSIZE The size of the result in bytes.

XRESQNAM The queue name of the result file.

XACTION This field is blank when MainframeConnect sends it on.The exit program can place a value in this field to indicatewhich of the following actions MainframeConnect takes:

• If you leave this field blank, MainframeConnect doesnothing. Processing proceeds in the normal fashion.

• If you specify IGNORE or REJECT, MainframeConnectbypasses this result, which means the result exit iscalled once per result, not once for each row. It does notreturn the result to the client application. The resultsmight also be rejected if a row count is exceeded.

XERRMSG The error message or blank. If you want an additionalerror message in the XERRMSG field, the exit program cansupply it.

Page 112: MainframeConnect™ for DB2/MVS-CICS Installation and ...

9-10 User Exits

Request/Result Validation Exits MainframeConnect for DB2/MVS-CICS version 11.1.1

Using the Group ID Exit Name

The Group ID Exit Name is a CICS program that builds a list of groupIDs for CSPs to use. Depending on the configuration values of thecatalog access parameters, this program can be called, before CSPsare generated. This program provides the appropriate list of groupIDs used to determine table and column authorizations for CSPresults.

Generally, you write CSP exit programs when you are not usingRACF, ACF2, or Top Secret; yet, you want the equivalent ofGroup-ID Support. However, if you use those security packages, youcan also write an exit program to limit the result set returned fromCSPs; for example, when user IDs belong to large numbers of groups.

The Group ID Exit Name is a dynamic link. To use it, you must addan entry for a user CSP exit program to the CICS PPT. Also, theprogram must be in the CICS RPL.

Understanding Group ID Exit Name Processing

When the Group ID Exit Name is called, MainframeConnect passesthe exit program a 4012-byte communication area into which the exitprogram can build a list of up to 500 eight-byte group IDs.

The format of the communication area is as follows:

COMMAREA DSECTCOUNT DS FUSERID DS CL8ENTRIES DS 500CL8

The COUNT field contains the number of entries in the list includingthe original user ID; ENTRIES can contain a list of 500 eight-bytegroup IDs.

The communication area comes with an entry for USERID alreadyfilled in. The COUNT field contains 1. The exit program can performone of the following actions:

• Do nothing. The user ID is used for CSPs.

• Replace the user ID with a new ID. The new ID is used for CSPs.

• Add additional IDs to the list. The additional IDs must follow theentry for user ID, and the COUNT field must change to reflect thetotal number of IDs in the list (including the user ID). All the IDsare used for the CSPs.

Page 113: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 9-11

MainframeConnect for DB2/MVS-CICS version 11.1.1 Parse Exit Routine

In the example that follows, two group IDs (GROUP1 and GROUP2) areadded to the list:

EXITPROG DFHEIENTUSING COMMAREA,R2L R2,DFHEICAPMVC COUNT,=F'3'MVC ENTRIES+08(08),=CL8'GROUP1'MVC ENTRIES+16(08),=CL8'GROUP2'EXEC CICS RETURNLTORGDFHEISTG

COMMAREA DSECTCOUNT DS FENTRIES DS 501CL8

END

Parse Exit Routine

The parse exit routine is similar to a request exit. It allows acustomer-written exit routine to alter SQL text received fromMainframeConnect clients before the SQL statements are passed toDB2. By altering the SQL text, your routine can customize SQLcommands for a particular database or a specific purpose.

There are several potential uses for this option. For example, you canuse a parse exit routine to limit the scope of client access byrestricting client SQL statements to select statements only. You canalso use the parse exit routine to modify the qualifiers for DB2 objectnames to provide additional security restraints on accessingmainframe data.

This section explains how to write a parse exit routine. It is organizedaround the following tasks, which are performed by theprogrammer:

1. Understanding the parse exit routine

2. Preparing to code your routine

3. Coding your routine

4. Compiling and link-editing your routine

5. Enabling your routine

A section containing the definitions for the fields that pass values toand from your routine is included in “CICS Common Area Fields”on page 9-15.

Page 114: MainframeConnect™ for DB2/MVS-CICS Installation and ...

9-12 User Exits

Parse Exit Routine MainframeConnect for DB2/MVS-CICS version 11.1.1

Understanding the Parse Exit Routine

When the CICS transaction AMD2 receives SQL text from aDirectConnect client, it processes the statements and prepares tosend the SQL text to DB2. If the parse exit is specified on theMainframeConnect Configuration screen, AMD2 calls the parse exitroutine before passing the SQL text to DB2. For more information,see “Parse exit name” in Chapter 7, “ConfiguringMainframeConnect.”

Calling the Parse Exit from AMD2

For CICS, AMD2 uses the EXEC CICS LINK command to call the parse exitroutine. The call is executed only if the parse exit option is selectedusing the MainframeConnect Configuration screen. See “Changingthe MainframeConnect Configuration” in Chapter 7, “ConfiguringMainframeConnect,” for instructions on using theMainframeConnect Configuration screen.

This option can be selected during installation of the product (seestep 3 in “Changing the MainframeConnect Configuration” on page7-1), or when you enable your routine following the instructions inthis section.

Before calling the parse exit routine, AMD2 sets up the parse exitcommon area that a parse exit routine can access. Your routineshould alter the values in the common area of the parse exit as shownin the following table. An explanation of the fields and informationabout changing their values is included in “CICS Common AreaFields” on page 9-15.

Table 9-4: Altering values in common area fields

Common Area Field When to Alter the Value

USERID Never

PASSWORD Never

NETGWNAME Never

STMT-PTR When the SQL text length changes

RETCODE Always (every invocation of the routine)

MSGCODE When the return code equals +2

Page 115: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 9-13

MainframeConnect for DB2/MVS-CICS version 11.1.1 Parse Exit Routine

Processing Batched SQL Statements

AMD2 calls the parse exit routine once for each SQL statement. If theSQL statements are batched using the semicolon delimiter, AMD2processes each statement separately, calling the parse exit routineand passing the returned SQL text to DB2. Processing continues untilone of the following conditions occurs:

• The batch is exhausted.

• The parse exit routine requests that the batch be aborted.

• A DB2 error occurs in processing any statement in the batch.

Processing User-Defined Transactions

A user-defined transaction is a unit of work explicitly defined by theclient application with transaction control statements such as begintran, commit, and rollback. A unit of work is the data that the users wantto confirm was added to the back end database.

The parse exit routine is called once for each SQL statement,including the transaction control statements that define thetransaction. Your routine should not alter transaction controlstatements.

◆ WARNING!A customer-defined transaction causes AMD2 to maintain databaselocks and the DirectConnect-to-mainframe connection until you endthe transaction. If your parse exit routine alters the transaction controlstatements, especially those that explicitly end the transaction, yourroutine can impact DB2 and other mainframe resource usage.

Returning to AMD2

After customizing the SQL text, the exit routine returns to AMD2,which passes the altered SQL statements to DB2 without furthermodification.

The Parse Exit Common Area

The parse exit common area passes information between AMD2 andthe parse exit routine. It is acquired and initialized by AMD2. A

Page 116: MainframeConnect™ for DB2/MVS-CICS Installation and ...

9-14 User Exits

Parse Exit Routine MainframeConnect for DB2/MVS-CICS version 11.1.1

COBOL II copy book, AMD2XCOB, defines the common area fieldsthat are passed (through the linkage section) to a COBOL II parse exitroutine. This copy book is distributed with MainframeConnect (see“COPY Library” in Chapter 5, “Installing the MainframeConnectTape”).

The layout of the common area follows, with descriptions of eachfield.

Layout of the AMD2XCOB Copy Book

The CICS common area has the following structure. (“DB2 AccessModule” in the following copy book means “AMD2.”)

**************************************************************

* AMD2XCOB Rel 10.1

* This copy book defines the LINKAGE SECTION for a COBOL II

* Parse Exit Routine for DB2 Access Module.**************************************************************

01 AMD2XCOB-COMMAREA REDEFINES DFHCOMMAREA.

05 AMD2XCOB-CA-EYECATCHERPIC X(8).

05 AMD2XCOB-CA-USERID PIC X(32).

05 AMD2XCOB-CA-PASSWORDPIC X(32).

05 AMD2XCOB-CA-NETGWNAMEPIC X(32).

05 AMD2XCOB-CA-CHARSETCLTPIC X(32).

05 AMD2XCOB-CA-CHARSETSRVPIC X(32).

05 AMD2XCOB-CA-NATLANGCLTPIC X(32).

05 AMD2XCOB-CA-DBCSPIC X(32).

05 AMD2XCOB-CA-STMT-PTRPOINTER.

05 AMD2XCOB-CA-RETCODEPIC S9(9) COMP.

05 AMD2XCOB-CA-MSGCODEPIC S9(9) COMP.

05 AMD2XCOB-CA-RESERVEDPIC X(80).

*------------------------------------------------------------

* Define SQL text area pointed to by AMD2XCOB-CA-STMT-PTR

*------------------------------------------------------------

01 AMD2SQL-TEXT-LVL-01.

03 AMD2SQL-TEXT.

05 AMD2SQL-TEXT-LLPIC S9(4) COMP.

05 AMD2SQL-TEXT-CHARS OCCURS 0 TO 32704 TIMES

Page 117: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 9-15

MainframeConnect for DB2/MVS-CICS version 11.1.1 Parse Exit Routine

DEPENDING ON AMD2SQL-TEXT-LL

PIC X.

03 AMD2SQL-TEXT-DUMMY-LVLPIC X.

*****************************************************************

* END AMD2XCOB COPY BOOK

*****************************************************************

CICS Common Area Fields

The following AMD2XCOB-CA- fields are defined forCOBOL/CICS.

Table 9-5: CICS Common Area Fields

Field Description

EYECATCHER This value is set by AMD2. If it is altered by the parse exitroutine, unpredictable results occur.

USERID The user ID of the client sending the request. This fieldshould not be altered by the parse exit routine.

PASSWORD The password of the client sending the request. This fieldshould not be altered by the parse exit routine.

NETGWNAME The name of DirectConnect specified by the client. Thesefields should not be altered by the parse exit routine.

CHARSETCLT Reserved for future use.

CHARSETSRV Reserved for future use.

ATLANGCLT Reserved for future use.

DBCS Reserved for future use.

STMT-PTR A pointer to a single SQL statement beginning with the 2-byte SQL length. The parse exit routine should alter thepointer to hold the new address of the SQL text area whenthis address is changed by the exit routine. It is onlynecessary to acquire a new SQL text area if the existingarea is not large enough for the SQL text after it is alteredby the user.

AMD2 uses this pointer to determine whether the exitroutine allocated storage that AMD2 must deallocate.

Page 118: MainframeConnect™ for DB2/MVS-CICS Installation and ...

9-16 User Exits

Parse Exit Routine MainframeConnect for DB2/MVS-CICS version 11.1.1

Getting Ready to Code Your Routine

This section describes your programming language options and thematerials we provide, such as the sample routine and the COBOLcopy book, that can help you write your routine.

Programming Languages

The parse exit feature is designed to work with Assembler, COBOL,and PL/I.

We supply a sample parse exit routine in COBOL and a COBOL copybook that defines the linkage section for a COBOL II parse exitroutine. This routine is in the SOURCE library.

Sample Parse Exit Routine

The sample parse exit routine, AMD2CCPX, is located in the SOURCElibrary. You can modify this program or use it as an example. TheCOBOL copy book is discussed in the “The Parse Exit CommonArea” on page 9-13.

Coding Your Routine

This section contains information about the tasks that you shouldcode your routine to perform. These tasks include:

RETCODE A full-word return code. The user-written parse exitroutine should alter this field. Valid values are:

0—Passes the SQL text to DB2.

+1—Does not pass the SQL text to DB2 and continues withthe next statement in the batch, if there is one.

+2—Aborts the batch and returns an error message usingthe message code in the next parse exit communicationarea field.

MSGCODE A fullword message code. This field should be altered bythe user-written parse exit routine if the return code wasset to +2. AMD2 ignores it in all other cases.

RESERVED Reserved for future use.

Table 9-5: CICS Common Area Fields

Field Description

Page 119: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 9-17

MainframeConnect for DB2/MVS-CICS version 11.1.1 Parse Exit Routine

• Altering the SQL text to suit your purposes

• Acquiring additional storage, if necessary

• Handling errors

• Assigning a return code

• Selecting an error message

Altering the SQL Text

The parse exit common area contains a pointer to the SQL text area.The text area consists of the SQL text preceded by a 2-byte SQLlength field, which provides the number of bytes in the SQL text.(The SQL length field does not include the 2 bytes for the length fielditself.)

If your exit routine changes the length of the SQL text, it must alsochange the value in the 2-byte length field.

• If the SQL text is shortened by the processing of your exit routine,you need only to correct the value in the length field.

• If the SQL text is expanded by your exit routine, you must acquireadditional storage to handle the overflow.

➤ NoteAs you code your exit routine to alter the SQL text, be aware that AMD2 does

not modify the SQL text after your routine is executed; therefore, the SQL

statements must be in the DB2 syntax before the parse exit routine returns

to AMD2.

Acquiring Additional Storage

If your routine expands the SQL statements beyond the lengthspecified in the 2-byte SQL length field, the parse exit routine mustacquire additional storage before it alters the SQL text.

◆ WARNING!A storage violation can occur if your routine expands the SQL textarea beyond the specified length in the 2-byte SQL length field withoutfirst acquiring additional storage.

Page 120: MainframeConnect™ for DB2/MVS-CICS Installation and ...

9-18 User Exits

Parse Exit Routine MainframeConnect for DB2/MVS-CICS version 11.1.1

To acquire additional storage for a larger SQL text area, your routinemust issue a GETMAIN command. Like the old SQL text area, the newone must allow 2 bytes for the length field in addition to the areaneeded for the expanded SQL statement.

After altering the new SQL text, your routine must:

• Load the length field with the new length of the SQL text after itis expanded

• Change the pointer in the parse exit common area to the locationof the new SQL text area

This pointer should be altered by the parse exit routine to hold thenew address of the SQL text area if this address is changed by the exitroutine. It is only necessary to acquire a new SQL text area if theexisting area is not large enough for the SQL text after it is altered bythe user.

Your exit routine does not need to deallocate the storage it acquires.After the routine returns, AMD2 checks the SQL text pointer. If thepointer changed during the exit routine execution, AMD2 deallocatesthe additional storage after DB2 processes the SQL statement.

Handling Errors

Errors associated with parse exit routine execution can occur beforethe routine is called, during the routine’s processing, and after theroutine returns to AMD2. This section describes the types of errors andtheir consequences, so that you can provide appropriate errorhandling code in your routine.

Before the Routine Is Called

The parse exit routine is not invoked if an error occurs in AMD2processing before the parse exit call. “Error 33233” on page A-72 issent to the client if this occurs.

During Parse Exit Routine Processing

Errors that occur during the processing of your routine produce thefollowing results:

• If your routine abnormally ends (abends) and your code does nothandle the abend, MainframeConnect abends and theappropriate messages may not be returned.

Page 121: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 9-19

MainframeConnect for DB2/MVS-CICS version 11.1.1 Parse Exit Routine

• If your routine abends and your code handles the abend,MainframeConnect may not be aware of the abend, dependingupon how your abend handler is written.

• If your routine contains an internal logic error, the results may beunpredictable.

After Returning to AMD2

Errors that result from exit routine processing can occur after theroutine returns to AMD2.

• If your routine acquires additional storage and incorrectly altersthe pointer to the SQL text, MainframeConnect abends whenAMD2 issues a FREEMAIN command to deallocate the additionalstorage.

• If the modifications of the SQL text are invalid, DB2 performs itsusual error handling. Any DB2 error that occurs in batched SQLcommands terminates the entire batch, unless the Stop_on_errorproperty is set. For DirectConnect messages, see theDirectConnect Error Message Guide.

Assigning a Return Code

Your exit routine must pass a return code back to AMD2 in the parseexit common area field AMD2XCOB-CA-RETCODE. Valid valuesare:

0—Passes the SQL text on to DB2.

+1—Does not pass the SQL text to DB2 and continues with the nextstatement, if there is one.

+2—Aborts the batch and returns an error message using themessage code in the AMD2XCOB-CA-MSCODE field.

Selecting an Error Message

If your exit routine sets the return code to +2, it should also changethe parse exit common area message code fieldAMD2XCOB-CA-MSGCODE.

After a parse exit routine returns to AMD2 with a return code of +2,AMD2 matches the message code against the message tableAMD2CAMX. If the message code is in the table, AMD2 sends the textassociated with that message number. If AMD2 cannot find the

Page 122: MainframeConnect™ for DB2/MVS-CICS Installation and ...

9-20 User Exits

Parse Exit Routine MainframeConnect for DB2/MVS-CICS version 11.1.1

message code in the table, it sends the default error message: “Error33231” on page A-70.

Any message code between 33400 and 33999 is available for use as auser message code. AMD2CAMX is shipped with a sample errormessage (“Error 33400” on page A-86), which is coded for the parseexit routine.

Altering the Message Table

To add messages for your routine to the message table, add entries tothe SOURCE library member AMD2CAMX. After making anychanges, you must reassemble and relink the message table. The JCLfor this job is in JCL Library members AMD2CAMX.

For more information, see “Changing the AMD2 Message Table” inChapter 8, “Customizing MainframeConnect Messages.”

Compiling and Link-Editing Your Routine

The JCL for compiling and link-editing a parse exit routine is in theJCL library member SYSAPARS. Change the property values to thosefor your routine before running the job.

Enabling Your Routine

You can enable your routine by specifying the parse exit name on theMainframeConnect Configuration screen, which shows you whetherit is successfully enabled.

Page 123: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Troubleshooting

Page 124: MainframeConnect™ for DB2/MVS-CICS Installation and ...
Page 125: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 10-1

10 Troubleshooting 10.

This chapter provides guidelines for what to do when a clientapplication cannot access data on the mainframe. The guidelinesinclude how to locate an error and cover the most frequent problems.

This chapter also includes operational and process flow overviewsfor Enterprise Connect. The information applies to both CICS LU 6.2and TCP/IP environments, except where differentiated.

The sections in this chapter are:

• Verifying Connectivity After Installing MainframeConnect 10-1

• Where to Start Troubleshooting 10-2

• Common Problems and Suggested Solutions 10-3

• Components 10-6

• Coordination 10-14

➤ NoteThis chapter describes mainframe troubleshooting. For comparable

DirectConnect information, see the DirectConnect Transaction RouterService User’s Guide and the DirectConnect for MVS Access ServiceUser’s Guide.

Verifying Connectivity After Installing MainframeConnect

Be sure the AMD2 transaction processor and the client and serverconnections are configured correctly. You can use one of thestandalone utilities (snaping or cicsping) shipped with OpenServerConnect to test the network connections between theworkstation and mainframe. Use snaping for Open ServerConnect forLU 6.2 and cicsping for Open ServerConnect for TCP/IP.

These utilities do not require DirectConnect to be active. For detailson using them, see the DirectConnect for MVS Connectivity Guide.

If these utilities fail to operate correctly, the failure is caused by aconfiguration error or line outage problem. Based on the errormessage returned, you can narrow your search. Resolution mayrequire coordination with the DirectConnect administrator to makechanges to the configuration.

If you already ransnaping or cicsping,

successfully, skip to“Where to Start

Troubleshooting” onpage 10-2

Page 126: MainframeConnect™ for DB2/MVS-CICS Installation and ...

10-2 Troubleshooting

Where to Start Troubleshooting MainframeConnect for DB2/MVS-CICS version 11.1.1

After snaping or cicsping runs successfully, be sure the DirectConnectadministrator defined all the necessary remote procedure call (RPC)and connection information to DirectConnect. Be sure thatDirectConnect is started. Use the guidelines in the following sectionfor further problem determination.

Where to Start Troubleshooting

System administrators at the client, DirectConnect server, andmainframe must check components systematically to locate thesource of the problem. Check for problems in this sequence:

1. Major outage, such as CICS crashed or your personal computeris unplugged

2. Client application

3. Client LAN

4. Client network setup

5. DirectConnect server

6. Connection from the client application to the DirectConnectserver

7. Connection from the DirectConnect server to the mainframe

8. Configuration between the transaction processor and OpenServerConnect or MainframeConnect

For any of these problems, the appropriate system administratorshould:

• Record specific information about the error message(s),including:

- Error message number

- Associated SNA sense codes, SNA Services error codes, orTCP/IP error codes

- The time the error occurred

- The client or user affected

• See the appropriate documentation, as needed. For example, ifyou need information about MainframeConnect errors, seeAppendix A, “Error Messages.”

• Perform the recommended action.

• Continue the process until the problem is resolved.

Page 127: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 10-3

MainframeConnect for DB2/MVS-CICS version 11.1.1 Common Problems and Suggested Solutions

Common Problems and Suggested Solutions

Problems often can be traced to configuration errors or network, line,modem, or adapter outages.

Configuration Errors

Configuration errors are most often the cause of communicationsfailure. To resolve these errors, you need the following information,which is created when the network is installed and successfullyimplemented:

• CICS table definitions for TCT, PCT, PPT, FCT, and RCT

• VTAM/NCP definitions for the logical unit (LU) and associatedLogmode table

• SDLC or Token Ring connection charts to the mainframe

• Named pipe and SPX charts to clients

• TCP/IP connection charts to clients

• For CICS LU 6.2, server SNA configuration

• For CICS TCP/IP, server TCP/IP configuration

• Sybase interface files for clients and DirectConnect servers

• Sybase security definitions, including client logins, connectiongroups, and transaction groups

Verify that this information is still the same as before the erroroccurred. If it is not the same, determine if a recent change iscontributing to the problem. The following subsections explain thecauses and actions for common configuration errors.

Cannot Establish a Session

Cause

Any of the following:

• Mismatched LU definitions between VTAM and server

• Mismatched modenames

• Incorrect VTAM MODETAB and APPLID macros

• Incorrect CICS TCT definitions

Page 128: MainframeConnect™ for DB2/MVS-CICS Installation and ...

10-4 Troubleshooting

Common Problems and Suggested Solutions MainframeConnect for DB2/MVS-CICS version 11.1.1

Action

Correct the spelling.

Coordinate with the DirectConnect administrator to checkconnection and modename profiles using the snaping or cicsping utilityshipped with the product.

Session Established, but the Transaction Does Not Run

Cause

Any of the following:

• CICS PCT or PPT entry error

• host security error

• Incorrect transaction ID in the DirectConnect RPC table

Action

Verify definitions.

Coordinate with the DirectConnect administrator for correct securityand transaction ID setups.

SDLC Line or Token Ring is Not Up

Cause

Address incorrectly configured with NCP (assumes correct line ormodem setup)

Action

Check both ends of the SDLC station or Token Ring addressconfiguration.

SDLC Link and PU are Active, but the LU Is Not Active

Cause

Any of the following:

• VTAM and DirectConnect LU definition errors

• SSCPID value in the local LU profile set incorrectly

Page 129: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 10-5

MainframeConnect for DB2/MVS-CICS version 11.1.1 Common Problems and Suggested Solutions

Action

Use the SDLC trace and error log facilities to find the error.

Mainframe Network Operational Failure

On the mainframe, there are two frequent causes of operationalerrors:

• The CICS or VTAM operator varied the resource out of service.

• VTAM placed the line, physical unit (PU), or LU into a non-operating (INOP) state because of a network outage.

In these cases, either:

• The DirectConnect administrator sees SNA software time-outand connection failure messages in trying to start upDirectConnect, or

• The requesting client sees a SNA software message indicatingthat the system could not start the RPC.

When you are contacted about such messages, reactivate thenecessary mainframe resources.

Network Session or Line Failures

Line, adapter, or modem outages result in error messages at both theVTAM console and DirectConnect. DirectConnect records themessage and, if possible, sends a similar error message to anyaffected clients.

Preventative Measures

Intermittent hardware errors and line degradation problems candisrupt processing, but can be difficult to find. You should checkperiodically for these types of problems. For example:

• To check for hardware errors, use the associated VTAM error logsand report errors to IBM Service.

• To check for line degradation, use VTAM to periodically reportthe SDLC line statistics. Examine the statistics for a significantnumber of re-transmissions or idle detect time-outs. Linedegradation results in random SDLC line failures or very slowresponse to the client, even during a moderate processing load.

Page 130: MainframeConnect™ for DB2/MVS-CICS Installation and ...

10-6 Troubleshooting

Components MainframeConnect for DB2/MVS-CICS version 11.1.1

Components

Enterprise Connect support consists of several components on theIBM mainframe and the DirectConnect platform, as Figure 10-1shows. These components provide tracing and logging, which youcan use to locate errors. This section includes examples of tracing andlogging for CICS.

The following figure shows Enterprise Connect components in aCICS environment:

Page 131: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 10-7

MainframeConnect for DB2/MVS-CICS version 11.1.1 Components

Figure 10-1: Open ServerConnect and DirectConnect support components

DirectConnect Support

DirectConnect performs the following functions:

Page 132: MainframeConnect™ for DB2/MVS-CICS Installation and ...

10-8 Troubleshooting

Components MainframeConnect for DB2/MVS-CICS version 11.1.1

• Receives requests from client applications

• Converts the requests to the appropriate communicationsprotocol call

• Sends the requests to the mainframe

Each TRS or access service includes a unique server name, whichclients use to select a server for communication. Each TRS or accessservice has its own set of configuration information.

As shown in Figure 10-1, DirectConnect uses four files:

• nglog for logging TDS traffic between TRS and clientworkstations, and for recording errors

• ngtds for tracing Sybase TDS traffic between TRS and mainframeSNA

• servername.log for logging TDS traffic between the Access Serviceand client workstations, and for recording errors

• tds.trc for tracing Sybase TDS traffic between the Access Serviceand mainframe SNA

For more information, see the DirectConnect Transaction Router ServiceUser’s Guide and the DirectConnect for MVS Access Service User’sGuide.

DirectConnect Communications with MainframeConnect

DirectConnect depends on the communications support, suppliedby the platform vendor, to communicate with MainframeConnect.Depending on the server-based communications software installed,DirectConnect uses SNA LU 6.2 or TCP/IP Uplink support.

SNA LU 6.2

SNA software uses the SNA trace file to record SDLC/SNA trafficbetween the server and mainframe. The vendor trace utility extractsthis file.

For Windows NT platforms, the error log file records errors that SNAServer for Windows NT detects.

TCP/IP Uplink

For CICS TCP/IP environments, third-party TCP/IP trace facilitiesprovide a way of obtaining low-level TCP/IP level traces between

Page 133: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 10-9

MainframeConnect for DB2/MVS-CICS version 11.1.1 Components

the mainframe and DirectConnect. For AIX platforms, the error logfile records errors that SNA Server/6000 detects. The IBM error logreport utility extracts this information. Microsoft SNA Server forWindows NT also has a trace process.

Mainframe Communications with DirectConnect

Mainframe-based communications support provides the “transport”level of function. Depending on the mainframe communicationssoftware installed, Gateway-Library uses VTAM/NCP or TCP/IPfor MVS.

VTAM/NCP

For CICS LU 6.2 environments, you can use the VTAM General TraceFacility (GTF) files to trace SDLC/SNA traffic between Gateway-Library and the mainframe. The IBM TAP utility extracts thisinformation.

TCP/IP for MVS

For CICS TCP/IP environments, you can use the Netstat facility tocheck the status of TCP/IP connections, as well as to deactivate themif problems occur.

You can use the TCP/IP trace facility to trace traffic betweenDirectConnect and the mainframe.

TCP/IP Sockets Interface

The TCP/IP Sockets Interface provides the interface between CICSand the MVS/TCP support. The Sockets Interface enables CICSapplications to use TCP/IP communications facilities. It uses theIBM-supplied TCP/IP Listener transaction to initiate transactionswhen operating with TCP/IP devices, such as DirectConnect.

The TCP/IP Sockets Interface provides CICS user exit traces,denoting each TCP call issued and the associated return call.

CICS

For CICS, Gateway-Library tracing stores information on the TDStraffic between the mainframe and server in the VSAM ESDS file,

Page 134: MainframeConnect™ for DB2/MVS-CICS Installation and ...

10-10 Troubleshooting

Components MainframeConnect for DB2/MVS-CICS version 11.1.1

SYTDLOG1. This information includes any errors detected in thetraffic.

Some TD calls fill up internal TDS buffers before sending them out tothe network. For example, a TDSNDROW or TDSNDMSG call does notcause execution of a corresponding CICS EXEC SEND call, unless theTDS buffer becomes full.

◆ WARNING!To avoid losing records, periodically archive or delete the tracerecords on SYTDLOG1. Trace records append to this file until it is full.Then it rejects any further records.

MainframeConnect for DB2/MVS-CICS

MainframeConnect for DB2/MVS-CICS provides the AMD2transaction, which automatically processes client SQL languagerequests using the DB2 dynamic SQL facilities.

Using this product, client applications can communicate directlywith DirectConnect or with another server that communicates withDirectConnect, such as SQL Server or OmniConnect (as shown in thefollowing figure):

Page 135: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 10-11

MainframeConnect for DB2/MVS-CICS version 11.1.1 Components

Figure 10-2: MainframeConnect and DirectConnect support components

Tracing

For MainframeConnect, you can use the standard DirectConnecttracing support. See Figure 10-1.

Logging

You can determine the errors logged. Enter changes in SOURCElibrary member AMD2MAMX, as detailed in MainframeConnect

Page 136: MainframeConnect™ for DB2/MVS-CICS Installation and ...

10-12 Troubleshooting

Components MainframeConnect for DB2/MVS-CICS version 11.1.1

installation instructions. For example, to indicate that you want amessage logged, set LOG=Y.

SYRTMAMX TYPE=ENTRY,MSGNR=32000,SQLCODE=0,LEVEL=11,STATEC=0,STATESC=0,LOG=Y,SQLFATAL=N

◆ WARNING!If a connection fails, the error log is the only method of tracking anerror. To prevent the log from running out of room, initialize the log fileregularly.

In a CICS environment, MainframeConnect provides the AMD2LOGand AMD2LOGO files. The AMD2 transaction writes errors toAMD2LOG, including task ID, term ID, timestamp, and the uniquemessage code for each error. AMD2 also returns an error message tothe client.

Under CICS, if AMD2LOG is full or no longer accepts messages, AMD2writes errors to the overflow file, AMD2LOGO. AMD2 then issueserror message 33219:

MainframeConnect error (Write to log file AMD2LOGfailed, switching to overflow log AMD2LOGO).

Under CICS, you can close, archive (if desired), and purgeAMD2LOG when it becomes full. During the time AMD2LOG isclosed, AMD2 writes messages to AMD2LOGO that you can close,archive, and purge once you reopen AMD2LOG.

In this example, AMD2 writes an internal error 32000 to AMD2LOG (orAMD2LOGO, if AMD2LOG is full).

For CICS environments, you must define the error log files to CICS inan FCT entry as follows:

• AMD2LOG

Page 137: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 10-13

MainframeConnect for DB2/MVS-CICS version 11.1.1 Components

DFHFCT TYPE=DATASET,ACCMETH=VSAM,DATASET=AMD2LOG,RECFORM=(FIXED,BLOCKED),DSNAME=your.syrtlog.dataset.name ,DISP=SHR,SERVREQ=(ADD,BROWSE)

• AMD2LOGO

DFHFCT TYPE=DATASET,ACCMETH=VSAM,DATASET=AMD2LOGO,RECFORM=(FIXED,BLOCKED),DSNAME=your.syrtlogo.dataset.name ,DISP=SHR,SERVREQ=(ADD,BROWSE)

Page 138: MainframeConnect™ for DB2/MVS-CICS Installation and ...

10-14 Troubleshooting

Coordination MainframeConnect for DB2/MVS-CICS version 11.1.1

Coordination

System administrators at the mainframe, DirectConnect, and clientneed to coordinate troubleshooting efforts. To aid in your analysis,this section describes the processing flow from the client throughDirectConnect to the mainframe.

Processing Flow and Enterprise Connect Requirements

Enterprise Connect processing can involve CT-Library, DB-Library,and ODBC. The following figure shows Enterprise Connectprocessing with DB-Library (for more information, see theDirectConnect for MVS Access Service User’s Guide):

Figure 10-3: Processing flow: client-to-DirectConnect-to-mainframe

The following points describe the sequence shown in Figure 10-3 andhighlight Enterprise Connect requirements:

Page 139: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 10-15

MainframeConnect for DB2/MVS-CICS version 11.1.1 Coordination

➤ NoteThe following points describe both RPC and dynamic SQL processing

flows.

1. Assuming DirectConnect is started, the client opens a LANconnection to a designated DirectConnect Service and logs in. Ifthe message Server name not found in interfacefile occurs, make sure:

- The client interfaces file is correctly set up.

- The client Sybase path variable is correctly defined.

- The DirectConnect server is specified in the DSQUERYvariable.

2. On receiving the client login information, DirectConnect checkssecurity as follows (for TRS only):

- If security is turned on, DirectConnect ensures the client isauthorized. If the client is not authorized, this error occurs:

Security Violation: Login denied (no loginentry).

- If the client is authorized or security is turned off,DirectConnect acknowledges the login.

3. When the client application needs to invoke an RPC or languagerequest on the mainframe, the client sends a request toDirectConnect over the LAN connection.

4. DirectConnect receives the request and performs a table lookupto find the mainframe session and Open ServerConnecttransaction ID to use. The RPC and connection must be in thetable. If security is turned on, the client must be authorized touse the RPC and connection to the mainframe. Provided that thetable lookup and security check are successful, the line is up, andthe session is active, DirectConnect allocates a conversation withthe named transaction.

If a failure occurs during this process, one of the following errormessages is written to both the DirectConnect log and client:

- Security Violation: Access to RPC ‘xxxx’denied.

The client is not authorized or is not listed correctly.

Page 140: MainframeConnect™ for DB2/MVS-CICS Installation and ...

10-16 Troubleshooting

Coordination MainframeConnect for DB2/MVS-CICS version 11.1.1

- Request Rejected: No host connections areavailable.

Connections to the mainframe are unavailable.

- Request Rejected: Remote procedure ‘xxxx’ notfound.

The RPC name was entered incorrectly or the name is not in thelookup table.

5. DirectConnect sends the client’s External Data Representation(XDR) information and RPC parameters to the mainframe, andthen waits for a reply from the transaction.

6. On the mainframe, the transaction processor initiates the namedtransaction, and the transaction issues Open ServerConnectGateway-Library calls. These calls read the client’s XDRinformation and RPC parameters. The transaction also performsassociated processing, such as issuing static SQL DB2 requests orreading VSAM or other database data.

7. The transaction issues Gateway-Library calls to send resultsback to the client. These calls perform any data conversions,generate the TDS reply datastream, and send out reply data.

8. DirectConnect receives each TDS reply packet and forwards it tothe client, which continues until the Open ServerConnecttransaction issues a TDSNDDON call.

If a failure occurs during this process, an error message iswritten to the DirectConnect log. An “Unexpected EOF fromSQL Server” message is written to the client. (The mainframe isacting as a SQL Server.) Gateway-Library tracing functions, if inuse, also record errors in this process. See ‘‘Tracing’’ on page10-11.

9. When completed with the request, the transaction exits; then theconversation terminates. For a long-running transaction (alsocalled a user-defined transaction), the transaction can remainactive through multiple requests before the conversationterminates. If a long-running transaction ends before it finishesprocessing, determine whether appropriate client support is setup. For example:

- The client can be set up to disconnect after invoking thetransaction and before the transaction ends.

- SQL Server logs out after sending a client request and,therefore, does not support long-running transactions.

Page 141: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide 10-17

MainframeConnect for DB2/MVS-CICS version 11.1.1 Coordination

➤ NoteAMD2 supports user-defined transactions, which are comparable to long-

running transactions based on Gateway-Library support.

Process Flow During Attention Sequences

Any of the following actions results in an attention sequence:

• Database-Library issues a dbcancel( ) command.

• A SQL user cancels processing while the server is sending results.

• An APT program or form issues a closesql command.

When an attention sequence is issued, the process flow is as follows:

1. Open Client issues an attention packet to DirectConnect, thendiscards anything else received until it receives a TDSDONE packetwith the attention Ack bit on.

2. DirectConnect converts the attention packet into a SNA SIGNALcommand, issuing an LU 6.2 request-to-send verb.DirectConnect then discards any results received from themainframe until receiving a TDS DONE packet with theattention Ack bit on.

3. At the mainframe, CICS receives the SIGNAL command andinforms Open ServerConnect.

4. Gateway-Library passes back a return code, indicatingTDS_CANCEL_RECEIVED, on all subsequent TDSNDROW,TDSNDMSG, and TDSETPRM calls from an application. Any dataassociated with TDSNDROW or TDSNDMSG calls is discarded untilthe application issues a TDSNDDON call.

For details on these calls, see the Open ServerConnectProgrammer’s Reference. COBOL and PL/1 versions of this guideare available.

5. When the application issues a TDSNDDON call, OpenServerConnect support sends a TDS DONE packet with theattention Ack bit on. This ends the attention sequence.

Page 142: MainframeConnect™ for DB2/MVS-CICS Installation and ...

10-18 Troubleshooting

Coordination MainframeConnect for DB2/MVS-CICS version 11.1.1

Page 143: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Appendixes

Page 144: MainframeConnect™ for DB2/MVS-CICS Installation and ...
Page 145: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-1

A Error Messages A.

This appendix describes provides general information about themessages that MainframeConnect returns. It also lists and describeseach message, providing a probable cause and suggested course ofaction.

Understanding the Messages

This section provides the following information:

• Message sources

• How errors are logged

• Interpreting the messages

• Understanding TDSNDMSG properties

Message Sources

Two sources for MainframeConnect messages are:

• MainframeConnect

• Messages mapped to SQL Server

MainframeConnect Messages

The SQL transaction processing component of MainframeConnectreturns messages identified by “MainframeConnect error.”

These messages have a 5-digit message number and consist oftwo types:

• DB2 messages forwarded from DB2 to the client

• Internal messages generated by the SQL transaction processorAMD2

The AMD2 message table handles both types of messages. Thismessage processing table, which consists of a translation table and atext table, is created during installation of MainframeConnect. It isan editable table that can be customized to suit customerrequirements. For more information about the AMD2 message tableand customizing MainframeConnect messages, see Chapter 8,“Customizing MainframeConnect Messages.”

Page 146: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-2 Error Messages

Understanding the Messages MainframeConnect for DB2/MVS-CICS version 11.1.1

DB2 Messages

DB2 errors generate messages that are returned to AMD2. The AMD2message table processes the DB2 SQLCODEs and forwards the DB2message and any additional information, such as SQL codes, to theclient.

Internal Messages

The AMD2 message table processes MainframeConnect internalmessages and sends them to the client.

Messages Mapped to SQL Server Messages

MainframeConnect maps its messages to SQL Server messageswhere appropriate. The AMD2 message table, described in theprevious section, performs this mapping. These messages areidentified by 3- or 4-digit message numbers, compared to the 5-digitnumbers used for the other messages.

How Errors are Logged

The AMD2 message table determines the logging of errors forMainframeConnect. If the translation table LOG property is Y for agiven message, that message writes to the AMD2LOG error log. Likeother parts of the message table, the value of the LOG property canbe changed to meet a customer’s error logging requirements.

AMD2LOG and AMD2LOGO are VSAM ESDS files installed as partof the product. Logged errors originally write to the AMD2LOG file.When AMD2LOG becomes full or does not accept messages for anyreason, errors write to the overflow file, AMD2LOGO.

When this occurs, you should close, archive (if desired), and purgethe AMD2LOG file. While AMD2LOG is closed, errors write toAMD2LOGO. When AMD2LOG is reopened, the systemprogrammer can close, archive, and purge AMD2LOGO. WhenAMD2LOGO is closed, errors automatically redirect to AMD2LOG.

Defining Log Files to CICS

The CICS system programmer must define the error log files to CICSin an FCT entry. This section shows sample FCT entries forAMD2LOG and AMD2LOGO.

Page 147: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-3

MainframeConnect for DB2/MVS-CICS version 11.1.1 Understanding the Messages

AMD2LOG:

DFHFCT TYPE=DATASET,ACCMETH=VSAM,DATASET=AMD2LOG,RECFORM=(FIXED,BLOCKED),DSNAME=your.AMD2log.dataset.name,DISP=SHR,SERVREQ=(ADD,BROWSE)

AMD2LOGO:

DFHFCT TYPE=DATASET,ACCMETH=VSAM,DATASET=AMD2LOGO,RECFORM=(FIXED,BLOCKED),DSNAME=your.AMD2logo.dataset.name ,DISP=SHR,SERVREQ=(ADD,BROWSE)

Interpreting the Messages

To help you understand what to do in response to a message, themessages are presented as follows:

Error xxxxx

Message text

Explanation

Why the error occurred

Action

The action we recommend to correct the problem

If the action recommended does not correct the problem, youshould do one of the following:

- Run the error report facility for additional information aboutthe error.

- Rerun the failing situation with SDLC or Token-Ring traceactivated.

Message Source

The source of the message

Page 148: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-4 Error Messages

Understanding the Messages MainframeConnect for DB2/MVS-CICS version 11.1.1

In some cases, the message text uses different terms to refer to theproducts, as shown in the following table:

Table A-1: Abbreviations for message text

This abbreviation Stands for...DB2 Access Module MainframeConnect for DB2/MVS-CICSMainframeConnect MainframeConnect for DB2/MVS-CICSGWLib Gateway-LibraryMSG Transaction Router Service Library (formerly

Mainframe Server Gateway)AMD2 The name of the MainframeConnect

transactionAMD2LOG andAMD2LOGO

The names of the MainframeConnect primaryand backup error log files

Page 149: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-5

MainframeConnect for DB2/MVS-CICS version 11.1.1 MainframeConnect Error Messages

MainframeConnect Error Messages

The MainframeConnect error messages are listed in numerical orderon the following pages.

Page 150: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-6 Error Messages

Error 102 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 102

Incorrect syntax (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the SQLCODE returned inthe %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 151: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-7

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 103

Error 103

String is too long (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the SQLCODE returned inthe %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 152: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-8 Error Messages

Error 105 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 105

Unclosed quote (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 153: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-9

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 106

Error 106

Too many table names (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 154: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-10 Error Messages

Error 108 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 108

Order-by position is out of range of number of itemsin the select-list (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 155: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-11

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 109

Error 109

There are more columns in the INSERT statement thanvalues specified in the VALUES clause. The numberof values in the VALUES clause must match the numberof columns specified in the INSERT statement (DB2%s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 156: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-12 Error Messages

Error 131 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 131

Size exceeds maximum (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 157: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-13

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 147

Error 147

Aggregate function may not appear in WHERE clauseunless in subquery in HAVING clause (DB2 %s failed:%S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 158: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-14 Error Messages

Error 164 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 164

GROUP BY expressions must refer to column names thatappear in the SELECT list (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 159: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-15

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 183

Error 183

Scale out of range (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 160: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-16 Error Messages

Error 189 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 189

Function has incorrect number of arguments (DB2 %sfailed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 161: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-17

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 191

Error 191

SQL statement nested too deeply, too long or toocomplex (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 162: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-18 Error Messages

Error 193 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 193

Object or column name is too long (DB2 %s failed:%S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 163: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-19

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 206

Error 206

Operand type clash (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 164: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-20 Error Messages

Error 207 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 207

Invalid column name (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 165: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-21

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 209

Error 209

Ambiguous column name (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 166: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-22 Error Messages

Error 220 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 220

Arithmetic overflow (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 167: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-23

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 229

Error 229

Permission denied (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 168: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-24 Error Messages

Error 233 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 233

Column may not be null (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 169: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-25

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 241

Error 241

Syntax error converting DATETIME from characterstring (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 170: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-26 Error Messages

Error 242 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 242

Conversion to DATETIME resulted in a DATETIME valueout of range (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 171: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-27

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 254

Error 254

Maximum number of columns exceeded (DB2 %s failed:%S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 172: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-28 Error Messages

Error 255 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 255

Maximum row size exceeded (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 173: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-29

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 257

Error 257

Datatype conversion not allowed (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 174: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-30 Error Messages

Error 264 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 264

Column name appears more than once (DB2 %s failed:%S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 175: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-31

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 267

Error 267

Object cannot be found (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 176: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-32 Error Messages

Error 512 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 512

Subquery returned more than 1 value (DB2 %s failed:%S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 177: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-33

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 536

Error 536

Invalid length parameter passed to the substringfunction (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 178: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-34 Error Messages

Error 546 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 546

Foreign key constraint violation occurred (DB2 %sfailed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 179: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-35

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 547

Error 547

Dependent foreign key constraint violation in areferential integrity constraint (DB2 %s failed:%S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 180: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-36 Error Messages

Error 550 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 550

The insert or update is not allowed because aresulting row does not satisfy the view definition.(DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 181: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-37

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 557

Error 557

Cursor cannot be found (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 182: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-38 Error Messages

Error 558 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 558

Attempt to open a cursor which is already open (DB2%s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 183: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-39

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 559

Error 559

Attempt to issue a cursor which is not open (DB2 %sfailed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 184: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-40 Error Messages

Error 560 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 560

Cursor in Update or Delete is not positioned on arow (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 185: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-41

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 593

Error 593

The UPDATE WHERE CURRENT OF to a cursor failedbecause the column being updated was not specifiedin the FOR UPDATE OF list (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 186: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-42 Error Messages

Error 1903 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 1903

Index too large (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 187: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-43

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 1904

Error 1904

Too many columns for index (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 188: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-44 Error Messages

Error 2714 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 2714

Object already exists (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 189: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-45

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 4403

Error 4403

View is not updatable (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 190: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-46 Error Messages

Error 4409 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 4409

Columns in the query definition and the viewdefinition do not match (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 191: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-47

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 4607

Error 4607

Privilege may not be GRANTed or REVOKEd (DB2 %sfailed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

AMD2 (module AMD2CAMX) call to DB2 that is mapped to a SQLServer message

Page 192: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-48 Error Messages

Error 30000 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 30000

DB2 Access Module DBMS error (DB2 %s failed: %S)

Explanation

Request failed. The cause is indicated by the DB2 message text andSQLCODE returned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

See your DB2 documentation.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 193: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-49

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 30001

Error 30001

DB2 Access Module DBMS warning (DB2 %s warning: %S)

Explanation

The cause is indicated by the DB2 message text and SQLCODEreturned in the %S variable.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

No action required. This is only a warning. For more information,look up the message and SQLCODE in your DB2 documentation.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 194: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-50 Error Messages

Error 30002 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 30002

DB2 Access Module DBMS confirm (DB2 %s completedsuccessfully: %S)

Explanation

The DB2 request completed without errors.

• %s is replaced by a string message variable value.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

Action

No action required.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 195: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-51

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 30003

Error 30003

DB2 Access Module DBMS info (DB2 completed SQLCODE= %d, SQLSTATE = %s)

Explanation

Informational message providing the SQLCODE and statement.

• %d is the return code number.

• %s is replaced by a string message variable value.

Action

No action.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 196: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-52 Error Messages

Error 32000 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 32000

DB2 Access Module GWLib error (%s returned %d)

Explanation

An internal MainframeConnect error occurred.

• %s is replaced by a string message variable value.

• %d is the return code number.

Action

Record the return code, and contact Sybase Technical Support.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

➤ NoteMore than one type of error can generate this number. See “Error 32000”

on page A-53 for more information.

Page 197: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-53

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 32000

Error 32000

tds_ms error (tdinflog, etc)

Explanation

An internal MainframeConnect error occurred.

Action

Contact Sybase Technical Support.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

➤ NoteMore than one type of error can generate this number. See “Error 32000”

on page A-52 for more information.

Page 198: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-54 Error Messages

Error 33214 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 33214

DB2 Access Module error (Get storage failed)

Explanation

The AMD2 transaction was unable to get requested storage. CICS isrunning short on storage.

Action

Ask the CICS system programmer to increase the size of the DSA orEDSA storage pools in the CICS start-up procedure.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 199: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-55

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 33215

Error 33215

DB2 Access Module error (Illogical request in I/Oroutine. Request not honored because host cannotcontinue.)

Explanation

A MainframeConnect error.

Action

Contact Sybase Technical Support.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 200: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-56 Error Messages

Error 33216 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 33216

DB2 Access Module error (Invalid request in I/Oroutine. Internal error.)

Explanation

A MainframeConnect error.

Action

Contact Sybase Technical Support.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 201: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-57

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 33218

Error 33218

DB2 Access Module error (Rollback error)

Explanation

MainframeConnect received an error while attempting to roll back atransaction.

Action

Check the CICS and DB2 error logs to determine the reason for therollback error.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 202: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-58 Error Messages

Error 33219 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 33219

DB2 Access Module error (Write to log file AMD2LOGfailed, switching to overflow log AMD2LOGO)

Explanation

MainframeConnect is now writing messages to the secondary errorlog, AMD2LOGO. MainframeConnect is unable to write to theprimary error log, AMD2LOG, possibly because it is full.

Action

No immediate action is required. Before AMD2LOGO fills up, youneed to determine why the write to AMD2LOG failed and correct thecondition. If AMD2LOG is full, follow your site's procedures forstoring error log information; then delete the messages fromAMD2LOG and reopen it. After you reopen AMD2LOG,MainframeConnect directs messages there.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 203: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-59

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 33220

Error 33220

DB2 Access Module error (Write to overflow log fileAMD2LOGO failed. Error not logged.)

Explanation

MainframeConnect is unable to write to the overflow error log,AMD2LOGO, possibly because it is full.

Action

Determine why the write to AMD2LOGO failed and correct thecondition.

If AMD2LOGO is full:

1. Follow your site's procedures for storing message loginformation in AMD2LOGO and AMD2LOG.

2. Delete the archive or purge messages from AMD2LOGO andAMD2LOG.

3. Reopen AMD2LOG so that MainframeConnect redirectsmessages to AMD2LOG.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 204: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-60 Error Messages

Error 33221 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 33221

DB2 Access Module error (Datatype %d not supported)

Explanation

The specified datatype is not supported by MainframeConnect forDB2. %d is replaced by a numeric message variable value.

Action

The client must use a supported datatype in the request.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 205: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-61

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 33222

Error 33222

DB2 Access Module error (Illogical request in DB2routine. Request not honored because DB2 cannotcontinue.)

Explanation

An error in the MainframeConnect code.

Action

Contact Sybase Technical Support.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 206: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-62 Error Messages

Error 33223 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 33223

DB2 Access Module error (Invalid request in DB2routine. Internal error.)

Explanation

An internal error.

Action

Contact Sybase Technical Support.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 207: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-63

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 33224

Error 33224

DB2 Access Module error (No SQLDA. Internal error.)

Explanation

An internal error.

Action

Contact Sybase Technical Support.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 208: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-64 Error Messages

Error 33225 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 33225

DB2 Access Module error (DB2 SQL statement toolong.)

Explanation

The SQL statement received from the client exceeds the maximumnumber of characters allowed by MainframeConnect andDirectConnect.

Action

Requests sent by the client must be limited to fewer than 32,705characters.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 209: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-65

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 33226

Error 33226

DB2 Access Module error (DB2 Invalid character inSQL statement at position %d)

Explanation

The request failed because it included an invalid character. %d isreplaced by a numeric message variable value.

Action

Identify the invalid character and remove it; then resubmit therequest.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 210: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-66 Error Messages

Error 33227 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 33227

DB2 Access Module error (No SQL statement.)

Explanation

MainframeConnect did not receive any SQL from the client.

Action

• If the client is an application, the client should resubmit therequest.

• If the client is SQL Server, the system administrator should checkthe stored procedure for errors.

• If the client is an application other than SQL Server, check theapplication.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 211: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-67

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 33228

Error 33228

DB2 Access Module error (Long varchar column datatruncated when truncation not allowed.)

Explanation

MainframeConnect retrieved a LongVarChar column with datagreater than 255 bytes when TRS was set to prevent truncation ofLongVarChar columns.

Action

Reset the truncate option when you start MSG or avoid fetchingcolumns that exceed 255 bytes.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 212: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-68 Error Messages

Error 33229 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 33229

DB2 Access Module error (Stack overflow. Internalerror.)

Explanation

MainframeConnect internal stack overflowed.

Action

Contact Sybase Technical Support.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 213: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-69

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 33230

Error 33230

DB2 Access Module error (Abend, code = %s)

Explanation

If the abend code is AE49, the attachment facility did not start. %s isreplaced by a string message variable value.

Action

For other abend codes, contact Sybase Technical Support.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 214: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-70 Error Messages

Error 33231 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 33231

DB2 Access Module error (Message table not loadedor code not matched. Message code = %d, sql error =%S)

Explanation

MainframeConnect message table (module AMD2CAMX) could notbe loaded, or the message code generated within MainframeConnectcould not be matched in AMD2CAMX.

This message always returns in U.S. English.

• %S is replaced by the DB2 DSNTIAR message information,including the SQLCA message tokens and the SQLCODE.

• %d is replaced by a numeric message variable value.

Action

Be sure AMD2CAMX is correctly defined to CICS. If AMD2CAMXwas customized at your site, be sure no message codes are removed;otherwise, contact Sybase Technical Support.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 215: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-71

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 33232

Error 33232

DB2 Access Module error (Default options will beused; failure in %s, error = %d)

Explanation

An internal error in a call prevented MainframeConnect from settingthe options in the TDCUSTOM CSECT (control section, the Assemblerverb starting the program) through the customization macroSYGWMCST. The default options are used. MainframeConnect issuesthis message each time it is invoked until the error is resolved, but itstill processes incoming SQL.

• %s is replaced by a string message variable value.

• %d is replaced by a numeric message variable value.

Action

Contact Sybase Technical Support.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 216: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-72 Error Messages

Error 33233 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 33233

DB2 Access Module error (Parsexit will not beinvoked; failure in %s, error = %d)

Explanation

An internal error in a Gateway-Library call specifically for the parseexit routine failed. The parse exit routine is not invoked for thisinstance of the AMD2 transaction. MainframeConnect issues thismessage each time it is invoked until the error is resolved, but it stillprocesses incoming SQL.

• %s is replaced by a string message variable value.

• %d is replaced by a numeric message variable value.

Action

Contact Sybase Technical Support.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 217: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-73

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 33234

Error 33234

DB2 Access Module error (Transactions cannot belabeled.)

Explanation

A transaction statement included a label. AMD2 does not supportlabels such as begin tran mytran, where mytran is a label for thetransaction.

Action

If a transaction is in progress when AMD2 receives the invalidstatement, MainframeConnect ignores it and the transactioncontinues. If a transaction is not in progress, then AMD2 issues arollback and a transaction does not begin.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 218: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-74 Error Messages

Error 33235 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 33235

DB2 Access Module error (Transaction must be endedbefore another transaction is begun.)

Explanation

A begin tran statement was sent to AMD2 before the current transactionwas terminated by commit, end tran or rollback.

Action

This error message is returned to the client, but the transactionremains active, waiting for the next SQL text to be sent.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 219: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-75

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 33236

Error 33236

DB2 Access Module error (BEGIN or END must befollowed by TRAN or TRANSACTION.)

Explanation

A begin or end statement was sent to AMD2 without tran or transaction.

Action

MainframeConnect returns this error message to the client. If atransaction is in progress, it continues. If a transaction is not inprogress, then another transaction does not begin.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 220: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-76 Error Messages

Error 33242 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 33242

DB2 Access Module error (Request or RSP not found.)

Explanation

MainframeConnect did not find the remote stored procedure (RSP)or host resident request specified in the use statement.

Action

Refer to the RSP.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 221: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-77

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 33300

Error 33300

DB2 Access Module error (No dynamic entriesavailable.)

Explanation

MainframeConnect supports 1–50 dynamic requests. This limit wasexceeded.

Action

Reduce the number of dynamic requests to 50 or less.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 222: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-78 Error Messages

Error 33301 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 33301

DB2 Access Module error (Selects not allowed fordynamic events.)

Explanation

The SQL entered for a dynamic event was a select statement, which isnot allowed.

Action

To process a select statement, either execute it as a language requestor open a cursor.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 223: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-79

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 33302

Error 33302

DB2 Access Module error (Invalid cursor event, %d,received.)

Explanation

An invalid cursor event was received from DirectConnect. The eventnumber appears. This is an internal error.

Action

Report this information to your DirectConnect administrator.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 224: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-80 Error Messages

Error 33303 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 33303

DB2 Access Module error (Unable to declare cursor;all cursor ids are in use.)

Explanation

The maximum number of dynamic events are currently in aprepared state.

Action

Free at least one dynamic event name to prepare another dynamicevent.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 225: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-81

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 33304

Error 33304

DB2 Access Module error (Declare cursor was not aselect statement.)

Explanation

The SQL statement supplied when declaring a cursor must be a validSQL select statement.

Action

Provide a valid select statement for the cursor request. Forinformation, see your DB2 documentation.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 226: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-82 Error Messages

Error 33305 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 33305

DB2 Access Module error (Invalid cursor ID of %dsupplied.)

Explanation

The cursor ID that the cursor request supplied does not match acursor ID that was prepared by MainframeConnect.

Action

Make sure that a cursor with this ID is prepared before attempting touse the ID.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 227: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-83

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 33306

Error 33306

DB2 Access Module error (Unknown Open Serverdatatype %d supplied.)

Explanation

An attempt to send data of a type that is not recognized byMainframeConnect occurred.

Action

Change the client application to supply the correct datatype. Seeyour DirectConnect documentation for more information.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 228: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-84 Error Messages

Error 33307 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 33307

DB2 Access Module error (Cursor name of %s does notmatch what was given in the update sql statement.)

Explanation

A cursor was prepared using one cursor name and the client tried toupdate the cursor using a different cursor name.

Action

Change the client application to specify the correct cursor names.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 229: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide A-85

MainframeConnect for DB2/MVS-CICS version 11.1.1 Error 33308

Error 33308

DB2 Access Module error (bad parms in bulk load.)

Explanation

MainframeConnect received bad parameters in a bulk load request.

Action

Try the transfer again.

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 230: MainframeConnect™ for DB2/MVS-CICS Installation and ...

A-86 Error Messages

Error 33400 MainframeConnect for DB2/MVS-CICS version 11.1.1

Error 33400

Sample Parsexit message for sample parse exit: SQLCommand was not a Select; batch aborted.

Explanation

The sample parse exit routine issues this message. The sampleprogram rejects all incoming SQL except SELECT statements.

Action

For information about disabling the parse exit routine, see “ParseExit Routine” in Chapter 9, “User Exits.” For information aboutchanging the AMD2 message table, see “Changing the AMD2 MessageTable” in Chapter 8, “Customizing MainframeConnect Messages.”

Message Source

DB2 Access Module - AMD2 (module AMD2CAMX)

Page 231: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide B-1

B DB2 Database AdministratorInformation for TRS B.

This section is intended for the DB2 database administrator. Itdescribes Sybase-defined tables that store requested Catalog StoredProcedure (CSP) information that is not available in the DB2 catalog.This information is for application programs on personal computersand workstations.

➤ NoteFor comparable Access Service information, see the DirectConnect forMVS Access Service User’s Guide.

This appendix contains the following sections:

• Stored Procedures and DBMS B-1

• Keeping Server and Stored Procedure Information Current B-1

Stored Procedures and DBMS

Several CSPs access tables that the DB2 database administratormaintains, including the tables shown in the following table.

During installation of the CSPs, the tables that these CSPs query arecreated and populated.

For details on the CSPs, see the DirectConnect for MVS Access ServiceUser’s Guide.

Keeping Server and Stored Procedure Information Current

This section specifies changes to consider to keep server and storedprocedure information current at your site.

Table B-1: DB2 Database administrator-maintained tables

Member Description

sp_server_info The server, including capabilities and limitations

sp_sproc_columns Stored procedures that an application can execute

sp_stored_procedures Stored procedures executable from DirectConnect

Page 232: MainframeConnect™ for DB2/MVS-CICS Installation and ...

B-2 DB2 Database Administrator Information for TRS

Keeping Server and Stored Procedure Information Current MainframeConnect for DB2/MVS-CICS version 11.1.1

New Stored Procedures

The CSPs, sp_capabilities and sp_thread_props, are included forOmniConnect support.

• sp_capabilities returns information about the capabilities of the TRSso that OmniConnect knows how to format its DB2 statementscorrectly.

• sp_thread_props returns minimal information at this time.

Stored Procedure Names on DirectCONNECT

sp_stored_procedures stores the names of procedures executable fromDirectConnect.

Page 233: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Glossary-1

Glossary

abendThe abnormal ending of a task.

accessTo obtain the use of a computer resource.

access codeA number or binary code assigned to programs, documents, or folders that allowsauthorized users to access them.

Access Service Library (ACSLIB)A component of DirectConnect, a service library that provides access to non-Sybase data contained in a database management system or other type ofrepository. Each such repository is called a “target.” Each access service libraryinteracts with exactly one target and is named accordingly. See also service library.

ACFSee Advanced Communications Function.

ACSLIBSee Access Service Library.

Advanced Communications Function (ACF)A group of IBM licensed programs, principally VTAM programs, TCAM, NCP,and SSP, that use the concepts of Systems Network Architecture (SNA), includingdistribution of function and resource sharing.

Advanced Peer-to-Peer Networking (APPN)An extension to SNA featuring (a) greater distributed network control that avoidscritical hierarchical dependencies, thereby isolating the effects of single points offailure; (b) dynamic exchange of network topology information to foster ease ofconnection, reconfiguration, and adaptive route selection; (c) dynamic definitionof network resources; and (d) automated resource registration and directorylookup. APPN extends the LU 6.2 peer orientation for end-user services to networkcontrol and supports multiple LU types, including LU 2, LU 3, and LU 6.2.

Page 234: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Glossary-2

MainframeConnect for DB2/MVS-CICS version 11.1.1

advanced program-to-program communication (APPC)Hardware and software that characterize the LU 6.2 architecture and its variousimplementations in products. See also logical unit 6.2.

algorithmAn ordered set of well-defined rules for the solution of a problem in a finitenumber of steps.

American Standard Code for Information InterchangeSee ASCII.

APARSee authorized program analysis report.

APISee application program interface.

APPCSee advanced program-to-program communication.

APPC communications linkHardware and software configured to enable a remote transaction program toestablish an APPC conversation with a partner transaction program in an SNAnetwork. See also Systems Network Architecture.

APPNSee Advanced Peer-to-Peer Networking.

applicationThe use to which an information processing system is put; for example, a payrollapplication, an airline reservation application, a network application.

application planThe control structure produced during the bind process and used by the DB2program to process SQL statements during application execution.

application programA program that is specific to the solution of an application problem.

Page 235: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Glossary-3

MainframeConnect for DB2/MVS-CICS version 11.1.1

application program interface (API)A functional interface, supplied by an operating system or other licensed program,that allows an application program written in a high-level language to use specificdata or functions of the operating system or the licensed program.

application programmerA programmer who designs programming systems and other applications for auser that applies to the user’s work.

APTSee automatically programmed tools.

argumentA value supplied to a function or procedure that is required to evaluate thefunction.

ASCII (American Standard Code for Information Interchange)A 7-bit standard code that permits transmittal of text, numbers, and some specialcharacters among systems. Characters are represented by the numbers between 32and 127, inclusive. The set includes uppercase and lowercase letters, numbers, andfrequently-used special characters (such as $ & ; : # . ,).

assembleTo translate an assembly language program into an object program.

assembler languageA source language that includes symbolic machine language statements in whichthere is a one-to-one correspondence with the instruction formats and data formatsof the computer.

attachTo connect a device logically to a ring network.

authorityThe right to access objects, resources, or functions.

authorized program analysis report (APAR)A report of a problem caused by a suspected defect in a current unaltered releaseof a program.

Page 236: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Glossary-4

MainframeConnect for DB2/MVS-CICS version 11.1.1

automatically programmed tools (APT)A programming language for numerically-controlled machine tools.

auxiliary storageAll addressable storage, other than main storage, that can be accessed by means ofan input/output channel; for example, storage on magnetic tape or direct accessdevices.

batchA group of records or data processing jobs brought together for processing ortransmission.

base tapeSee Open ServerConnect for CICS/MVS base tape.

bindSQL statements from a compiled mainframe program where the access to DB2 wasoptimized and saved as static SQL in an application plan.

blockIn programming languages, a compound statement that coincides with the scopeof at least one of the declarations contained within it. A block can also specifystorage allocation or segment programs for other purposes.

block sizeThe number of data elements in a block.

bridgeIn the connection of local loops, channels, or rings, the equipment and techniquesused to match circuits and to facilitate accurate data transmission. A bridgeconnects networks or systems of the same or similar architectures, whereas agateway connects networks or systems of different architectures. Contrast withgateway, router.

callThe action of bringing a computer program, a routine, or a subroutine into effect,usually by specifying the entry conditions and jumping to an entry point.

catalogA system table that contains information about objects in a database, such astables, views, columns, and authorizations.

Page 237: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Glossary-5

MainframeConnect for DB2/MVS-CICS version 11.1.1

Catalog Stored Procedure (CSP)A procedure that provides information about tables, columns, and authorizations.It is used in SQL generation and application development.

chainA group of logically-linked user data records processed by LU 6.2.

channel-attachedDevices attached to a controlling unit by cables, rather than by telecommunicationlines.

character dataData in the form of letters and special characters, such as punctuation marks.

character setA set of specific (usually standardized) characters with an encoding scheme thatuniquely defines each character. ASCII is a common character set.

character stringA sequence of consecutive characters that are used as a value.

CICSSee Customer Information Control System.

CICS regionThe CICS area of the computer system in which an application is running.

clientIn client/server systems, the part of the system that sends requests to servers andprocesses the results of those requests. See also client/server. Contrast with server.

client applicationSoftware that is responsible for the user interface, including menus, data entryscreens, and report formats or an application that sends requests to anotherapplication that acts as a server. See also client, client/server, server.

client/serverAn architecture in which the client is an application that handles the user interfaceand local data manipulation functions, while the server provides data processingaccess and management for multiple clients. See also client application.

Page 238: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Glossary-6

MainframeConnect for DB2/MVS-CICS version 11.1.1

Client Services Application (CSA)A customer-written CICS program initiated on the host that uses the Sybase API toinvoke MainframeConnect for DB2 as a client to MainframeConnect or to SQLServer. See also application program interface.

clusterA station that consists of a control unit (a cluster controller) and the terminalsattached to it.

cluster controllerA device that can control the input/output operations of more than one deviceconnected to it. A cluster controller can be controlled by a program stored andexecuted in the unit, or it can be entirely controlled by hardware.

COBOL (common business-oriented language)A high-level programming language, based on English, that is used primarily forbusiness applications.

code pageAn assignment of graphic characters and control function meanings to all codepoint.

commandAn order for an action to take place.

command levelAn operation performed for a particular command in a program.

commitAn instruction to a database to make permanent all changes made to one or moredatabase files since the last commit or rollback operation, and to make the changedrecords available to other users. Contrast with rollback.

common areaA control section used to reserve a main storage area that can be referred to byother modules.

common business-oriented languageSee COBOL.

Page 239: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Glossary-7

MainframeConnect for DB2/MVS-CICS version 11.1.1

compatibilityThe capability of a hardware or software component to conform with the interfacerequirements of a given data processing system without adversely affecting itsfunctions.

compileTo translate all or part of a program that is expressed in a high-level language intoa computer program that is expressed in an intermediate language, an assemblylanguage, or a machine language.

concatenationTo append one term to another to make a combined term. For example, aaaabbb isa concatenation of aaaa and bbb.

configureTo define to a system the devices, optional features, and programs installed on thesystem.

connectivityThe capability to attach a variety of functional units without modifying them.

control section (CSECT)The part of a program specified by the programmer to be a relocatable unit, allelements of which are to be loaded into adjoining main storage locations.

control statementIn programming languages, a statement that is used to alter the continuoussequential execution of statements; a control statement may be a conditionalstatement, or an imperative statement.

conversationa) A dialog between a user and an interactive data processing system.

b) Within the context of APPC, an exchange of information or a sequence ofmessages sent between two transaction programs. Conversations take placebetween two LUs over an established session. Also, a sequence of messages sentbetween two applications (for instance, client application and SQL Server).

CSECTSee control section.

Page 240: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Glossary-8

MainframeConnect for DB2/MVS-CICS version 11.1.1

CSPSee Catalog Stored Procedure.

cursorIn SQL, a named control structure used by an application program to point to arow of data. The position of the row is within a table or view, and the cursor is usedinteractively to select rows from the columns.

Customer Information Control System (CICS)An IBM licensed program that enables transactions entered at remote terminals tobe processed concurrently by user-written application programs. It includesfacilities for building, using, and maintaining databases.

DASDSee direct access storage device.

data areaA storage area used by a program or device to hold information.

databaseA set of related data tables and other database objects that are organized andpresented to serve a specific purpose.

database management system (DBMS)A computer-based system for defining, creating, manipulating, controlling,managing, and using databases. The software for using a database can be part ofthe database management system, or it can be a stand-alone database system.

Database 2 (DB2)An IBM relational database management system.

data definition statement (DD statement)A job control statement describing a data set associated with a specific job step. Seejob control language.

data objectIn a program, an element of data structure, such as a file, array, or operand, that isneeded for the execution of a program and that is named or otherwise specified bythe allowable character set of the language in which the program is coded.

Page 241: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Glossary-9

MainframeConnect for DB2/MVS-CICS version 11.1.1

data queueAn object that communicates and stores data used by several programs in a job orbetween jobs.

data recordA collection of items of information from the standpoint of its use in an application,as the user supplies it. The data record is stored physically separate from itsassociated control information in a control interval.

datasetThe major unit of data storage and retrieval, consisting of a collection of data in oneof several prescribed arrangements and described by control information to whichthe system has access.

dataset nameThe term or phrase used to identify a dataset.

data sourceA collection of data, such as a database.

datatypeIn programming languages, a set of values together with a set of permittedoperations.

DBCSSee double-byte character set.

DB-LibraryA Sybase and Microsoft API that allows client applications to interact with ODSapplications. See also application program interface.

DBMSSee database management system.

DB2See Database 2.

DD statementSee data definition statement.

Page 242: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Glossary-10

MainframeConnect for DB2/MVS-CICS version 11.1.1

debugTo detect, locate, and eliminate errors in computer programs.

decodeTo convert data by reversing the effect of some previous encoding.

delimiterA character that groups or separates words or values in a line of input.

direct access storage device (DASD)A device in which access time is effectively independent of the location of the data.

DirectConnectA Sybase Open Server application that provides access management for non-Sybase databases, copy management (transfer), and remote systems management.Each DirectConnect consists of a server and one or more service libraries toprovide access to a specific data source. DirectConnect replaces the products “MDIDatabase Gateway” and “Net-Gateway.”

DirectConnect Configuration ToolA Sybase Windows application that provides remote management capabilities forDirectConnect products. These capabilities include starting, stopping, creating,and copying services.

DirectConnect for MVSA Sybase LAN-based solution that communicates with mainframe hostcomponents. It incorporates the functionality of the MDI Database Gateway andthe Sybase Net-Gateway and includes LU 6.2 and TCP/IP support.

directoryA type of file containing the names and controlling information for other files orother directories.

disk volumeA disk pack or part of a disk storage module.

distributed databaseA database that is physically decentralized and handled by a databasemanagement system in a way that provides a logically centralized view of thedatabase to the user.

Page 243: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Glossary-11

MainframeConnect for DB2/MVS-CICS version 11.1.1

double-byte character set (DBCS)A set of characters in which each character is represented by 2 bytes. Languagessuch as Japanese, Chinese, and Korean, which contain more symbols than can berepresented by 256 code points, require double-byte character sets. Because eachcharacter requires 2 bytes, the typing, display, and printing of DBCS charactersrequires hardware and programs that support DBCS. Contrast with single-bytecharacter set.

driverA system or device that enables a functional unit to operate.

dumpTo record, at a particular moment, the contents of all or part of one storage devicein another storage device. Dumping is usually for the purpose of debugging.

dynamic SQLPertaining to the preparation and processing of SQL source statements within aprogram while the program runs. The SQL source statements are contained inhost-language variables rather than being coded directly into the applicationprogram. The SQL statement can change several times while the program runs.Contrast with static SQL.

EBCDIC (Extended Binary-Coded Decimal Interchange Code)A coded character set of 256 8-bit characters.

echoIn data communication, a reflected signal on a communications channel. On acommunications terminal, each signal is displayed twice, once when entered at thelocal terminal and again when returned over the communications link. This allowsthe signals to be checked for accuracy.

embedded SQL (ESQL)SQL statements that are embedded within a program and are prepared in theprogram preparation process before the program runs. After it is prepared, thestatement itself does not change, although values of host variables specified withinthe statement might change.

enableIn interactive communications, to load and start a subsystem, or to design aproduct in such a way as to facilitate the inclusion of national language functions.

Page 244: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Glossary-12

MainframeConnect for DB2/MVS-CICS version 11.1.1

end-of-fileA coded character recorded on a data medium to indicate the end of the mediumor end of data.

Enterprise ConnectThe encompassing architecture upon which Sybase implements heterogeneousdata integration. Compare with DirectConnect.

environment variableA variable that describes how an operating system runs and the devices itrecognizes.

error logA dataset or file in a product or system where error information is stored for lateraccess.

error messageA message that a program issues, usually to the client application, when it detectsan error condition.

ESQLSee embedded SQL.

executeTo carry out an instruction.

exit routineA user-written routine that receives control at predefined user exit points.

expressionIn programming languages, a language construct for computing a value from oneor more operands; for example, literals, identifiers, array references, and functioncalls.

Extended Binary-Coded Decimal Interchange CodeSee EBCDIC.

FCTSee forms control table.

Page 245: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Glossary-13

MainframeConnect for DB2/MVS-CICS version 11.1.1

fieldThe smallest identifiable part of a record.

fileA collection of related data that is stored and retrieved by an assigned name.

fixed-length recordA record having the same length as all other records with which it is logically orphysically associated. Contrast with variable-length record.

FMHSee function management header.

formatIn programming languages, a language construct that specifies the representation,in character form, of data objects in a file.

forms control table (FCT)An object that contains the special processing requirements for output datastreams received from a host system by a remote session.

fullwordA word suitable for processing by a given computer, usually treated as a unit.

function management header (FMH)One or more headers, optionally present in the leading request units (RUs) of anRU chain, that allow one LU to (a) select a transaction program or device at thesession partner and control the way in which the end-user data it sends is handledat the destination, (b) change the destination or the characteristics of the dataduring the session, and (c) transmit between session partners status or userinformation about the destination (for example, a program or device). Functionmanagement headers can be used with LU type 1, 4, and 6.2 protocols.

gatewayConnectivity software that allows two or more computer systems with differentnetwork architectures to communicate. Contrast with bridge, router.

globalizationThe combination of internationalization and localization. See alsointernationalization, localization.

Page 246: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Glossary-14

MainframeConnect for DB2/MVS-CICS version 11.1.1

global variableA variable defined in one portion of a computer program and used in at least oneother portion of the computer program. Contrast with local variable.

graphical user interface (GUI)A type of computer interface consisting of a visual metaphor of a real-world scene,often of a desktop. Within that scene are icons, representing actual objects, that theuser can access and manipulate with a pointing device.

group IDA combination of alphanumeric characters that corresponds to a specific groupname. The group ID can often be substituted in commands that take a group nameas a value.

GUISee graphical user interface.

halfwordA contiguous sequence of bits or characters that constitutes half a computer wordand can be addressed as a unit.

handlerA routine that controls a program’s reaction to specific external events; forexample, an interrupt handler.

hexadecimalA system of numbers to the base 16; hexadecimal digits range from 0 through 9 andA through F, where A represents 10 and F represents 16.

hostThe mainframe or other machine on which a database, an application, or aprogram resides.

IMSSee Information Management System.

indexA list of the contents of a file or of a document, together with keys or references forlocating the contents.

Page 247: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Glossary-15

MainframeConnect for DB2/MVS-CICS version 11.1.1

Information Management System (IMS)A database/data communication (DB/DC) system that can manage complexdatabases and networks.

interfaceHardware, software, or both, that links systems, programs, or devices.

internationalizationThe process of extracting locale-specific components from the source code andmoving them into one or more separate modules, making the code culturallyneutral so it may be localized for a specific culture. See also globalization. Contrastwith localization.

International Organization for Standardization (ISO)An organization of national standards bodies from various countries established tofacilitate international exchange of goods and services, and develop cooperation inintellectual, scientific, technological, and economic activity.

invokeTo start a command, procedure, or program.

ISOSee International Organization for Standardization.

Japanese Conversion ModuleA component of MainframeConnect that enables Open ServerConnectapplications and the DB2 Access Module AMD2 transaction to convert data thatpasses between the mainframe and client using kanji and hankaku-katakana.

JCLSee job control language.

jobA collection of related programs, identified by appropriate job control statements.

job control language (JCL)In MVS, a control language used to identify a job to an operating system and todescribe the job’s requirements.

Page 248: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Glossary-16

MainframeConnect for DB2/MVS-CICS version 11.1.1

kanjiA graphic character set consisting of symbols used in Japanese idiographicalphabets. Each character is represented by 2 bytes.

keywordIn programming languages, a lexical unit that, in certain contexts, characterizessome language construct; a keyword normally has the form of an identifier.

LANSee local area network.

lengthThe number of characters in a character string.

librarya) A named area on disk that can contain programs and related information (notfiles). A library consists of different sections, called library members.

b) A partitioned dataset containing file members for the mainframe.

library memberA named collection of records or statements in a library.

line feedThe movement of the print or display position to the corresponding position on thenext line.

linkageIn computer security, combining data or information from one information systemwith data or information from another system with the intention to deriveadditional information; for example, the combination of computer files from twoor more sources.

linkage editorA computer program for creating load modules from one or more object modulesor creating load modules by resolving cross references among the modules and, ifnecessary, adjusting addresses.

link-editTo create a loadable computer program by means of a linkage editor. See alsolinkage editor.

Page 249: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Glossary-17

MainframeConnect for DB2/MVS-CICS version 11.1.1

load moduleAll or part of a computer program in a form suitable for loading into main storagefor execution. A load module is usually the output of a linkage editor.

local area network (LAN)A computer network located on the user’s premises and covering a limitedgeographical area. Communication within a local area network is not subject toexternal regulations; however, communication across the LAN boundary can besubject to some form of regulation.

localizationThe process of preparing an extracted module for a target environment. Thefollowing items are addressed: messages are displayed and logged in the user’slanguage; numbers, money, dates, and time are represented using the user’scultural convention; and documents are displayed in the user’s language. See alsoglobalization. Contrast with internationalization.

local variableA variable that is defined and used only in one specified portion of a computerprogram. Contrast with global variable.

log fileThe log file maintained by the MainframeConnect Server. The server log filecontains entries of events for each service managed by the MainframeConnectServer.

logical unit (LU)A type of network-accessible unit that enables end users to gain access to networkresources and communicate with each other.

logical unit 6.2 (LU 6.2)A type of logical unit that supports general communication between programs ina distributed processing environment. See also advanced program-to-programcommunication.

loginThe act of gaining access to a computer system by entering identification andauthentication information at the workstation.

LUSee logical unit.

Page 250: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Glossary-18

MainframeConnect for DB2/MVS-CICS version 11.1.1

LU 6.2See logical unit 6.2.

macroAn instruction in a source language that is to be replaced by a defined sequence ofinstructions in the same source language and that can also specify values forparameters in the replaced instructions.

mainframeA large computer, in particular one to which other computers can be connected sothat they can share facilities the mainframe provides; for example, a System/370computing system to which personal computers are attached so that they canupload and download programs and data.

Mainframe Access ProductsSybase products that enable client applications to communicate with mainframesin a client/server environment. See client/server.

MainframeConnect for DB2/MVS-CICSA Sybase mainframe solution that provides dynamic access to DB2 data. It replacesthe OmniSQL Access Module for DB2 and the functionality in the MDI AccessServer. See also Customer Information Control System, Database 2, MultipleVirtual Storage.

main storageProgram-addressable storage from which instructions and other data can beloaded directly into registers for subsequent execution or processing.

mapA set of values that have defined correspondence with the quantities or values ofanother set.

memberA partition of a partitioned dataset.

message numberThe number that uniquely identifies an error message.

migrationInstallation of a new version or release of a program to replace an earlier version orrelease.

Page 251: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Glossary-19

MainframeConnect for DB2/MVS-CICS version 11.1.1

moduleA program unit that is discrete and identifiable with respect to compiling,combining with other units, and loading; for example, the input to or output froman assembler, compiler, linkage editor, or executive routine.

Multiple Virtual Storage (MVS)An IBM operating system that runs on most System/370 and System/390mainframes. It supports 24-bit addressing up to 16 megabytes.

Multiple Virtual Storage/Enterprise Systems Architecture (MVS/ESA)An IBM operating system that extends virtual memory to 16 terabytes. It allowslarger applications, such as DB2, to run more efficiently.

Multiple Virtual Storage/Extended Architecture (MVS/XA)A version of MVS that supports 31-bit addressing of up to 2 gigabytes.

MVSSee Multiple Virtual Storage.

MVS/ESASee Multiple Virtual Storage/Enterprise Systems Architecture.

MVS/XASee Multiple Virtual Storage/Extended Architecture.

NCPSee Network Control Program.

Net-GatewayA Sybase product that provides communication between a mainframe and a LANserver. Net-Gateway is the “ancestor” of the DirectConnect Transaction RouterService.

nestTo incorporate one or more structures of one kind into a structure of the same kind;for example, to nest one loop (the nested or inner loop) within another loop (thenesting or outer loop); to nest one subroutine within another subroutine.

networkA configuration of data processing devices and software connected forinformation exchange.

Page 252: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Glossary-20

MainframeConnect for DB2/MVS-CICS version 11.1.1

Network Control Program (NCP)An IBM licensed program that provides communication controller support forsingle domain, multiple-domain, and interConnected network capability.

nullA pointer that does not point to a data object.

OAMSee Omni Access Module.

objectA passive entity that contains or receives information but cannot change theinformation it contains. In MainframeConnect, objects include rows, tables,databases, stored procedures, triggers, defaults, and views.

object codeOutput from a compiler or assembler that is also executable machine code or issuitable for processing to produce executable machine code. Contrast with sourcecode.

ODBCSee Open Database Connectivity.

Omni Access Module (OAM)Provides built-in access to ISAM, RMS, and SQL Server.

Open ClientA Sybase product that provides customer applications, third-party products, andother Sybase products with the interfaces required to communicate with OpenClient and Open Server applications.

Open Client applicationAn application written using Open Client libraries.

Open ClientConnectA Sybase product that provides capability for the mainframe to act as a client toLAN-based resources. See client.

Page 253: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Glossary-21

MainframeConnect for DB2/MVS-CICS version 11.1.1

Open Database Connectivity (ODBC)A Microsoft API that allows access to both relational and non-relational databases.ODBC allows client application developers to produce vendor-neutral Windowsapplications that can access data sources without including code for a specificdatabase. See also application program interface.

Open ServerA Sybase product that provides the tools and interfaces required to create a customserver. For example, clients can route requests to DirectConnect, which is an OpenServer application that they configured to meet specific needs, such as thepreprocessing of SQL statements or decision making about routing RPCs toTransaction Router Service for DB2 or to other servers. See the Open Serverdocumentation for information about this product.

Open ServerConnectA Sybase product that provides capability for programmatic access to mainframedata.

Open ServerConnect for CICS/MVS base tapeAn installation tape that installs the portion of Open ServerConnect that isrequired by MainframeConnect to operate correctly.

overwriteTo write into an area of storage, thereby destroying the data previously stored inthe same area.

parameterA variable that is given a constant value for a specified application and that candenote the application. Contrast with property.

parseIn systems with time sharing, to analyze the operands entered with a commandand create a parameter list for the command processor from the information.

pipeTo direct data so that the output from one process becomes the input to anotherprocess. The standard output of one command can be connected to the standardinput of another with the pipe operator (|). Two commands connected in this wayconstitute a pipeline.

platformThe operating system environment in which a program runs.

Page 254: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Glossary-22

MainframeConnect for DB2/MVS-CICS version 11.1.1

PL/ISee Programming Language/I.

pointerA data element that indicates the location of another data element.

pollTo determine whether any remote device on a telecommunication line is ready totransmit data.

precompileTo process programs containing SQL statements before they are compiled. SQLstatements are replaced with statements that will be recognized by the hostlanguage compiler. The output from this precompile includes source code that canbe submitted to the compiler and used in the bind process.

programA sequence of instructions that a computer can interpret and execute.

programming languageAn artificial language for expressing computer programs.

Programming Language/I (PL/I)A programming language designed for use in a wide range of commercial andscientific computer applications.

propertyA setting for a server or service that defines the characteristics of the service, suchas how events are logged or how datatypes are converted. Contrast withparameter.

protocolA set of rules that governs the behavior of computers communicating on anetwork.

pseudocodeA set of instructions that is logically structured but does not follow the syntax ofany particular programming language.

RDBMSSee relational database management system.

Page 255: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Glossary-23

MainframeConnect for DB2/MVS-CICS version 11.1.1

recordA set of one or more related data items grouped for processing.

relational databaseA database in which data is viewed as being stored in tables consisting of columns(data items) and rows (units of information). Data from different tables can becombined to form new data relationships.

relational database management system (RDBMS)An application that controls relational databases. See also relational database.Contrast with database management system.

remote procedure call (RPC)A stored procedure executed on a different MainframeConnect server from the oneonto which a user is logged.

remote stored procedure (RSP)A customer-written CICS program that resides on the mainframe andcommunicates with MainframeConnect for DB2/MVS. See also CustomerInformation Control System. Contrast with Client Services Application.

requestOne or more database operations the application sends as a unit to the database.During a request, the application gives up control to the DBMS and waits for itsresponse. Depending upon the response, the application commits or rolls back therequest. One or more requests can be grouped into a single unit of work. See alsocommit, rollback.

resource tableA main storage table that associates each resource identifier with an externallogical unit (LU) or application program.

return codeA value returned to a program to indicate the results of an operation requested bythat program.

rollbackAn instruction to a database to back out of the changes requested in a unit of work.Contrast with commit.

Page 256: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Glossary-24

MainframeConnect for DB2/MVS-CICS version 11.1.1

routerAn attaching device that connects two LAN segments, which use similar ordifferent architectures, at the OSI reference model network layer. Contrast withbridge, gateway.

routineA program, or part of a program, that can have general or frequent use.

RPCSee remote procedure call.

RSPSee remote stored procedure.

SBCSSee single-byte character set.

serverA functional unit that provides shared services to workstations over a network.Contrast with client. See client/server.

serviceA functionality available to DirectConnect applications. It is the pairing of a servicelibrary and a set of specific configuration properties.

service libraryA set of configuration properties that determine service functionality. Examples ofservice libraries include access service libraries, transfer service libraries,administrative service libraries, and transaction router service libraries. See alsoAccess Service Library.

shellA command interpreter that acts as an interface between the user and theoperating system. A shell can contain another shell nested inside it; the outer shellis the parent shell and the inner shell is the child.

single-byte character set (SBCS)A character set in which each character is represented by a 1-byte code. Contrastwith double-byte character set.

Page 257: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Glossary-25

MainframeConnect for DB2/MVS-CICS version 11.1.1

SNASee Systems Network Architecture.

socketA unique host identifier created by the concatenation of a port identifier with aTCP/IP address.

source codeThe input to a compiler or assembler, written in a source language. Contrast withobject code.

source languageA language from which statements are translated.

SPAREA (Stored Procedure Communication Area)An area in which a CSA exchanges information with Open ClientConnect.

SQLSee structured query language.

SQLDA (SQL descriptor area)A set of variables used in the processing of certain SQL statements. The SQLDA isintended for dynamic SQL programs.

SQL descriptor areaSee SQLDA.

SQL ServerThe server in the Sybase Client-Server architecture. It manages multiple databasesand multiple users, tracks the actual location of data on disks, maintains mappingof logical data description to physical data storage, and maintains data andprocedure caches in memory.

stagingThe movement of data from an off-line or low-priority device back to an online orhigher-priority device, usually on demand of the system or on request of a user.

stand-aloneAn operation that is independent of any other device, program, or system.

Page 258: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Glossary-26

MainframeConnect for DB2/MVS-CICS version 11.1.1

standard input (STD input)The primary source of data entered into a command. Standard input comes fromthe keyboard unless redirection or piping is used, in which case standard input canbe from a file or the output from another command.

statementA basic unit of SQL, which is a single SQL operation, such as select, update, or delete.

static SQLSQL statements that are embedded within a program and are prepared during theprogram preparation process before the program runs. After being prepared, thestatement itself does not change, although values of host variables specified by thestatement can change. Contrast with dynamic SQL.

STD inputSee standard input.

Stored Procedure Communication AreaSee SPAREA.

stringIn programming languages, the form of data used for storing and manipulatingtext. For example, in PL/I, a string is a sequence of characters or bits that is treatedas a single data item; and in SQL, a string is a character string.

structured fieldA mechanism that permits variable-length data or non-3270 data to be encoded fortransmission in the 3270 data stream.

structured query language (SQL)An IBM industry-standard language for processing data in a relational database.

stubA program module that transfers remote procedure calls and responses between aclient and a server. See client, server.

syntaxThe rules for how to construct a statement.

Page 259: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Glossary-27

MainframeConnect for DB2/MVS-CICS version 11.1.1

Systems AdministratorA user authorized to handle MainframeConnect system administration, includingcreating user accounts, assigning permissions, and creating new databases.

Systems Network Architecture (SNA)An IBM proprietary plan for the logical structure, formats, protocols, andoperational sequences for transmitting information units through networks andcontrolling network configuration and operation. See also advanced program-to-program communication.

Systems ProgrammerA programmer who plans, generates, maintains, extends, and controls the use ofan operating system with the aim of improving overall productivity of aninstallation.

tableAn array of data or a named data object that contains a specific number ofunordered rows. Each item in a row can be unambiguously identified by means ofone or more arguments.

TCP/IPSee Transmission Control Protocol/Internet Protocol.

temporary storageIn computer programming, storage locations reserved for intermediate results.

Time Sharing Option (TSO)An operating system option for the System/370 system; the option providesinteractive time sharing from remote terminals. See also Customer InformationControl System.

transactionAn exchange between a program on a local system and a program on a remotesystem that accomplishes a particular action or result.

transferA DirectConnect feature that allows users to move data or copies of data from onedatabase to another.

transientA program or subroutine that does not reside in main storage or in a temporarystorage area for such a program.

Page 260: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Glossary-28

MainframeConnect for DB2/MVS-CICS version 11.1.1

Transmission Control Protocol/Internet Protocol (TCP/IP))A set of communication protocols that supports peer-to-peer connectivityfunctions for both local and wide area networks.

troubleshootTo detect, locate, and eliminate errors in computer programs or faults in hardware.

TSOSee Time Sharing Option.

uppercasePertaining to the capital letters, as distinguished from the small letters; forexample, A, B, G, rather than a, b, g.

variableAn entity that is assigned a value. DirectConnect has two kinds of variables, calledlocal variables and global variables.

variable-length recordA record having a length independent of the length of other records with which itis logically or physically associated. Contrast with fixed-length record.

Virtual Storage Access Method (VSAM)An IBM licensed program that controls communication and the flow of data in anSNA network. It provides single-domain, multiple-domain, and interconnectednetwork capability.

Virtual Telecommunications Access Method (VTAM)A set of programs that maintain control of the communication between terminalsand application programs running under DOS/VS, OS/VS1, OS/VS2, and MVSoperating systems.

VSAMSee Virtual Storage Access Method.

VTAMSee Virtual Telecommunications Access Method.

workstationA terminal, microcomputer, or personal computer usually one that is connected toa mainframe or to a network, at which a user can perform tasks.

Page 261: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Index-1

Index

Symbols%d message variable indicator 8-6%S message variable indicator 8-6%s message variable indicator 8-6

Numerics33231 error message 8-6, 9-20

AACF2

AMD2ACF2 group ID exit name 7-5AMD2ACF2 member 5-8mainframe product 2-5

Altering SQL text 9-17AMCF command 7-1AMD2

returning after user exit 9-13AMD2ACE member 5-7AMD2ACF2 member 5-8, 7-5AMD2CAMX member 5-8, 5-9AMD2CAMX module 4-3, 8-2AMD2CCPX member 5-9AMD2CCPX sample parse exit routine 9-16AMD2CFG member 5-7, 5-8AMD2CHAB member 5-8AMD2CICS member 5-8AMD2CM member 5-8AMD2 command 5-5AMD2DB2 member 5-7AMD2DSN member 5-8AMD2HRCT member 5-6AMD2LOG error log 10-12AMD2LOG member 5-7AMD2LOGO error overflow file 10-12AMD2MAMT macro 8-2AMD2MAMX macro 8-2AMD2 messages. See MessagesAMD2MSG member 5-7

AMD2PXIT member 5-7AMD2PXIT sample validation program 9-3AMD2RACF member 5-8, 7-5AMD2RDO3 member 5-6AMD2RDO member 5-6AMD2TOP member 5-8AMD2 transaction processor 2-4AMD2TS member 7-5AMD2XCOB-CA- fields 9-15AMD2XCOB copy book 9-1, 9-14AMD2XCOB member 5-6Application plan, authorizing users 5-4APT Workbench 2-5Assembler, coding parse exit

routine 9-16Assigning return codes 9-19Attention sequence 10-17Authorize users

for application plan 5-4for DB2 packages 5-4for system tables 5-5

Bbegin tran statement 9-13BINDPKG member 5-7BINDPLAN member 5-7Book, COBOL copy 9-13

CChanges

to DirectConnect stored procedurename B-2

to MainframeConnect from priorproducts 4-1

Character setscustomization on

MainframeCnnect 2-2CHARSETCLT field 9-15CHARSETSRV field 9-15

Page 262: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Index-2

MainframeConnect for DB2/MVS-CICS version 11.1.1

Checklists, preinstallation 3-2CICS

configuration 3-7defining SYRT error logs to CICS A-2MainframeConnect default

transaction name 2-4mainframe product 2-5sample FCT entries for SYRT error

logs A-3troubleshooting 10-9

CICS common area fields. See Commonarea fields

CICS PPT entry 9-3CICS system programmer

MainframeConnect tape tasks 5-1, 5-3TRS CSP tasks 6-1, 6-2

ClearConnectcapabilities 1-8description 1-9use with DRDA 1-8

Client applications, communicatingwith other products 2-5

COBOL, coding parse exit routine 9-16COBOL copy book 9-13, 9-14Coding

changes to messages 8-11parse exit routines 9-16

Columns, non-truncated 2-3Commands

AMCF 7-1AMD2 5-5EXEC CICS LINK 9-1, 9-2, 9-12FREEMAIN 9-19GETMAIN 9-18

commit statement 9-13Common area fields

altering values 9-12CHARSETCLT 9-15CHARSETSRV 9-15DBCS 9-15EYECATCHER 9-15MSGCODE 9-12, 9-16, 9-19NATLANGCLT 9-15NETGWNAME 9-12, 9-15

PASSWORD 9-12, 9-15RESERVED 9-16RETCODE 9-12, 9-16, 9-19STMT-PTR 9-12, 9-15USERID 9-12, 9-15

Common area of the parse exitroutine 9-13

Common problems 10-3Communicating with other products

client applications 2-5DirectConnect 2-5other servers 2-5

Communication areaCSP exit program 9-10in request validation exit 9-5in result validation exit 9-5

Communication pathDB2 Access Module 2-5MainframeConnect 2-5

CommunicationsSee DirectConnect communicationsSee Mainframe communicationswith other products 2-4

Compatibility 3-6Compiling parse exit routines 9-20Components of DB2 Access Module 2-3CompuServe

Sybase online information xxiiiConfiguring CICS 3-7Configuring MainframeConnect

changing settings 7-1understanding parameters 7-3

Connectivityin MainframeConnect 2-1preinstallation checklist 3-6verifying 10-1

Considerations for DBA-maintainedtables B-1

Contacting Sybase technical support xixCoordination of troubleshooting 10-14Copy books

AMD2XCOB 9-1, 9-14COBOL 9-13

COPY library 5-6

Page 263: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Index-3

MainframeConnect for DB2/MVS-CICS version 11.1.1

COUNT field 9-10CREATPKG member 5-6CSAs, migrating 4-1CSDLOAD member 5-7CSP access table

sp_server_info table B-1sp_sproc_columns table B-1sp_stored_procedures table B-1

CSP exit 9-10CSP exit programs 9-10CSPs

exit processing 9-10exit program 9-10exit program group ID 9-10sp_capabilities B-2sp_stored_procedures B-2sp_thread_props B-2

CTRL libraryMainframeConnect tape 5-6

Customizationcharacter set 2-2messages on AMD2CAMX 4-3message text 8-9

DDASD requirements 3-6Data accessed by ClearConnect 1-8Datatypes, user 2-3Data Workbench 2-5DB2

mainframe product 2-4DB2 Access Module

components 2-3defining error logs to CICS A-2error logging A-2 to A-3full error logs A-2handling messages A-2how DB2 messages are returned to

client A-2how error logs work A-2messages A-1 to A-3See also SYRTSQL Server messages mapped to A-2

DB2 data access 2-2DB2 database administrator

considerations for maintainedtables B-1

MainframeConnect tape tasks 5-3personnel requirements 3-3tables to maintain 6-1, B-1tasks 6-2TRS CSP tasks 6-2

DB2 messageshow handled by SYRT A-2how returned to client A-2

DB2 packages, authorizing users 5-4DBCS field 9-15DBMS B-1DBRM library 5-7Defaults, transaction name 4-1Definitions

verifying NCP 3-7VTAM, verifying 3-7

DFHCSDUB utility 5-2, 6-1DirectConnect

communicating with otherproducts 2-5

stored procedure name changes B-2stored procedure names B-2support 10-7

DirectConnect communicationsSNA LU6.2 10-8TCP/IP uplink 10-8

DRDAuse with ClearConnect 1-8

Dynamic SQL DB2 data access 2-2

EElectronic mail

for documentation xxivfor technical support xx

Eliminating messages 8-10Enabling parse exit routine 9-20Enterprise CONNECT

processing environment 1-10ENTRIES field 9-10

Page 264: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Index-4

MainframeConnect for DB2/MVS-CICS version 11.1.1

Error handling in parse exitroutines 9-18

Error log, AMD2LOG 10-12Error logging

DB2 Access Module A-2 to A-3DB2 Access Module log files A-2

Error messages33231 8-6, 9-20

ErrorsAMD2LOGO error overflow 10-12common problems 10-3fatal indicator 8-4preventative measures 10-5

Estimating temporary storage 7-6Examples

source code for translate table 8-2EXEC CICS LINK command 9-1, 9-2, 9-12EXITAREA 9-5Exit processing, CSPs 9-10Exit programs

and Temporary Storage Type 9-9CSP 9-10parse exit routine 9-11request validation 9-2result validation 9-2

Exit routinescoding 9-16in MainframeConnect 2-3returning to AMD2 9-13See Exit programs 9-11understanding 9-2

Exitsrequest validation 9-1result validation 9-1

EXITSAMP 9-3EYECATCHER field 9-15

FFailure

mainframe network 10-5network session or line 10-5

Fatal error indicator 8-4Fax-on-Demand

how to contact xxivFeatures of MainframeConnect 2-3Fields

AMD2XCOB-CA. See Common areafields

COUNT 9-10ENTRIES 9-10Group ID exit name 9-10See Common area fieldsUSERID 9-10XACTION 9-8, 9-9XDATE 9-7XDBSID 9-7XDBUID 9-7XERRMSG 9-8, 9-9XHEADER 9-7XREASON 9-7, 9-9XREQADDR 9-8XREQFUNC 9-8XREQNAME 9-8XREQOPT 9-8XRESCODE 9-9XRESNAME 9-9XRESOPT 9-9XRESQNAM 9-9XRESROWS 9-9XRESSIZE 9-9XRESTYPE 9-9XSERVER 9-7XTERMID 9-7XTIME 9-7XUSERID 9-7

Flow, process 10-14FREEMAIN command 9-19Functionality

in MainframeConnect 2-1

GGETMAIN command 9-18Group ID exit, setting the name 7-4Group ID exit name field 9-10Group ID exit name property 7-4Group ID in CSP exit program 9-10

Page 265: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Index-5

MainframeConnect for DB2/MVS-CICS version 11.1.1

HHandling errors in parse exit

routines 9-18Host Request Library DB2 table 2-4Host request library ID property 7-5

IIndicators

fatal error 8-4for message variables 8-6

Installation stepsMainframeConnect tape 5-1

Installation task summary 3-1Internationalization

in MainframeConnect 2-2

JJCL library

MainframeConnect tape 5-7JCL to retrieve JCL

MainframeConnect tape 5-1

LLanguages

programming 9-16Level, severity 8-4Level property 8-4Libraries

COPY 5-6CTRL 5-6DBRM 5-7host request 7-5JCL 5-7LOADLIB 5-7MACLIB 5-8MainframeConnect contents 5-6MainframeConnect TRS contents 6-3SOURCE 5-9TRLSJCL 6-5TRSCTRL 6-3

TRSDBRM 6-4TRSLOAD 6-5

Library names 4-3Line failure 10-5Link-editing the parse exit routine 9-20LOADLIB library

MainframeConnect tape 5-7Logging

messages 8-10troubleshooting 10-11

LOG property 8-4, A-2Logs, nglog traffic log 10-8Long-running transactions 2-1LU6.2

troubleshooting 10-8LU is inactive 10-4

MMACLIB library 5-8Macros

AMD2MAMT 8-2AMD2MAMX 8-2

Mainframenetwork failure 10-5

Mainframe communicationsTCP/IP for MVS 10-9TCP/IP Sockets Interface 10-9VTAM/NCP 10-9

MainframeConnectaccessing relational and

non-relational data 2-2AMD2 transaction processor 2-4changes from prior products 4-1changing settings 7-1character set customization 2-2communication path 2-5communication with other

products 2-4dynamic SQL DB2 data access 2-2exit routines 2-3functionality 2-1Host Request Library DB2 table 2-4internationalization 2-2

Page 266: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Index-6

MainframeConnect for DB2/MVS-CICS version 11.1.1

library contents 5-6long-running transactions 2-1migrating 4-2multiple connectivity 2-1non-truncated columns 2-3other features 2-3protocols 2-1tape installation steps 5-1tapes 3-1troubleshooting 10-10TRS library contents 6-3understanding properties 7-3user datatypes 2-3verifying connectivity 10-1

MainframeConnect Configuration TranID Selection window 7-1

MainframeConnect Configurationwindow 7-2

MainframeConnect tapeinstallation steps 5-1JCL to retrieve JCL 5-1library contents 5-6TRS library contents 6-3

mainframe network operationalfailure 10-5

Mainframe productsACF2 2-5CICS 2-5DB2 2-4MVS 2-5NCP 2-5RACF 2-5Resource Access Control Facility 2-5Systems Network Architecture 2-5TCP/IP 2-5Top Secret 2-5

Main memory, temporary storage 7-6Maintain DB2 database administrator

tables B-1MDI transaction processor 2-3Measures for preventing problems 10-5Members

ADM2CM 5-8AMD2ACE 5-7

AMD2ACF2 5-8AMD2CAMX 5-8, 5-9AMD2CCPX 5-9AMD2CFG 5-7, 5-8AMD2CHAB 5-8AMD2CICS 5-8AMD2DB2 5-7AMD2DSN 5-8AMD2HRCT 5-6AMD2LOG 5-7AMD2MSG 5-7AMD2PXIT 5-7AMD2RACF 5-8AMD2RDO 5-6AMD2RDO3 5-6AMD2TOP 5-8AMD2XCOB 5-6BINDPKG 5-7BINDPLAN 5-7CREATEPKG 5-6CSDLOAD 5-7SYBACO00 6-4SYBACO01 6-4SYBACP00 6-4SYBADB00 6-4SYBADT00 6-4SYBAFK00 6-4SYBAGNAM 6-4SYBAPK00 6-4SYBASC00 6-4SYBASI00 6-4SYBASL00 6-4SYBASP00 6-4SYBAST00 6-4SYBATB00 6-4SYBATB01 6-4SYBATB02 6-4SYBATP00 6-4SYBCAPAB 6-5SYBTHRED 6-5SYCACERR 6-5SYCACPGM 6-5SYRTMAMT 5-8SYRTMAMX 5-8

Page 267: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Index-7

MainframeConnect for DB2/MVS-CICS version 11.1.1

SYSAPARS 9-20TRSBIND 6-5TRSCREA2 6-3TRSCREAT 6-3TRSCSD 6-3, 6-5TRSDROP 6-3TRSGRANT 6-3TRSRCT 6-3

Messagesadding SQLCODEs 8-7changing 8-1 to 8-11changing message table 8-7changing text 8-1coding changes 8-11customized on AMD2CAMX 4-3customizing 8-9eliminating 8-10list of A-1 to A-86logging 8-10Text table 8-1, 8-4translate table 8-1, 8-2variables 8-6

Message table, SYRT A-1Migrating

assigning library names 4-3CSAs 4-1MainframeConnect changes 4-1preserving customized messages 4-3remove a prior product 4-2RSPs 4-1to MainframeConnect 4-2

ModulesAMD2CAMX 8-2

MSGCODE field 9-12, 9-16, 9-19MSGNO property 8-3Multiple connectivity in

MainframeConnect 2-1MVS mainframe product 2-5

NNames

DirectConnect stored procedurechanges B-2

Group ID exit name property 7-4library 4-3Parse exit name property 7-4Request exit name property 7-4Result exit name property 7-4stored procedure on

DirectConnect B-2transaction 4-1

NATLANGCLT field 9-15NCP

mainframe product 2-5troubleshooting 10-9verifying definition 3-7

Net-Gateway 1-4NETGWNAME field 9-12, 9-15Network failure

mainframe 10-5session or line 10-5

network operational failure 10-5Network session failures 10-5nglog traffic log 10-8ngtds trace file 10-8Non-relational data, accessing 2-2Non-truncated columns 2-3

OODBC 2-5OmniSQL Access Module for DB2 1-3Open Database Connectivity 2-5overflow error file, AMD2LOGO 10-12Overviews, result validation exit 9-1

PPackages, DB2 5-4Parse exit name property 7-4Parse exit routine 9-11

acquiring additional storage 9-17assigning return code 9-19calling 9-12COBOL copy book 9-13coding 9-16common area 9-13

Page 268: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Index-8

MainframeConnect for DB2/MVS-CICS version 11.1.1

compiling 9-20enabling 9-20handling errors 9-18link-editing 9-20programming languages 9-16sample 9-16setting the name 7-4understanding 9-12

PASSWORD field 9-12, 9-15Performance upgrades 3-5Personnel requirements 3-3PL/I coding parse exit routine 9-16Plan, application 5-4Planning

installation task summary 3-1MainframeConnect tapes 3-1preinstallation checklist 3-2

Post-installation tasksauthorizing users for application

plan 5-4authorizing users for DB2

packages 5-4authorizing users for system

tables 5-5Preinstallation checklist

CICS configuration 3-7Components 3-6connectivity 3-6NCP definition 3-7performance upgrades 3-5personnel requirements 3-3space requirements 3-6special system requirements 3-4summary 3-2system requirements 3-3VTAM definition 3-7

Preventative measures 10-5Prior products, removing groups 4-2Problems

common 10-3preventative measures 10-5

ProceduresDirectConnect stored name

changes B-2

DirectConnect stored names B-2stored B-1

Process flow 10-14Processing environment 1-10Processing SQL statements 9-13Processing user-defined

transactions 9-13Product names 4-2Professional Services

how to contact xxiProgramming languages and parse exit

routine 9-16Programs

See Exit programs 9-9See Sample programs 9-3

PropertiesDateTime results type 7-7Group ID exit name 7-4Host request library 7-5Level 8-4LOG 8-4, A-2MSGNO 8-3Parse exit name 7-4Request exit name 7-4Result exit name 7-4SQLCODE 8-3, 8-7SQLFATAL 8-4STATEC 8-4Temp storage queue type 7-5, 9-9Transaction ID 7-3understanding MainframeConnect

configuration 7-3Protocols

MainframeConnect 2-1Tabular Data Stream 2-5

RRACF

AMD2RACF group ID exit name 7-5AMD2RACF member 5-8mainframe product 2-5

Related software productsrelated IBM products 1-12

Page 269: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Index-9

MainframeConnect for DB2/MVS-CICS version 11.1.1

related Sybase products 1-11Relational data, accessing 2-2Release numbers 4-2Request exit name property 7-4Request validation exit

communication area 9-5description 9-7enabling 9-3fields 9-7overview 9-1sample program 9-3setting the name 7-4

Requirements 10-14DASD 3-6performance upgrades 3-5personnel 3-3space 3-6special system 3-4system 3-3

RESERVED field 9-16Resource Access Control Facility

AMD2RACF group ID exit name 7-5AMD2RACF member 5-8mainframe product 2-5

Result exit name property 7-4Result validation exit

communication area 9-5description 9-8enabling 9-3fields 9-8overview 9-1sample program 9-3setting the name 7-4

RETCODE field 9-12, 9-16, 9-19Return codes, assigning 9-19rollback statement 9-13Routines, exit 9-2RSPs, migrating 4-1RU size 3-5

SSample parse exit routine 9-16Sample programs

CSP exit 9-10request validation exit 9-3result validation exit 9-3

SDLCline is not up 10-4planning considerations 3-5

Security Administrator 3-3select statement 9-11Sequence, attention 10-17Servers, communicating with other

products 2-5Session failure 10-5Settings, changing

MainframeConnect 7-1Severity level 8-4Sizes, RU 3-5SNA LU6.2 10-8Source code for translate table 8-2SOURCE library

MainframeConnect tape 5-9sp_capabilities procedure B-2sp_server_info table B-1sp_sproc_columns table B-1sp_stored_procedures CSP B-1, B-2sp_thread_props procedure B-2Space requirements 3-6SQLCA

in DB2 Access Module messages A-7,A-8, A-9, A-10, A-11, A-12, A-13,A-14, A-15, A-16, A-17, A-18,A-19, A-20, A-21, A-22, A-23,A-24, A-25, A-26, A-27, A-28,A-29, A-30, A-31, A-32, A-33,A-34, A-35, A-36, A-37, A-38,A-39, A-40, A-41, A-42, A-43,A-44, A-45, A-46, A-47, A-48,A-49, A-50, A-70

in MainframeConnect forDB2/MVS-CICS messages A-6

SQLCODEin DB2 Access Module messages A-6,

A-7, A-8, A-9, A-10, A-11, A-12,A-13, A-14, A-15, A-16, A-17,A-18, A-19, A-20, A-21, A-22,

Page 270: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Index-10

MainframeConnect for DB2/MVS-CICS version 11.1.1

A-23, A-24, A-25, A-26, A-27,A-28, A-29, A-30, A-31, A-32,A-33, A-34, A-35, A-36, A-37,A-38, A-39, A-40, A-41, A-42,A-43, A-44, A-45, A-46, A-47,A-48, A-49, A-50, A-70

SQLCODE propertyadding 8-7definition 8-3

SQL DB2 data access 2-2SQLFATAL property 8-4SQL Server

messages mapped to SYRTmessages A-2

other servers 2-5SQL statements, processing 9-13SQL text, altering 9-17STATEC property 8-4Statements

begin tran 9-13commit 9-13processing SQL 9-13rollback 9-13select 9-11USE REQUEST 9-3

STATESC subclass 8-4Steps, installation

CSPs for Transaction RouterService 6-1

MainframeConnect tape 5-1STMT-PTR field 9-12, 9-15Storage

acquiring additional for parse exitroutine 9-17

DateTime results type property 7-7estimating temporary 7-6See Temporary Storage Typetemporary storage 7-6Temp queue type property 7-5

Stored procedures, DB2 databaseadministrator information B-1

Subclasses, STATESC 8-4Suggested solutions for

troubleshooting 10-3

Summaryof installation tasks 3-1

SupportDirectConnect 10-7

SYBACO00 member 6-4SYBACO01 member 6-4SYBACP00 member 6-4SYBADB00 member 6-4SYBADT00 member 6-4SYBAFK00 member 6-4SYBAGNAM member 6-4SYBASC00 member 6-4Sybase online information

how to access xxiiiSYBASI00 member 6-4SYBASL00 member 6-4SYBASP00 member 6-4SYBAST00 member 6-4SYBATB00 member 6-4SYBATB01 member 6-4SYBATB02 member 6-4SYBATP00 member 6-4SYBCAPAB member 6-5SYBPKO00 member 6-4SYBTHRED member 6-5SYCACERR member 6-5SYCACPGM member 6-5SYRT

how DB2 messages are handled A-2how internal messages are

handled A-2message table processes DB2

SQLCODEs A-2See also DB2 Access Module

SYRTLOGdefinition A-2sample FCT entry A-3

SYRTLOGOdefinition A-2sample FCT entry A-3

SYRTMAMT member 5-8SYRTMAMX member 5-8SYRT transaction processor 2-3SYSAPARS member 9-20

Page 271: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Index-11

MainframeConnect for DB2/MVS-CICS version 11.1.1

System requirementsoperating system 3-3performance upgrades 3-5platform 3-3special 3-4

Systems Network Architecture 2-5System tables, authorizing users 5-5

TTables

considerations for DB2 databaseadministrator-maintainedtables B-1

DB2 database administrator B-1DB2 database

administrator-maintained 6-1Host Request Library DB2 2-4message text 8-1, 8-4message translate 8-1, 8-2system 5-5

Tabular Data Stream protocol 2-5Tapes, MainframeConnect 3-1Tasks

CICS system programmer 5-1, 5-3,6-1, 6-2

DB2 database administrator 5-3, 6-2installation summary 3-1post-installation 5-4, 5-5

TCP/IPfor MVS 10-9mainframe product 2-5Sockets Interface 10-9troubleshooting 10-8uplink 10-8

TDS 2-5Technical support

how to contact xixTemporary storage

estimating 7-6in main memory 7-6

Temporary Storage Type and exitprograms 9-9

Temp storage queue type property 7-5, 7-7,9-9

Textaltering SQL 9-17changing message 8-1message table 8-1, 8-4

Token Ringline is not up 10-4upgrade considerations 3-5

Top SecretAMD2TOP member 5-8AMD2TS group ID exit name 7-5mainframe product 2-5

Trace files, ngtds 10-8Tracing 10-11Transaction ID property 7-3Transaction name 4-1Transaction processor

AMD2 2-4MDI 2-3SYRT 2-3

Transactionslong-running 2-1processing user-defined 9-13

Translate tablemessages 8-1, 8-2source code 8-2

Troubleshootingattention sequences 10-17cannot establish a session 10-3CICS 10-9common problems 10-3components 10-6configuration errors 10-3coordination 10-14DirectConnect support 10-7flow process 10-14line failure 10-5logging 10-11LU is inactive 10-4mainframe communications with

MainframeConnect 10-9MainframeConnect 10-10

Page 272: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Index-12

MainframeConnect for DB2/MVS-CICS version 11.1.1

mainframe network operationalfailure 10-5

NCP 10-9network session failure 10-5preventative measures 10-5SDLC line not up 10-4SNA LU6.2 10-8suggested solutions 10-3TCP/IP for MVS 10-9TCP/IP Sockets Interface 10-9TCP/IP uplink 10-8Token Ring is not up 10-4tracing 10-11transaction does not run 10-4verifying connectivity 10-1VTAM 10-9where to start 10-2

TRSBIND member 6-5TRSCREA2 member 6-3TRSCREAT member 6-3TRSCSD member 6-3, 6-5TRSCTRL library 6-3TRSDBRM library 6-4TRSDROP member 6-3TRSGRANT member 6-3TRSJCL library 6-5TRSLOAD library 6-5TRSRCT member 6-3

UUnit of work 9-13Upgrade considerations

performance 3-5RU size 3-5using a Token Ring 3-5using SDLC 3-5

User datatypes 2-3User-defined transactions 9-13USE REQUEST statement 9-3User exits

coding 9-16enabling 9-3returning to AMD2 9-13

understanding 9-2USERID field 9-10, 9-12, 9-15Utility, DFHCSDUB 5-2, 6-1

VValidation exits

request 9-1result 9-1, 9-2

Validation programs. See Sampleprograms

Variables, messages 8-6VTAM

knowledgeable person 3-3verifying definition 3-7

WWhere to start troubleshooting 10-2Windows

MainframeConnectConfiguration 7-2

MainframeConnect ConfigurationTrans ID Selection 7-1

XXACTION field 9-8, 9-9XDATE field 9-7XDBSID field 9-7XDBUID field 9-7XERRMSG field 9-8, 9-9XHEADER field 9-7XREASON field 9-7, 9-9XREQADDR field 9-8XREQFUNC field 9-8XREQNAME field 9-8XREQOPT field 9-8XRESCODE field 9-9XRESNAME field 9-9XRESOPT field 9-9XRESQNAM field 9-9XRESROWS field 9-9XRESSIZE field 9-9

Page 273: MainframeConnect™ for DB2/MVS-CICS Installation and ...

MainframeConnect for DB2/MVS-CICS Install & Admin Guide Index-13

MainframeConnect for DB2/MVS-CICS version 11.1.1

XRESTYPE field 9-9XSERVER field 9-7XTERMID field 9-7XTIME field 9-7XUSERID field 9-7

Page 274: MainframeConnect™ for DB2/MVS-CICS Installation and ...

Index-14

MainframeConnect for DB2/MVS-CICS version 11.1.1