CA-IDMS Data Adapter User's Manual

Feedback

Copyright © 2013 Information Builders

This documentation describes how to use the CA-IDMS® Read Only Data Adapter in the MVS™ and VM/CMS operating environments. It is intended for FOCUS® users who need to retrieve information from CA-IDMS®/DB data sources. It is available in the following formats: printed manual and Adobe® Acrobat®. References to MVS apply to all supported releases of MVS, OS/390®, and z/OS™. References to VM, VM/CMS, or CMS apply to all supported releases of VM/CMS and z/VM™.

How This Manual Is Organized

Chapter/Appendix

Contents

1

Introduction to the CA-IDMS Data Adapter

Introduces the data adapter, its operating environments, and its core requirements.

2

Getting Started

Describes how to access the data adapter.

3

IDMS Overview and Mapping Concepts

Discusses IDMS data source structures and how they are represented as FOCUS structures.

4

CA-IDMS Data Adapter Master Files

Describes the elements in a Master File that describes network record-types and Logical Record Facility (LRF)-based records.

5

CA-IDMS Data Adapter 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

CA-IDMS Data Adapter 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 data 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

CA-IDMS Data Adapter Samples

Contains sample schemas, subschemas, Master Files, and Access Files.

C

Tracing CA-IDMS Data Adapter Processing

Describes how to activate and deactivate data adapter traces.

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.

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 World Wide Web site, http://www.informationbuilders.com. You can also contact the Publications Order Department at (800) 969-4636.

Customer Support

Do you have questions about CA-IDMS Data Adapter?

Call 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 FOCUS 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 (xxxx.xx) when you call.

You can also access support services electronically, 24 hours a day, with InfoResponse Online. InfoResponse Online is accessible through our World Wide 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.

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 most effectively, be ready to provide the following information when you call:

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 relay suggestions for improving the 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 World Wide Web site (http://www.informationbuilders.com) or call (800) 969-INFO to speak to an Education Representative.