Uniformance 150

Toolset Database
Reporter
User Guide
Copyright, Notice, and Trademarks

Copyright, Notices, and Trademarks

© Honeywell Inc. 1998 – 1999. All Rights Reserved.
Release 150 – July 30, 1999
While this information is presented in good faith and believed to be accurate, Honeywell disclaims the implied warranties
of merchantability and fitness for a particular purpose and makes no express warranties except as may be stated in its
written agreement with and for its customers.
In no event is Honeywell liable to anyone for any indirect, special or consequential damages. The information and
specifications in this document are subject to change without notice.

Honeywell, TotalPlant, Uniformance, and Business.FLEX are U.S. registered trademarks of Honeywell Inc.
Other brand or product names are trademarks of their respective owners.

Release Information
Uniformance 150
Revision 1
Revision Date: July 30, 1999
Document Number: TL-060.1

Honeywell Inc.
Industrial Automation and Control
Automation College
2820 West Kelton Lane
Phoenix, AZ, 85023-3028

ii • Uniformance Toolset Database Reporter User Guide

 Contents

Contents
Copyright, Notices, and Trademarks ii

Release Information ii

Understanding the Database Reporter 5

Forms 7
SQL Query Configuration 7

Understanding the Database Reporter 9

Configuration Procedure 11
SQL Query Configuration 11

Database Reporter 12

Configuration Sources 13
SQL Query Configuration 13

Database Reporter 13

Glossary 15

Index 17

Uniformance Toolset Database Reporter User Guide • iii

 Understanding the Database Reporter

Understanding the Database

Reporter

The Database Reporter is used to query and report data stored in the Relational
Database Management System (RDBMS). The Database Reporter consists of the
following two components:
Component Description

SQL Query SQL Query Definition is a tool used to define and save
SQL queries. SQL queries can be executed interactively
or used as part of a report defined through the DB
Reporter.
DB (Database) Reporter The DB Reporter groups multiple queries defined through
the SQL Query Builder. With the DB Reporter you can
query output to browse interactively, print, and optionally
save to a file.

Uniformance Toolset Database Reporter User Guide • 5

 Forms

Forms

SQL Query Configuration

The SQL Query Configuration form allows you to define queries to access the
relational database. This is useful when the existing set of standard reports do not
supply the required information. Queries are saved in the database and accessible by
any user with access to the form. Only the owner of the query can update or delete
the query definition.
The query can be executed from the form by using the Test Query button located in
the title bar of the form. The query runs interactively on the user's workstation, and
when completed, the results display on the workstation. You can scan the output and
then print to the default printer if desired. Validation of the SQL statement occurs at
run-time, verifying the statement to be syntactically correct and to be a SQL Select
statement. If the query is not a valid SQL Select statement, an error message
displays.
The following buttons appear on the SQL Query Configuration form title bar:
Click… To…

Test Query Execute the query and display the results on the tabular
format providing the ability to test the logic of the query
and detect any syntax errors.
Enter Query Search for any SQL Query Configurations stored within the
database.

Uniformance Toolset Database Reporter User Guide • 7

Forms

Following is the SQL Query Configuration form:

The following fields appear on the SQL Query Configuration form. The asterisk (*)
indicates mandatory fields.
In this field… Do this…
*Query Name Indicate the name of the query.
Owner Name Indicate the system-generated name of the user who
created the query. You cannot edit this field.
*Description Enter a brief description of the query.
*SQL Statement Enter the SQL Select statement. The statement may span
multiple lines. There is no validation of this field until the
SQL Statement is executed with the Test SQL button.

8 • Uniformance Toolset Database Reporter User Guide

 Forms

Understanding the Database Reporter

The Database Reporter form allows you to define reports or file extracts using one or
several queries defined using the SQL Query form.
Click the Execute Report button located in the title bar to display the form. The
query runs interactively on your workstation, and when complete, you can use an
ASCII file editor such as NotePad or WordPad to open the output file and view the
results.
The system validates and verifies the SQL statement at run-time to be syntactically
correct as a SQL Select statement.
The following buttons appear on the title bar of the Database Reporter form:
Click… To…
Execute Report Execute the report as defined and write the results to the
file name indicated in the Output File field.
Enter Query Search for any database reporter records stored within the
database.

Following is the Database Reporter form:

Uniformance Toolset Database Reporter User Guide • 9

Forms

The following fields appear on the Database Reporter form. The asterisk (*) indicates
mandatory fields.
In this field… Do this…
Report Name Indicate the report name.
Owner Name Indicate the system-generated name of the user who
created the record. This field is read-only.
Title Indicate the title that appears on the report or extract.
Sub Title Indicate the sub-title that appears on the report or extract.
X Axis Indicate the label for the X Axis for the extract.
Y Axis Indicate the label for the Y Axis for the extract.
*Format Indicate the type of output file format. The Lookup
Configuration information with a lookup type of EXTFMT
provides validation.
Output File Indicate the name of the output file. Used if the report is
executed from this form.
*Query Indicate the name of the query to be executed. The SQL
Query Configuration information provides validation.
*Seq Indicate the execution sequence of the query list.

10 • Uniformance Toolset Database Reporter User Guide

 Configuration Procedure

Configuration Procedure

SQL Query Configuration

The SQL Query Configuration form allows you to define queries to access the
relational database. This is useful when the existing set of standard reports do not
supply the required information. Queries are saved in the database and accessible by
any user who has access to the form. Only the owner of the query can update or
delete the query definition.

To define a query to access the relational database:

1. Choose the Form: SQL Query Configuration from the Database Reporter menu.
2. Select the Query Name field and enter a unique query name.
3. Select the Description field and provide additional information or comments
about the query.
4. Select the SQL Statement field and enter the Select statement. Click the Test
Query button to ensure all syntax and logic errors are fixed.
5. Save the entry to the database. The Owner Name field is set to the user name
when you save the entry to the database.

Uniformance Toolset Database Reporter User Guide • 11

Forms

Database Reporter
The Database Reporter form allows you to define reports and file extracts using
queries set-up in the SQL Query form.

To define a report:
1. Choose the Form: Database Reporter from the Database Reporter menu.
2. Select the Report Name field and enter a unique report name.
3. Select the Format field and select the value form the list. The Lookup
Configuration information with a lookup type of EXTFMT provides validation.
4. Select the Seq field and enter the unique sequence number for the entry.
5. Select the Query Name and select the query name. The SQL Query Definition
information provides validation.
The following fields are optional on the form. You may enter these fields depending
on your preferences.
In this field… Do this…
Title Identify the text to appear in the report title of the report or
extract output.
Sub-Title Identify the text to appear as the report sub-title of the
report or extract.
X Axis Identify the X Axis label for extract reports.
Y Axis Identify the Y Axis label for extract reports.
Output File Identify the output file path. This path is required when you
initiate the report using the Execute Report button located
in the title bar of the form.
Owner Name Identify the user name that will be saved when you save
the entry to the database.

12 • Uniformance Toolset Database Reporter User Guide

 Configuration Sources

Configuration Sources

SQL Query Configuration

In this field… Do this…

*Query Name Indicate the name of the query.

Owner Name Indicate the system-generated name of the user who
created the query. You can not edit this field.
*Description Enter a brief description of the query.
*SQL Statement Enter the SQL Select statement. The statement may span
multiple lines. There is no validation of this field until the
SQL Statement is executed with the Test SQL button.

Database Reporter
In this field… Do this…

Report Name Indicate the report name.

Owner Name Indicate the system-generated name of the user who
created the record. This field is read-only.
Title Indicate the title to appears on the report or extract.
Sub Title Indicate the sub-title to appears on the report or extract.
X Axis Indicate the label for the X Axis for the extract.
Y Axis Indicate the label for the Y Axis for the extract.
*Format Indicate the type of output file format. The Lookup
Configuration information with a lookup type of EXTFMT
provides validation.
Output File Indicate the name of the output file. Used if the report is
executed from this form.
*Query Indicate the name of the query to be executed. The SQL
Query Configuration information provides validation.
*Seq Indicate the execution sequence of the query list.

Uniformance Toolset Database Reporter User Guide • 13

 Glossary

Glossary

query
A Query is a SQL statement, which retrieves data from a relational database and
returns data to the requester. The Select statement is the method in which the data is
queried. For additional information regarding the Select statement, refer to The SQL
Language Reference Guide published by the Rdbms vendor.

SQL
Structured Query Language is the language used to manipulate and retrieve data from
most relational database systems. Retrieval of data is performed using the Select
statement, for example Select* FROM<TABLE_NAME>(where TABLE_NAME is
the name of an actual relational database table). For additional information, refer to a
SQL Language Reference Guide published by the RDBMS vendor.

Uniformance Toolset Database Reporter User Guide • 15

 Index

Index quering
data from the RDBMS 5
names on the SQL query configuration forms 8,
11–13
the SQL query forms 7–13
B
S
building the SQL query 5
saving
SQL queries 5
C
SQL queries
configuring SQL queries 11, 13 configuration 7
fields 13
D
formatting 7, 11
defining
a query to access the relational database 11 U
reports or file extracts 9, 12 understanding
SQL queries 11 fields in the database reporter 13
SQL query configuration 7 the database reporter 5, 9
SQL query forms 7–8 using
forms 7
E
the description field on SQL query 11
executing the test query 7
a report 9–10
from the SQL query form 7 V
interactive SQL queries 5 validating SQL statements 7–9
verifying SQL statements 7, 9
F
fixing syntax and logic errors 11 W
windows
I
database reporter form 9
interactive SQL queries 7, 9 SQL query configuration 8

O
opening the output file 9–10

Uniformance Toolset Database Reporter User Guide • 17