risrep

RIS Report Writer User’s Guide for Windows August 1994 DNA115310 Version 5.0

Warranties and Liabilities All warranties given by Intergraph Corporation about equipment or software are set forth in your purchase contract, and nothing stated in, or implied by, this document or its contents shall be considered or deemed a modification or amendment of such warranties. The information and the software discussed in this document are subject to change without notice and should not be considered commitments by Intergraph Corporation. Intergraph Corporation assumes no responsibility for any error that may appear in this document. The software discussed in this document is furnished under a license and may be used or copied only in accordance with the terms of this license. No responsibility is assumed by Intergraph for the use or reliability of software on equipment that is not supplied by Intergraph or its affiliated companies.

Trademarks CLIX, Intergraph, and RIS are registered trademarks of Intergraph Corporation. DMRS, I/NFM, and TD1 are trademarks of Intergraph Corporation. All other brands and product names are trademarks of their respective owners.

Copyright  19100 Intergraph Corporation All Rights Reserved Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains confidential and proprietary information of Intergraph and/or third parties which is protected by copyright and trade secret law and may not be provided or otherwise made available without proper authorization. RESTRICTED RIGHTS LEGEND Use, duplication, or disclosure by the government is subject to restrictions as set forth in subparagraph (c) (1) (ii) of The Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 or subparagraphs (c) (1) and (2) of Commercial Computer Software — Restricted Rights at 48 CFR 52.227-19, as applicable. Unpublished — rights reserved under the copyright laws of the United States. Intergraph Corporation Huntsville, Alabama 35894-0001

Table of Contents

__________________________________________________________________________________________________________________________________________________

Table of Contents

__________________________________________________________________________________________________________________________________________________

1.

Before You Begin ..................................................................................................

1-3

1.1

Using On-line Help ......................................................................................

1-5

1.1.1

Parts of the Help Window ................................................................

1-5

Getting Started .....................................................................................................

2-3

2.1 2.2 2.3 2.4 2.5

RIS Report Writer Structure and Functions .............................................. Changes to RIS Report Writer .................................................................... Creating a Database .................................................................................... Attaching a RIS Schema .............................................................................. Templates .....................................................................................................

2-3 2-4 2-4 2-4 2-5

2.5.1

Template Libraries ...........................................................................

2-6

Join Columns ................................................................................................

2-6

2.6.1 2.6.2 2.6.3

Multi-Schema Joins .......................................................................... Outer Joins ....................................................................................... Edit Relations ...................................................................................

2-7 2-7 2-8

Reports ..................................................................................................................

3-3

3.1

Report Types ................................................................................................

3-3

3.1.1 3.1.2

Default Reports ................................................................................. Blank Reports ...................................................................................

3-3 3-5

3.1.2.1

Unrelated Tables Reports ..................................................

3-5

Accessing the Report Builder ...................................................................... Processing Reports .......................................................................................

3-6 3-6

4.

Edit Script .............................................................................................................

4-3

5.

Template Librarian ..............................................................................................

5-3

Accessing the Template Librarian .......................................................................

5-3

Database Edit .......................................................................................................

6-3

2.

2.6

3.

3.2 3.3

6.

6.1 6.2

Accessing Database Edit .............................................................................. Creating and Using Query Criteria ............................................................

6-3 6-5

6.2.1

Using Query Functions ....................................................................

6-5

Editing Database Values .............................................................................

6-7

7.

SQL Statements ...................................................................................................

7-3

8.

RIS Report Writer Commands .............................................................................

8-3

Add Query (Database Edit) .................................................................................. Change All (Database Edit) ................................................................................. Change Row (Database Edit) ............................................................................... Column (Report Builder) ...................................................................................... Copy Field ............................................................................................................. Copy Line .............................................................................................................. Counter (Report Builder) ...................................................................................... Current Row (Database Edit) .............................................................................. Date ....................................................................................................................... Define Structure ................................................................................................... Delete All (Database Edit) ................................................................................... Delete Field ........................................................................................................... Delete Line ............................................................................................................ Delete Row (Database Edit) ................................................................................. Delete Space .......................................................................................................... Derived .................................................................................................................. Dump Template .................................................................................................... Edit Code (Database Edit) .................................................................................... Edit Field .............................................................................................................. Edit Line ............................................................................................................... Edit Query (Database Edit) ................................................................................. Edit Report Parameters ....................................................................................... Exit ........................................................................................................................ Field Format (Report Builder) ............................................................................. Fields On/Off (Database Edit) .............................................................................. Field Operations (Report Builder) ....................................................................... Initialize Query (Database Edit) .......................................................................... Insert Row (Database Edit) .................................................................................. Insert Space (Report Builder) .............................................................................. Key Column (Database Edit) ............................................................................... Line Operations (Report Builder) ........................................................................ Line Script ............................................................................................................ Load From Library (Report Builder) ................................................................... Locate Graphics (Database Edit) ......................................................................... Modify Sort ........................................................................................................... Move Field ............................................................................................................. Move Line .............................................................................................................. New Blank (Report Builder) ................................................................................. New Default (Report Builder) ..............................................................................

A-1 C-1 C-3 C-4 C-8 C - 10 C - 12 C - 14 D-1 D-3 D-9 D - 10 D - 12 D - 13 D - 14 D - 15 D - 17 E-1 E-6 E-7 E - 10 E - 11 E - 13 F-1 F-3 F-4 I-1 I-2 I-3 K-1 L-1 L-2 L-5 L-8 M-1 M-5 M-7 N-1 N-3

6.3

Numeric ................................................................................................................. Page ....................................................................................................................... Place Field (Report Builder) ................................................................................. Place Line .............................................................................................................. Process Query (Database Edit) ............................................................................ Process Report ...................................................................................................... Report (Database Edit) ......................................................................................... Review (Database Edit) ........................................................................................ Save Report ........................................................................................................... Text (Report Builder) ............................................................................................ Text Size ................................................................................................................ Time ...................................................................................................................... Undelete Field (Report Builder) ........................................................................... Undelete Line (Report Builder) ............................................................................ Update Active (Database Edit) ............................................................................ Update Row (Database Edit) ............................................................................... User Variable (Report Builder) ............................................................................

N-6 P-1 P-3 P-5 P-8 P-9 R-1 R-2 S-1 T-1 T-3 T-4 U-1 U-2 U-3 U-4 U-5

Appendix A:

RIS Report Writer Environment Variables ........................................

AA - 3

Appendix B:

RIS Report Writer Reserved Tables ...................................................

BB - 3

Tables Needed for Raster Graphics ................................................................... Unique Row Identification .................................................................................

BB - 3 BB - 3

B.2.1 B.2.2 B.2.3

mslink Column ....................................................................................... Key Columns (mscatalog Table) ............................................................ Unique Index ..........................................................................................

BB - 4 BB - 5 BB - 7

Coded Columns and mscodelist ......................................................................... mscolumns ..........................................................................................................

BB - 7 BB - 9

B.1 B.2

B.3 B.4

Appendix C:

Timestamp Columns ...........................................................................

CC - 3

Appendix D:

RIS Report Writer Error Messages ....................................................

DD - 3

Glossary .......................................................................................................................

GL - 3

Index ............................................................................................................................

IN - 3

Before You Begin 1 - 1

Before You Begin

__________________________________________________________________________________________________________________________________________________

1-2

Before You Begin

Before You Begin 1 - 3

1.

__________________________________________________________________________________________________________________________________________________

Before You Begin Document Purpose This document describes the functions and commands in the Intergraph RIS Report Writer product. This document is intended for database system administrators and users.

Document Prerequisites This document assumes that you: Understand SQL database terminology and structure. Are familiar with the Intergraph Relational Interface System (RIS).

Related Documentation You can refer to the following documents for additional information: DNA1133 DNA1001 DNA0032 DSA0300

DB Access Administrator’s Guide DB Access Programmer’s Relational Interface System (RIS) for Windows NT SQL User’s Guide CLIPPER User’s Guide

1-4

Before You Begin

Document Conventions Filenames and directory paths appear in italic typeface. However, the italic typeface is also used for emphasis of new words or important phrases. For example: c:\windows Command names, menu names, tools, system prompts and messages, and keys may appear in boldface type. For example: File menu — OR — Press Enter The word mouse refers to the 2-button or 3-button mouse. The word select means to select a command by pressing the left mouse button over a menu command or by pressing the Alt key and the underlined character simultaneously. The word choose means to choose a button or icon by pressing the left mouse button over a Toolbar button, or application icon. The word reset means to terminate a command initiated with the mouse. Reset by pressing the right mouse button. The word identify means to define an area or place graphic elements in a graphics file. For PCs, identify with the left mouse button. The phrase key in generally means to enter data into a field on a dialog box. To advance to the next field, use the Tab key. Do not use the Enter key to advance to the next field. This key is mostly used as the default key to accept a dialog box instead of pressing the OK button. System key-ins, keywords, and programming code segments, appear in monospaced type. For example: main ( )

— OR — commit In actual usage, keywords can be in either upper or lowercase.

Before You Begin 1 - 5

Words that appear in angle brackets, < >, are identifiers or names that you must supply, or dynamic information that can change for each error message. For example: ERROR: Error opening the file Phrases in square brackets, [ ], are optional phrases. Curly braces contain several options (used in conjunction with a logical OR symbol ( | )) or phrases that can be repeated (used in conjunction with [, ...]). A comma followed by a series of three periods in square brackets ([, ...]) indicates that the last phrase contained within curly braces ({}), or the last item, can be repeated numerous times (separated by commas). For example: { } [, ...] means that numerous column names and associated data types can be specified (separated by commas). The logical or symbol ( | ) separates phrases or keywords within curly braces ({}) that can be used alone but not together. For example: { user | database } means that either the user keyword or the database keyword can be specified, but not both. This symbol notes important information.

This symbol cautions about operations that can cause limited damage.

This symbol warns about operations that can cause severe damage.

1.1 Using On-line Help On-line Help is an on-line reference tool accessible at any time the application is in use. The on-line Help contains a description for each command and tool and step-by-step procedures for common tasks. For example, if you need to perform a certain task, search and display the topic. You can move or resize your application and Help windows so that they are next to each other. This lets you follow the procedures without having to search for the pages in the documentation.

1-6

Before You Begin

1.1.1 Parts of the Help Window To view the on-line Help, select Contents from the Help menu. To get more specific information, select one of the major topics or perform a search on a specific topic.

Before You Begin 1 - 7

Use

To

Contents

Display a listing of the table of contents for the on-line Help file.

Search

Locate information about a certain topic that you enter in the Search box.

Back

Take you back to the previous Help topics you have already viewed.

History

Display a sequential list of every Help topic you have viewed during your current Windows session.

Find

Display a dialog box used to retrieve partial or full text strings in the help file. Use the Hints button for information on constructing your search query.

>

View the next topic in a series of related topics. The button is dimmed when you reach the last topic in the series. If the graphics in the on-line Help appear distorted, check your graphics driver. If you are using an Intergraph TD1 machine, the S3 1024x768 256 color (Large Font) distorts the graphics slightly. Changing to the (Small Font) version corrects the display. If you are using other drivers, check with your PC manual for information about available graphics drivers.

1-8

Before You Begin

Getting Started 2 - 1

Getting Started

__________________________________________________________________________________________________________________________________________________

2-2

Getting Started

Getting Started 2 - 3

2.

__________________________________________________________________________________________________________________________________________________

Getting Started RIS Report Writer is a report writer and database editor that lets you access ANSI/ISO SQL-standard databases supported by the Intergraph Relational Interface System (RIS). RIS Report Writer also runs in conjunction with alphanumeric user data and ASCII data. You can define the input structures for these types of data so that you can design and run reports. You can customize user data reports provided with Intergraph applications. For more information, see these sections: 2.1

RIS Report Writer Structure and Functions

2.2

Changes to RIS Report Writer

2.3

Creating a Database

2.4

Attaching a RIS Schema

2.5

Templates

2.6

Join Columns

2.1 RIS Report Writer Structure and Functions Two fuctional areas are included in the RIS Report Writer product: Reports and Utilities. Reports — This function lets you design report templates, which process information from a relational database to generate report output. You can: — Interactively place column fields to report on one or more tables in one or more databases. — Place fields to display text, the date, time, and page number, and to provide numeric information (totals, averages, and so forth). — Establish sort criteria, print conditions, and reset conditions for lines and fields in the report. — Use system and user-defined variables to build scripts that provide more flexibility in formatting report output.

2-4

Getting Started

Utilities — This function includes Database Edit and SQL Statements. — Database Edit gives you a graphic window into the attached database. You can edit rows in the database, create query criteria to search for rows with common properties, or generate reports to review the universe of rows that the query criteria create. — SQL Statements let you create, store, and recall commonly used Structured Query Language statements.

2.2 Changes to RIS Report Writer For a complete listing of major changes incorporated since the last release, see the c:\win32app\ingr\risrpt\README.TXT file.

2.3 Creating a Database Before you use RIS Report Writer, you must create a database with your relational database management system (RDBMS). Each RDBMS has specific requirements for creating a database. See the RDBMS-specific documents for information.

2.4 Attaching a RIS Schema RIS Report Writer attaches to a database through the Intergraph Relational Interface System (RIS). RIS is a generic relational database interface that isolates the differences in specific vendors’ relational database management systems (RDBMSs). Each user of a database must have a RIS schema created for that database. A schema defines a unique database/user combination in the commercial RDBMS. See the Relational Interface System (RIS) for Windows NT SQL User’s Guide for information on creating schemas. The following methods, listed in order of precedence, attaches a schema to RIS Report Writer. If no schema is attached when RIS Report Writer is invoked, you can specify a schema in the Schema field on the main dialog. You can key in the schema name or select the list indicator at the end of the field to display a list of available schemas. Select a schema from the list. You can specify a RIS schema with the -s command line option when you invoke RIS Report Writer from the DOS prompt. For example: risrpt -s

Getting Started 2 - 5

You can set the environment variable DBA_SCHEMA in your propertities under the command line on c: drive or the autoexec.bat file. See the section RIS Report Writer Environment Variables for information on using RIS Report Writer environment variables.

2.5 Templates RIS Report Writer stores various types of output as templates. For example, you can save reports created with the Report Builder as report templates in a template library. Templates can be used repeatedly or they can serve as the starting point for new templates. The following types of templates can be stored in a template library: Applications Bitmap Dialogs Design options Query criteria Palettes Relations Reports Report structures Scripts SQL statements Status Bar Toolbars You must assign a name for a template when saving it to a template library. Template names must consist of 20 or fewer alphanumeric characters with no embedded spaces. It is recommended that you use the underbar character (_) between words.

2-6

Getting Started

2.5.1 Template Libraries A template library is a data file in which you can store templates. You can create multiple libraries and group templates according to application, use, privilege, or type. A special command-line process, the Template Librarian (templib), lets you manipulate templates and template libraries. See the section Template Librarian for more information. The Template Librarian is also located on the RIS Report Writer main menu. Any time you see a Library field on a dialog, you can create a new template library by keying in a template library name that does not exist (full or relative filename) and answering Yes to create it. To attach a template library, you can specify a library name: 1.

Using the -l option when you invoke RIS Report Writer from the command line under properties on c: drive. For example: risrpt -l

2.

In the Library field of the Load From Library dialog.

3.

In the DBA_LIB environment variable. (You can also specify a list of template libraries in the DBA_LIB_LIST environment variable.)

2.6 Join Columns RIS Report Writer lets you relate the data in any two RIS-supported database tables that share a common column. These join columns are not required to have the same name, but they must have common values. The following figure shows the columns for the manufacturer, parts, and sale tables created by the auto.sql file. Potential join columns are highlighted.

Getting Started 2 - 7

2.6.1 Multi-Schema Joins You can use multi-schema joins to relate information from more than one schema. Multischema joins require that you specify a schema list, using the -S command-line option or the DBA_SCHEMA_LIST environment variable. The primary schema in a multi-schema join must have select access to the secondary schema’s tables. Use the RIS GRANT command to grant select access.

2.6.2 Outer Joins The Join Columns dialog lets you specify whether or not a join should be an outer join (as opposed to a standard join).

2-8

Getting Started

If you select Yes, the resulting universe includes all occurrences from the primary table whether or not it has a corresponding row in the secondary (join) table. If you select No, the resulting universe includes only those occurrences for which the join column values are equal (for example, parts.part_num = sale.part_num). In general, outer joins process faster than standard joins across schemas. Standard joins process faster if the tables are in the same schema. Query criteria for the secondary table are ignored for outer joins, but used for standard joins.

2.7 Edit Relations The Edit Relations dialog (available from Schema Edit) lets the Database Administrator graphically depict relations between tables in the database and store this information in a DBA template library. Once a relations template has been created and attached to a dialog/report from the Edit Dialog or Edit Report dialogs, the dialog/report designer can place columns from joined tables without being aware of the complexity of the database. Relations can be simple, as in previous versions with the Join Columns dialog, or complex, consisting of several tables and multiple columns to each table join. DBA can find the shortest available route between tables when performing runtime join operations. If no relations template is attached, or if no path exists between the tables to be joined, the Join Columns dialog is displayed the first time a join is specified. Existing dialogs/reports will work as before without change. In fact, the relations template is ignored unless the Join Columns dialog for the joined column is blank. DBA 5.0 Edit Relations does not support multi-schema joins or outer joins. However, the Join Columns dialog can be used to specify simple multi-schema joins and outer joins, as in past versions. The following commands are available from the Edit Relations dialog: Template — The name of the relations template. Description — The description of the relations template. Load Relations — Displays the Load from Library dialog for loading an existing relations template. Save Relations — Displays the Save Template dialog for saving a new or changed relations template. Add Join — Displays the Join Columns dialog for adding new joins. Delete Join — Deletes a join, by selecting the connecting line between the join columns. Move Table — Aligns the table fields as wanted (added joins are placed automatically).

Getting Started 2 - 9

Delete Table —Deletes a table and all associated joins.

2 - 10

Getting Started

Reports 3 - 1

Reports

__________________________________________________________________________________________________________________________________________________

3-2

Reports

Reports 3 - 3

3.

__________________________________________________________________________________________________________________________________________________

Reports RIS Report Writer lets you create, load, modify, and save report templates. You can specify the layout of different types of lines and fields within the report template. When the template is processed, RIS Report Writer reads information from a relational database, ASCII file, binary file, or element list file and formats it to your specifications. For more information, see these sections: 3.1

Report Types

3.2

Accessing the Report Builder

3.3

Processing Reports

3.1 Report Types The Report Builder provides several options for creating reports. You can define templates to report on database tables, ASCII files, binary files, or user data in design files. Blank and default reports are available for all four report types. The four report types are: Database reports — Loads a default template, a blank template, or an existing template from a template library. ASCII reports — Creates an ASCII structure template or loads an existing ASCII report template from a template library. See the section Define Structure. Binary reports — Creates a binary structure template or loads an existing binary report template from a template library. See the section Define Structure. User data reports — Creates a user data structure template or loads an existing user data report template from a template library. See the section Define Structure.

3.1.1 Default Reports The New Default (Report Builder) command reads the structure of the attached database or structure and generates a default report template for the selected table. You can select columns to be included in or excluded from the default template when it is loaded. The following is the default report template for the manufacturer table in the sample database.

3-4

Reports

In a report template, the column on the left indicates the line type. A represents alphanumeric data, I represents integer data, F represents floatingpoint data, D represents derived field, and C represents a coded column field. The number of As, Is, Fs, Ds, or Cs represents the field length for the column in the database. A default template has the following characteristics: Sort criteria — One sort key (the first selected column of the table) Top lines — Title line (the table name) – Date, Time, and Page line – Column Header lines (underlined column names) Body lines — Detail line. Printed once for each row in the input universe, it contains the selected columns. You can specify 1 to 2000 characters per line for the default report on the Edit Report Parameters dialog. If the selected columns overrun the current characters per line, the line is extended to fit all selected columns. In addition, the line contains a counter field which counts rows and resets when sort key 1 breaks or changes.

Reports 3 - 5

— Subtotal line. Printed when sort key 1 breaks; it totals, prints, and resets the counter field and totals, prints, and resets any numeric columns included in the report. Final line — The system totals and prints the counter field, and totals and prints any numeric columns included in the report in this line. For more information, see the section New Default (Report Builder).

3.1.2 Blank Reports The New Blank (Report Builder) command loads a blank report template for a selected table. Unrelated Tables loads a blank template that lets you report on tables that have no relationship. A blank report contains no lines or fields. You can design a template with the features and functionality needed.

3.1.2.1 Unrelated Tables Reports To report on tables that do not share join columns, you must create an unrelated tables report. Possible reports on unrelated tables include reports in which preface information comes from one table and body information from another. You must place one or more Single Table lines for each table on the report template. Fields for a table must be placed on a line associated with that table. Common lines, such as page headings, are placed on All Tables lines. You must set up separate sorts for each table in the report.

3-6

Reports

For more information, see these sections Join Columns, New Blank (Report Builder), and Modify Sort.

3.2 Accessing the Report Builder To access the Report Builder, click on the third icon on the Toolbar dialog.

The Report Builder dialog displays on top of the RIS Report Writer main dialog.

RIS Report Writer loads the Report Builder menu bar.

3.3 Processing Reports You can access the Process Report command from the Reports area of the RIS Report Writer main dialog. This command lets you process report templates that have been created in the Report Builder. For more information see section Process Reports.

Edit Script 4 - 1

Edit Script

__________________________________________________________________________________________________________________________________________________

4-2

Edit Script

Edit Script 4 - 3

4.

__________________________________________________________________________________________________________________________________________________

Edit Script The Edit Script button on the RIS Report Writer main dialog calls the Edit Script dialog. The Edit Script dialog lets you create or edit scripts. All major functions designed for runtime users can be manipulated by scripts. In addition, System commands can be included within scripts. Scripting assumes a knowledge of the C programming language. In fact, the structure of a script is in the form of a C function. For descriptions of supported functions, see the DB Access Programmer’s Guide or the c:\win32app\ingr\dba\doc\script.doc file.

Dialog Options When you select Edit Script, the Edit Script dialog appears.

Name — Specifies the name of the script. The name of the script template must be the same as the function name.

4-4

Edit Script

Description — Contains a description of the script (up to 50 characters). Load from ASCII file — Specifies the name of an ASCII file to load. You can edit the file and save it as a script. Save to ASCII file — Specifies the name of an ASCII file to contain the current script. Scripts saved as ASCII files can be printed. Debugger — A check box that determines whether the Script Debugger is off or on. When the toggle is set to On, a Debugger icon appears on the screen. For more information, see the section Script Debugger. Store Compiled Scripts — A check box that determines whether the compiled version of the script is stored in the template library. When the toggle is set to On, the compiled script is stored in the template library so that it does not have to be recompiled each time the application is invoked. When the toggle is set to Off, the script is not stored in the template library and is recompiled each time the application is invoked. Load Script — Calls the Load from Library dialog. You can select a script from the list of available script templates. For more information, see the section Load From Library (Report Builder). Check Script — Displays a Script Errors form that displays any detected errors and the line numbers where the errors were detected. (Usually an error is detected somewhere just after it occurs.) If you select an error line in the Script Errors form, the cursor moves to the point in the script (on the Edit Script dialog) where the error was detected. Save Script — Calls the Save Template dialog. You can save the current script as a template in the current template library. For more information, see the section Save Options. Options — Calls the Script Options dialog, which is described in the following section. Text field — Displays the current script. When the Edit Script dialog first appears, this field is in edit mode. You can key in a script or edit one that has been loaded. Clear — Clears the text field on the Edit Script dialog. It also clears the delete buffer. Delete — Puts the text field in delete mode; any script statement you select is deleted and stored in a delete buffer. The delete buffer stores deleted lines until you exit delete mode or select Clear. Select Delete again to exit delete mode. Undelete — Inserts the current delete buffer at the marker (highlighted) line in the text field. If no marker line exists, the delete buffer is inserted at the bottom of the text.

Edit Script 4 - 5

Select a line to make it a marker line. The text field cannot be in delete or edit mode. (That is, the Delete, Undelete, and Edit buttons are not depressed.) Edit — This button places the text field in edit mode. You can key in or edit scripts. Use Editor — This button invokes the preferred editor (defined by the EDITOR environment variable). If EDITOR is not defined, Notepad is the default editor. — The name of the current editor appears in the field to the right of the Use Editor button. To change editors, select and clear this field, and key in the name of the new editor.

Options Button When you select the Script Options button, the Script Options dialog appears.

Run Current Script — This button runs the current script in the editor and accepts any arguments. Some scripts, such as one that requires input from a dialog, cannot run with this command. The Arguments field is used to place any literal arguments that normally appear inside the parentheses of a function call. Separate the literal arguments with commas, but do not key in the parentheses. Delete Globals — This button deletes all global variables from memory. This is useful if you need to change a global type. Run Initial Script — By default, this button runs the script specified by DBA_INITIAL_SCRIPT. You can specify another script in the Initial Script field. (Initial scripts can be used to initialize global variables and require no arguments.) This button also deletes all global variables. Verbose Errors and Warnings — The gadgets in this area let you manipulate verbose error checking mode. Use of this mode eliminates the need to check status returns in script function calls.

4-6

Edit Script

— Edit Settings. This button calls the Verbose Error Settings dialog, which lets you select which function types undergo verbose error checking (standard C, DB Access, I/Forms, I/NFM, RIS, or all). These settings can be saved and loaded as design options. For more information see the section Save Options. — Off/On. This toggle turns verbose error checking mode off or on.

Script Debugger The Script Debugger is a troubleshooting tool for scripts. You can use the Script Debugger to: Set breakpoints to stop a script at specified points in processing. Review the variables associated with a script. Set values for these variables. Set verbose error checking mode options. Return to the Edit Script dialog.

Script Debugger Dialog Options The Script Debugger dialog is invoked from the Edit Script dialog. When you set the Debugger toggle to On, a Debugger icon appears on the screen. You can move the icon by pressing and holding the mouse button and moving the mouse.

When any dialogs associated with the Script Debugger are collapsed, a Debugger icon appears on the screen. Select the icon to uncollapse the Script Debugger dialog.

Edit Script 4 - 7

Edit Script — This button returns you to the Edit Script dialog. The last script function displayed in the Script Debugger text field appears in the Edit Script text field. Single Step — This button steps to the next line of the script code being debugged. Any function called is executed. Step Into — When a script calls a user-defined script function, this button displays the called function. Execution stops on the first line of the called function. Step Into acts as a single step on button functions and dynamically loaded functions. Breakpoints — This button calls the Set/Review Breakpoints dialog. For more information, see the section Set/Review Breakpoints. Go — This button runs the script to completion or to the next breakpoint. Continue — This button runs the current function to completion. Execution stops on the line of script following the point where the function is called. Variables — This button calls the Review Variables dialog. For more information, see the section Review Variables. Abort — This button stops execution of the current script and any other gadget processing which is pending.

4-8

Edit Script

Visual Script Trace — This toggle turns the Visual Script Trace on and off. When the toggle is On, the debugger displays functions as they are called, highlighting the line being executed. Break on Script Gadget — This toggle sets the Break on Script switch. When the toggle is On and a gadget (or report line, dialog script, or notify script) that has an associated script is activated, the debugger becomes uncollapsed. Script processing is suspended just as if a breakpoint had been set. Verbose Errors and Warnings — The gadgets in this area let you manipulate verbose error checking mode. Use of this mode eliminates the need to check status returns in script function calls. — Edit Settings. This button calls the Verbose Error Settings dialog, which lets you select which function types undergo verbose error checking (standard C, DB Access, I/Forms, I/NFM, RIS, or all). These settings can be saved and loaded as design options (see the section Save Options). — Off/On. This toggle turns verbose error checking mode off or on. Breakpoints — This toggle turns all breakpoints on (Enabled) or off (Disabled) without calling the Set/Review Breakpoints dialog. This does not affect the automatic break on gadget/line scripts. Name — This field specifies the script function being debugged. Description — This field contains a description of the script function.

Edit Script 4 - 9

Set/Review Breakpoints When you select Breakpoints from the Script Debugger dialog, the Set/Review Breakpoints dialog appears.

Break on Function — This field displays the script templates available from the current library. You can select functions from this list. Script processing stops when a selected function is called. Clear All Breakpoints — This button clears all functions and line breakpoints. Undo Changes — This button resets all breakpoints to the way they were when the Set/Review Breakpoints dialog was invoked. Function — This field specifies which function’s line breakpoints appear in the Break on Line field. You can key in a function or select one using the list indicator. Edit Line Breakpoints — This button starts Add/Remove Line Breakpoints mode. In this mode, you can select lines displayed in the Script Debugger dialog text field to add them as line breakpoints (displayed in the Break on Line field). You can remove the line breakpoint by deselecting the line (that is, selecting the line a second time) on the Script Debugger dialog. Delete Line Breakpoints — This button removes line breakpoints from lines in the Break on Line field. Select Delete Line Breakpoints. Then select the lines to remove breakpoints.

4 - 10

Edit Script

Break on Line — This field specifies the lines of a function on which the Script Debugger stops processing.

Review Variables When you select Variables from the Script Debugger dialog, the Review Variables dialog appears.

Function — This field specifies which function’s variables are currently displayed. You can key in a function or select one using the list indicator. Name — This field specifies the name of the variable. Type — This field gives the type of the variable, its level of indirection, if its an array and the numbers and sizes of dimensions. Value — This field specifies the value of the variable. Most pointers are displayed as two integers separated by a colon. Some pointers, such as dba_errtxt, appear as a single integer. To change a variable’s value, position the cursor on the value to be changed and key in a new value.

Template Librarian 5 - 1

Template Librarian

__________________________________________________________________________________________________________________________________________________

5-2

Template Librarian

Template Librarian 5 - 3

5.

__________________________________________________________________________________________________________________________________________________

Template Librarian The Template Librarian (templib) is a standalone utility. It is an integrated part of the administrator which provides many of the features of templib, RIS Report Writer template libraries. You can use the Template Librarian to: List the templates in a specified template library. Copy templates from one template library to another. Extract a template into a text file (only available from templib). Delete a template. Compress a template library to recover space after templates have been replaced or deleted. The Template Librarian is an embedded DBA application. Most of the code behind it are scripts. These dialogs and scripts can be customized and added to by the user.

Accessing the Template Librarian To access the Template Librarian, click on the fifth icon on the Toolbar dialog.

5-4

Template Librarian

The Template Librarian screen appears.

Before you can copy, delete, or move libraries, you must select the libraries necessary for the operation. To select one library, just click on it. To select more than one, hold the Ctrl key down when using the mouse.

Copy Libraries To copy a library select Template and then select Copy from the pulldown menu.

When Copy is selected the Copy dialog appears.

Template Librarian 5 - 5

Copy selected templates to — The name of the library to copy to. If it does not exist, you are prompted to create it. Browse — The Browse button can be used to activate the standard Open dialog to search for the library to copy to. Replace templates —The Replace templates option must be checked for a DBA existing template to be overwritten.

Move Libraries To move a library select Template and then select Move from the pulldown menu.

When Move is selected the Move dialog appears.

Move selected templates to — The name of the library to move to. If it does not exist, you are prompted to create it. Browse — The Browse button can be used to activate the standard Open dialog to search for the library to move to. Replace templates —The Replace templates option must be checked for a DBA existing template to be overwritten.

5-6

Template Librarian

Delete When you select Template, then Delete, a confirmation dialog box displays.

Undelete To retrieve previous versions of a template or recover a template that has been deleted, you first have to see the deleted/modified templates. Then choose the templates to undelete. (The Undelete command is disabled until this point). Select Undelete, the template is moved from the Deleted list and becomes visible again when you do another Show Deleted (to turn the mode off). If there is already a nondeleted template in the library with the same name and type, it becomes deleted (they are basically swapped). All deleted templates are permanently removed (and do not show up in the deleted list) if a Compress is performed on the template library.

Select All

When you select Template, then Select All, the template librarian marks everything in the Current List of Templates.

Template Librarian 5 - 7

Unselect All When you select Template, then Unselect All, the template librarian undoes the Select All command.

Template Types To see the template types, select View and then select Template Type from the pulldown menu.

5-8

Template Librarian

When you select Template Types, the Template Types Filter dialog appears.

This is used to control what types of templates are shown in the Template List.

Sort By To sort a library select View and then select Sort By from the pulldown menu.

When the Sort By is selected the Sort By dialog appears.

Template Librarian 5 - 9

Show Deleted To look at the deleted templates, select View and then select Show Deleted from the pulldown menu.

When you select Show Deleted, a list of deleted templates dialog appears.

Compress To compress the library, select Tools and then select Compress from the pulldown menu.

5 - 10

Template Librarian

This command only affects the current library. This permanently removes any deleted templates.

Bulk Compile To do a bulk script compile, select Tools and then select Bulk Compile from the pulldown menu.

When you select Bulk Compile, the Bulk Script Compiler dialog appears.

This compiles all script templates in all the libraries in the DBA_LIB_LIST into stored script objects. For information see the section Store Compiled Scripts and Object libraries. If any of the scripts do not compile, use the Review Errors button to view any errors.

Template Librarian 5 - 11

Cross Reference To generate a cross reference report, select Tools and then select Cross Reference from the pulldown menu.

When you select Cross Reference, the Cross Reference dialog appears.

Object Template Library — This field has the library name that is created in the bulk script compile command. Report Output Filename — This is what the report file is named. Report Description — This field gives you a description of the report to be run. A cross reference report is really a DBA ASCII Report. You can choose which cross reference you want to generate: FUNCTION_REF — Lists each function and indicates which scripts call it. FUNC_SYMBOL_DUMP — Lists each function, along with all automatic variables, and global variables for each function name.

5 - 12

Template Librarian

GLOBAL_REF — Lists each global variable and indicates which scripts reference them. INCLUDE_REF — Lists each include file/include template and which scripts include them. All these reports can be customized and new ones added. For more information see the file c:\win32app\ingr\risrpt\support\tl.tlb.

Database Edit 6 - 1

Database Edit

__________________________________________________________________________________________________________________________________________________

6-2

Database Edit

Database Edit 6 - 3

6.

__________________________________________________________________________________________________________________________________________________

Database Edit The Database Edit function lets you review, add, delete, or modify rows in an attached relational database. You can manipulate individual rows or a universe of rows. You can process report templates from Database Edit. For more information, see these sections: 6.1

Accessing Database Edit

6.2

Creating and Using Query Criteria

6.3

Editing Database Values

6.1 Accessing Database Edit When you select Utilities from the RIS Report Writer menu bar, the pulldown menu appears. Select the Database Edit command and the Database Edit dialog appears. If a schema and table are active, the column list for the table is displayed. If there is not a schema present enter one in the schema field and press the Return key. The schema is attached, and you can select a table in the table field.

6-4

Database Edit

Initialize Query — This button initializes (clears) the current query criteria. For more information, see sections Creating and Using Query Criteria and Initialize Query (Database Edit). Edit Query — This button lets you edit or save the current query criteria, or load a query criteria template from a template library. For more information, see sections Creating and Using Query Criteria and Edit Query (Database Edit). Process Query — This button finds all rows in the current table that meet the query criteria. If no query criteria exists, Process Query returns all rows in the current table. For more information see sections, Creating and Using Query Criteria and Process Query (Database Edit). Current Row — This area lets you determine which row in the universe is current. For more information, see the section Current Row (Database Edit). Add Query — This area is used to set up query criteria, values used to search the database for rows with common information. For more information, see sections Creating and Using Query Criteria and Add Query (Database Edit). Edit Code — This button lets you display, edit, and insert new code list values in a code list. You can also add a code list value to the current row. For more information, see sections RIS Report Writer Reserved Tables. Change All — This button lets you change the value for one or more columns for all rows in the current universe. For more information, see sections Editing Database Values and Change All (Database Edit). Delete All — This button deletes all rows in the current universe from the database upon verification. For more information, see the section Delete All (Database Edit). Fields On/Off — This button toggles all column fields off or on. Off fields are not included in universe reviews. You can toggle individual fields on or off by selecting the column name for the field on the Database Edit dialog. For more information, see the section Fields On/Off (Database Edit). Review — This button generates a formatted column-by-column listing of the current universe. For more information, see the section Review (Database Edit). Report — This button calls the Process Reports dialog, which lets you load and process a report template. You can list the report output to the screen or print the output file. For more information, see the section Report (Database Edit). Key Column — This button puts the dialog in key column mode, which overrides the key-in mode for database fields. For more information, see the section Key Column (Database Edit). Change Row — This button puts the dialog in change row mode, which overrides the key-in mode for key column, add query, and update active fields. For more information, see sections Editing Database Values and Change Row (Database Edit).

Database Edit 6 - 5

Delete Row — This button deletes the current row from the database upon verification. For more information, see the section Delete Row (Database Edit). Update Active — This button lets you enter data in the multiple column field which is used in creating a new row. Select Insert Row to insert the displayed data as a row in the database. For more information, see the section Update Active (Database Edit). Insert Row — This button inserts a new row in the database, based on the currently displayed column values. You can select Update Active, enter the column values you want for a row, and select Insert Row to create the new row. For more information, see sections Insert Row (Database Edit) and Update Active (Database Edit). Update Row — This button updates the current row based on the currently displayed columns values. For more information, see the section Update Row (Database Edit). The eight gadgets in the lower right corner of the screen are reserved for creating and manipulating graphics linkages in the Intergraph DB Access Administrator Toolkit product. These functions are not available in RIS Report Writer.

6.2 Creating and Using Query Criteria Database Edit lets you build query criteria to search a database table for rows with common column values. For example, you might want to search the parts table for all tires made by a particular manufacturer, or all tires of a certain size and price range. The set of rows that match the query criteria is called a universe of rows.

6.2.1 Using Query Functions The following is a suggested sequence for clearing, creating, and processing query criteria. In this example, the parts table is current. This example creates query criteria to search for 15-inch tires with a price of less than 100 dollars by: Using a substring search (!!) relational operator for the mfr_name field to limit the query to manufacturers of tires. The two manufacturers in the database that produce tires (GoodTire and Armstrong Tires) have the character string Tire in their names. Using a substring search relational operator for the description1 field to limit the size of the tires to 15. Using the less than ( < ) relational operator for the price field to search for tires that cost less than 100 dollars. Selecting the AND function to find only the tires that meet all the criteria.

6-6

Database Edit

Operating Sequence 1.

Select Initialize Query from the Database Edit dialog to clear any existing query criteria. The message Query initialized appears.

2.

Create a query criteria. a.

Select Add Query. The Add Query button appears to be depressed. The dialog is in Add Query mode. Any edits to the column values of the current row are added as query criteria and do not change the database.

b.

Set the AND/OR toggle to AND.

c.

Select the list indicator on the relational operators field. Select the substring search ( !! ) operator from the displayed list.

d.

Select the mfr_name column field. Clear the column field and key in Tire. The message Query added appears.

3.

Repeat the process to add a substring search for 15 in the description1 field.

4.

Add query criteria in the price field for less than ( < ) 100. (This requires you to select a new relational operator.)

5.

Select Edit Query to review the query criteria. The Edit Query dialog displays the query criteria. The query criteria should resemble the following:

a.

If there are errors in the query criteria, select the appropriate line and make the needed edits.

b.

Select OK to accept the query criteria and to exit the Edit Query dialog.

Database Edit 6 - 7

6.

Select Process Query to process the query criteria. The system displays the message Found nn "parts" row(s) and displays the first row in the universe.

7.

Use the Current Row functions to page through the universe, or select Review to see a formatted listing of the universe.

6.3 Editing Database Values You can use Database Edit to change most column values in a database. By default, the multiple column field on the Database Edit dialog is in change row mode. To update a value in the current row, select the appropriate column field and key in a new value. The row is automatically updated in the database. Exceptions to this process include: If a dialog contains add query, update active, or key column fields, you must select Change Row to change the associated value. For more information, see the section Change Row (Database Edit). You cannot edit a serial column value in an INFORMIX database by keying in a new value. You cannot use the Change Row command to change serial column values. If you convert serial columns to integer columns, you should be able to modify their values through RIS Report Writer. You cannot enter duplicate values in a column used for unique row identification (mslink, mscatalog.key column, or unique index). For more information, see the section RIS Report Writer Reserved Tables. To change one or more column values for all rows in the current universe, use the Change All command. For more information, see the section Change All (Database Edit).

6-8

Database Edit

SQL Statements 7 - 1

SQL Statements

__________________________________________________________________________________________________________________________________________________

7-2

SQL Statements

SQL Statements 7 - 3

7.

__________________________________________________________________________________________________________________________________________________

SQL Statements The SQL Statements button on the RIS Report Writer main dialog calls the SQL Statements dialog. You can enter and process SQL statements, and save them as templates. You can load SQL templates to process or edit. You can load an ASCII file to edit and process. In general, you should use the SQL Statements dialog to process Data Manipulation Language (DML) statements (such as delete, insert, select, and update). Use the RIS Schema Manager in the Schema Edit utility for functions performed by Data Definition Language (DDL) statements (such as create, alter, and drop). The Structured Query Language (SQL) is an ANSI standard language for creating and manipulating databases. For information on RIS-supported SQL statements, see the Relational Interface System (RIS) for Windows NT SQL User’s Guide.

Dialog Options When you select SQL Statements, the SQL Statements dialog appears.

SQL Statement Field — This field specifies the current SQL statements. You can key in one or more statements. You can break a statement over more than one line by inserting a Return between words. If there are multiple SQL statements, terminate each statement with a semicolon (;).

7-4

SQL Statements

A single SQL statement

Multiple SQL statements Load ASCII — This field lets you specify an ASCII file to be loaded. The contents of the file displays in the SQL Statement field. You can edit the display, process it, or save it as an SQL template. Editor — This button invokes the preferred editor which is defined by the EDITOR environment variable. If EDITOR is not defined, Notepad is the default editor. — The name of the current editor appears in the field to the right of the Editor button. To change editors, select and clear this field, and key in the name of the new editor. Load SQL — This button calls the Load from Library dialog. You can select a template from the list of available SQL templates. For more information, see the section Load From Library (Report Builder). Save SQL — This button calls the Save Template dialog. You can save the current SQL statements as a template in a template library. For more information, see the section Save Options. Apply — This button executes the SQL statements. If you process an SQL select statement, the Database Edit dialog appears. Select Review to see a listing of the resulting universe, or select Process Query and use the Current Row functions to step through the universe a row at a time.

SQL Statements 7 - 5

Clear — This button clears the SQL Statement field. Close — This button exits the SQL Statements.

7-6

SQL Statements

RIS Report Writer Commands 8 - 1

RIS Report Writer Commands

__________________________________________________________________________________________________________________________________________________

8-2

RIS Report Writer Commands

RIS Report Writer Commands 8 - 3

8.

__________________________________________________________________________________________________________________________________________________

RIS Report Writer Commands This section contains alphabetized descriptions of the commands available in RIS Report Writer. In addition to general information about the command, a description may include any of the following, if appropriate. All command descriptions do not include all sections. Command Path — This figure represents the selection path for the command. Select each palette command in the path (from left to right in the figure) to select the command. A command can have more than one command path.

Dialog Options — If the command invokes a menu, this section describes the gadgets on the menu. Before Using This Command — This section contains information you should know before selecting the command. Operating Sequence — This section provides step-by-step instructions for using the command.

8-4

RIS Report Writer Commands

RIS Report Writer Commands A - 1

Add Query (Database Edit)

__________________________________________________________________________________________________________________________________________________

The Add Query command lets you establish query criteria. You can use query criteria to limit the input universe processed by a report. If, for example, you want to search the parts table for tires, you can use the substring search (!!) relational operator to query the mfr_name field for the character string Tire. The resulting query criteria: parts.mfr_name like ’%Tire%’

would return rows for the two manufacturers in the database that produce tires (GoodTire and Armstrong Tires). Note that values for substring searches are enclosed in single tics (’) and percent signs (%). If you want to search for all parts except tires, you can do one of the following: Edit the previous query, adding the word not, to produce: parts.mfr_name not like ’%Tire%’

For information on editing queries, see the section Edit Query (Database Edit). In the relational operator field, key in not like when adding the query. In the mfr_name field, key in %Tire%. Again, the resulting query criteria would be: parts.mfr_name not like ’%Tire%’

Dialog Options

Add Query — This button places the dialog in add query mode. Any value you key in for a column field is added as query criteria. The value in the database is not changed. The dialog remains in add query mode until you select Add Query again, or select another key-in mode.

A-2

RIS Report Writer Commands

AND/OR — This toggle lets you establish a logical AND or OR operation. — AND returns rows that contain the previous query criteria and the current column query criteria. — OR returns rows that contain the previous query criteria or the current column query criteria. Multiple column searches process in order, with logical AND having precedence over logical OR. Relational Operator List — This field lets you specify a relational operator for the query. You can key in a value or use the list indicator to select a relational operator. The following relational operators are available: = != < > = !!

equal to (default) not equal to less than greater than less than or equal to greater than or equal to substring search You can key in any relational operator supported by RIS.

RIS Report Writer Commands C - 1

Change All (Database Edit)

__________________________________________________________________________________________________________________________________________________

The Change All command lets you change the value of one or more columns for all rows in the current universe. You cannot use Change All to edit a serial column (INFORMIX). You cannot enter duplicate values in a column used for unique row identification (mslink, mscatalog.key column, or unique index). For more information, see sections Editing Database Values and RIS Report Writer Reserved Tables.

Operating Sequence 1.

Use the query functions to generate the universe of rows you want to change.

2.

Select Change All. The Change All button appears to be depressed. The screen dialog is in change all mode; any edits you make are added as change criteria.

3.

Select a column field. Key in the value you want to establish for all rows in the current universe. The message Change criteria added appears.

4.

Continue to select column fields and key in new values until all change criteria have been added.

5.

Select Change All again. The SQL Statements dialog appears, displaying the SQL update statement that changes the column values.

C-2

RIS Report Writer Commands

You can save the update statement as an SQL template with the Save SQL command. 6.

Select Process from the SQL Statements dialog to update the values in the universe. — OR — Select Cancel to cancel the change. You can bypass Steps 5 and 6 setting the global variable DBA_NO_CHANGE_ALL_VERIFY. For more information, see the c:\win32app\ingr\risrpt\doc\globals.txt file.

RIS Report Writer Commands C - 3

Change Row (Database Edit)

__________________________________________________________________________________________________________________________________________________

The Change Row command puts the dialog in change row mode, which overrides the key-in mode for key column, add query, and update active fields. Key column, add query, and update active fields can be placed on custom dialogs created with RIS Report Writer. By default, the multiple column field on the Database Edit dialog is in change row mode. To update a value in the current row, select the appropriate column field and key in a new value. The row is automatically updated in the database. You cannot use Change Row to edit a serial column (INFORMIX). You cannot enter duplicate values in a column used for unique row identification (mslink, mscatalog.key column, or unique index). For more information, see sections Editing Database Values and RIS Report Writer Reserved Tables.

Operating Sequence 1.

Select Change Row. The Change Row button appears to be depressed. The screen dialog is in change row mode; any column values you edit are updated in the database.

2.

Select a key column, add query, or update active field. Key in a new value. The message Row changed appears.

3.

Continue to select column fields and key in new values until all changes have been made.

4.

Select Change Row again to exit change row mode.

C-4

RIS Report Writer Commands

Column (Report Builder)

__________________________________________________________________________________________________________________________________________________

The Column (Report Builder) command places a field that retrieves and prints column values from the current universe of rows. Column fields are the most important on the report template, because they retrieve information fields from the database, user data file, or ASCII file. Column fields are usually placed on body lines. Join columns let you use a single table report to report on more than one table. Any two database tables that have columns with common values can be joined. See the section Join Columns. There is no need to use the more complex unrelated table report unless the tables are not related. For example, to report on the manufacturer and sale tables, which do not share a join column, you need an unrelated tables report template. You must place separate body lines for each table in the report.

Dialog Options When you select Column, the DBA Column Field dialog appears.

RIS Report Writer Commands C - 5

The following list describes the options on the menu except for the Print Condition field, which is described in the section Place Field. Schema — This field specifies the schema containing the table for which you want to place a column field. You can key in a new schema name or use the list indicator to select a new schema. Table — This field specifies the table for which you want to place a column field. You can key in a new table name or use the list indicator to select a new table. Column — This field specifies the column from the current table for which you want to place a column field. You can key in a new column name or use the list indicator to select a new column. Join Columns — This button lets you review and edit the join column relationship. The button is inactive until join columns are specified. If you place a column field from a table other than the current table on a single table report, you must specify a join column between the primary (that is, the current) table and the secondary table. See the section Join Columns. Code Text/Number — These radio buttons lets you specify whether the column field displays the code number or code text for a coded column. These radio buttons are inactive until a coded column is specified in the Column field. Length — This field specifies the character length of the column field. Decimal Places — This field specifies the number of decimal places for numeric data.

Operating Sequence 1.

Select Column from the Report Builder menu bar. The DBA Column Field dialog appears.

2.

At the Column field, enter the name of a column from the current table using key-in or the list indicator. Go to Step 5. — OR — At the Schema and/or Table field, enter a new schema and/or table using key-in or the list indicator.

C-6

RIS Report Writer Commands

The DBA Join Columns dialog appears.

3.

At the Column field for the primary table, enter the name of the join column using key-in or the list indicator. Repeat for the secondary table. — Then — Specify whether the join is an outer join. Select OK to return to the DBA Column Field dialog. The DBA Join Columns dialog disappears. The Join Columns button on the DBA Column Field dialog is active. You can optionally specify all table relations in your database through Edit Relations (Utilities - Schema Edit.)

4.

At the Column field on the DBA Column Field dialog, use key-in or the list indicator to enter the name of the column from the secondary table for which you want to place a field.

5.

Set any other parameters as needed. Select OK. The field is dynamically attached to the cursor. The values in the message area can help you position the field on the dialog. RIS Report Writer uses F-1, F-2, and so on to represent the first, second, and any subsequent fields on a line.

6.

Click the left mouse button to place the field. The field is inserted before the current field (if any), with one space separating the two fields. Any fields to the right of the new field will shift to the right. You can realign the fields using the following commands: Move Field Delete Field Undelete Field (Report Builder)

Insert Space (Report Builder) Delete Space

— OR — Select Cancel to end the placement.

RIS Report Writer Commands C - 7

Once you establish a join column between two tables, you can place additional column fields from the secondary table. The DBA Join Columns dialog does not reappear.

C-8

RIS Report Writer Commands

Copy Field

__________________________________________________________________________________________________________________________________________________

The Copy Field command copies a field on a report template one or more times.

Operating Sequence 1.

Select Edit from the Toolbar menu, then select Field and Copy from the pulldown menus. The prompt Select field appears.

2.

Select a field on the current report template. The field is dynamically attached to the cursor. As you move the cursor over the report template, information in the message area changes to reflect the current line, column, line type, table, and field. RIS Report Writer uses F-1, F-2, and so on to represent the first, second, and any subsequent fields on a line.

3.

Click the left mouse button to place the field. RIS Report Writer copies the field to the new position.

— OR — Click the right mouse button to select a different field. Return to Step 2.

RIS Report Writer Commands C - 9

4.

Continue to copy the field to new positions. — OR — Click the right mouse button to select a different field. Return to Step 2. — OR — Click the right mouse button to exit the command.

C - 10

RIS Report Writer Commands

Copy Line

__________________________________________________________________________________________________________________________________________________

The Copy Line command copies a line on a report template one or more times.

Operating Sequence 1.

Select Edit from the Toolbar menu. Select Line and Copy from the pulldown menus. The prompt Select line appears.

2.

Select a line on the current report template. The line is dynamically attached to the cursor. As you move the cursor over the report template, information in the message area changes to reflect the current line, column, table, and field.

3.

Click the left mouse button to place the line. RIS Report Writer copies the line to the new position.

— OR — Click the right mouse button to select a different line. Return to Step 2. 4.

Continue to copy the line to new positions. — OR — Click the right mouse button to select a different line. Return to Step 2.

RIS Report Writer Commands C - 11

— OR — Click the right mouse button to exit the command.

C - 12

RIS Report Writer Commands

Counter (Report Builder)

__________________________________________________________________________________________________________________________________________________

The Counter (Report Builder) command lets you place a field that prints the number of rows that have processed. The fields in any default report under the text field Quantity are counter fields. You can set up counters to count certain types of rows or to give subtotals of the number of rows processed. A counter field on an All Tables line counts the rows for all tables; a counter field on a line for a particular table counts rows for that table only. Counter fields used for subtotals and totals are usually placed on body lines and final lines respectively.

Dialog Options When you select Counter, the DBA Counter Field dialog appears.

The following list describes the options on the menu except for the Print Condition field, which is described in the section Place Field. Length — This field lets you specify the length of the counter field.

RIS Report Writer Commands C - 13

Update Condition — This field lets you specify a condition which must exist for the field to be incremented. If the Update Condition field is blank, the counter field is incremented for every row. Reset Condition — This field lets you specify a condition which must exist for the field to be reset to zero. If the Reset Condition field is blank, the counter field is not reset.

Operating Sequence Place this field using the standard Place Field operating sequence. See the section Place Field for a description of this sequence.

C - 14

RIS Report Writer Commands

Current Row (Database Edit)

__________________________________________________________________________________________________________________________________________________

The gadgets in the Current Row area let you determine which row in the universe is current. Column values for the current row appear in the multiple column field on the Database Edit dialog.

Current Row Slider — Move the slider to scroll through the universe of rows. Previous Row — This (left-facing) arrow makes the previous row current. Select the arrow repeatedly to move backward through the universe a row at a time. Next Row — This (right-facing) arrow makes the next row current. Select the arrow repeatedly to move forward through the universe a row at a time. Pick Row — This field lets you key in the number of a row to make it current.

RIS Report Writer Commands D - 1

Date

__________________________________________________________________________________________________________________________________________________

The Date command places a field that prints the system date (month, date, and year) in a format that you choose. You usually place date fields on a top or preface line.

Dialog Options When you select Date, the DBA Date Field dialog appears.

The following list describes the options on the menu except for the Print Condition field, which is described in the section Place Field. Date Formats — This checklist lets you select the print format for the date field.

D-2

RIS Report Writer Commands

Operating Sequence Place this field using the standard Place Field operating sequence. See the section Place Field for a description of this sequence.

RIS Report Writer Commands D - 3

Define Structure

__________________________________________________________________________________________________________________________________________________

The Define Structure command calls the DBA Structure Definition dialog containing commands for defining data structure templates. Several Intergraph applications and some customers use user data on MicroStation elements and ASCII or binary files to store data. RIS Report Writer requires data structure templates so that reports can be written on this data. Once these templates are defined, reports can be created in the same way that they are for databases. The DBA Structure Definition dialog changes slightly as you choose to define an ASCII, Binary, or user data template. For more information, see sections ASCII Structure, Userdata Structure.

Before Using this Command You must know the structure of the file on which you want to report.

ASCII Structure Selecting a structure type of ASCII from the Structure Definition dialog lets you define a structure template so that RIS Report Writer can report on data in an ASCII file. RIS Report Writer uses the structure template to interpret the ASCII file and format the specified data into a report. The template you create describes a row structure, or table, for the ASCII file and the columns (type, length, and offset) for that table.

D-4

RIS Report Writer Commands

Dialog Options When you select a structure type of ASCII from the DBA Structure Definition dialog, the dialog appears as follows:

Table Number — This field specifies the table number. Table Name — This field specifies the table name. Table Condition — This field specifies a condition that must exist for a row in the ASCII input file to qualify as this table type. This is only necessary if multiple row types exist in the input file. If the field is blank, all rows qualify. The table condition normally compares column values to a constant, for example: c_type == 1

If the type column equals 1, this row qualifies for this table. Tables — This select-only field lists the specified tables. Select a line to make it a marker (highlighted) line. The dialog cannot be in delete or edit mode. (That is, the Delete and Edit buttons are not depressed). New tables can be added and the delete buffer inserted before a marker line.

RIS Report Writer Commands D - 5

Columns — This select-only field lists the columns in the specified tables. Select a line to make it a marker (highlighted) line. The dialog cannot be in delete or edit mode. (That is, the Delete and Edit buttons are not depressed.) New columns can be added and the delete buffer inserted before a marker line. Column Number — This field specifies the column number. Column Name — This field specifies the column name. Column Type — This checklist lets you select the column data type (Floating Point, Integer, or Character). Length — This field specifies the number of characters in the field. Byte Offset — This field specifies where the valid data begins relative to zero. Load — This button loads an ASCII structure from a template library. Save — This button saves an ASCII structure to a template library. Edit — This button places the dialog in edit mode. Select Edit and then select a column from the column list. The attributes for the column appear in the area at the bottom of the dialog. You can edit these attributes. Delete — This button puts the dialog in delete mode; any line, either table or column, you select is deleted and stored in a delete buffer. The delete buffer stores deleted lines until you exit delete mode. Select Delete again to exit delete mode. The delete buffer is cleared whenever you enter delete mode. Add Table — This button adds the table to the table list. Add Column — This button adds a column to the column list. Select Add after you enter information at the bottom of the dialog. The new column is inserted before the marker line in the column list. If no marker line exists, the new column is inserted at the bottom of the list.

Binary Structure Selecting a structure type of Binary from the DBA Structure Definition dialog lets you define a structure template so that RIS Report Writer can report on data in a binary file. RIS Report Writer uses the structure template to interpret the binary file and format the specified data into a report. The template you create describes a row structure, or table, for the binary file and the columns (type, length, and offset) for that table.

D-6

RIS Report Writer Commands

Dialog Options The dialog for binary structure definition contains many of the same features as the ASCII structure definition dialog. See ASCII Structure for information on these features. When you select a structure type of binary from the DBA Structure Definition dialog, the dialog appears as follows:

Table Length — This field lets you manually restrict the columns in the specified table. This number is adjusted as you add and delete columns. Column Type — This checklist lets you select the column data type. The following types are available: Bit Field Character 4-byte Float

8-byte Float 1-byte Integer 2-byte Integer

3-byte Integer 4-byte Integer

Bit Offset — This field specifies where the relevant data begins in bits (for bit fields only). RIS Report Writer supports variable length records in Unrelated Tables reports.

RIS Report Writer Commands D - 7

Userdata Structure Selecting a structure type of Userdata from the DBA Structure Definition dialog lets you define a structure template so that RIS Report Writer can report on user data in a design file. RIS Report Writer uses the structure template to interpret the user data and format it into a report. The template you create describes a user data structure, or table, for the user data design file and the columns (type, length, and offset) for that table. These columns identify the fields carried in the design file. Userdata structures can be delivered with an application product. If not, you can define the structure of the nongraphic data attached to graphic elements using the Define Structure command.

Dialog Options The dialog for binary structure definition contains many of the same features as the ASCII structure definition dialog. See the section ASCII Structure for information on these features. When you select a structure type of Userdata from the DBA Structure Definition dialog, the dialog appears as follows:

D-8

RIS Report Writer Commands

Column Type — This checklist lets you select the column data type. The following types are available: Bit Field Character 4-byte Float

8-byte Float 1-byte Integer 2-byte Integer

3-byte Integer 4-byte Integer

Bit Offset — This field specifies where the relevant data begins in bits (for bit fields only).

RIS Report Writer Commands D - 9

Delete All (Database Edit)

__________________________________________________________________________________________________________________________________________________

The Delete All command deletes all rows in the current universe from the database upon verification.

Operating Sequence 1.

Use the query functions to generate the universe of rows you want to delete.

2.

Select Delete All. The SQL Statements dialog appears, displaying an SQL delete statement that deletes the current universe of rows.

You can save the delete statement as an SQL template with the Save SQL command. 3.

Select Process from the SQL Statements dialog to delete the rows. — OR — Select Cancel to cancel the deletion.

D - 10

RIS Report Writer Commands

Delete Field

__________________________________________________________________________________________________________________________________________________

The Delete Field command deletes a field from a report template. You can also use Delete Field to delete a field of spaces, any number of spaces between two fields. Fields to the right of the cursor position are shifted over to the current cursor position. Use Delete Field with Undelete Field, to align or reposition fields on different lines.

Operating Sequence 1.

Select Edit from the Toolbar menu. Select Field and Delete from the pulldown menus. The prompt Select Field appears. As you move the cursor over the report template, information in the message area changes to reflect the current line, column, table, and field. RIS Report Writer uses F-1, F-2, and so on to represent the first, second, and any subsequent fields on a line.

2.

Select a field on the current report template. The prompt Accept/Reject field appears.

3.

Click the left mouse button to delete the field. RIS Report Writer deletes the field. — OR — Click the right mouse button to reject the deletion.

RIS Report Writer Commands D - 11

When you delete a field in the report template, fields to the right of the deleted field stay in the same position. Click the left mouse button again to delete the field of spaces between the cursor and the next field.

D - 12

RIS Report Writer Commands

Delete Line

__________________________________________________________________________________________________________________________________________________

The Delete Line command deletes a line from a report template.

Operating Sequence 1.

Select Edit on the Toolbar menu. Select Line and Delete from the pulldown menus. The prompt Select Line appears. As you move the cursor over the report template, information in the message area changes to reflect the current line, column, table, and field.

2.

Select a line on the current report template. The prompt Accept/Reject line appears.

3.

Click the left mouse button to delete the line. RIS Report Writer deletes the line. — OR — Click the right mouse button to reject the deletion.

RIS Report Writer Commands D - 13

Delete Row (Database Edit)

__________________________________________________________________________________________________________________________________________________

The Delete Row command deletes the current row from the database. When you select Delete Row, a dialog appears asking you to verify the deletion. Select Yes to delete the current row. Select No to cancel the deletion.

D - 14

RIS Report Writer Commands

Delete Space

__________________________________________________________________________________________________________________________________________________

The Delete Space command lets you delete spaces between fields in a report template. You can use the Delete Field command to delete several spaces at once. For more information, see the section Delete Field.

Operating Sequence 1.

Select Edit from the Toolbar menu. Select Delete space from the pulldown menu.

2.

Place the cursor where you want to delete spaces. Click the left mouse button once for each space. Fields to the right of the cursor are moved left.

3.

Delete spaces from a new location. — OR — Click the right mouse button to exit the command.

RIS Report Writer Commands D - 15

Derived

__________________________________________________________________________________________________________________________________________________

The Derived command lets you place a field that prints the results of a formula. This formula can be a user variable or an equation using specified fields, columns, constants, or variables. Derived fields are usually placed on body lines and display in the report template as a string of Ds.

Dialog Options When you select Derived, the DBA Derived Field dialog appears.

The following list describes the options on the menu except for the Print Condition field, which is described in the section Place Field. Length — This field lets you specify the length of the derived field. Decimal Places — This field specifies the number of decimal places. Formula — This field lets you specify a formula, the result of which prints in the derived field.

D - 16

RIS Report Writer Commands

Operating Sequence Place this field using the standard Place Field operating sequence. See the section Place Field for a description of this sequence.

RIS Report Writer Commands D - 17

Design Options (Report Builder)

__________________________________________________________________________________________________________________________________________________

The Design Options command calls a dialog that lets you save and load parameters commonly used in report design. When you select Design Options, the Design Options dialog appears:

D - 18

RIS Report Writer Commands

Template — Specifies the template library. Description — Specifies a description of the template. Load Options — This button lets you load an existing options template from a specified template library. Save Options — This button lets you save common parameters to an options template. See the section Save Options. Dialog Location — These fields let you specify the x and y origin and height and width of a new blank dialog in pixels. Typeface & Size Sample — Displays an example of the typeface with the current display settings. Typeface — Specifies the default typeface for new gadgets. Size — Specifies the text size in points for new gadgets. Bold — Specifies the display text is boldface. Italic — Specifies the display text is italicized. Load Dialog Cell — This parameter specifies the active dialog cell for the Place Cell command. Either key in a dialog template name or select the Load Dialog Cell button and select one from a template library. Verbose Mode — Controls verbose notification of script errors. — Edit Settings — This button calls the Verbose Error Settings dialog, which lets you select which function types undergo verbose error checking (standard C, DB Access, I/Forms, I/NFM, RIS, or all). — Off/On. This toggle turns verbose error checking mode off or on. Builder Modes — Specifies default verification mode. – No save dialog — Dialogs are always saved by the current name/description. – No save on template change — Disables save check when templates are modified. – Don’t verify template replace — Templates are replaced without the Yes/No dialog. – Don’t verify template delete — Templates are deleted without the Yes/No dialog. – Don’t erase dialog on save — Dialogs are still displayed after saving. Grid Lock — Specifies a grid lock number used in placing gadgets. If you set the grid lock number to 10, gadgets placed by data point are forced to x and y coordinates that are multiples of 10.

RIS Report Writer Commands D - 19

Dump Template

__________________________________________________________________________________________________________________________________________________

Dialog Builder:

Report Builder:

The Dump Template command provides an ASCII dump of a report or dialog template file. The file contains general information about the report or dialog. It also contains specific information about lines and columns. The dump is a debugging tool showing such things as field size and type, sorts, print conditions, and other details associated with a report template. Any errors that RIS Report Writer detects are reported on the Errors Detected dialog when the template is dumped.

D - 20

RIS Report Writer Commands

Dialog Options When you select Dump Template, the Dump Template dialog appears.

Filename — This field specifies the filename for the template dump. You can key in the full or relative pathname. Any file with the same name is overwritten.

RIS Report Writer Commands E - 1

Edit Code (Database Edit)

__________________________________________________________________________________________________________________________________________________

The Edit Code command lets you display, edit, and insert values in a code list. You can also select a code list value for a coded column in the current row. You can use coded columns to limit the values that are valid for a column. A coded column accepts only data that is contained in a code list, a unique set of values stored in a join table. A join table can contain more than one code list. You can create the mscodelist table and the join table needed for coded columns with the RIS Schema Manager. For information on the RIS Schema Manager, see the Relational Interface System (RIS) for Windows NT Utilities User’s Guide. For information on mscodelist, see the section RIS Report Writer Reserved Tables. The process of creating coded columns is greatly simplified in the DB Access Administrator Toolkit product. For information, see the DB Access Administrator’s Guide.

E-2

RIS Report Writer Commands

Coded columns are indicated by a (c) to the left of the column name on the Database Edit dialog. In the following example, the coded column region has been added to the manufacturer table. By default, the code list value generated for slot one is *UNK*, which stands for unknown.

Dialog Options When you select a coded column and Edit Code, the Edit Code dialog appears.

RIS Report Writer Commands E - 3

Code List - n Slot(s) — This text string displays the name of the coded column. n is the number of values contained in the code list. Code List Values — This field lists the code column and text column values for the code list. Add Code Slot — This button lets you add slots to the code list. When you add a code list slot, you add a row in the join table that contains the code list. The code slot number is contained in the code column and the value you enter is contained in the text column. Edit/Select — This toggle lets you place the code list field in edit mode (dark gray) or select mode (light gray). — When the field is in edit mode, you can edit code list values or add new slots. — When the field is in select mode, you can select a code list value to insert in the coded column for the current row.

Before Using this Command You must have created a coded column in a database table, or you must be using an Intergraph application that supports coded columns. The table you add code list values to must have a means of unique row identification (mslink, mscatalog.key_columns, or unique index). For more information, see the section RIS Report Writer Reserved Tables.

Operating Sequence 1.

Select the column field for a coded column.

2.

Select Edit Code. The Edit Code dialog appears, displaying the code list for the coded column. If you have selected a new coded column, the code list contains only the *UNK* value.

3.

Add a new value to the code list. a.

Select Add Code Slot. A new code slot is inserted. The cursor appears in the text field for the new code slot.

b.

Key in the value you want to add to the code list. The code list value is added. The join table is updated to include the new code column and text column values.

E-4

4.

RIS Report Writer Commands

Repeat Step 3 to add other code list entries. — OR — Select Cancel to dismiss the Edit Code dialog.

Deleting Code List Slots To delete slots from a code list, you must delete the associated rows from the join table that contains the code list values. If you insert a row for the join table into the mscatalog table, you can use Database Edit to delete join table rows. Using Database Edit to add code list slots is not recommended. You should use the Edit Code dialog to add code list slots. RIS Report Writer stores code lists in memory. Any changes made to the code list outside of the Edit Code dialog are not recognized until you exit and reinvoke RIS Report Writer or rebuild the code list by calling the script function dba_flush_schema or dba_flush_codelist.

Entering Code List Values for a Row Once you have established a code list for a coded column, you can use the code list values to edit rows in the attached database. You can enter code-list values in the following ways: 1.

Select a coded column in the current row and key in: #n#

where n is the code slot number. The corresponding text value is entered for the column. 2.

Select the coded column and key in a valid text column value.

RIS Report Writer Commands E - 5

3.

Select the coded column and select Edit Code. Set the Edit/Select toggle to Select. Select a value from the Edit Code dialog. The code list value is added to the current row.

E-6

RIS Report Writer Commands

Edit Field

__________________________________________________________________________________________________________________________________________________

The Edit Field command lets you edit parameters associated with a field on a report template. The type of field you select determines which parameters can be edited. To save changes made to the field, you must save the template. See the section Save Report. When you select Edit Field and a field, the dialog used to place that field appears. For example, if you select a text field, the Text Field dialog appears.

Operating Sequence 1.

Select Edit from the Toolbar menu. Select Field and Edit from the pulldown menus. The prompt Select Field appears.

2.

Select the field you want to edit. The dialog used to place the field appears.

3.

Edit any available parameters you want to change.

4.

Select OK. The field is updated in the report template. — OR — Select Cancel to end the edit.

RIS Report Writer Commands E - 7

Edit Line

__________________________________________________________________________________________________________________________________________________

The Edit Line command lets you edit the parameters for lines in a report template. You can modify line type, print conditions, table information, and other parameters. To save changes made to a line, you must save the template. See the section Save Report.

Dialog Options When you select Edit Line and a line, the Edit Line dialog appears.

Single table/All tables — These radio buttons specify whether the line is processed against a specific (single) table or against all tables in the attached database. Select All tables for common lines (such as page headings) in an unrelated tables report. Select Single table for all other report lines.

E-8

RIS Report Writer Commands

You cannot place column or numeric fields on All table lines. Schema — This field specifies the schema which contains the table associated with the line. You can key in a new schema name or use the list indicator to select a new schema. This field is labeled Structure for userdata and ASCII reports. Table — This field specifies the table associated with the line. You can key in a new table name or use the list indicator to select a new table. The Schema and Table fields are active only if the Single table setting is selected. Line Type — This checklist specifies the current line type. — Preface — These lines print once at the beginning of a report. After all preface lines are printed, the report continues on a new page. You can use preface lines to print a cover sheet, title page, or legend. — Top — These lines print once at the top of every page. Page headings, column headings, date, time, and page number are included in the top lines of default reports created with the Load Default command. — Body — These lines print once for every row in the input universe. They usually contain column fields. — Bottom — These lines print once at the bottom of every page. Page numbers or footnotes can be printed with bottom lines. — Final — These lines print once at the end of the report. You can use final lines to print report summaries or report totals. Blank Lines Before — This field specifies the number of blank lines that print before the line. Blank Lines After — This field specifies the number of blank lines that print after the line. Print Condition — This field lets you specify a condition which must exist for the line to print. If Print Condition is blank, the line is always printed.

Operating Sequence 1.

Select Edit from the Toolbar menu. Select Line and Edit from the pulldown menus. The prompt Select Line appears.

RIS Report Writer Commands E - 9

2.

Select the line you want to edit. The Edit Line dialog appears, displaying the values for the selected line.

3.

Edit any available parameters you want to change.

4.

Select OK. The line is updated in the report template. — OR — Select Cancel to end the edit.

E - 10

RIS Report Writer Commands

Edit Query (Database Edit)

__________________________________________________________________________________________________________________________________________________

The Edit Query command lets you review, edit, or save the current query criteria, or load a query template from a template library.

Dialog Options When you select Edit Query, the Edit Query dialog appears.

Schema — This field specifies the schema containing the table for which the query is created. You can key in a new schema name or use the list indicator to select a new schema. Table — This field specifies the table to be searched for column values matching the query criteria. You can key in a new table name or use the list indicator to select a new table. Query — This key-in field displays the current query (if any). You can edit the query or key in a new query. Load Query — This button calls the Load From Library dialog, which lets you load a query criteria template. For more information, see the section Load From Library (Report Builder). Save Query — This button calls the Save Template dialog, which lets you save a query criteria template. For a description of this dialog, see the section Save Options.

RIS Report Writer Commands E - 11

Edit Report Parameters

__________________________________________________________________________________________________________________________________________________

The Edit Report Parameters command lets you modify certain parameters for the current report template.

Dialog Options When you select Edit Report Parameters, the Edit Report Parameters dialog appears.

Single table/Unrelated tables — This toggle lets you specify whether the report is a single table or an unrelated tables report.

E - 12

RIS Report Writer Commands

— Select Single table to specify a table that is the only table reported on or that is the primary table in a join columns operation. — Select Unrelated tables when you want to report on tables that do not share a join column. The Schema and Table fields are active only if the Single table setting is selected. Schema — This field specifies the schema which contains the table associated with the report. You can key in a new schema name or use the list indicator to select a new schema. This field is labeled Structure for user data and ASCII reports. Table — This field specifies the table associated with the report. You can key in a new table name or use the list indicator to select a new table. Type — This checklist specifies the current template type (Database, Userdata, ASCII, or Binary). Name — This field specifies the current report template name. To rename the template, key in a maximum of 20 characters with no embedded spaces. Description — This field specifies a description of the template. To change the description, key in up to 50 characters. Output — This field displays the default output filename. Key in up to 50 characters to name a different output file. If the output filename is stdout, no file is created. The report output is sent to the RIS Report Writer standard output device which, by default, is the invoking window. Characters Per Line — This field displays the page width. Key in a number from 1 to 2000. You can edit templates that are wider than the screen by using the Shift Left and Shift Right arrows at the bottom of the Report Builder dialog.

Lines Per Page — This field specifies when page breaks occur. Key in a number from 0 to 999. (0 creates a file without page breaks.) Relations — This field specifies a Relations Template to be associated with this dialog, to satisfy secondary table column fields. For more information, see Edit Relations. It is not possible to switch from Report Scripting to User Action. Report Scripting is the recommended interpreter.

RIS Report Writer Commands E - 13

Exit

__________________________________________________________________________________________________________________________________________________

The Exit command is available in several places in RIS Report Writer.

To Exit the Report Builder

Select Exit from the Report Builder menu bar. If you have modified the current report template, the Save Report dialog is called, which lets you write the current report template before loading another from the template library. See the section Save Report for information on using this dialog. You are returned to the Program Manager Window.

E - 14

RIS Report Writer Commands

RIS Report Writer Commands F - 1

Field Format (Report Builder)

__________________________________________________________________________________________________________________________________________________

The Field Format command lets you associate a format with a field in a report template. The format modifies the field as it is printed out to the report. You must save the report template to save the field formats you have established.

Dialog Options When you select Field Format and select the field to format, the DBA Special Field Formats dialog for that field appears.

F-2

RIS Report Writer Commands

Convert to Feet - Inches — This option converts a numeric field to feet and inches format. The initial field is assumed to be in inches. For example, if a wall length is stored in a database as 136.75 inches, the formatted field prints the report output as 11’-4 3/4". If a field is not stored as inches in the input data, it is usually easier to convert it to inches (by way of a derived field) and then use the field format rather than convert it to a feet-inches format. Convert to Fraction — This option converts a floating point field to a fraction. For example, a 136.75 inch wall length is printed as 136 3/4. Fractions are rounded to the nearest 1/8th. Variable Start — This option prints the field in the column represented by an integer user variable. Select this format to stagger the start of report fields according to a predetermined value or condition. — User Variable. This field lets you specify the user variable that contains the integer value. Suppress — This option suppresses the number of blanks between two fields. Select Suppress for the second of two fields to define the number of blanks between the end of the data in the first field and the start of the second field. Select this option for fields that should print with only one or two blanks between them, regardless of the length of their text. For example: Last_name, First_name

or

City, State Zip_Code

You can also use Suppress to create a free format file to be used as input for another process. — Blanks. This field lets you specify the number of blanks inserted before the field. Zero Fill — This option replaces leading blanks in a numeric field with zeros. By default, RIS Report Writer does not print leading zeros in a numeric field. Auto Wrap — This option automatically wraps lengthy text in a field to a second line in the report output. You must specify a field length on the report template that is shorter than the length of the associated column. The text is broken at the last blank before the specified field length. Justification Format — This checklist lets you specify how the field is aligned. Select Right Justify, Center Justify, or Left Justify.

RIS Report Writer Commands F - 3

Fields On/Off (Database Edit)

__________________________________________________________________________________________________________________________________________________

The Fields On/Off command toggles all column fields off or on. You can turn an individual field on or off by selecting the field’s corresponding column name (for example, part_num, mfr_name, and so on). By default, all column fields on the Database Edit dialog are on (the field is dark gray). Off fields (light gray) are not included in universe reviews.

F-4

RIS Report Writer Commands

Field Operations (Report Builder)

__________________________________________________________________________________________________________________________________________________

The Field Operations (Report Builder) command calls the following panel:

The Field Operations (Report Builder) command contains the edit, copy, move, delete, and undelete functions on the pulldown menu to field commands from line commands. 1.

Select Edit from the Toolbar menu. Select Field from the pulldown menu.

2.

Select the command that you want to execute.

RIS Report Writer Commands I - 1

Initialize Query (Database Edit)

__________________________________________________________________________________________________________________________________________________

The Initialize Query command clears the current query criteria. If you select Initialize Query and then Process Query, a universe of all rows in the current table is generated.

I-2

RIS Report Writer Commands

Insert Row (Database Edit)

__________________________________________________________________________________________________________________________________________________

The Insert Row command inserts a new row in the attached database. The new row contains the column values currently displayed. If there are no restrictions on duplicate column values in the database, you can use Insert Row to create a row that contains the same values as the current row. Only the mslink value (if the column exists) is changed. RIS Report Writer automatically increments the mslink value for each new row in the database. Insert Row cannot create a new row if: 1.

A column is a serial column (INFORMIX), a key column (defined in mscatalog), or defines a unique index — AND —

2.

The column value for the new row is not unique.

The Update Active command lets you change currently displayed values for the row to be inserted without changing the corresponding value for the current row. For more information, see the section Update Active (Database Edit).

RIS Report Writer Commands I - 3

Insert Space (Report Builder)

__________________________________________________________________________________________________________________________________________________

The Insert Space (Report Builder) command lets you insert spaces between fields in a report template. All fields to the right of the cursor are moved to the right. You can use the Delete Field and Undelete Field commands to align fields on several lines. For more information, see these sections Delete Field and Undelete Field (Report Builder).

Operating Sequence 1.

Select Edit from the Toolbar menu and then select Insert space from the pulldown menu.

2.

Place the cursor where you want to insert spaces. Click the left mouse button once for each space. Fields to the right of the cursor are moved right.

3.

Insert spaces in a new location. — OR — Click the right mouse button to exit the command.

I-4

RIS Report Writer Commands

RIS Report Writer Commands K - 1

Key Column (Database Edit)

__________________________________________________________________________________________________________________________________________________

The Key Column command lets you perform a quick search on the database. If you key in a value for a column field, RIS Report Writer searches the database and retrieves the first row that has the same value for the column. This command provides the same functionality as an Initialize Query, Add Query, and Process Query sequence.

K-2

RIS Report Writer Commands

RIS Report Writer Commands L - 1

Line Operations (Report Builder)

__________________________________________________________________________________________________________________________________________________

The Line Operations (Report Builder) command calls the following panels:

The Line Operations (Report Builder) command contains edit, copy, move, delete, and undelete functions on the pulldown menu to line commands from field commands.

Operating Sequence 1.

Select Line Operations (Report Builder) from the Dialog Builder menu bar.

2.

Select the command that you want to execute.

L-2

RIS Report Writer Commands

Line Script

__________________________________________________________________________________________________________________________________________________

The Line Script command lets you write more complex statements for a report template to process. Line scripts can perform looping, if-else-if structures, paging, multiple calculations, and other report control functions. You can define scripts to process before or after a line in a report template is printed. If the line is not printed, the after line script does not process. Scripts can also be processed before or after a sort of the input data. Line Script does not require a function name or opening and closing braces. A line script cannot include a preprocessor directive, such as #include or #define, because Report Scripting treats each line script as one long line of C code.

RIS Report Writer Commands L - 3

Dialog Options When you select Line Script, the Line Script dialog appears.

Before Line Processing — This field lets you specify line scripts to process before the line is printed. If you select a line with an existing before line script, the script appears in this field. Select the Clear button to clear the field. After Line Processing — This field lets you specify line scripts to process after the line is printed. If you select a line with an existing after line script, the script appears in this field. Select the Clear button to clear the field. If the line is not printed, the after line script does not process. When the Line Script dialog appears, these fields are in edit mode. Select a field to key in a script or edit an existing one. Editor — This button lets you use a specified editor to edit the text in the last active field. You can specify an editor with the EDITOR environment variable. If EDITOR is not defined, notepad is the default editor. — The name of the current editor appears in the field to the right of the Editor button. To change editors, key in the name of the new editor.

L-4

RIS Report Writer Commands

Before Using this Command The Line Script command appears on the Report Builder panel dialog if the Interpreter toggle on the Edit Report Parameters dialog is set to Report Scripting. You must define user variables before using them in line scripts.

RIS Report Writer Commands L - 5

Load From Library (Report Builder)

__________________________________________________________________________________________________________________________________________________

The Load From Library command calls the DBA Load From Library dialog, which lists the templates found in the current template library. For information about the types of templates that can be loaded from a template library, see the section Templates.

Dialog Options When you select Load From Library, the Load From Library dialog appears.

Library — This field displays the name of the current template library. To change the name, select the field, clear the field, and key in a new name. Template — This field displays the name of the current template. To change the name, select the field, clear the field, and key in a new name. Type — This field displays the type of template. To change the type, select the field, and either key in a new type or select one from the list.

L-6

RIS Report Writer Commands

Load — This button places the dialog in Load Template mode. Select this button if you want to load a template from the current library. To leave Load Template mode, select Load again or select one of the other buttons on the dialog. Delete — This button places the dialog in Delete Template mode. Select this button if you want to delete a template from the current library. To leave Delete Template mode, select Delete again or select one of the other buttons on the dialog. Compress — This button compresses the contents of the current template library to recover space from deleted or replaced templates. Name, Description, Type — This field lists the name, description, and type of the templates in the template library. You can select a template to be loaded or deleted from this list. Most Recent — This field lists the most recently used templates in the template library. When a template is used it becomes the first in the list. The list is cleared after each log-in. You can select templates from this field.

Operating Sequence 1.

Select Load From Library from the Report Builder menu bar. If you have modified the current dialog, the Save Report dialog is called, which lets you to write the current report template before loading another from the template library. See the section Save Report for information on using this dialog. The Load From Library dialog appears, displaying a list of the report templates in the current library. Three types of report templates are listed: Database, ASCII, and Userdata. If you have not previously attached a template library, the Library field is blank and no templates are listed. Attach a template library by selecting the Library field and keying in the path to a valid template library file.

2.

The Load function button should appear to be depressed, indicating that the dialog is in Load Template mode. Select a template from the displayed list. The specified template appears. — OR — Select Delete to enter Delete Template mode. a.

Select a template from the displayed list.

RIS Report Writer Commands L - 7

A dialog requesting confirmation of the deletion appears. b.

You have two options: – Select Yes to delete the template. The template is deleted from the library. – Select No to abort the deletion.

— OR — Select Compress to compress the contents of the current template library. 3.

To exit the Load Template or Delete Template mode, select the function button again or select a different button.

L-8

RIS Report Writer Commands

RIS Report Writer Commands M - 1

Modify Sort

__________________________________________________________________________________________________________________________________________________

The Modify Sort command lets you modify the sort keys for a report template. Sort keys define the order in which input rows from the database are processed and output through a report template. A sort key can be a text string, a column in a table, or a field derived from a calculation. You must save the report template to save the sort keys you define.

If you select the Line Script command while the Modify Sort dialog is displayed, you can specify scripts or user action statements, respectively, to process before or after input data is sorted. The Sort Script dialog functions the same as the Line Script dialog. See the section Line Script.

M-2

RIS Report Writer Commands

Dialog Options When you select Modify Sort, the DBA Modify Sort dialog appears.

Schema — This field specifies the schema containing the table in an unrelated tables report for which you want to define a sort key. You can key in a new schema name or use the list indicator to select a new schema. Table — This field specifies the table in an unrelated tables report for which you want to define a sort key. You can key in a new table name or use the list indicator to select a new table. The Schema and Table fields are active only when you load an unrelated tables report template. Sort, Order, Sort Value, New Page — This select-only field lists the sort keys for the current report. Select a line to make it a marker (highlighted) line. The field cannot be in delete or edit mode. (That is, the Delete and Edit buttons are not depressed.) New sort keys can be added and the delete buffer inserted before a marker line. Add — This button adds a sort key to the sort key list. Select Add after you enter information in the area at the bottom of the dialog. The new sort key is inserted before the marker line in the sort key list. If no marker line exists, the new sort key is inserted at the bottom of the list.

RIS Report Writer Commands M - 3

Edit — This button places the dialog in edit mode. Select Edit and then select a sort key from the sort key list. The values for the sort key appear in the area at the bottom of the dialog. You can edit these values. Delete — This button puts the dialog in delete mode; any line you select is deleted and stored in a delete buffer. The delete buffer stores deleted lines until you exit delete mode. Select Delete again to exit delete mode. The delete buffer is cleared whenever you enter delete mode. Undelete — This button inserts the current delete buffer before the marker line in the sort key list. If no marker line exists, the delete buffer is inserted at the bottom of the list. Clear Select — This button clears the currently selected sort key, so that newly added sort keys go to the bottom of the list. Otherwise, new sort keys are placed before the current sort key. Sort Type — This checklist lets you select the type of sort. — Text — This option sorts the input rows by a text string you key in. You can use text sort keys with unrelated tables reports to specify which table’s data should be sorted first. For the table containing the rows to sort first, specify a string which alphabetically precedes the string for the table containing the rows to sort second. For example, for the unrelated tables Table A and Table B, make sort key 1 a text sort for both tables. To sort the Table A rows first, key in the text string 1 for Table A and 2 for Table B. – Text — This field lets you specify the text string for a text sort. — Column — This option sorts rows according to the values for a specified column in the database. – Schema — This field specifies the schema containing the column by which you want to sort. You can key in a new schema name or use the list indicator to select a new schema. – Table — This field specifies the table containing the column by which you want to sort. You can key in a new table name or use the list indicator to select a new table. – Column — This field specifies the column containing the values by which you want to sort. You can key in a new column name or use the list indicator to select a new column. – Join Columns — This button lets you review and edit the join column relationship. The button is inactive until join columns are specified. If you define sort keys for columns from more than one table on a single table report, you must specify a join column between the primary table and the secondary table. See the section Join Columns.

M-4

RIS Report Writer Commands

– Code Text/Number — This toggle lets you specify whether a coded column sort is by the code_number or code_text. This toggle is inactive until a coded column is specified in the Column field. — Derived — This option sorts input data according to the result of a formula. You can sort input rows based on a calculated value that is not represented by a column in the database. – Formula — This field lets you specify a formula, which can include columns, constants, and user variables. Because it is not tied to a line in the report template, a derived sort key cannot reference fields (f_1, f_2, and so on). Length — This field specifies the number of characters used in the sort key. If the length were set to 2, the values ABCD and ABZZZZ would be equivalent during the sort. Sort Order — This checklist lets you select the order in which rows are sorted. — Ascending — This option orders rows in alphabetical or numerical order: A,A,B,C,C,D or 1,1,2,2,3. — Descending — This option orders rows in reverse alphabetical or numerical order: D,C,C,B,A,A or 3,2,2,1,1. — None — This option does not sort the rows. However, sort breaks (system variables that indicate when a sort value changes) can still be used. New Page — This checklist lets you select whether a page break is inserted into the report when the value of the sort key changes.

RIS Report Writer Commands M - 5

Move Field

__________________________________________________________________________________________________________________________________________________

The Move Field command moves a field on a report template.

Operating Sequence 1.

Select Edit from the Toolbar menu. Select Field and then Move from the pulldown menus. The prompt Select field appears.

2.

Select a field on the report template. The field is dynamically attached to the cursor. The prompt Select placement point appears.

3.

Move the field to a new location on the report template. As you move the cursor over the report template, information in the message area changes to reflect the current line, column, table, and field. RIS Report Writer uses F-1, F-2, and so on to represent the first, second, and any subsequent fields on a line.

4.

Click the left mouse button to place the field. RIS Report Writer moves the field to the new position.

5.

Move the field to another position. — OR —

M-6

RIS Report Writer Commands

Click the right mouse button to select a different field. Return to Step 2. — OR — Click the right mouse button to exit the command.

RIS Report Writer Commands M - 7

Move Line

__________________________________________________________________________________________________________________________________________________

The Move Line command moves a line on a report template.

Operating Sequence 1.

Select Edit from the Toolbar menu. Select Line and then Move from the pulldown menus. The prompt Select line appears.

2.

Select a line on the report template. The line is dynamically attached to the cursor. The prompt Select placement point appears.

3.

Move the line to a new location on the report template. As you move the cursor over the report template, information in the message area changes to reflect the current line, column, table, and field.

4.

Click the left mouse button to place the line. RIS Report Writer moves the line to the new position.

5.

Return to Step 3 to move the line to another position. — OR — Click the right mouse button to select a different line. Return to Step 2. — OR — Click the right mouse button to exit the command.

M-8

RIS Report Writer Commands

RIS Report Writer Commands N - 1

New Blank (Report Builder)

__________________________________________________________________________________________________________________________________________________

The New Blank (Report Builder) command loads a blank report template for a table you select. Or you can select Unrelated Tables to load a blank template that lets you report on tables that have no relationship. A blank template lets you start from scratch, using the commands on the menu bar to design a template with the features and functionality you need.

Dialog Options When you select New Blank (Report Builder), the DBA Load Report dialog appears.

Schema — This field displays the name of the current schema. Key in a schema name or select a schema using the display list box. Table — This field displays the name of the current table. Key in a table name or select a table from the following table list.

N-2

RIS Report Writer Commands

Table List — Below the Table field is a field listing the available tables. You can select a table from this list. Unrelated Tables — This button lets you create a template that reports on tables that have no relationship.

Operating Sequence 1.

Select Load Blank from the Report Builder menu bar. If you have modified the current report template, the Save Report dialog is called, which lets you write the current template before loading a blank template. The Select Table dialog appears.

2.

Select the table for which you want to generate a blank report template. Select OK. — OR — Select Unrelated Tables to load a blank report template for unrelated tables. A blank report template is loaded.

3.

Use the commands on the menu bar to build the template. Select Save Report to save the report template.

RIS Report Writer Commands N - 3

New Default (Report Builder)

__________________________________________________________________________________________________________________________________________________

The New Default (Report Builder) command reads the structure of the attached database and generates a default report template for the table you select. A default report template contains page headers, lines displaying columns for the input data, subtotals and totals for numeric fields, and a sort key. Default reports can provide a quick listing of the database table contents or can provide a starting point for creating customized reports. Default templates do not support unrelated table reports. See the section Blank Reports for information on unrelated table reports.

Dialog Options When you select New Default (Report Builder), the DBA Load Report dialog appears.

Schema — This field displays the name of the current schema. Key in a schema name or select a schema using the display list box.

N-4

RIS Report Writer Commands

Table — This field displays the name of the current table. Key in a table name or select a table from the following table list. Table List — Below the Table field is a field listing the available tables. You can select a table from this list. Select Columns — This button calls the DBA Select Columns dialog, which is described in the following section.

Select Columns Menu Options Table — This field displays the name of the current table. To change the table, key in a table name or select a table using the display list box. Column List — Below the Table field is a field listing the columns in the current table. You can select columns from this list to be included or excluded from the report template, depending on the Select All Columns/Select No Columns toggle. Select All Columns/Select No Columns — This toggle lets you exclude or include selected columns from the report template. Set the toggle to Select All Columns to select columns to be excluded. Set the toggle to Select No Columns to select columns to be included. Columns are ordered across the page in the order you select them.

Operating Sequence 1.

Select Load Default from the Report Builder menu bar. If you have modified the current report template, the Save Report dialog is called, which lets you write the current report template before loading a default report template. See the section Save Report for information on using this dialog. The Select Table dialog appears.

2.

Select or key in the table for which you want to generate a default report template. Select OK. The specified template appears. — OR — Select Select Columns to choose which columns are displayed on the template.

RIS Report Writer Commands N - 5

The Select Columns dialog appears. Set the Select All Columns/Select No Columns toggle and select the columns to be excluded/included. Select OK. The specified template appears. 3.

Process the template as it appears. — OR — Use the commands on the menu bar to change the report template. There are three ways to display columns that do not fit on the default template:

4.

a.

Delete unwanted fields, which moves fields over from the right margin. See the section Delete Field.

b.

Increase the Columns Per Page of the template. See the section Edit Report Parameters.

c.

Use the Place Line and Place Field functions to add lines with additional fields. See the sections Place Line and Place Field.

Select Save Report to save the template to the template library.

N-6

RIS Report Writer Commands

Numeric

__________________________________________________________________________________________________________________________________________________

The Numeric command lets you place a field that performs a specified calculation for the numeric values in a column. A numeric field can calculate integer or floating point column values. You can specify update and reset conditions, as well as calculate subtotals. Numeric fields used for subtotals and totals are usually placed on body lines and final lines respectively. Numeric fields are not allowed on All Table lines. Join columns let you use a single table report to report on more than one table. Any two database tables that have columns with common values can be joined. See the section Join Columns.

RIS Report Writer Commands N - 7

Dialog Options When you select Numeric, the Numeric Field dialog appears.

The following list describes the options on the menu except for the Print Condition field, which is described in the section Place Field. Calculation — This checklist lets you select the type of calculation that will be performed. — Total —Sums the column’s values. — Average — Averages the column’s values. — Minimum — Prints the minimum value for the column. — Maximum — Prints the maximum value for the column. — Percentage — Prints the percentage of the total of the column. Schema — This field specifies the schema containing the table for which you want to place a numeric field. You can key in a new schema name or use the list indicator to select a new schema. Table — This field specifies the table for which you want to place a numeric field. You can key in a new table name or use the list indicator to select a new table. Column — This field specifies the column from the current table for which you want to place a numeric field. You can key in a new column name or use the list indicator to select a new column.

N-8

RIS Report Writer Commands

Join Columns — This button lets you review and edit the join column relationship. The button is inactive until join columns are specified. If you place a numeric field from a table other than the current table on a single table report, you must specify a join column between the primary (that is, the current) table and the secondary table. See the section Join Columns. Length — This field specifies the length of the numeric field. Decimal Places — This field specifies the number of decimal places for floating point data. Update Condition — This field lets you specify a condition which must exist for the field to be incremented. If the Update Condition field is blank, the numeric field is incremented for every row. Reset Condition — This field lets you specify a condition which must exist for the field to be reset to zero. If the Reset Condition field is blank, the numeric field is not reset.

Operating Sequence 1.

Select Numeric from the Report Builder menu bar. The Numeric Field dialog appears.

2.

At the Column field, enter the name of a column from the current table using key-in or the list indicator. Go to Step 5. — OR — At the Schema or Table field, enter a new schema or table using key-in or the list indicator. The Join Columns dialog appears.

3.

At the Column field for the primary table, enter the name of the join column using key-in or the list indicator. Repeat for the secondary table. — Then — Specify whether the join is an outer join. Select OK to return to the Numeric Field dialog.

RIS Report Writer Commands N - 9

The Join Columns dialog disappears. The Join Columns button on the Numeric Field dialog is active. 4.

At the Column field on the Numeric Field dialog, use key-in or the list indicator to enter the name of the column from the secondary table for which you want to place a field.

5.

Set any other parameters as needed. Select OK. The field is dynamically attached to the cursor. The values in the message area can help you position the field on the dialog. RIS Report Writer uses F-1, F-2, and so on to represent the first, second, and any subsequent fields on a line.

6.

Click the middle mouse button to place the field. The field is inserted before the current field (if any), with one space separating the two fields. Any fields to the right of the new field may shift to the right. You can realign the fields using the following commands: Copy Field Delete Field Undelete Field (Report Builder)

Insert Space (Report Builder) Delete Space

— OR — Select Cancel to end the placement. Once you establish a join column between two tables, you can place additional numeric fields from the secondary table. The Join Columns dialog does not reappear.

N - 10

RIS Report Writer Commands

RIS Report Writer Commands P - 1

Page

__________________________________________________________________________________________________________________________________________________

The Page command places a field that prints the report page number. You usually place page fields on a top or bottom line.

Dialog Options When you select Page, the DBA Page Field dialog appears.

The following list describes the options on the menu except for the Print Condition field, which is described in the section Place Field. Length — This field lets you specify the length of the page field. Current page/Total pages — These radio buttons let you specify the page number to print out in the page field. If you choose Current Page, the current page of your report prints in the page field of each page. If you choose Total Pages, the total number of pages in the report prints in the page field of each page.

P-2

RIS Report Writer Commands

Operating Sequence Place this field using the standard Place Field operating sequence. See the section Place Field for a description of this sequence.

RIS Report Writer Commands P - 3

Place Field (Report Builder)

__________________________________________________________________________________________________________________________________________________

The Place Field command calls a submenu of commands that place fields on a report template. A field must be placed on a line. If you load a blank template, you must place a line before placing any fields.

Text — This button places a field that prints a literal text string you assign. Text fields are used to print text that remains the same in a report: titles, column headers, and so forth. See the section Text (Report Builder). Column — This button places a field that prints column values from rows in the current universe. You can place column fields from more than one table on a template. See the section Column. Date — This button places a field that prints the current date. See the section Date. Time — This button places a field that prints the current time. See the section Time. Page — This button places a field that prints the current page number for the report. See the section Page. Counter — This button places a field that keeps track of how many rows from the input universe have processed. See the section Counter. Numeric — This button places a field that calculates a running total for a numeric column value. See the section Numeric. Derived — This button places a field that prints the results of calculations or the contents of a variable that has been assigned in a script or user action statement. See the section Derived.

P-4

RIS Report Writer Commands

Print Condition Option All Place Field dialogs have a Print Condition field, which lets you specify a condition which must exist for the field to print. If the Print Condition field is blank, the associated report template field always prints.

Standard Operating Sequence The following sequence is common to most of the Place Field commands. Any exceptions are discussed in the individual command descriptions. 1.

Select Place Field from the Report Builder menu bar. The Place Field dialog appears.

2.

Select the button for the type of field you want to place. The dialog for the specified field appears.

3.

Edit the available parameters or accept the default parameters. Select OK. The field is dynamically attached to the cursor. The values in the message area can help you position the field on the dialog. RIS Report Writer uses F-1, F-2, and so on to represent the first, second, and any subsequent fields on a line.

4.

Click the middle mouse button to place the field. The field is inserted before the current field (if any), with one space separating the two fields. Any fields to the right of the new field may shift to the right. You can realign the fields using the following commands: Copy Field Delete Field Undelete Field (Report Builder)

Insert Space (Report Builder) Delete Space

— OR — Select Cancel to end the placement.

RIS Report Writer Commands P - 5

Place Line

__________________________________________________________________________________________________________________________________________________

The Place Line command calls the Edit Line menu, which lets you place blank report lines. You must place lines on a report template before placing fields.

Dialog Options When you select Place Line, the DBA Edit Line dialog appears.

Single table/All tables — These radio buttons specify whether the line is processed against a specific (single) table or against all tables in the attached database. Select All tables for common lines (such as page headings) in an unrelated tables report. Select Single table for all other report lines. You cannot place column or numeric fields on All table lines.

P-6

RIS Report Writer Commands

Schema — This field specifies the schema which contains the table associated with the line. You can key in a new schema name or use the list indicator to select a new schema. This field is labeled Structure for userdata and ASCII reports. Table — This field specifies the table associated with the line. You can key in a new table name or use the list indicator to select a new table. The Schema and Table fields are active only if the Single table setting is selected. Line Type — This checklist specifies the current line type. — Preface — These lines print once at the beginning of a report. After all preface lines are printed, the report continues on a new page. You can use preface lines to print a cover sheet, title page, or legend. — Top — These lines print once at the top of every page. Page headings, column headings, date, time, and page number are included in the top lines of default reports created with the Load Default command. — Body — These lines print once for every row in the input universe. They usually contain column fields. — Bottom — These lines print once at the bottom of every page. Page numbers or footnotes can be printed with bottom lines. — Final — These lines print once at the end of the report. You can use final lines to print report summaries or report totals. Blank Lines Before — This field specifies the number of blank lines that print before the line. Blank Lines After — This field specifies the number of blank lines that print after the line. Print Condition — This field lets you specify a condition which must exist for the line to print. If Print Condition is blank, the line is always printed.

Operating Sequence 1.

Select Placement from the Toolbar menu and then select Line from the pulldown menu. The Edit Line dialog appears.

2.

Edit the available parameters or accept the default parameters. Select OK.

RIS Report Writer Commands P - 7

The line is dynamically attached to the cursor. The values in the message area can help you position the blank line on the template. 3.

Click the left mouse button to place the line. The line is inserted before the current line (if any). — OR — Select Cancel to end the placement.

P-8

RIS Report Writer Commands

Process Query (Database Edit)

__________________________________________________________________________________________________________________________________________________

The Process Query command returns all rows in the current table that meet the query criteria. The set of rows that meets the query criteria is called a universe of rows. If no query criteria exist, the universe contains all rows for the current table.

RIS Report Writer Commands P - 9

Process Report

__________________________________________________________________________________________________________________________________________________

The Process Report command processes templates created in the Report Builder. You can send report output to a file or review it on the screen. To generate the input universe of rows for the report, you can use an SQL select statement or a saved query criteria. You can access the Process Report command from the menu bar, from Database Edit, or from the Report Builder menu bar. The Process button calls the Process Reports dialog. Output File — This field specifies the output filename for the report generated when you process the report template. If you do not specify a full pathname for the file, it is written to your working directory (from which you invoked RIS Report Writer). If the output filename is stdout, no file is created. The report output is sent to the RIS Report Writer standard output device which, by default, is the invoking window. Element List/Input File — This field specifies an element list or input file to use as input to a report template. Load Report — This button calls the Load From Library dialog, which lets you load a report template from a specified template library. For more information, see the section Load From Library (Report Builder). Edit Query — This button calls the Edit Query dialog, which lets you load a query criteria template. The query criteria is used to generate an input universe of rows for the report. For unrelated table reports, you can load a query criteria template for each table. You can also edit the current query criteria. For more information, see the section Edit Query (Database Edit). Process — This button processes the input universe of rows against the current report template to generate the report to the specified output file. List Output — This button calls a report output dialog, which is described in the following section, Report Output Dialog Options. Report Tables — The fields just below the Element List/Input File field list the tables that the current report template reports on. If the report is an unrelated tables report, more than one table is listed. You can control the input universe for each table independently. A single table report template lists only one (primary) table. Processing Options — This field lets you select the method for generating the input universe for the report.

P - 10

RIS Report Writer Commands

— All — This option includes all rows for the specified table as input for the report template. — Query — This option includes rows that meet the specified query criteria to generate the input universe for the report template. If you load a query criteria template but do not select Query, the query criteria is not used. — Element List/Input File — This option uses an element list/ASCII file as input to a user data/ASCII structure template. You must identify the file in the Element List/Input File field. — Exclude — This option excludes the table as input to the report template. Select this option only with unrelated table reports when you want to report on some, but not all, of the tables.

Report Output Dialog Options When you select List Output, a report output dialog appears.

Report Listing — This field displays the report. Read More — This button displays the next page of a multipage report. Read To EOF — This button scrolls to the end of the report.

RIS Report Writer Commands P - 11

Text Size — This button calls the Text Size dialog, which lets you change the size of the text display on the report output dialog. Use the slider to change the text size. Print — This button displays the standard print dialog, so that report output can be printed. RIS Report Writer Environment Variables

From Database Edit When you select Report, the Process Reports dialog appears. The dialog is described in the previous section, From the Main Dialog.

From Report Builder When you select Process Report from the menu bar, the report output dialog for the current report template appears. See the section Report Output Dialog Options for a description of the dialog.

P - 12

RIS Report Writer Commands

RIS Report Writer Commands R - 1

Report (Database Edit)

__________________________________________________________________________________________________________________________________________________

The Report command calls the Process Reports dialog, which lets you load and process a report template. For more information, see the section Process Report.

R-2

RIS Report Writer Commands

Review (Database Edit)

__________________________________________________________________________________________________________________________________________________

The Review command generates a formatted column-by-column listing of the current universe (defined by the current query criteria). The review lists each column that is toggled on (see the section Fields On/Off (Database Edit)). The review also totals numeric columns.

Dialog Options When you select Review, a Universe Review dialog appears.

Universe Listing — This worksheet displays multiple columns and rows from the current universe. Worksheet headers list the names of on columns. Filename — This field specifies the name of a file to which the universe review can be written. Line Length — This field specifies the number of characters in a line in the output file. Page Length — This field specifies the number of lines in a page in the output file. Write File — This button writes the universe review to the file specified.

RIS Report Writer Commands R - 3

Print File — This button prints the universe review. This button invokes the Print dialog, which sends the review to a print device. Read More — This button displays the next page of a multipage review. Read To EOF — This button scrolls to the end of the universe review.

R-4

RIS Report Writer Commands

RIS Report Writer Commands S - 1

Save Report

__________________________________________________________________________________________________________________________________________________

The Save Report command saves the current report to a template library. If a template with the same name exists in the library, you must confirm that you want to replace the previous version. In most cases, errors received while saving a report template are only warnings. Usually, the report template is written successfully.

Dialog Options When you select a Save function, the DBA Save Template dialog appears.

Library — This field displays the name of the current template library. You can select the field and key in the name of a different template library. You can create a new template library by keying in a template library name that does not exist (full or relative filename). You are asked to confirm that you want to create a new library. Name — This field displays the name of the current template (if one exists). Select the field and key in a new name. Description — This field lets you enter a description of the template.

S-2

RIS Report Writer Commands

Operating Sequence 1.

Select the Save function. The Save Template dialog appears.

2.

Accept the default values or edit the fields as necessary. Select OK to save the template. The template is written to the specified library. If a template with the same name already exists in the library, you are asked to confirm that you want to replace the old template with the new one. a.

Select Yes to replace the existing template with the new one.

b.

Select No to cancel the write.

— OR — Select Cancel to dismiss the dialog without saving the template.

RIS Report Writer Commands S - 3

Save Options (Report Builder)

__________________________________________________________________________________________________________________________________________________

Use the Save button on the Design Options dialog to save commonly used parameters to an optional template.

Dialog Options When you select a Save function, the DBA Save Template dialog appears.

Library — This field displays the name of the current template library. You can select the field and key in the name of a different template library. You can create a new template library by keying in a template library name that does not exist (full or relative filename). You are asked to confirm that you want to create a new library. Name — This field displays the name of the current template (if one exists). Select the field and key in a new name. Description — This field lets you enter a description of the template.

Operating Sequence 1.

Select the Save function. The Save Template dialog appears.

2.

Accept the default values or edit the fields as necessary. Select OK to save the template. The template is written to the specified library. If a template with the same name already exists in the library, you are asked to confirm that you want to replace the old template with the new one. a.

Select Yes to replace the existing template with the new one.

S-4

RIS Report Writer Commands

b.

Select No to cancel the write.

— OR — Select Cancel to dismiss the dialog without saving the template.

RIS Report Writer Commands T - 1

Text (Report Builder)

__________________________________________________________________________________________________________________________________________________

The Text (Report Builder) command places a field that prints a literal text string you assign. Text fields are used to print text that remains the same in a report: titles, column headers, and so on. Text fields are commonly placed on preface, top, bottom, and final lines.

Menu Options When you select Text (Report Builder), the DBA Text Field dialog appears.

The following list describes the options on the menu except for the Print Condition field, which is described in the section Place Field. Text — This field lets you specify the text string to print.

T-2

RIS Report Writer Commands

Operating Sequence Place this field using the standard Place Field operating sequence. See the section Place Field for a description of this sequence.

RIS Report Writer Commands T - 3

Text Size

__________________________________________________________________________________________________________________________________________________

The Text Size command lets you change the size of the text display on a report template or a report output dialog. Make the text smaller to see more fields at the same time. Make the text larger to make the display easier to read. The text size setting can be saved as part of a design options template, using the Save Options command.

Dialog Options When you select Text Size, the Text Size dialog appears.

Use the slider to set the text size. Text sizes range from 1 to 5. You may set the environment variable DBA_TEXT_SIZE to globally define the text size. Example: set DBA_TEXT_SIZE=1

T-4

RIS Report Writer Commands

Time

__________________________________________________________________________________________________________________________________________________

The Time command places a field that prints the system time in a format that you choose. You usually place time fields on a top or preface line.

Dialog Options When you select Time, the Time Field dialog appears.

The following list describes the options on the menu except for the Print Condition field, which is described in the section Place Field. Time Formats — This checklist lets you select the print format for the time field.

Operating Sequence Place this field using the standard Place Field operating sequence. See the section Place Field for a description of this sequence.

RIS Report Writer Commands U - 1

Undelete Field (Report Builder)

__________________________________________________________________________________________________________________________________________________

The Undelete Field (Report Builder) command restores the last field deleted with the Delete Field command.

Operating Sequence 1.

Select Edit from the Toolbar menu. Select Field and then Undelete from the pulldown menus. The prompt Select placement point appears. The field is dynamically attached to the cursor. As you move the cursor over the report template, information in the message area changes to reflect the current line, column, table, and field. RIS Report Writer uses F-1, F-2, and so on to represent the first, second, and any subsequent fields on a line.

2.

Click the left mouse button to place the field. RIS Report Writer restores the field to the specified position.

3.

Continue to copy the field to new positions. — OR — Click the right mouse button to exit the command.

U-2

RIS Report Writer Commands

Undelete Line (Report Builder)

__________________________________________________________________________________________________________________________________________________

The Undelete Line (Report Builder) command restores the last line deleted with the Delete Line command.

Operating Sequence 1.

Select Edit from the Toolbar menu. Select Line and then Undelete from the pulldown menus. The prompt Select placement point appears. The line is dynamically attached to the cursor. As you move the cursor over the report template, information in the message area changes to reflect the current line, column, table, and field.

2.

Click the left mouse button to place the line. RIS Report Writer restores the line to the specified position.

3.

Continue to copy the line to new positions. — OR — Click the right mouse button to exit the command.

RIS Report Writer Commands U - 3

Update Active (Database Edit)

__________________________________________________________________________________________________________________________________________________

The Update Active command places the dialog in update active mode. You can change currently displayed column values without changing the corresponding values for the current row. Select Insert Row to insert the displayed data as a row in the database. For more information, see the section Insert Row (Database Edit).

Operating Sequence The following sequence demonstrates how Update Active can be used with Insert Row to create a new row. 1.

Select Update Active. The Update Active button appears to be depressed. The dialog is in update active mode; you can enter data on the displayed row without changing the database.

2.

Select a column field. Key in a value to be contained in the new row.

3.

Continue to select column fields and key in new values until all changes have been made.

4.

Select Insert Row to insert the displayed data as a new row in the database.

U-4

RIS Report Writer Commands

Update Row (Database Edit)

__________________________________________________________________________________________________________________________________________________

The Update Row command places the dialog in update row mode. You can change currently displayed column values without changing the corresponding values for the current row. You can then select Insert Row to insert the displayed data as a row in the database. For more information, see the section Insert Row (Database Edit).

Operating Sequence The following sequence demonstrates how Update Row can be used with Insert Row to create a new row. 1.

Select Update Row. The Update Row button appears to be depressed. The dialog is in update row mode; you can enter data on the displayed row without changing the database.

2.

Select a column field. Key in a value to be contained in the new row.

3.

Continue to select column fields and key in new values until all changes have been made.

4.

Select Insert Row to insert the displayed data as a new row in the database.

RIS Report Writer Commands U - 5

User Variable (Report Builder)

__________________________________________________________________________________________________________________________________________________

The User Variable (Report Builder) command lets you create variables for use in scripts, user action statements, and derived fields. You can create variables to store three types of data: character, integer, and floating point.

Arrays You can create single- and multi-dimension arrays. Single-dimension arrays are automatically resized if an element outside the array’s current size is referenced. Multidimension arrays are not automatically resized. For example, an integer variable num with an x array value of 10 is referenced by num[0] through num[9]. If num is referenced by an x subscript greater than the initial size, the variable is extended and processing continues.

Character Variables Character user variables are designed to store text strings. For a single text string, the x size determines the length of the string, and the y size is set to 1. For an array of text strings, the x size determines the number of text strings allocated, and the y size determines the length of each.

U-6

RIS Report Writer Commands

Dialog Options When you select User Variable, the DBA User Variable dialog appears.

Name, Type, X, Y — This select-only field lists the name, variable type, x size, and y size of the user variables defined for the current report template. Select a line to make it a marker (highlighted) line. The dialog cannot be in delete or edit mode. (That is, the Delete and Edit buttons are not depressed.) New variables can be added and the delete buffer inserted before a marker line. Add — This button adds a variable to the user variable list. Select Add after you enter information in the Name, X Size, and Y Size fields and select a variable type at the bottom of the dialog. The new variable is inserted before the marker line in the user variable list. If no marker line exists, the new variable is inserted at the bottom of the list. Edit — This button places the dialog in edit mode. Select Edit and then select a variable from the user variable list. The values for the variable appear in the area at the bottom of the dialog. You can edit these values. Delete — This button puts the dialog in delete mode; any line you select is deleted and stored in a delete buffer. The delete buffer stores deleted lines until you exit delete mode. Select Delete again to exit delete mode. The delete buffer is cleared whenever you enter delete mode. Undelete — This button inserts the current delete buffer before the marker line in the user variable list. If no marker line exists, the delete buffer is inserted at the bottom of the list. Name — This key-in field lets you specify the name of a new variable or edit the name of an existing one.

RIS Report Writer Commands U - 7

Variable Type — This checklist lets you select a data type for the variable. X Size — This key-in field lets you specify the x size of the variable. Y Size — This key-in field lets you specify the y size of the variable.

U-8

RIS Report Writer Commands

Appendix A: RIS Report Writer Environment Variables AA - 1

Appendix A

__________________________________________________________________________________________________________________________________________________

RIS Report Writer Environment Variables

AA - 2 Appendix A: RIS Report Writer Environment Variables

Appendix A: RIS Report Writer Environment Variables AA - 3

Appendix A

__________________________________________________________________________________________________________________________________________________

RIS Report Writer Environment Variables This section lists the environment variables that can be used by RIS Report Writer. DBA_AUTOCOMMIT

Determines whether RIS Report Writer can turn autocommit off. See the file c:\win32app\ingr\risrpt\doc\autocomm.txt. Default = NO

DBA_BG_COLOR

Specifies the background color for the raster display when raster graphics mode is active. Default = 15

DBA_BLANK_PAD

Controls whether report output lines are padded with blanks to the length specified by columns per page. Default = NO

DBA_DEBUG

Causes the script debugger to be automatically activated upon startup. The command line switch -D can also be used.

DBA_BUTTON_SCRIPT

Used to specify a script call when a button is pressed. See c:\win32app\ingr\risrpt\doc\butkey.txt for more details.

DBA_CODE_SORT

If YES, code lists are sorted by ascending code text. If NO, code lists are sorted by ascending code number. Default = NO

DBA_CONVERT_INPUT

Specifies a script call that converts column values input by the user before passing them to the database, so that the user can work with units other than those stored in the database. See c:\win32app\ingr\risrpt\doc\convert.txt.

DBA_CONVERT_OUTPUT

Specifies a script call that converts column values from the database for output on menus and reports, so that the user can work with units other than those stored in the database. See c:\win32app\ingr\risrpt\doc\convert.txt.

AA - 4 Appendix A: RIS Report Writer Environment Variables

DBA_DAP_FILE

Defines the text file that is used to associate the report index number stored in a Displayable Attribute with the name of a report to run. There should be one report name on each line of this file.

DBA_DB_NUMBERS

Controls whether table and column specifications in dialog and report templates are written out as names (the default) or numbers (used in conjunction with mscolumns for schemas where table and column names will be translated).

DBA_DEBUG

Causes the script debugger to be automatically activated upon startup. The command line switch -D can also be used.

DBA_ERROR_LOG

Redirects messages from the Errors Detected form to the specified file.

DBA_FG_COLOR

Specifies the foreground color for the raster display when raster graphics mode is active. Default = 0

DBA_FORMS_COLORS

Controls whether Native or Shamrock fields are used (see doc/native.txt for details). 0 — fields are Windows native controls unless the Field PLUS check box is selected from the Dialog Builder. 1 — fields are always Windows native controls. 2 — fields are always Shamrock custom controls.

DBA_FORMS_MODE

Causes DM/DBA to take on the CLIX look-and-feel. Setting this variable sets DBA_FORMS_COLORS and DBA_NATIVE_MODE to 2.

DBA_HL_COLOR

Specifies the highlight color for the raster display when raster graphics mode is active. Default = 4

DBA_INITIAL_SCRIPT

Specifies a script function to execute when DB Access starts. This can be used to initialize global variables.

DBA_JOIN_TO_MANY

Causes DB Access to process secondary selects on outer and multi-schema joins when process query or universe review commands are issued to add duplicate rows caused by multiple hits in the secondary table. It increases processing times for these joins, and should be used only when one-to-many or many-tomany relationships exists. This flag is not necessary for standard, single schema joins or for any report joins. Default = NO

Appendix A: RIS Report Writer Environment Variables AA - 5

DBA_KEY_SCRIPT

Specifies a script call when a key is pressed. See c:\win32app\ingr\risrpt\doc\butkey.txt for more details.

DBA_LIB

Set to the template library DBA will use initially. Default = none

DBA_LIB_LIST

List the template libraries to search when loading templates Default = none

DBA_LINK_MODE

Determines type of linkage to be written to graphic elements by the Attach Linkage command, or read from graphic elements by the Review Element and Locate Graphics commands. Set to RIS for eight-word RIS (user data) linkages, or DMRS for standard four-word DMRS linkages. Default = "RIS"

DBA_LOG_MESSAGE

Causes DB Access to redirect all messages (normally displayed in the message field or message gadget) to the file specified by the DBA_LOG_ERROR shell variable. Default = NO

DBA_MCE_RESTRICT

This environment variable exists, you cannot invoke placement, manipulation, or subprocess commands, effectively making the design file read-only. Default is unrestricted.

DBA_MENU

Sets dialog template name that RIS Report Writer or RIS Report Writer Runtime invokes initially. Default = none

DBA_MESSAGE_STRIP

If NO, standard message strip is not displayed while dialogs are processed. Default = YES

DBA_MSLINK

Specifies his own MSLINK column, to be used in linking database rows to MicroStation elements, or as a key column, or for DBA-driven incrementing of the key column upon inserts of new rows. The column must be an integer, and should be uniquely indexed. Default = mslink

AA - 6 Appendix A: RIS Report Writer Environment Variables

DBA_NATIVE_MODE

Controls whether Native or Shamrock fields are used (see doc/native.txt for details). 0 — fields are Windows native controls unless the Field PLUS check box is selected from the Dialog Builder. 1 — fields are always Windows native controls. 2 — fields are always Shamrock custom controls.

DBA_NO_MSCATALOG

Forces DB Access to build its table list from RISTABLES instead of MSCATALOG even if it exists. Default = NO

DBA_NORMAL_TEXT

Forces dialog text display style to be normal. Normal text displays considerably faster under X Windows, especially on PCs. Default = NO

DBA_NO_READ_LOCK

NFS-mounted template libraries are not be locked when reading (loading templates), if true. Useful for read-only sessions when NFS file locking is not desired. WARNING setting true may cause bad reads if other users are writing to the library. Default = NO

DBA_NO_SCALING

Overrides automatic resizing of forms and dialogs based on screen size and based on resizing and moving the main dialog. Default = NO

DBA_NO_STOP

Disables the STOP sign on the RIS Report Writer message strip. Default = NO (STOP sign enabled.)

DBA_OBJECT_LIB

Specifies the template library that compiled script objects are written to. If not defined, they are written to DBA_LIB.

DBA_OPTIMIZE

Optimizes response for large databases. See c:588ngr\risrpt\doc\optimize.txt for details and operational differences. Default = NO

DBA_OPTIONS

The name of an options template, used for setting active design options such as font name and body size, grid lock, color, line style, line weight, line depth, default CR mode, text justification, text style, verbose mode, text size, or lines and columns per report page.

Appendix A: RIS Report Writer Environment Variables AA - 7

DBA_PARTITION_BITS

Determines the number of bits to be ignored in the occurrence number in DMRS linkages to partitioned entities on graphic elements (can be determined by using DMRS on the VAX DMRS database, LIST e.!, where e is the entity number, use the Partition Number value). Can also be used to mask out the reuse counter, if set to zero (0). Default = 8

DBA_PAUSE

Specifies an interval (in seconds) between inputs when using the DBA_PLAYBACK_FILE option. Default is 1

DBA_PLAYBACK_FILE

Specifies a file (created by DBA_RECORD_FILE) for playing back all input from a previous RIS Report Writer session.

DBA_PLOT_QUEUE

Provides a queue name for the plot command whenever a Plot Window button is selected. Default = ilp811

DBA_PRINT

Provides a format string for the print command issued whenever a PRINT button is selected (the %s in the string is replaced with the filename). Default = windows print dialog

DBA_RASTER

Specifies the name of the raster graphics control file. Previously this was done with the -d switch; this environment variable is now the preferred method.

DBA_RASTER_PATH

Specifies a default pathname to search for raster files, this applies to the cosmetic and dynamic raster gadgets.

DBA_RECORD_FILE

Specifies a file for recording all input in a RIS Report Writer session. This file can then be used in a subsequent playback session (see DBA_PLAYBACK_FILE).

DBA_REPORT_MEMORY

Used to preset report memory to be allocated so that large reports do not fragment memory by repeatedly adding small chunks. Set it to the number of bytes required to store all rows in memory (# of report rows times bytes per row, as specified by the Error allocating report memory ... error message). Default is 100000

DBA_REPORT_NULLS

Causes DBA to print an error message whenever a script or a numeric field references a NULL column value. Default = NO

AA - 8 Appendix A: RIS Report Writer Environment Variables

DBA_SCHEMA

Set to the schema name DBA connect to initially. Default = none

DBA_SCHEMA_LIST

Set to a string of schemas for multi-database joins. Default = none

DBA_SCRAP

Causes characters deleted from DBA fields to be put on the EnvironV scrap (so they may be accessed by other I/Forms applications). Setting this variable slows down field editing noticeably. Default = NO

DBA_SHELL

Provides a command string for the SHELL button on the DBA Message Strip. Default = "xterm -shell"

DBA_STORE_SCRIPT

Causes DB Access to write a compiled script object to DBA_OBJECT_LIB or DBA_LIB whenever a script is compiled. DB Access then reads this object in future sessions instead of recompiling the script again. Compiled objects are only read from DBA_OBJECT_LIB or DBA_LIB. Default = NO

DBA_SUPPORT

Sets to the DB Access support directories. (Only necessary when using multiple support paths. Separate paths with colons). Default = /usr/ip32/risrpt/support

DBA_SYNC_MENUS

Causes DB Access to update all of the same table when a menu’s current row is changed. Default = NO

DBA_TABLE_ORDER

Lets you select order in which table lists are sorted. Default = mscatalog.entitynum (if mscatalog exists), or ristables.table_name (if mscatalog does not exist).

DBA_TEXT_SIZE

Presets Report Builder and Output text size (1-5, from the Text Size form). If this shell variable is not defined the default is 3.

DBA_TIMESTAMP_FORMAT

Overrides the default input/output format for timestamp columns. See c:\win32app\ingr\risrpt\doc\timestamp.txt for format details. Default = "yyyy-mm-dd:hh:nn:ss"

Appendix A: RIS Report Writer Environment Variables AA - 9

DBA_TMP_OUTPUT

When set, this flag causes all report output to be placed in TMPDIR (usually /usr/tmp) with a unique name. This makes it easy to clean up report output as well as eliminating multiple user file conflicts.

DBA_TOPMOST

Controls the window priority of DBA dialogs. If not set, DBA dialogs are normal priority. If set, DBA dialogs are always on top of nontopmost windows. This is useful when running DBA from MicroStation.

DBA_USE_SERVER

Forces all DBA RIS commands to be channeled through a DBASRV connection. This option requires the -n command line switch. It is useful to prevent DBA_NFM applications from creating an extra connection to the NFM database.

DBA_WRITE_ACCESS

Set to YES for database write access, or NO for readonly. Default = YES

Certain global variables need only to be set to evaluate to true: DBA_AUTOCOMMIT DBA_BLANK_PAD DBA_CODE_SORT

DBA_DB_NUMBERS DBA_OPTIMIZE

For example: set DBA_DB_NUMBERS=

The equal sign (=) is required. You can also specify a value, such as: set DBA_DB_NUMBERS=YES

If these environment variables are not exported, they default to NO. The environment variable DBA_WRITE_ACCESS defaults to YES. You must set this variable to NO and export it to specify a condition other than the default. For example: set DBA_WRITE_ACCESS=NO

AA - 10

Appendix A: RIS Report Writer Environment Variables

Appendix B: RIS Report Writer Reserved Tables BB - 1

Appendix B

__________________________________________________________________________________________________________________________________________________

RIS Report Writer Reserved Tables

BB - 2

Appendix B: RIS Report Writer Reserved Tables

Appendix B: RIS Report Writer Reserved Tables BB - 3

Appendix B

__________________________________________________________________________________________________________________________________________________

RIS Report Writer Reserved Tables RIS Report Writer lets you create special reserved tables for various purposes. These tables are optional unless otherwise noted. The environment variable DBA_DB_NUMBERS can be set to YES to force RIS Report Writer to write out dialogs and report templates referencing tables and columns by number instead of name. If you create a reserved table with the Create/Alter Table function of the Schema Edit utility, DB Access automatically creates the columns for the table. B.1

Tables Needed for Raster Graphics

B.2

Unique Row Identification

B.3

Coded Columns and mscodelist

B.4

mscolumns

B.1

Tables Needed for Raster Graphics

Several tables are required for RIS Report Writer raster graphics.

B.2

Unique Row Identification

RIS Report Writer requires unique row identification for the following Database Edit functions: Change Row Delete Row Previous Row Unique row identification is also required for RIS Report Writer to display the number of rows generated by the Process Query command. You can use any of three methods for unique row identification. Listed in order of precedence, they are:

BB - 4

Appendix B: RIS Report Writer Reserved Tables

1.

Add an mslink column to each table.

2.

Define one or more key columns in the mscatalog table.

3.

Create a unique index for each table.

B.2.1

mslink Column

The default method for identifying unique rows is to add an mslink column to each table. This can be done through the RIS Schema Manager (/usr#/ip32/ris/dba_pointbin/risschema_mgr). Alternatively, an mslink column can be added using the SQL alter table statement.

RIS Schema Manager The RIS Schema Manager is a forms-based utility for creating and managing RIS schemas and tables. Use the Data Definition option to alter an existing table.

Operating Sequence 1.

From the /usr/ip32/ris/bin directory, invoke the RIS Schema Manager by keying in: risschema_mgr The RIS Schema Manager form appears, displaying a list of available schemas.

2.

Use the left mouse button to select the Data Definition button. The Data Definition form displays.

3.

At the Schema Name field, key in the name of the schema associated with the table you want to alter. Key in a password if needed. RIS Schema Manager displays Reading dictionary tables... and then lists the tables associated with the schema.

4.

Use the left mouse button to select the table you want to alter. Select the Alter Table button. The Alter Table form appears, displaying a list of available columns.

5.

At the Column Name field, key in mslink. At the Column Type field, select integer.

6.

To add the column, select the Run button (the arrow pointing to the right at the top of the form). When processing is finished, the column list is updated to display mslink.

You must now assign unique mslink values to each row in the table. This can be done in the RIS Report Writer SQL Statements option using the update statement. The syntax of the update statement is:

Appendix B: RIS Report Writer Reserved Tables BB - 5

update

[.] set { = } [, ...] [where ]

Sample values: schema table mslink value name value

= = = =

risdvw college 3 UNIVERSITY OF TENNESSEE

update risdvw.college set mslink = 3 where name = ’UNIVERSITY OF TENNESSEE’

In this example, the where clause restricts the mslink value of 3 to the row where the column name has the value UNIVERSITY OF TENNESSEE. If no where clause is specified, all rows in the table are updated. If you are using an INFORMIX database, a faster way to assign unique mslink values is to set mslink equal to rowid in an ISQL update statement: update set mslink = rowid

SQL alter table Statement You can also add an mslink column to a table from the RIS Report Writer SQL Statements option using the alter table statement. The syntax of the alter table statement is: alter table add [not null]

The not null keywords should be used only if the table does not contain any data.

B.2.2

Key Columns (mscatalog Table)

The second method of identifying unique rows is to define one or more key columns in the mscatalog table. If the mscatalog table does not exist, you can create it using the RIS Schema Manager (/usr#/ip32/ris/bin/risschema_mgr). Alternatively, you can create mscatalog using the SQL create table statement.

BB - 6

Appendix B: RIS Report Writer Reserved Tables

The following are columns in an mscatalog table: tablename

char(32) (required)

alias_name

char(32) (optional)

entitynum

integer (required)

screenform

char(64) (required for USTN)

reporttable

char(64) (required for USTN)

sqlreview

char(240) (required for USTN)

fencefilter

char(240) (required for USTN)

dastable

char(32) (required for USTN)

key_columns

char(50)(optional)

nextocc

integer (optional)

mslink

integer (optional)

The tablename column must be identical to any RIS-supported database table name to be accessed by RIS Report Writer. The alias_name column specifies a different name for the table that is not bound by SQL standard restrictions. The entitynum column determines table number, and may be matched with DMRS entities in existing VAX templates. The nextocc column provides a more efficient method of inserting rows with mslink columns. It eliminates the need for RIS Report Writer to issue the statement select max (mslink) from

in assigning an mslink value to the row inserted. You can set nextocc to the next mslink value available for insert, or let RIS Report Writer maintain the value. Any RIS-supported database table (ristables, mscatalog, and so forth) can be added to or removed from mscatalog.

Defining Key Columns Once the mscatalog table exists, you can define key columns for any table with an occurrence in the mscatalog table. 1.

From the RIS Report Writer main dialog, select mscatalog as the current table. Select Database Edit.

2.

From the Database Edit dialog, create a universe of all tables with occurrences in mscatalog.

Appendix B: RIS Report Writer Reserved Tables BB - 7

3.

Make the table for which you want to define the key columns the current row.

4.

At the key_columns column, key in one or more column names, separated by spaces. The message Row changed appears.

5.

Using the same process, define key columns for any other tables in mscatalog. When you are finished, exit RIS Report Writer.

B.2.3

Unique Index

The third, and simplest, method for uniquely identifying rows in a non-graphic database is to create a unique index for a given table. From the SQL Statements dialog in RIS Report Writer, use the SQL create index statement: create [unique] index on ( [, ...])

To create a unique index called friendex on the name and nickname columns of the friends table: create unique index friendex on friends (name, nickname)

B.3

Coded Columns and mscodelist

The mscodelist table has the following columns. All columns are required except mslink, which makes it easier to edit the table with Database Edit. See the section Unique Row Identification. table_name

char(32)

column_name

char(32)

join_table

char(32)

code_column

char(32)

text_column

char(32)

index_column

char(32)

index_value

integer

mslink

integer

For a column to be considered coded, it must have a row entry in mscodelist where: table_name is the column table name. column_name is the column name. join_table is the table name of the code list. code_column is the name of an integer column in join_table. text_column is the name of a character column in join_table.

BB - 8

Appendix B: RIS Report Writer Reserved Tables

If multiple code lists are to be stored in one table, index_column is the name of an integer column in join_table that stores the index_value of each code list. For example, the following mscodelist entries table name _ ____

column name _ ____

join table _____

code column _______

text column _______

index column _______

index value _____

pipe pipe

material shape

material codelists

code_number code_number

code_text code_text

index_num

2

would refer to two coded columns (material and shape) in the pipe table. The material column has its own code list (the join table named material) with the following columns: code_number _____________

code_text _________

1 2 3

CONCRETE STEEL PVC

The shape column uses a shared code list (the join table named codelists) with the following columns: code_number _____________

code_text _________

index_num ___________

1 2 3 1 2 3

CONCRETE STEEL PVC CIRCULAR RECTANGULAR ELLIPTICAL

1 1 1 2 2 2

The shape column accepts values from rows in codelists where index_num is equal to 2.

Appendix B: RIS Report Writer Reserved Tables BB - 9

B.4

mscolumns

The following are columns in the mscolumns table. Required columns are indicated. entitynum

integer (required)

attrnum

integer (required)

column_name

char(32) (required)

alias_name

char(32)

column_format

char(10)

default_value

char(10)

mslink

integer

The entitynum column determines table number. The attrnum column determines column number. The column_name column specifies the name of the column (determined in the create table statement). If you set DBA_DB_NUMBERS to YES, report templates store column numbers instead of names. They can then be processed against translated databases without change. For more information, see the section RIS Report Writer Environment Variables. The alias_name column specifies a different name for the column that is not bound by SQL standard restrictions. The column_format column specifies a standard C format string (for example, "%lG") used when column values are output to custom dialogs built with the DB Access Administrator Toolkit. The default_value column specifies a string to be displayed when there is no current row (for subsequent inserts).

BB - 10

Appendix B: RIS Report Writer Reserved Tables

Appendix C: Timestamp Columns CC - 1

Appendix C

__________________________________________________________________________________________________________________________________________________

Timestamp Columns

CC - 2

Appendix C: Timestamp Columns

Appendix C: Timestamp Columns CC - 3

Appendix C

__________________________________________________________________________________________________________________________________________________

Timestamp Columns Timestamp columns can be used to specify a date and time in a database row. They are useful for indicating when data was entered or updated in a database. By default, timestamp columns display in the following format: yyyy-mm-dd:hh:nn:ss. You can specify a timestamp format with the DBA_TIMESTAMP_FORMAT environment variable. The global variable char *dba_timestamp_format can then be modified at any time from script. You can also then input timestamp columns using the format specified by DBA_TIMESTAMP_FORMAT. For more information, see the section RIS Report Writer Environment Variables.

Format Characters Year yyyy yy y

Four digits padded with leading zeros. Last two digits padded with leading zeros. One to four digits; no padding.

mm m month mon

Two digits padded with leading zeros. One or two digits; no padding. Name of month. Up to nine characters; no padding. Name of month. Three-character abbreviation; no padding.

ddd dd d day dy

Day of the year. One to three digits; no padding. Day of the month. Two digits padded with leading zeros. Day of the month. One or two digits; no padding. Name of day of the week. Up to nine characters; no padding. Name of day of the week. Three-character abbreviation; no padding.

Month

Day

CC - 4

Appendix C: Timestamp Columns

Hour hh24 h24 hh12 or hh h12 or h

24-hour mode. Two digits padded with leading zeros. 24-hour mode. One or two digits; no padding. 12-hour mode. Two digits padded with leading zeros.

nn n

Two digits padded with leading zeros. One or two digits; no padding.

ss s

Two digits padded with leading zeros. One or two digits; no padding.

am or pm a.m. or p.m. ´text´ ´´ default

Meridian indicator. Two characters; no padding.

12-hour mode. One or two digits; no padding.

Minute

Second

Other

Meridian indicator with periods. 4 characters; no padding. Single quotation string is reproduced in destination string. Single quotation is reproduced in destination string. Any other character is reproduced in destination string.

To capitalize a word or abbreviation, capitalize the corresponding timestamp format element.

Examples These examples indicate possible formats and the resulting output given the following date structure: date.year = 1990 date.month = 12 date.day = 5 date.hour = 10 date.minute = 33 date.second = 32 format = buffer = format = "mm/dd/yy" buffer = "12/05/90" format = "mm/dd/yyyy" buffer = "12/05/1990" format = "dy, mon d yyyy" buffer = "wed, dec 5 1990"

Appendix C: Timestamp Columns CC - 5

format = "day, month d yyyy" buffer = "wednesday, december 5 1990" format = "’’’day = ’day’’, month d yyyy" buffer = "’day = wednesday’, december 5 1990" format = "’day = ’day, month d yyyy" buffer = "day = wednesday, december 5 1990" format = "Dy, Mon d yyyy" buffer = "Wed, Dec 5 1990" format = "Day, Month d yyyy" buffer = "Wednesday, December 5 1990" format = "DY, MON d yyyy" buffer = "WED, DEC 5 1990" format = "DAY, MONTH d yyyy" buffer = "WEDNESDAY, DECEMBER 5 1990" format = "DAY, MONTH d yyyy hh12:nn:ss AM" buffer = "WEDNESDAY, DECEMBER 5 1990 10:33:32 AM" format = "DAY, MONTH d yyyy hh:nn:ss P.M." buffer = "WEDNESDAY, DECEMBER 5 1990 10:33:32 A.M." format = "day, month d yyyy hh12:nn:ss am" buffer = "wednesday, december 5 1990 10:33:32 am" format = "day, month d yyyy hh:nn:ss p.m." buffer = "wednesday, december 5 1990 10:33:32 a.m." format = "day, month d yyyy hh24:nn:ss" buffer = "wednesday, december 5 1990 10:33:32" format = "Day’ the ’dth’ day of ’Month, yyyy" buffer = "Wednesday the 5th day of December, 1990" format = "’The ’sth’ second of the ’nth’ minute of the ’h24th’ hour" buffer = "The 32nd second of the 33rd minute of the 10th hour"

CC - 6

Appendix C: Timestamp Columns

Appendix D: RIS Report Writer Error Messages DD - 1

Appendix D

__________________________________________________________________________________________________________________________________________________

RIS Report Writer Error Messages

DD - 2

Appendix D: RIS Report Writer Error Messages

Appendix D: RIS Report Writer Error Messages DD - 3

Appendix D

__________________________________________________________________________________________________________________________________________________

RIS Report Writer Error Messages The following is a list of RIS Report Writer error messages and their meanings. Error Message

Meaning

Cannot change key column.

RIS Report Writer uses this column for unique row identification. You cannot change a value in this column.

Code list entry not found.

You have tried to enter a value in a coded column that does not exist in the associated code list. You can enter only values from the code list.

Columns per page out of range (1-2000).

You have specified too many or too few columns per page for report output. Enter a value from 1 to 2000.

Error creating template library "".

RIS Report Writer could not create the named template library. Either you do not have write access to the directory that you tried to create the library in, or, if the library exists, you do not have write access to it.

File "" not found.

RIS Report Writer could not locate the file. Check the spelling of the filename. Check that the path for the file is accurate.

Invalid column name.

You have specified a column name that is not permitted. Key in up to 18 alphanumeric or underscore characters. The first character must be an alphabetic character.

Invalid table name.

You have specified a table name that is not permitted. Key in up to 18 alphanumeric or underscore characters. The first character must be an alphabetic character.

DD - 4

Appendix D: RIS Report Writer Error Messages

Invalid template name "".

You have specified a template name that is not permitted. Key in up to 20 alphanumeric or underscore characters.

Invalid user variable name.

You have specified a user variable name that is not permitted. Key in up to 20 alphanumeric or underscore characters. The first character must be an alphabetic character.

Invalid user variable name ("wtr_" prefix).

You have defined a user variable with a wtr_ prefix. All wtr_ variables are reserved. Rename the variable.

Lines per page out of range (1-999).

You have specified too many or too few lines per page for report output. Enter a value from 1 to 999.

Maximum character length (2000) exceeded in user variable "".

You have exceeded the length allowed for a character user variable. Specify a character variable length of 2000 or less.

Maximum filename length (14 characters) exceeded.

You have specified a filename of more than 14 characters. Enter a filename of 14 or fewer characters.

Missing input library specification.

You did not specify an input library for a function of the Template Librarian utility (/usr#/ip32/risrpt/bin/templib).

Missing output library specification.

You did not specify an output library for a function of the Template Librarian utility (/usr#/ip32/risrpt/bin/templib).

No COLUMN or NUMERIC fields allowed on "ALL" lines.

You cannot place a column or numeric field on an all tables line. These fields must be placed on a single table line.

No current field.

A field must be current for this command. Select a field before selecting the command.

No current line.

A line must be current for this command. Select a line before selecting the command.

No current row.

A row must be current for this command. Use the query and current row functions to establish a current row. Then select the command.

Appendix D: RIS Report Writer Error Messages DD - 5

No current schema.

A schema must be current for this command. Key in or select a schema name before selecting the command.

No current table.

A table must be current for this command. Key in or select a table name before selecting the command.

No current universe.

This command requires a current universe of rows. Use the query functions to generate a current universe.

No key column(s) defined for "".

This command requires that a means of uniquely identifying rows be provided for the table. See the section RIS Report Writer Reserved Tables for information on establishing key columns.

No MSCODELIST in current schema.

You have attempted to add a coded column to a table in a schema that does not have an mscodelist table. You must create mscodelist before adding coded columns.

No rows found.

No rows meet the current query criteria.

No table found.

RIS Report Writer could not locate the table. Check the spelling of the table name. Check that the correct library is current.

No table found in MSCATALOG.

You have specified a table that does not have a corresponding row in the mscatalog table. You can insert a row for the table into mscatalog.

No templates found in library "".

You have tried to load a template from a library that does not contain templates of that type (dialog, report, script, and so forth). Or you have called a popup list of templates (such as the Load from Library dialog) when the attached library does not contain templates of the correct type. Attach a library that contains templates of the correct type.

RIS Error.

An RIS error has occurred. RIS Report Writer displays the error. For information on RIS errors, see the Relational Interface System (RIS) for Windows NT SQL User’s Guide.

DD - 6

Appendix D: RIS Report Writer Error Messages

Schema "" not found in schema list.

You have specified a schema that is not in the current schema list. Check that you have correctly spelled the schema name. If you own or have been granted privileges on the schema, you can add it to the schema list. A schema list is necessary only for multischema joins. If no schema list is specified (using DBA_SCHEMA_LIST or the -S command-line option), any available RIS schema can be attached.

Script template \’\’ doesn’t match function name \’\’.

You have specified a script template name that differs from the name of the function being saved in the template. The script template must match the name of the function.

Table "" not found.

RIS Report Writer could not locate the table. Check the spelling of the table name. Check that the correct library is current.

Undefined symbol:

The scripting interpreter has encountered an operand that is unknown. Check that syntax is correct and any user variables have been defined.

Glossary GL - 1

Glossary

__________________________________________________________________________________________________________________________________________________

GL - 2

Glossary

Glossary GL - 3

Glossary

__________________________________________________________________________________________________________________________________________________

absolute pathname

Sequence of directories, beginning with the root directory (/) that locates a file. See also pathname and relative pathname.

accept

Receive input, such as characters, integers, or data buttons. Also, confirming an element selection.

access

Perform actions necessary to use software.

activate

Change the state of an object or entity so that it accepts or displays data.

add query

Key-in mode that lets a user add query criteria.

address

Label, name, or number that identifies an exact storage location in memory.

alphanumeric string

Set of characters treated as a unit and made up of numbers, alphabetic characters, blanks, and special characters.

ANSI

Acronym for American National Standards Institute, a private organization that develops, maintains, and publishes industry standards in the United States.

application

System of programs or utilities designed to accomplish specific tasks as requested by the user.

array

Data structure used to organize data into contiguous lists.

ASCII

American Standard Code for Information Interchange character set.

assembly

I/NFM set created with PDM version 2.4 or later.

association

A relationship between two or more objects.

associative

Having a relationship to another.

associative geometry

Subsystem that lets you place graphic elements based on a relationship (for example, parallel to) with existing graphic elements. Elements placed associatively maintain the relationship when the existing graphic element is manipulated.

GL - 4

Glossary

attribute

Characteristic of an element. See also parameter.

attributes

The features of an object, such as color, line width, font, and font size.

bit

Binary digit represented by a 1 or 0. Smallest unit of storage in a digital computer.

bitmap

An ordered array of pixels turned off and on to create a graphical image on a computer screen.

body line

A line on a report template that prints once for each input row.

bottom line

A line on a report template that prints at the end of each page.

breakpoint

Interruption of OM processing made possible through ODEN. Breakpoints are set so as to pass control back to the debugger from execution mode.

buffer

Data area.

button

State gadget that has a three-dimensional appearance and can be set on or off.

byte

Group of bits forming a unit of storage in a digital computer. A byte usually consists of 8 bits but can contain more or fewer depending on the model of computer. Bytes can also contain error recognition information.

C

General-purpose, structured programming language developed at Bell Labs in the early 1970s.

cabinet

A physical location for documents in DM/Manager. Tables in the DM/Manager database. An I/NFM catalog.

CAD

Acronym for Computer-Aided Design.

CCIT Group 4

An industry standard compression technique for black-andwhite (binary) data. When you load a nontiled Group 4 file, the data is decompressed into a bitmap and displayed on the screen.

change row

Key-in mode that lest a user change the value of one or more columns in the current row.

char

Data type which stores one character.

character

Alphabetic letter, digit, punctuation, or symbol.

Glossary GL - 5

check box

A small box that lets you select or unselect an option. When the check box is selected, an X appears in the box.

checklist

State gadget consisting of one or more boxes, followed by text or symbols, usually arranged in a column.

choose

To activate buttons, fields, and so forth on forms.

client

Portion of a client/server-based application that requests services.

CLIX

Version of the UNIX operating system ported to run on Intergraph systems.

code list

A set of unique column values stored in a join table. A coded column accepts values only from its code list.

coded column

A column that accepts values only from its code list. A coded column is represented by a row in the mdcodelist table.

collection

A logical grouping of files for ftr searching and indexing.

column

Vertical arrangement of figures or words.

column field

On a menu, a gadget that displays values for the current row. On a report template, a field that displays data from a specified column for each row processed.

command

Software that interacts with the user, obtaining user input and then acting in a specified way based on that input. Each icon on the menu accesses a command, although there could also be additional commands accessed only by key-in.

command line

Alphanumeric key-ins used to invoke an executable directly from the operating system environment.

command name

Alphanumeric string that corresponds to a given command.

command string

Alphanumeric string that corresponds to a given command. A command name.

compile

Translate a program written in some programming language into machine language or assembly language.

compress

Process that eliminates gaps, empty fields, redundancies, or unnecessary data in a file so that the size of the file is reduced.

constant

Value that remains unchanged during a program’s execution.

GL - 6

Glossary

counter field

A field on a report template that keeps track of how many input rows have been processed.

CPU

Acronym for Central Processing Unit.

CRT

Acronym for Cathode Ray Tube.

cursor

Pointer that the user moves on the screen to indicate an item or area.

Data Definition Language

(DDL) Subset of the ANSI SQL Standard statements which defines the schemas and relations of a database.

Data Manipulation Language

(DML) Subset of the ANSI SQL Standard statements which manipulate the data contained in a table.

data point

Point entered with the mouse or with a precision key-in, which specifies a position in a drawing file.

data structure

Structure whose components are data objects. Data structures are used to group logically related data.

data type

Classification of a data item as an integer, letter, or real number.

database

Collection of comprehensive informational files having predetermined structure and organization that can then be communicated, interpreted, or processed by a specific program.

database menu

A menu that is associated with a specific database table.

date field

A field on a report template that prints the system date.

DB2

Relational database management system.

DBA

Acronym for Database Administrator or DB Access.

DDL

Acronym for Data Definition Language.

DEC

Acronym for Digital Equipment Corporation.

default

Predetermined value of a parameter or option that is automatically supplied by the system or program whenever a value is not specified by the user.

delete

To remove, destroy, eliminate, or erase.

derived field

A field on a report template that prints the results of a formula.

Glossary GL - 7

design file

File containing graphic and text data. Also called a drawing file.

device

Nonaddressable component of a network, that is, a component onto which a user cannot log, for example, tape drive, disk drive, and floppy disk.

dialog box

A box that requests information about a particular task you are performing.

dimmed

A button or command that is displayed in light gray instead of black. When a button or command is dimmed, it is disabled and nonselectable.

directory, workstation

An alphabetical list of files on a computer.

disk

Round flat plate coated with a magnetic substance on which data is stored.

DM/Capture

A front-end software application for capturing and scanning documents and drawings, including optical character recognition (OCR) capability.

DML

Acronym of Data Manipulation Language.

document

A file or many files that are handled as one entity to the redlining software.

double

Data type which stores a range of floating point numbers. The storage requirement and range of values are dependent on the computer and compiler.

drawing

A file that contains graphics or images such as a MicroStation or a CAD file.

drawing file

File in which you place elements. Also called a design file. element so you can see it move.

drop

To discontinue current status or association; to return to a previous or more primitive status or association; to descend levels.

edit

To add, delete, or change text, graphics, and objects.

EMACS

ASCII text editor.

enter

To enter data from a mouse or from a keyboard.

entity

Graphic or descriptive component in a graphics file. Can also mean a database table.

GL - 8

Glossary

environment variable

Variable defined on or across invocations of a command shell. Processes are given access to the information in these variables by the operating system.

error message

Description of an error found in a program.

Ethernet

Popular implementation of a local area network.

executable

Program that has been written in or translated into, a machine language that is ready for execution by the computer.

exit

To terminate a job or process.

exit and save

To terminate a job or process and save any changes or data entered. Also, to dismiss a form and save any changes made.

field

Any of the data grouped together in a record (also known as an attribute or column). Also, a gadget allowing text entry on a form.

file

Collection of logical records stored as a unit.

file locking

Process that denies access to a file.

filename

User-defined name given to an interactively created file. The name should be relevant to the contents of the file.

final line

A line on a report template that prints on a new page at the end of the report. Used for report summaries or totals.

flag

A variable that can be set to indicate the presence or absence of a certain condition.

floppy disk

Flexible magnetic sheet used to store information.

font

Complete set and style of the characters and symbols of a typeface used for displaying text.

form

Rectangular display through which a user and an application can communicate using gadgets.

ftr

Acronym for Full Text Retrieval.

full pathname

Name of the entire path or directory hierarchy to a file, including the filename. See also relative pathname.

function

Small segment of code written to complete a portion of a larger task.

Glossary GL - 9

gadget

Graphic device on a form that helps a user enter or receive specific information.

geometry

Elements defined graphically; the mathematical branch dealing with the measurement, properties, and relationships of points, lines, curves, angles, surfaces, and solids.

global variable

Programming variable that is recognized everywhere in a program.

graphic

Any symbol or method of visual communication that is not text.

grid

Network of uniformly spaced horizontal and perpendicular lines that help to identify 2-D or 3-D relationships.

group

A collection of icons that represent documents and applications within the Program Manager.

Help

See on-line Help.

Help window

Form in which the Help topics are displayed by the Help process.

hierarchy

Classified structure with superiors (roots) and subordinates (dependents) for grouping files or commands.

horizontal

Parallel to, in the plane of, or operating in a plane parallel to the horizon or to a base line.

icon

Symbol that graphically identifies a command, application, or document.

ID

Name composed of numbers or characters given for identification purposes to a record. A record number.

identify

To indicate your selection on a form or graphics by placing a data point on the item.

include file

File that contains information such as symbolic constants, structure definitions, variable declarations, and some standard functions and macros.

index

Storage mechanism used to provide faster access to the rows in a table.

indexing

Extraction and sorting of all the indexable words in any new or modified documents and updating the index files with the new information.

GL - 10

Glossary

I/NFM

Intergraph Network File Manager software package.

INFORMIX

Relational database management system.

INGRES

Relational database management system.

initialize

To set storage location, counter, variable, internal structures, or the like to a beginning value.

integer

Value in the set of all positive and negative whole numbers and zero. Also, a data type which stores a range of integer values. Storage requirement and range of values are dependent on the computer and compiler. Of or relating to the process of entering data and receiving a response from the computer.

interactive

Of or relating to the process of entering data and receiving a response from the computer.

interface

Shared boundary through which the user and software communicate.

I/ORL

Intergraph On-line Reference Library. Provides easy access to Intergraph documentation on compact disk.

item

Unit of storage within a larger unit, such as a file in a cabinet.

job

The smallest organizational unit in the structural outline of DM/Capture. A job correlates to one item (that is, a storage unit) in the database. A job can contain one file or multiple files.

joining

Process of relating the data in two or more tables, possibly restricted by some condition.

justification

Point of orientation for text placement.

key column

Key-in mode that lets a user retrieve the first row in the current table having the specified column value.

key-in

Information or command keyed in, rather than selected using a mouse.

key-in mode

Mode that determines the effect of a user key-in in a menu column field. The four key-in modes are change row, add query, update active, and key column.

keyword

Word defined to have special meaning in a programming, command, query language, or indexing.

Glossary GL - 11

LAN

Acronym for local area network.

library

Collection of subroutines.

linear

Having a single dimension; a line.

list box

A box that displays a list of available options.

local

The physical location of the data on the machine or the location of the data by the way of remote mounting capabilities.

local area network

Computer networking scheme in which nodes which are geographically local are connected to a network through multiplexers, and networks of geographically remote nodes are connected through routers.

log in

Enter the necessary information, such as a username and password, to begin a session on a terminal.

log-in

Username/password combination used to gain access to a computer.

mask

Value with bits set on and off to set up certain attributes.

memory

Device that can store data.

menu

Means for storing and selecting commands: icon-based, function key, or paper.

menu bar

A list of menus for the window.

message field

Forms system gadget that appears along the bottom of a form and is used to display prompt and error messages to the user.

message strip

Area of the screen that contains the workstation icon, the message area and the process ID field.

Microsoft Windows

A windows-based graphical interface that is used with MSDOS.

MicroStation

Computer-aided design software.

MicroStation 32

Computer-aided design system for Intergraph workstations.

mode

Particular functioning arrangement or condition. Also, the behavior of a gadget.

model

Graphic representation or schema.

GL - 12

Glossary

mouse

Hand-controlled input and command selection device. There are several models; most common are the 2-button mouse, the 3-button mouse, and the 12-button mouse.

mscatalog

Database table required by MicroStation 32 for databases used with graphics. Key columns defined in mscatalog provide a means of unique row identification.

mscodelist

Database table required for a schema using coded columns.

mslink

Column in a database table used to uniquely identify a row. MicroStation uses mslink to specify a row that a graphics element is linked to.

multiple column field

A menu gadget that displays data from one or more columns in the current row.

network

Interconnection of host computers and workstations that lets them share data and control. The term network can mean the devices that connect the system, or it can mean the connected system.

NFS

Acronym for Network File System. The NFS product lets you access files that are physically located on another node on your local area network (LAN). Network file systems will appear local to the NFS client.

no database menu

A menu that can be processed against any table, or that has no database functionality (such as a main menu).

node

Any nonaddressable component of a network; that is, any component of the network onto which a user can locally or remotely log.

nodename

Symbolic name given to each device on an ethernet network which can be translated into a network address.

NULL

Indicates no value.

numeric field

A field on a report template that provides default calculations on a numeric column value.

occurrence

A set of associative geometry elements placed using the Place Macro command.

on-line Help

Set of on-line, context sensitive files, that provide information to the user about the capabilities of an application.

operating system

System programs that control the overall operation of a computer system.

Glossary GL - 13

operator

Symbol that indicates that an arithmetic, logical, or relational operation is to be performed.

ORACLE

Relational database management system.

ORL

See I/ORL.

overview

Reduced resolution display of an image in a raster data file. An overview is normally located in the raster data file itself.

page field

A field on a report template that prints the current page number.

palette

Set or assortment of colors, or a collection of logically related menu buttons, or a level of menu buttons.

panel menu

Panel of buttons to the right of the window area. The buttons are arranged hierarchically and are used to select commands.

parameter

Property that associates a variable name with a value.

password

Word that is entered during log in that prevents unauthorized people from using the file, software, or computer.

path

Sequence of directories leading to a file or a sequence of menus leading to a command.

pathname

Sequence of directories leading to a file. See also absolute pathname and relative pathname.

place

To create and position an element or object.

pointing

Moving the mouse to place the pointer over a menu command, button, or an item on your screen.

preface line

A line on a report template that prints once at the beginning of the report. After preface lines are printed, the report continues on a new page. Used to print a cover sheet, title page, or legend.

preprocessor

Program that performs some type of calculation or manipulations on the data in a file, usually in preparation for another process.

PRINT

Writes data to the request, graphics, and output files when the defined event has the specified relationship to VALUE.

privilege

Described by the ANSI SQL Standard. A privilege is a right to access. For example: a relation privilege is a right to access a relation (table or view) within a database.

GL - 14

Glossary

process

Entity composed of a program or series of programs.

Program Manager

The main window in Microsoft Windows, used to start applications and open documents. It also organizes the applications and documents into groups. Within these groups reside icons that represent each application and document.

prompt

Text displayed by a command that tells you the inputs expected by that command.

prompt field

Menu gadget that displays prompt messages to the user.

query

A search in a database.

query criteria

Values used to limit a database search.

raster

Pattern of horizontal scanning lines on the screen of a CRT: input data causes the beam of the tube to illuminate the correct pixels on these lines to produce the required characters, curves, and so forth.

raster data

Generic term that refers to a group of pixels. Each of these pixels has an associated color and together they form a viewable image.

raster data file

File containing raster data (pixels). Raster data files can be generated by optical scanner, video frame grabber, digital camera, interactive paint package, and so forth. Intergraph raster data files are characterized by specific data formats which are identified in the file headers.

raster file

See raster data file.

raster graphics

Term that may refer to raster data, canvases, or files.

RDBMS

Acronym for Relational Database Management System, the software that lets you organize, store, and manipulate data in a database.

real

Data type which stores a range of floating point numbers. The storage requirement and range of values are dependent on the computer and compiler.

record

Grouping of logically related data which can be manipulated as a single entity. One or more records make up a file or a table. Also known as a row or tuple.

relation

Table or view.

relation privilege

Privilege granted to a schema regarding its access to relations in other schemas.

Glossary GL - 15

relational database

Organizes data in two-dimensional tables to define relationships.

relational database management system

Database management system that adheres to concepts defined by the relational database model.

Relational Interface System

Intergraph software system that provides a generic interface for applications to access many popular relational database management systems.

relational operators

Operators used to test specified conditions. Used to search for ranges of database column values.

relative pathname

Sequence of directories leading from the current directory to a particular file. See also pathname and absolute pathname.

report

Standard and user-definable table format for information queried from the database.

report template

A template that can be processed against input data to produced formatted output.

resize

To change the size and position of a form or window.

resolution

Number of pixels of which a screen is composed. The greater the number of pixels, the higher the resolution.

RIS

Acronym for Relational Interface System, the software that lets different relational database management systems communicate with each other.

root

Element upon which an associative element or macro depends.

row

Grouping of logically related data which may be manipulated as a single entity. One or more rows make up a file or table. Also known as a record or tuple.

run

To execute a program or process.

runtime

Time at or during which a program or process is executed.

schema

Concept described by the ANSI SQL Standard as a collection of tables and views. Within RIS, this collection corresponds to the collection of tables and views within a database.

scripts

C-like statements that let you further customize reports.

scroll

To move vertically or horizontally through displayed text, symbols, or windows.

GL - 16

Glossary

select

To activate a command. This can be done by the user or software.

set

Grouping of items that can be manipulated as a single item.

Shamrock

Intergraph graphical user-interface toolkit for Windows NT.

shell

Body of commands providing interface to low level software. For example, a UNIX shell provides an interface between users and the UNIX kernel.

short

Data type which stores a range of integer values. Storage requirement and range of values are dependent on the computer and compiler.

slider

Numeric gadget that accepts and displays numerical values. Also, the three-dimensional portion of a slider gadget that moves along a linear track.

smallint

Data type which stores a range of integer values. Storage requirement and range of values are dependent on the computer and compiler.

SQL

Acronym for Structured Query Language.

statement

Word or group of words that has a specific meaning in a programming language.

stop

Terminate a job or process.

string

Sequence of characters.

Structured Query Language

Structured language designed for accessing relational database management systems.

syntax

Rules governing the structure and use of statements in a language.

system

Collection of information and processes designed to interact to complete a task.

table

Collection of data for quick reference, stored in sequential locations in memory or printed as an array of rows and columns of data items of the same type.

table, database

Collection of data rows (also known as tuples or records) and columns (also known as attributes or fields). A unit of storage described by the ANSI SQL Standard.

template library

A CLIX file that stores templates.

Glossary GL - 17

text

Graphic gadget used to label other gadgets.

text editor

Utility that lets you create an ASCII file.

text field

A field on a report template that prints a text string.

Tiled CCIT Group 4

An Intergraph modification of pure Group 4 compression. Data is compressed into tiles, with information describing the tiles written into the file header. When you want to view data from the file, only the pertinent tiles need to be decompressed. In most cases, the entire file does not have to be decompressed.

time field

A field on a report template that prints the time the report was processed.

toggle

To switch; to change between two alternatives. Also, a state gadget that can be used to change between two alternatives.

top line

A line on a report template that prints at the top to each page.

tuple

Record or a row.

type

Type of data that a programming variable can contain.

universe

A group of rows that match the current query criteria. A universe is generated by Process Query.

universe review

A formatted listing of the current universe. It contains all columns that are toggled on.

UNIX

General purpose operating system developed at Bell Laboratories in the late 60s and early 70s.

update active

Key-in mode that lets a user establish a new row in the current table. Used with Insert Row.

user

Person who uses a computer.

value

Numeric or character data.

variable

Quantity that can assume any one of a set of values.

vector

Quantity possessing both magnitude and direction, generally represented as a line. Vectors can be manipulated geometrically and are represented as a coordinate triple (x,y,z).

vector graphics

Graphics composed of traditional geometric elements such as lines, circles, curves, surfaces, and solids. Vector geometry can be represented by mathematical expressions defining all points on the geometry.

GL - 18

Glossary

version

The number associated with the specific release of a product.

vi

ASCII text editor available on many systems.

view

Concept described by the ANSI SQL Standard, used to combine tables or restrict access to columns in a table. A view looks and acts like a table, but does not actually store data.

window

Independent rectangular area which displays applications or documents and that can be moved, resized, reshaped, minimized, or maximized.

Windows NT

General purpose 32-bit operating system developed at Microsoft Corporation.

worksheet

A multiple column field that displays data from one or more rows.

workstation

Terminal that contains an internal CPU and can operate in a standalone mode or as part of a network.

Index IN - 1

Index

__________________________________________________________________________________________________________________________________________________

IN - 2

Index

Index IN - 3

Index

__________________________________________________________________________________________________________________________________________________

A accessing Database Edit 6-3 Report Builder 3-6 Add Query A-1 arrays U-5 automatic resizing U-5 ASCII Structure D-3 attaching schema 2-4 B Before You Begin 1-3 Binary Structure D-5 breakpoints editing 4-9 reviewing 4-9 setting 4-9 C Change All C-1 Change Row C-3 character user variables U-5 choose 1-4 code lists E-1 code slots adding E-3 deleting E-4 code values entering E-4 coded columns E-1 Column (Report Builder) C-4 column values changing 6-7 columns coded E-1, BB-7 key BB-5 defining BB-6 mslink BB-4 serial 6-7 timestamp CC-3 Copy Field C-8 Copy Line C-10

Counter (Report Builder) C-12 Current Row C-14 D Database Edit accessing 6-3 Date D-1 debugging scripts 4-6 Define Structure D-3 Delete All D-9 Delete Field D-10 Delete Line D-12 Delete Row D-13 Delete Space D-14 deleting rows D-9 deleting rows D-13 Derived D-15 document conventions 1-4 Dump Template D-17 E Edit Code E-1 Edit Field E-6 Edit Line E-7 Edit Query E-10 Edit Relations 2-8 Edit Report Parameters E-11 Edit Script 4-3 editing database values 6-7 environment variables AA-3 error messages DD-3 Exit E-13 F Field Format (Report Builder) F-1 Field Operations (Report Builder) F-4 fields column C-4 counter C-12 date D-1 derived D-15 formats F-1 numeric N-6

IN - 4

Index

fields (continued) page P-1 placing P-3 printing P-4 text T-1 time T-4 Fields On/Off F-3 function variable displaying 4-10 H help using on-line 1-5 I identify 1-4 INFORMIX serial columns 6-7 Initialize Query I-1 Insert Row I-2, U-3 − U-4 Insert Space (Report Builder) I-3 J join columns 2-6 multi-schema 2-7 outer join 2-7 K Key Column K-1 key columns BB-5 defining BB-6 key in 1-4 L libraries 2-6 line breakpoints 4-9 Line Operations (Report Builder) L-1 Line Script L-2 Load From Library L-5 loading templates query E-10 Locate Graphics L-8 logical operators A-2 M memory reallocation U-5 Modify Sort M-1 mouse 1-4 Move Field M-5

Move Line M-7 mscodelist BB-7 mslink BB-4 multi-schema joins 2-7 N New Blank report N-1 New Default report N-3 Numeric N-6 O off fields F-3 on fields F-3 on-line Help 1-5 outer join 2-7 P Page P-1 parts of the Help window 1-5 Place Field (Report Builder) P-3 Place Line P-5 placing fields P-3 column C-4 counter C-12 date D-1 derived D-15 numeric N-6 page P-1 text T-1 time T-4 print condition P-4 Process Query P-8 Process Report P-9 Q queries editing E-10 loading E-10 processing P-8 saving E-10 query criteria adding A-1 clearing I-1 creating 6-5 logical operators A-2 processing 6-5 relational operators A-2 substring searches A-1 using 6-5

Index IN - 5

R relational operators A-2 Report R-1 Report Builder accessing 3-6 reports blank N-1, 3-5 default N-3, 3-3 saving S-1 unrelated tables 3-5 reserved tables BB-3 reset 1-4 Review R-2 Review Variables 4-10 RIS Report Writer templates 2-5 RIS Schema Manager BB-4 rows changing values C-1 deleting D-9, D-13 inserting I-2, U-3 − U-4 reviewing R-2 unique identifying BB-3 S Save Report S-1 saving templates query E-10 schema attaching 2-4 schemas managing BB-4 Script Debugger 4-6 Script Debugger Dialog Options 4-6 scripts creating 4-3 editing 4-3 select 1-4 serial columns 6-7 Set/Review Breakpoints 4-9 sort keys M-1 space deleting D-14 inserting I-3 SQL Statements 7-3 structure templates ASCII D-3 binary D-5 user data D-7

Structured Query Language (SQL) 7-3 SQL statements alter table BB-5 create index BB-7 substring searches A-1 T tables adding mslink BB-4 altering BB-4 − BB-5 mscatalog BB-5 mscodelist BB-7 reserved BB-3 updating BB-4 Template Librarian 5-3 template libraries 2-6 maintaining 5-3 templates 2-5 ASCII structure D-3 binary structure D-5 report ASCII dump D-17 blank N-1, 3-5 default N-3, 3-3 processing P-9 saving S-1 unrelated tables N-1, 3-5 user data structure D-7 templib 5-3 Text (Report Builder) T-1 Text Size T-3 Time T-4 timestamp columns CC-3 U Undelete Field U-1 Undelete Line U-2 unique row identification 6-7 universe of rows P-8, 6-5 universe review R-2 unrelated tables N-1 reports 3-5 Update Active U-3 Update Row U-4 updating database values 6-7 User Variable U-5 user variables arrays U-5 character U-5 Userdata Structure D-7

IN - 6

Index

using on-line help 1-5 utilities schema management BB-4 V variables environment AA-3 viewing on-line Help 1-5