About this book

Remote stored procedures (RSPs) are written by customers to access DB2 in the MVS CICS environment. The Mainframe Connect Server Option Programmer’s Reference for Remote Stored Procedures describes how to design, code, and test RSPs.

This chapter contains the following topics:

Audience

This guide is for anyone responsible for the following tasks:

Designing, coding, and testing RSPs in one of the supported programming languages (COBOL II, assembler, PL/I, and C)
Preparing client applications
Implementing RSPs
Administering Open ClientConnect™, Open ServerConnect™, or DirectConnect™ environments
Administering database management systems
Supporting data transfer and staging

Product name changes

The following table describes new names for products in the 12.6 release of the Mainframe Connect Integrated Product Set.

Old product names	New product name
Open ClientConnect for CICS Open ClientCONNECT for CICS	Mainframe Connect Client Option for CICS
Open Client Connect for IMS and MVS Open ClientCONNECT for IMS and MVS	Mainframe Connect Client Option for IMS and MVS
Open ServerConnect for CICS Open ServerCONNECT for CICS	Mainframe Connect Server Option for CICS
Open ServerConnect for IMS and MVS Open ServerCONNECT for IMS and MVS	Mainframe Connect Server Option for IMS and MVS
MainframeConnect™ for DB2 UDB MainframeCONNECT for DB2/MVS-CICS	Mainframe Connect DB2 UDB Option for CICS
DirectConnect for OS/390 DirectCONNECT for DB2/MVS	DirectConnect for z/OS

The old product names are used throughout this book, except for on the title page.

This book also uses the terms MVS and OS/390 where the newer term z/OS would otherwise be used.

How to use this book

The majority of Sybase customers using COBOL II write RSPs to access DB2 in the MVS CICS environment. This guide therefore provides COBOL II examples. However, the Open ServerConnect API tape provides examples in all the supported programming languages.

If you are not familiar with CICS and the CICS control tables, ask your CICS programmer or system programmer to make the required CICS entries.

This guide provides a set of tasks and reference information, with each chapter representing a task and each appendix representing reference information to help you accomplish a task. This reference guide provides the following information:

**Table 1: Contents of each chapter**
Chapter	Contents
Chapter 1, “Overview of RSPs”	Provides an overview of RSPs and how they work.
Chapter 2, “Designing an RSP”	Discusses information to consider before you design an RSP.
Chapter 3, “Writing an RSP”	Explains how to write an RSP.
Chapter 4, “Compiling an RSP”	Explains how to compile an RSP.
Chapter 5, “Testing and invoking an RSP”	Explains how to test and invoke an RSP.
Chapter 6, “Troubleshooting”	Explains how to troubleshoot problems.
Appendix A, “RSP Commands”	Lists and explains the RSP commands.
Appendix B, “MODELRSP DB2 Output Pipe Sample RSP”	Provides and explains a sample RSP with DB2-formatted output pipes or multiple-column rows.
Appendix C, “RSP3C STD Input and Output Pipe Sample RSP”	Provides and explains a sample RSP that sends single-column rows of character strings.
Appendix D, “RSP4C Keyword Variable Sample RSP”	Provides and explains a sample RSP that passes keyword values.
Appendix E, “RSP8C Variable Text Sample RSP”	Provides and explains a sample RSP that reads variable text and uses output pipes to echo data that a client application sends to it.
Appendix F, “The SPAREA”	Explains how the SPAREA is used by RSPs. It includes SPAREA fields and SPAREA definitions.
Appendix G, “The SQLDA”	Explains how the SQLDA is used by RSPs.
Glossary	Provides definitions of technical terms used in this book.

Other sources of information

Use the Sybase Getting Started CD, the Sybase Technical Library CD, and the Technical Library Product Manuals Web site to learn more about your product:

The Getting Started CD contains release bulletins and installation guides in PDF format, and may also contain other documents or updated information not included on the Technical Library CD. It is included with your software. To read or print documents on the Getting Started CD, you need Adobe Acrobat Reader (downloadable at no charge from the Adobe Web site, using a link provided on the CD).
The Technical Library CD contains product manuals and is included with your software. The DynaText reader (included on the Technical Library CD) allows you to access technical information about your product in an easy-to-use format.

Refer to the Technical Library Installation Guide in your documentation package for instructions on installing and starting the Technical Library.
The Technical Library Product Manuals Web site is an HTML version of the Technical Library CD that you can access using a standard Web browser. In addition to product manuals, you will find links to EBFs/Maintenance, Technical Documents, Case Management, Solved Cases, newsgroups, and the Sybase Developer Network.

To access the Technical Library Product Manuals Web site, go to Product Manuals.

Sybase certifications on the Web

Technical documentation at the Sybase Web site is updated frequently.

Finding the latest information on product certifications

Point your Web browser to Technical Documents.
Select Products from the navigation bar on the left.
Select a product name from the product list and click Go.
Select the Certification Report filter, specify a time frame, and click Go.
Click a Certification Report title to display the report.

Creating a personalized view of the Sybase Web site (including support pages)

Set up a MySybase profile. MySybase is a free service that allows you to create a personalized view of Sybase Web pages.

Point your Web browser to Technical Documents.
Click MySybase and create a MySybase profile.

Sybase EBFs and software maintenance

Finding the latest information on EBFs and software maintenance

Point your Web browser to the Sybase Support Page.
Select EBFs/Maintenance. Enter user name and password information, if prompted (for existing Web accounts) or create a new account (a free service).
Select a product.
Specify a time frame and click Go.
Click the Info icon to display the EBF/Maintenance report, or click the product description to download the software.

Conventions

The following sections describe syntax and style conventions used in this guide.

Throughout this book, all references to MVS refer to native MVS programs, and all references to Adaptive Server™ Enterprise also apply to its predecessor, SQL Server®.

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

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

The following table explains the syntax conventions used in this guide.

**Table 2: Syntax conventions**
Symbol	Convention
( )	Include parentheses as part of the command.
{ }	Braces indicate that you must choose at least one of the enclosed options. Do not type the braces when you type the option.
[ ]	Brackets indicate that you can choose one or more of the enclosed options, or none. Do not type the brackets when you type the options.
\|	The vertical bar indicates that you can select only one of the options shown. Do not type the bar in your command.
,	The comma indicates that you can choose one or more of the options shown. Separate each choice by using a comma as part of the command.

The following style conventions are used in this guide:

The names of files and directories are shown as:

econnect\ServerName\CFG
The names of programs, utilities, procedures, and commands are shown as:

snrfck
The names of properties are shown as:

Allocate
The names of options are shown as:

connect
Code examples and text on screen are shown as:
```
this font
```
In a sample command line display, commands you should enter are shown as:
```
this font
```
In a sample command line display, variables (words you should replace with the appropriate value for your system) are shown as:
```
this font
```

If you need help

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

View this book as PDF