Sybase Technical Library - Product Manuals Home
[Search Forms] [Previous Section with Hits] [Next Section with Hits] [Clear Search] Expand Search

Open ServerConnect(TM) Programmer's Reference for COBOL [Table of Contents] Chapter 1: Introduction

Open ServerConnect Programmer's Reference for COBOL

[-] About This Book

About This Book

Open ServerConnect Programmer's Reference for COBOL contains reference information for the COBOL version of Open ServerConnect(TM) Gateway-Library(TM).

Note: The Open ServerConnect Gateway-Library is a subset of the generic Sybase(R) Gateway-Library.

This chapter includes the following topics:

Who Should Read This Book

Open ServerConnect Programmer's Reference for COBOL is a reference book for application programmers who write COBOL programs that call Open ServerConnect Gateway-Library functions, and for system programmers who want to use its tracing and accounting features.

This book assumes that you are familiar with the COBOL programming language and know how to write COBOL programs under either CICS, MVS or IMS TM. It does not contain instructions for writing COBOL programs. Rather, it describes the functions that can be called within your COBOL programs to perform communication, conversion, tracing, and accounting functions.

Organization of This Book

The following table shows how the Open ServerConnect Programmer's Reference for COBOL is organized.

Table 1: Chapter descriptions

Chapter

Contents

Chapter 1, "Introduction"

An overview of Open ServerConnect including discussion of different kinds of client requests and explanations of how Open ServerConnect programs process them.

Everyone who writes programs using Open ServerConnect should read this chapter.

Chapter 2, "Topics"

Descriptions of Gateway-Library concepts, and information on how to accomplish specific programming tasks.

This chapter discusses tasks, resources, and other topics that the application programmer needs to understand to write Gateway-Library applications. It includes a detailed discussion of the Gateway-Library cursor, dynamic SQL and Japanese language support and a list of supported datatypes and models for structures used to store data.

Chapter 3, "Functions"

Reference pages for each Gateway-Library function. Each function description contains sections on functionality, syntax, explanatory comments and related functions, as well as an example.

Appendix A, "Gateway-Library Quick Reference"

A table of all Gateway-Library functions, their arguments and where they exist, and the symbolic constants used with each argument.

Appendix B, "Sample RPC Application for CICS"

A sample COBOL application program that processes client RPC requests under CICS and three COBOL programs that are Open ServerConnect versions of the RSP3C, RSP4C and RSP8C remote stored procedures.

Appendix C, "Sample Language Application for CICS"

A sample COBOL application program that processes client language requests under CICS.

Appendix D, "Sample RPC Application for IMS TM (Implicit)"

A sample COBOL application program that processes client RPC requests under the IMS TM implicit API.

Appendix E, "Sample RPC Application for IMS TM (Explicit)"

A sample COBOL application program that processes client RPC requests under the IMS TM explicit API.

Appendix F, "Sample Mixed-Mode Application"

A sample COBOL application program that includes both Gateway-Library and Client-Library function calls (a mixed mode application).

Appendix G, "Sample Tracing and Accounting Program"

A sample COBOL program that demonstrates the use of all Gateway-Library tracing and accounting functions.

Related Documents

To install, administer, troubleshoot, and write applications for Open ServerConnect, see the following documentation:

Syntax and Style Conventions in This Book

This section describes the syntax and style conventions used in this book.

Note: Throughout this book, all references to MVS refer to native MVS programs and all references to Adaptive Server(TM) Enterprise also apply to its predecessor, SQL Server.

Syntax Conventions

Open ServerConnect uses eight-character function names; other versions of Server-Library use longer names. This book uses the long version of Server-Library names with this exception: the eight-character version is used in syntax statements. For example, CTBCMDPROPS has 11 letters. In the syntax statement, it is written CTBCMDPR. You can use either version in your code.

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

Table 2: Syntax conventions

Symbol

( )

Parentheses indicate that parentheses are included 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.

Style Conventions

The following table explains the style conventions used in this book.

Table 3: Style conventions

This type of information

Looks like this

Gateway-Library function names

TDINIT, TDRESULT

Client-Library function names

CTBINIT, CTBRESULTS

Other executables (DB-Library routines, SQL commands) in text

the dbrpcparam routine, a select statement

Directory names, path names, and file names

/usr/bin directory, interfaces file

Variables

n bytes

Adaptive Server datatypes

datetime, float

Sample code

01 BUFFER PIC S9(9) COMP SYNC.
01 BUFFER PIC X(n).

User input

01 BUFFER PIC X(n)

Client-Library and Gateway-Library function argument names

BUFFER, RETCODE

Client-Library function arguments that are input (I) or output (O)

COMMAND - (I)
RETCODE - (O)

Names of objects stored on the mainframe

SYCTSAA5

Symbolic values used with function arguments, properties, and structure fields

CS-UNUSED, FMT-NAME, CS-SV-FATAL

Client-Library property names

CS-PASSWORD, CS-USERNAME

Client-Library and Gateway-Library datatypes

CS-CHAR, TDSCHAR

All other names and terms are in regular typeface.

How to Get Help Using Sybase Products

Each Sybase installation that has purchased a support contract has one or more designated person who is 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.

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

Sybase Technical Support

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

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

Contacting Sybase Technical Support

You can contact Sybase Technical Support by phone or electronic mail (e-mail). This section explains:

Before you contact Sybase Technical Support, complete these steps:

  1. Thoroughly review the documentation, especially all troubleshooting sections.

  2. Be prepared to generate a trace, if requested to do so by Sybase Technical Support.

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, Mountain Standard or Daylight Savings Time (MST or MDT), except holidays.

Note: Outside the continental United States and Canada, obtain the correct telephone numbers from your sales representative and record them for future reference.

Contacting by E-Mail

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

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

icdtech@sybase.com

Sending Log and Trace Files to Sybase Technical Support

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

Using File Transfer Protocol (ftp)

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

  1. Save your trace output or other document as an ASCII file.

  2. In the directory where the file resides, enter the following at the command line:

    ftp ftp.sybase.com
  3. When prompted, provide the following information:

  4. Enter:

    cd /pub/incoming/wcss
    Note: This is a protected ftp site. Files cannot be displayed.
  5. To change to binary mode (if necessary), enter:

    bin
  6. Place one or more files into the directory.

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

Using the Bulletin Board Service (BBS)

The BBS allows you to transfer log and trace files to Sybase Technical Support or to receive software fixes using a modem. To use 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 training programs to help you maximize the benefits of our products. For more information, call (303) 486-7700.

Note: Outside the continental United States and Canada, obtain the correct telephone numbers from your sales representative and record them for future reference.

Other Sources of Information

Other sources of information include:

Online Documentation

Use the Sybase Technical Library CD and the Technical Library Web site to learn more about your product:

Sybase Certifications on the Web

Technical documentation at the Sybase Web site is updated frequently.

For the latest information on product certifications and/or the EBF Rollups:

  1. Point your Web browser to Technical Documents at the following Web site:

    techinfo.sybase.com

  2. In the Browse section, click on the Hot entry.

  3. Explore your area of interest: Hot Docs covering various topics, or Hot Links to Technical News, Certification Reports, Partner Certifications, and so on.

If you are a registered SupportPlus user:

  1. Point your Web browser to Technical Documents at the following Web site:

    techinfo.sybase.com

  2. In the Browse section, click on the Hot entry.

  3. Click on the EBF Rollups entry.

    You can research EBFs using Technical Documents, and you can download EBFs using Electronic Software Distribution (ESD).

  4. Follow the instructions associated with the SupportPlusSM Online Services entries.

If you are not a registered SupportPlus user, and you want to become one:

You can register by following the instructions on the Web.

To use SupportPlus, you need:

Whether or not you are a registered SupportPlus user:

You may use Sybase's Technical Documents. Certification Reports are among the features documented at this site.

  1. Point your Web browser to Technical Documents at the following Web site:

    techinfo.sybase.com

  2. In the Browse section, click on the Hot entry.

  3. Click on the topic that interests you.

Sybase OpenLine and PrivateLine on CompuServe

Sybase OpenLine and PrivateLine are the Sybase Technical Support question and answer forums on CompuServe. To access Sybase OpenLine:

  1. Connect to CompuServe using the normal procedures for your site.

  2. At any menu prompt, type:

    go sybase

Fax-on-Demand

Use Fax-on-Demand to receive Certification Reports, Release Summaries, Sample Programs, Technical News Letters (TNL), and Technical 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:

icd_doc@sybase.com

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

We will respond as promptly as possible by e-mail. Your feedback helps us provide more accurate, detailed, and easy-to-use documentation.

Note: Please send comments about product features, functionality, or problems to your system engineer or Sybase Technical Support.

To order additional copies of Sybase documentation, see "Document Orders" on the disclaimer page following the title page.


Open ServerConnect(TM) Programmer's Reference for COBOL [Table of Contents] Chapter 1: Introduction