Relational Data Adapter User’s Manual

Feedback

This manual describes how to use the FOCUS® Adapters for DB2®, Teradata®, Oracle®, and CA-IDMS™. It applies to FOCUS Version 7.7 and to all RDBMS releases, except where noted. References to z/OS™ also apply to MVS® and OS/390. You should use this manual in conjunction with the FOCUS for Mainframe Documentation Set.

With one or more of the FOCUS relational adapters installed, you can use FOCUS to update, analyze, and report from data stored in tables and views of the Relational Database Management System (RDBMS).

To use the adapter effectively, you must be familiar with basic FOCUS reporting and database maintenance procedures. You must also have access to relational table information, including the data within the tables and views themselves, and descriptive information about them (table names, column names, and data types). Check with your RDBMS database administrator

How This Manual Is Organized

This manual includes the following chapters:

Chapter/Appendix		Contents
1	Introduction to Adapters for Relational Data Sources	Describes how the adapters function and how to use them.
2	Invoking Relational Adapters	Explains how to invoke the adapters with sample CLISTs and JCL.
3	Connection, Authentication, and Security	Describes how to connect to relational data sources and discusses security.
4	Describing Tables to FOCUS	Describes single-table Master and Access Files.
5	Multi-Table Structures	Describes multi-table Master and Access Files.
6	Automated Procedures	Describes the AUTODB2 and AUTODBC facilities that generate Master and Access Files for existing RDBMS tables, and the FOCUS CREATE FILE command that creates RDBMS tables given a Master and Access File.
7	The Adapter Optimizer	Discusses how the adapters pass certain data manipulation operations to the RDBMS for processing. It also describes the FOCUS EXPLAIN Utility.
8	Advanced Reporting Techniques	Describes advanced reporting topics such as the TABLEF command, the HOLD command, and the JOIN command.
9	Direct SQL Passthru	Describes how to issue adapter and SQL commands using the Direct SQL Passthru facility and how to include parameter markers in Direct SQL Passthru commands.
10	Controlling Connection Scope	Describes commands for connecting to and disconnecting from the RDBMS, automatically issuing COMMIT WORK commands, and opening and closing DB2 threads.
11	Adapter Commands	Lists environmental commands that display and change the parameters that govern your FOCUS session and the Dialogue Manager variables that store the values of those parameters.
12	Maintaining Tables With FOCUS	Describes table maintenance, RDBMS-managed integrity and concurrency, FOCUS-managed integrity and concurrency, and error handling within a maintenance procedure.
13	Static SQL (DB2)	Describes how to compile and run procedures that contain SQL statements.
A	Additional Topics	Describes problem-solving aids (such as the RDBMS return code), stored procedure support, standard FOCUS and adapter differences, long field name considerations, default DATE considerations, and remote segment descriptions. Also contains topics specific to individual adapters.
B	SQL Codes and Adapter Messages	Lists common SQL return codes and describes how to access adapter messages.
C	File Descriptions and Tables	Contains Master and Access Files for the examples included throughout the manual.
D	Tracing Adapter Processing	Discusses adapter trace facilities.

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

Visit our Technical Documentation Library at 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, DB2 for VM, 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 relational data 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 website, 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 Technical Content Management staff welcomes your opinions regarding this document. Please use the Reader Comments form at the end of this document to communicate your feedback to us or to suggest changes that will support improvements to our documentation. You can also contact us through our website http://documentation.informationbuilders.com/connections.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 website (http://education.informationbuilders.com) or call (800) 969-INFO to speak to an Education Representative.