Adapter for CA-IDMS User's Manual

Feedback

This documentation describes how to use the Read Only Adapter for CA-IDMS® in the z/OS®operating environment. It is intended for FOCUS® users who need to retrieve information from CA-IDMS/DB data sources. References to z/OS apply to all supported releases of MVS, OS/390®, and z/OS™.

How This Manual Is Organized

This manual includes the following chapters:

Chapter/Appendix		Contents
1	Introduction to the Adapter for CA-IDMS	Introduces the adapter, its operating environments, and its core requirements.
2	Getting Started	Describes how to access the adapter.
3	IDMS Overview and Mapping Concepts	Discusses IDMS data source structures and how they are represented as FOCUS structures.
4	Adapter for CA-IDMS Master Files	Describes the elements in a Master File that describes network record-types and Logical Record Facility (LRF)-based records.
5	Adapter for CA-IDMS Access Files	Describes the elements in an Access File for network record-types and LRF-based records.
6	Creating File Descriptions With AUTOIDMS	Describes how to use the AUTOIDMS facility to automatically create Master and Access files.
7	Adapter for CA-IDMS Reporting Techniques	Describes advanced reporting topics, such as the retrieval sequence, retrieving short paths, file inversion, and the JOIN command.
8	CA-IDMS Record Retrieval Intervals	Describes internal calls that the adapter generates to retrieve records.
A	Error Messages and Troubleshooting	Describes how to generate error messages online, how to access errors files. Lists common errors and the associated IDMS response codes.
B	Adapter for CA-IDMS Samples	Contains sample schemas, subschemas, Master Files, and Access Files .
C	Tracing Adapter Processing	Describes how to activate and deactivate adapter traces.
D	Glossary

Documentation Conventions

The following table describes the documentation conventions that are used in this manual.

Convention	Description
THIS TYPEFACE or this typeface	Denotes syntax that you must enter exactly as shown.
this typeface	Represents a placeholder (or variable) in syntax for a value that you or the system must supply.
underscore	Indicates a default setting.
this typeface	Represents a placeholder (or variable), a cross-reference, or an important term. It may also indicate a button, menu item, or dialog box option that you can click or select.
this typeface	Highlights a file name or command.
Key + Key	Indicates keys that you must press simultaneously.
{ }	Indicates two or three choices. Type one of them, not the braces.
[ ]	Indicates a group of optional parameters. None are required, but you may select one of them. Type only the parameter in the brackets, not the brackets.
\|	Separates mutually exclusive choices in syntax. Type one of them, not the symbol.
...	Indicates that you can enter a parameter multiple times. Type only the parameter, not the ellipsis (...).
. . .	Indicates that there are (or could be) intervening or additional commands.

Related Publications

To view a current listing of our publications and to place an order, visit our Technical Documentation Library, http://documentation.informationbuilders.com. You can also contact the Publications Order Department at (800) 969-4636.

Terminology

The following summarizes standard terminology used throughout this manual:

SQL refers to the Structured Query Language.
RDBMS is a generic term for DB2, Teradata, Oracle, or CA-IDMS (with the SQL option). Where necessary, they are treated separately.
Table is a generic term for an RDBMS table or view.
Adapter refers any one or more of the adapter products. Where necessary, the adapters are treated separately.
Primary key refers to the column or columns that uniquely identify a row in a table. Used together, the terms primary key and foreign key refer to the columns that relate two tables. In either case, they do not refer to primary and foreign keys as defined in SQL CREATE TABLE statements (RDBMS referential integrity) unless explicitly stated.
TABLE request refers to a FOCUS report request.
Report request refers to a FOCUS report request or Direct SQL Passthru report request.
FOCEXEC refers to a FOCUS procedure or Direct SQL Passthru procedure.

Customer Support

Do you have any questions about this product?

Join the Focal Point community. Focal Point is our online developer center and more than a message board. It is an interactive network of more than 3,000 developers from almost every profession and industry, collaborating on solutions and sharing tips and techniques. Access Focal Point at http://forums.informationbuilders.com/eve/forums.

You can also access support services electronically, 24 hours a day, with InfoResponse Online. InfoResponse Online is accessible through our Web site, http://www.informationbuilders.com. It connects you to the tracking system and known-problem database at the Information Builders support center. Registered users can open, update, and view the status of cases in the tracking system and read descriptions of reported software issues. New users can register immediately for this service. The technical support section of www.informationbuilders.com also provides usage techniques, diagnostic tips, and answers to frequently asked questions.

Call the Information Builders Customer Support Services (CSS) at (800) 736-6130 or (212) 736-6130. Customer Support Consultants are available Monday through Friday between 8:00 a.m. and 8:00 p.m. EST to address all your questions. Information Builders consultants can also give you general guidance regarding product capabilities and documentation. Please be ready to provide your six-digit site code number (xxxx.xx) when you call.

To learn about the full range of available support services, ask your Information Builders representative about InfoResponse Online, or call (800) 969-INFO.

Information You Should Have

To help our consultants answer your questions effectively, be prepared to provide the following information when you call:

Your six-digit site code (xxxx.xx).
The stored procedure (preferably with line numbers) .
The Master File and Access File.
Run sheet (beginning at login, including call to FOCUS), containing the following information:
- ? RELEASE
- ? FDT
- ? LET
- ? LOAD
- ? COMBINE
- ? JOIN
- ? DEFINE
- ? STAT
- ? SET/? SET GRAPH
- ? TSO DDNAME
The exact nature of the problem:
- Are the results or the format incorrect? Are the text or calculations missing or misplaced?
- Provide the error message and return code, if applicable.
- Is this related to any other problem?
Has the procedure or query ever worked in its present form? Has it been changed recently? How often does the problem occur?
What release of the operating system are you using? Has it, your security system, communications protocol, or front-end software changed?
Is this problem reproducible? If so, how?
Have you tried to reproduce your problem in the simplest form possible? For example, if you are having problems joining two data sources, have you tried executing a query containing just the code to access the data source?
Do you have a trace file?
How is the problem affecting your business? Is it halting development or production? Do you just have questions about functionality or documentation?

User Feedback

In an effort to produce effective documentation, the Documentation Services staff welcomes your opinions regarding this manual. Please use the Reader Comments form at the end of this manual to communicate suggestions for improving this publication or to alert us to corrections. You can also use the Documentation Feedback form on our Web site, http://documentation.informationbuilders.com/feedback.asp.

Thank you, in advance, for your comments.

Information Builders Consulting and Training

Interested in training? Information Builders Education Department offers a wide variety of training courses for this and other Information Builders products.

For information on course descriptions, locations, and dates, or to register for classes, visit our Web site (http://www.informationbuilders.com) or call (800) 969-INFO to speak to an Education Representative.