b0193lj e Report Writer

® B0193LJ
REV E
I/A Series®
Report Writer
October 15, 1999
Help Archive/Restore Select Configure Exit
Report Scheduler
Report Name: odaily
DEMAND
REPORT
Day of the week: Everyday DELETE
Month: EveryMonth SCHEDULE
UPDATE
Day: * Hour: 09 Minute: 15 SCHEDULE
Currently Scheduled Reports
Report DoW Mon Day Hour Min Page
/usr/fox/rptwrt/rpt_run/RunReport mnthly 1
* * * * *
/usr/fox/rptwrt/rpt_run/RunReport weekly 1 1 1 1 1
/usr/fox/rptwrt/rpt_run/RunReport daily
/usr/fox/rptwrt/rpt_run/RunReport shift * * * * *
/usr/fox/rptwrt/rpt_run/RunReport odaily * * * * *
* * * * *
Foxboro and I/A Series are registered trademarks of the Foxboro Company.
INFORMIX is a trademark of INFORMIX Software, Inc.
Solaris is a trademark of SunSoft, Inc.
SunOS is a trademark of Sun Microsystems
VENIX is a trademark of VenturCom, Inc.
Copyright 1992-1999 by The Foxboro Company

All rights reserved
SOFTWARE LICENSE AND COPYRIGHT INFORMATION

Before using the Foxboro supplied software supported by this Foxboro documentation, you
should read and understand the following information concerning copyrighted software.
1. The license provisions in the Foxboro Software License for your system govern
your obligations and usage rights to the software described in this documentation.
If any portion of those license provisions is violated, The Foxboro Company will
no longer provide you with support services and assumes no further responsibili-
ties for your system or its operation.
2. All software issued by The Foxboro Company, and copies of the software that you
are specifically permitted to make, are protected in accordance with Federal copy-
right laws. It is illegal to make copies of any software media provided to you by
The Foxboro Company for any purpose other than those purposes mentioned in
the Foxboro Software License.
Contents
Figures............................................................................................................................... v
Tables.............................................................................................................................. vii
Preface.............................................................................................................................. ix
Reference Documents ........................................................................................................ ix
Revision Information ......................................................................................................... ix
1. Overview ..................................................................................................................... 1
Data Sources ....................................................................................................................... 1
Report Types ...................................................................................................................... 3
Field Types ......................................................................................................................... 3
Components ....................................................................................................................... 4
2. Report Configuration .................................................................................................. 5

Configuration Overview ...................................................................................................... 5
Creating New Report ..................................................................................................... 5
Report Configuration Window .................................................................................. 7
Page Length ............................................................................................................... 8
Text Entry ................................................................................................................. 8
Field Definition ......................................................................................................... 8
Saving Report Configuration ..................................................................................... 9
Editing Report ................................................................................................................ 9
Loading Report Configuration ................................................................................... 9
Editing Text ............................................................................................................... 9
Editing Field .............................................................................................................. 9
Resizing Fields in Report Writer ................................................................................ 9
Copying Report Configuration ....................................................................................... 9
Printing Report Configuration ....................................................................................... 9
Printing Report Configuration File .......................................................................... 10
Printing Sample Report ........................................................................................... 10
Exiting Report Configurator .................................................................................... 10
Configuration Examples .................................................................................................... 10
Historian Configuration for Report Examples .............................................................. 10
Configuration Procedures ............................................................................................. 12
Accessing Report Configurator ................................................................................ 12
Entering Report Name ............................................................................................. 12
Text Entry ............................................................................................................... 12
iii
B0193LJ – Rev E Contents
File Configuration ................................................................................................... 13

Data Source Definitions ........................................................................................... 13
Defining Report Fields ............................................................................................. 14
Saving Report Configuration ................................................................................... 16
Accessing Report Configurator Display ............................................................................. 16
Top Menu Bar Functions .................................................................................................. 16
File Menu ..................................................................................................................... 17
Edit Menu .................................................................................................................... 18
GoTo Menu ................................................................................................................. 18
Text Entry ......................................................................................................................... 19
Configuration Windows ................................................................................................... 19
File Configuration Parameters ...................................................................................... 19
Data Source Configuration ........................................................................................... 20
Field Definition ............................................................................................................ 22
Parameters on Field Definition Window .................................................................. 23
Soft Keys on Field Definition Window .................................................................... 24
Offline Configuration ....................................................................................................... 30
3. Report Scheduler ....................................................................................................... 33

Accessing Report Scheduler ............................................................................................... 33
Top Menu Bar Functions .................................................................................................. 34
Parameter Fields ................................................................................................................ 35
Soft Keys ........................................................................................................................... 36
Running Reports on Demand ........................................................................................... 36
Scheduling Reports ........................................................................................................... 37
Archiving, Deleting, and Restoring Reports ...................................................................... 38
Printing Reports ................................................................................................................ 39
Setting Archive/Restore Environment ............................................................................... 39
Index .............................................................................................................................. 41
iv
Figures
Sample Daily Report “daily” ..................................................................................................... 2
Accessing Report Configurator .................................................................................................. 6
Report Configurator Base Display - Typical (1 of 2) ................................................................. 6
Report Configurator Base Display - Typical (2 of 2) ................................................................. 7
Report Configuration Window (Typical) .................................................................................. 7
Field Definition Window (Typical) ........................................................................................... 8
Report Program Scheduler Display (Typical) .......................................................................... 34
v
B0193LJ – Rev E Figures
vi
Tables
Output Line Maximums* for Report and Field Types ............................................................... 3
Reduction Group Specifications .............................................................................................. 11
Field Definitions for Report “daily” ........................................................................................ 15
vii
B0193LJ – Rev E Tables
viii
Preface
This document provides guidelines for using the I/A Series Report Writer. It describes how to
configure, schedule, and execute reports from workstation displays provided by the Report
Writer. A sample report configuration file and its output are included for your reference.
Reference Documents
For further information on relevant topics, refer to the following I/A Series documentation:
♦ Historian (B0193BL)
♦ Real-Time Database Manager: INFORMIX-SQL (B0193BT)
♦ System Operations Guide (B0193CR)
♦ Workstation Configuration (B0193AG)
Revision Information
For Release 6.2.1, Summaries were added to the beginning of each chapter.
ix
B0193LJ – Rev E Preface
x
1. Overview
This chapter gives a general overview of the Report Writer and its components,
including data sources, report types and field types.
The Report Writer is a general purpose report definition and execution facility for the
Foxboro I/A Series environment. The graphic interface of the Report Writer makes it an easy-
to-use tool for specifying the format and content of a printed report, based on Foxboro
I/A Series Historian data and process control points. Figure 1-1 shows the printout for a sam-
ple daily report.
The Report Writer has two graphic interface programs:
♦ Report Configurator
♦ Report Scheduler
The Report Configurator provides a graphic interface for specifying the format and content of
the report.
The Report Scheduler provides a graphic interface for generating reports at regular intervals or
on demand.
You access these programs from an I/A Series environment pull-down menu. By default, they
are placed in the Configurators (Config) menu.
Data specification is generic enough to support the most commonly used sources of data:
♦ Historian reduced data.
♦ Instantaneous process point values from the Object Manager.
♦ INFORMIX databases that contain point id (Compound:Block.Parameter), time,
and data values in a single table or in two tables joined by a common key value.
Data Sources
A data source is one of the following classes of data supported by the Report Writer:
♦ Historian
♦ Single INFORMIX Table
♦ Joined INFORMIX Table
♦ Object Manager
A data source is one of these classes of data with the necessary parameters that enable the
report programs to locate and retrieve data. For example, a historian database name such as
"hist01" and the name of a reduction group and reduction operation are the parameters
needed to define a data source of the Historian class.
You specify the parameters for each data source including a mnemonic name that is used for
later reference when defining field parameters.
1
B0193LJ – Rev E 1. Overview
Sample Daily Report - daily Page 1

---------------------------------------
From Thu Dec 5 00:00:00 1991 To Thu Dec 5 23:59:59 1991
Dec 6 1991 11:27:43
TIME HT1:CLAC1.RI01 HT1:CALC1.RI02 HT1:CALC1.RI03 HT1:CALC1.RI04
avg max min sum
-----------------------------------------------------------------------------------------------------------------------------------------------
0:00 16.47 42.58 51.61 4597.69

1:00 16.52 41.79 47.90 4586.61
2:00 16.68 42.17 49.99 4608.38
3:00 16.52 40.84 50.97 4597.04
4:00 16.26 42.07 51.85 4582.49
5:00 16.44 42.09 51.06 4581.38
6:00 16.25 42.32 50.83 4611.38
7:00 16.15 42.56 50.91 4569.75
8:00 16.44 43.48 50.92 4609.42
9:00 17.09 41.82 51.02 4586.43
10:00 16.44 42.98 47.59 4585.81
11:00 16.52 44.94 51.42 4577.25
12:00 16.46 41.28 51.52 4592.08
13:00 16.47 42.85 51.13 4578.99
14:00 16.06 42.70 52.37 4576.28
15:00 16.49 41.63 50.50 4548.07
16:00 16.59 43.35 50.08 4557.87
17:00 16.70 43.76 51.71 4583.42
18:00 16.28 45.10 50.50 4609.58
19:00 16.62 41.32 51.86 4591.19
20:00 16.50 44.02 50.55 4618.59
21:00 16.21 42.78 49.94 4586.18
22:00 16.17 41.51 52.00 4590.60
23:00 16.79 40.30 51.26 4596.76
Daily Average 16.46 42.51 50.81 4588.47
Daily Maximum 17.09 45.10 52.37 4618.59
Daily Minimum 16.06 40.30 47.59 4548.07
Daily Total 395.12 1020.24 1219.48 110123.20
0:00 16.47 42.58 51.61 4597.69
- Report End -
=======================================================================
Figure 1-1. Sample Daily Report “daily”
2
1. Overview B0193LJ – Rev E
Report Types
Central to the entire Report Writer is the idea of a report type. The report type is simply a
specification of the time period a report covers. Thus the valid types are:
♦ Monthly
♦ Weekly
♦ Daily
♦ Shift
♦ Hourly
The exact period of time covered by each of these report types depends on the way you invoke
the report execution program. If you do not specify the date or time parameter, the time
period will be the last complete time period of the specified type.
For example, executing the command
mnthly
where mnthly defines a Monthly report and the time is currently 8:30 am on June 5, will pro-
duce a report for 0:00 am May 1 through 23:59 pm May 31.
Invoking the report execution program with a time or date parameter will produce a report
starting immediately AFTER the last complete time period prior to the specified time and
ending at the specified time. For example, executing the command
mnthly 6-5-91 7:30:00
will produce a report for 0:00 am June 1 through 7:30 am June 5, 1991. If you do not enter
the time, the current time is taken as the end time of the report, e.g., 8:30 am.
Field Types
A field is a variable element on a report. Like reports, fields can be assigned various types. The
same types are valid as for reports. The type specifies the period of time for which data will be
retrieved for producing the field output. Combining different report types and field types pro-
duces dramatic report contents with very little effort. Table 1-1 summarizes the effects of the
possible combinations.
Table 1-1. Output Line Maximums* for Report and Field Types
Report Type
Field Type Monthly Weekly Daily Shift Hourly
Monthly 1 1 1 1 1
Weekly 5 1 1 1 1
Daily DPM 7 1 1 1
Shift ** SPD X 7 SPD 1 1
Hourly ** ** 24 24/SPD 1
* DPM = Number of days in the report month; SPD = Configured shifts per Day
** = Not available, Limited to a page
Report Types 3
B0193LJ – Rev E 1. Overview
A field type that is a smaller time period than the report type will produce a list, a sub-period
value, or an operation on all sub-periods. Functions that produce lists cannot be further mod-
ified to perform on sub-periods. These are the LIST, DAY_OF_MONTH, DAY_OF_WEEK
and HOUR_OF_DAY functions. They will always produce a list of the size indicated in
Table 1-1.
Numeric operation functions, such as AVERAGE, MINIMUM, and MAXIMUM, allow the
user to select a particular sub-period of the report, e.g., Day 1 of a Weekly report. The
numeric operation is then performed on all data values for the specified day.
Entering a sub-period value of zero causes the numeric function to be performed for the SUM
OF THE VALUES IN ALL SUB-PERIODS. For example, a Daily field in a Monthly report
with the Day set to zero in the Sub-period entry, and a function of MINIMUM will produce
the smallest of the sums of the data values for each day in the report month. This allows the
numeric fields to be placed at the end of list fields and produce accurate results with respect to
the generated list, which is the sum of all values within each list item’s implicit sub-period.
Components
The Report Writer consists of the following programs.
♦ Report Configurator
♦ Report Execution Program
♦ Report Scheduler
The report configurator is a graphic application for specifying the format and content of the
report. You operate the configurator from a Workstation Processor 20, 30, or 50/51 (WP20,
WP30, or WP50/51), or a Personal Workstation (PW). The configurator runs on an Applica-
tion Processor 20 or 50/51 (AP20 or AP50/51), a PW, and an AW50/51.
The report execution program is a non-interactive VENIX program which receives a report
configuration file as input and produces an instance of a report relative to the time at which it
was run.
The system task server provides access to VENIX file manipulation commands for both the
configurator and the report execution program. It must be running on the AP20, AP50/51, or
PW that hosts the Report Writer.
The Report Scheduler is a graphic interface for scheduling the Report runtime routines to
execute at regular intervals or for executing a report on demand. You operate the Scheduler
from a WP20, WP30, WP50/51, or PW. The Scheduler runs on an AP20, AP50/51, or PW.
4
2. Report Configuration
This chapter gives a general overview of report configuration, including
configuration examples, accessing configuration displays, top menu bar functions,
text entry, configuration windows, and off-line configuration. It provides specific
instructions on creating a new report, editing, copying and printing it, and
defining report fields.
The base configuration display allows you to define formatted templates for the reporting of
data. You have access to numerous functions using the top menu bar options.
You use the mouse or trackball, and the keyboard to specify the location and content of text
(literal) information and data areas (fields).
Configuration Overview
From an I/A Series environment, you can access the Report Configurator (RptCfg) from the
Configurators (Config) pull-down menu, as shown in Figure 2-1. You use the Report Config-
urator base display and two windows to layout and configure your reports. These windows are
the Report Configuration and Field Definition windows.
Creating New Report

From the Report Configurator Base Display, select File from the top menu bar, select Load
from the File pull-down menu, and enter the new report name or select one of the pre-for-
matted reports in the Load menu. Figure 2-2 shows the Report Configurator Base Display
with the layout for sample report “daily.”
Next, select Config from the File pull-down menu. This displays the Report Configuration
window shown in Figure 2-4. This window consists of two sections:
♦ File Configuration (File Config)
♦ Data Source Definition
5
B0193LJ – Rev E 2. Report Configuration
Sys Alarm Help Select

Change_Env
Sys Alarm Help Select

Process_Eng_Env
Sys Alarm Help Config Disp Disp_1 Disp_2 Disp_3 SftMnt Select
RptCfg
Figure 2-1. Accessing Report Configurator
Help File Edit Field GoTo Schedule Exit

Daily Report, daily
Sample Daily Report - daily Page>R2<
>R4C4 <
>R6C3 >R6C18
TIIME HT1:CALC1.RI01 HT1:CALC1.RI02 HT1:CALC1.RI03 HT1:CALC1.RI04
avg avg avg avg
R12C3 R12C17 R12C34 R12C51 R12C68
Page 1 or 1 Lines 1-20 of 65 cols. 1-80 of 80 #Fields: 25
Figure 2-2. Report Configurator Base Display - Typical (1 of 2)
6
2. Report Configuration B0193LJ – Rev E

Daily Report, daily
DAILY AVERAGE R37C17 R37C34 R37C51 R37C68
DAILY MAXIMUM R39C17 R39C34 R39C51 R39C68
DAILY MINIMUM R41C17 R41C34 R41C51 R41C68
DAILY TOTAL R43C17 R43C34 R43C51 R43C68
-Report End-
Page 1 or 1 Lines 1-20 of 65 cols. 1-80 of 80 #Fields: 25
Figure 2-3. Report Configurator Base Display - Typical (2 of 2)
Daily report, daily

File Config
Report Name: daily
Report Type: daily Page Width: 80
OK
Start Hour: 0 Page Length: 65
Start DOW: Sunday Horiz. Pan: 52
CANCEL
Shifts/Day: 3 Printer: LP05 Vert. Pan: 15
Mnemonic: h01hoursum NEXT

Class: Historian
PREVIOUS
Historian: ht3201:
SAVE
Reduc. Group: hour_val Reduc. Operation: hoursum
VERIFY
Figure 2-4. Report Configuration Window (Typical)
Report Configuration Window

In the upper, File Config section, you can set or change basic report parameters from their
default values.
In the lower, Data Source Definition section, you can enter parameters to define instances of
the various data classes supported by the Report Writer.
Configuration Overview 7
After entering, verifying, and saving data source definitions, select OK to return to the Report
Configurator base display.
Page Length
A single report page contains 65 lines. A page length of 66 lines results in a 65 line page being
printed, followed by a second page with one line. The default page length in the Report Con-
figurator has been changed from 66 to 65. Any new chart that is configured now has a default
page length of 65 lines. Users are advised to modify existing report configurations to have a
maximum page length of 65 lines.
Text Entry
On the base display, pressing the left key on the mouse or trackball lets you type text, starting
at the position of the pointer, for headings and labels. Text input stops when you press the
Return (Enter) key.
Field Definition
On the base display, pressing the right key on the mouse or trackball displays the Field Defini-
tion window (Figure 2-5) with default row, column, and field name, based on the location of
pointer when the mouse or trackball key was pressed.
Select OK to save a field definition and return to the base display.

Daily report, daily
File Definition
Field Name: R12C17
Row: 12 Report period: Daily
Column: 17
Field Type: Hourly
Function:
LIST h01houravg /HT1:CALC1.RI01
PREVIOUS FUNCTION FIELDS POINTS Select Compound
HT1 OK
Scale: 1.000000 HT2
Discrete Value Labels: SEQ_MSGS10P DELETE
SEQ_MSGS10Q
Format: 8.2 00000. SEQ_MSGS10R
CANCEL
SEQ_MSGS10S
Figure 2-5. Field Definition Window (Typical)
8
Though it is possible to configure more then 99 fields per page, this is not recommended. See
the CAUTION note in the section titled “Field Definition” on page 22.
Saving Report Configuration

Pull down the File menu, select Save from it, and enter a report name in the Save menu. If
you select Exit before saving the report configuration, you will be prompted to save any
changes before exiting.
Editing Report
Loading Report Configuration

On the base display, pull down the File menu and then, select the Load option. This displays
a file selection menu from which you can select an existing report.
Editing Text
You edit text in the same way you enter it. You can type over text. The Edit menu provides
handy Mark, Cut, Copy and Paste functions which you can use to delete and copy text and
fields.
Editing Field
You can modify a field by moving the pointer to any character in the field, whether a list or
single line item, and clicking the right key on the mouse or trackball. This displays the Field
Definition window with the selected field's information on it.
Resizing Fields in Report Writer

Before enlarging the size of a field, users should make sure that adjacent fields are moved out
of the way. This prevents the enlarged fields from “overlapping” the adjacent fields and mak-
ing them unpickable (in which case the user must shrink the enlarged field).
Copying Report Configuration

To configure a report similar to an existing one, load the existing report, select SaveAs from
the File menu, and enter the new report name in the SaveAs menu. To edit the new report,
select Clear from the File menu and load the new report. This procedure avoids inadvertently
changing a report by selecting Save instead of SaveAs when you are through editing.
Alternately, you can load the existing report, edit it, select SaveAs from the File menu, and
enter the new report name in the SaveAs menu. Be sure you select SaveAs and not Save.
Printing Report Configuration

To access the print options menu, load the desired report, pull down the File menu, and select
Print from it.
Printing Report Configuration File

To print out the report configuration file, select “Config. Info” in the print options menu.
This sends the configuration file to the printer configured in the Report Configuration win-
dow.
Printing Sample Report

The “Current Page” and “All Pages” options of the print options menu produce sample report
output for the specified page in which all field data is represented by “underline” characters
(e.g.,____).
Exiting Report Configurator

Pull down the File menu, select Save, and then, select Exit from the top menu bar. Alternately,
you can select EXIT and then, respond to the dialog box asking if you want to save or discard
any changes.
Configuration Examples
The Report Writer configuration database includes examples of each report type for your ref-
erence. The following examples are available by selecting 'Load' from the File pull-down
menu:
♦ daily
♦ mnthly
♦ odaily
♦ shift
♦ weekly
Figure 1-1 in Chapter 1 “Overview” shows a printout for the report “daily” executed by the
Report Scheduler.
Use the Report Configuration and Field Definition windows to view the configuration speci-
fications for these examples.
For tutorial purposes, configuration requirements for the report “daily” are described in fol-
lowing sections.
Historian Configuration for Report Examples

The example reports listed in the previous section, except for “odaily,” use the following
reduction groups in a Historian named “ht3201”:
♦ hour_val
♦ daily_val (cascaded)
Table 2-1 lists the configuration specifications for these reduction groups. Refer to the
Historian document for configuration procedures.
10
Table 2-1. Reduction Group Specifications
Specification hour_val daily_val

Reduction Period 60 minutes 24 hours
Phasing Delay 0 0
Sampling Period 1 minute 0
Minimum Span for Reduction 30 minutes 12 hours
Data Retention Time Span 24 hours 744 hours
(31 days)
Reduction Operations avg avg
max max
min min
sum sum
Storage Columns houravg dailyavg
hourmax dailymax
hourmin dailymin
hoursum dailysum
Members HT1:CALC1.RI01 hour_val
HT1:CALC1.RI02
HT1:CALC1.RI03
HT1:CALC1.RI04
For group “hour_val,” each member point (C:B.P) is sampled every minute for one hour. For
each point, the 60 samples are reduced every hour and the results are stored in the appropriate
storage column. For a Data Retention Time Span of 24 hours, the Historian stores up to 24
reduced values in each storage column before overwriting the oldest values.
For the “hour_val” sum operation, the 60 sampled values are summed and the result is stored
in storage column “hoursum” on a per point basis. After 24 hours, “hoursum” contains 24
sums for each of the four member points.
Cascaded group “daily_val” uses data from group “hour_val.” Every day, “daily_val” reduction
operations are run on values stored in “hour_val” storage columns, and the results are stored
in the appropriate storage columns. For a Data Retention Time Span of 31 days, the Histo-
rian stores up to 31 reduced values in each storage column before overwriting the oldest val-
ues.
For the “daily_val” sum operation, the 24 “hour_val” sums are summed and the result is
stored in storage column “dailysum” on a per point basis. After 31 days, “dailysum” contains
31 sums for each of the four points.
For information on retrieving data from the Historian for scheduled reports, see the Cautions
on page 36 and page 38.
Configuration Examples 11
Configuration Procedures
To configure a daily report similar to the sample report “daily,” use the following procedures.
Accessing Report Configurator

1. Select “Config” from I/A Series environment (top) menu bar to pull down Config-
urators menu. See Figure 2-1 in Chapter 2 “Report Configuration”.
2. Select “RptCfg” from Configurators menu to call up the Report Configurator
Base Display. Figure 2-2 in “Creating New Report” on page 5 shows base display
with report “daily” loaded on it.
Entering Report Name

1. On base display (see Figure 2-2), select File from top menu bar to pull down File
menu.
2. Select Load from File menu to display Load menu.
3. Enter new report name in entry field on Load menu. This calls up base display
where screen area for report layout is blank.
Text Entry
Enter report title, column heading and subheading, and summary calculation text strings by
moving cursor to appropriate location on screen, pressing the left key on the mouse or track-
ball, typing the text string, and pressing Enter.
Figure 2-2 shows the location of the following text strings for sample report “daily:”
Sample Daily Report - daily
TIME
HT1:CALC1.RI01
HT1:CALC1.RIO2
HT1:CALC1.RI03
HT1:CALC1.RIO4
avg
max
min
sum
DAILY AVERAGE
DAILY MAXIMUM
DAILY MINIMUM
DAILY TOTAL
12
File Configuration
1. On base display, select “File” from top menu bar to pull down File menu.
2. Select “Config” from File menu to call up Report Configuration window.
3. On File Config section of Report Configuration window, use <> keys or keyboard
to define file configuration parameters.
File configuration parameters for report “daily” are defined as follows:
Report Type:
Daily
Start Hour:
0
Start DOW:
Sunday
Shifts/Day:
3
Printer:
LP05
Page Width:
80
Page Length:
65
Horiz. Pan:
52
Vert. Pan:
15
Data Source Definitions

1. On Data Source Definition section of Report Configuration window, use <> key
or keyboard to define parameters for a data source. These parameters change for
each class of data.
2. Select VERIFY key to verify your source definition. Correct any errors.
3. Select SAVE key to save the definition.
4. Select NEXT key and answer dialog box that pops up. Use PREVIOUS or
DELETE key as required and answer dialog box that pops up.
5. Repeat Steps 1 through 4 for all data sources.

Data source definitions for report “daily” are as follows:
Source 1:
Mnemonic: h01hoursum
Class: Historian
Historian: ht3201
Reduc. Group: hour_val
Reduc. Operation: hoursum
Source 2:
Mnemonic: h01houravg
Class: Historian
Historian: ht3201
Reduc. Operation: houravg
Source 3:
Mnemonic: h01hourmax
Class: Historian
Historian: ht3201
Reduc. Operation: hourmax
Source 4:
Mnemonic: h01hourmin
Class: Historian
Historian: ht3201
Reduc. Operation: hourmin
Defining Report Fields

1. On base display, move cursor to appropriate location, and press right key on
mouse or trackball to display Field Definition window.
2. Use default settings for following parameters:
♦ Field Name
♦ Row
♦ Column
♦ Report Period
♦ Scale
♦ Discrete Value Labels
3. Use <> key to set Field Type.
4. Select FUNCTION key to display list of functions.
14
5. Select desired function from list. This displays function name in Function entry
field. Page list of functions as required.
6. If function does not require a point source (e.g., PAGE_NUMBER), go to
Step 12. Otherwise, go to next step.
7. Select POINTS key to display list of data source mnemonics.
8. Select desired data source mnemonic from list. This displays list of compounds.
9. Select desired compound from list. This displays list of blocks.
10. Select desired block from list. This displays list of parameters.
11. Select desired parameter from list. This displays data source mnemonic and C:B.P
in Function entry field.
12. Enter desired value (e.g., 8.2) in Format field. This means a width of 8 with 2 dec-
imal places, e.g., 00000.00.
13. Select OK to save field definition. Use DELETE or CANCEL key as required.
Table 2-2 lists the field definitions for report “daily.” Parameters not listed use the default set-
tings.
Table 2-2. Field Definitions for Report “daily”
Field Function Field Type Format

R2C76 PAGE# Daily 2.0
R4C4 PERIOD Daily 58.0
R6C3 DATE Daily 11.0
R6C18 TIME Daily 8.0
R12C3 HOUR Hourly 5.0
R12C17 LIST h01houravg/HT1:CALC1.RI01 Hourly 8.2
R12C34 LIST h01hourmax/HT1:CALC1.RI02 Hourly 8.2
R12C51 LIST h01hourmin/HT1:CALC1.RI03 Hourly 8.2
R12C68 LIST h01hoursum/HT1:CALC1.RI04 Hourly 8.2
R37C17 AVG h01houravg/HT1:CALC1.RI01 Hourly 8.2
R37C34 AVG h01hourmax/HT1:CALC1.RI02 Hourly 8.2
R37C51 AVG h01hourmin/HT1:CALC1.RI03 Hourly 8.2
R37C68 AVG h01hoursum/HT1:CALC1.RI04 Hourly 8.2
R39C17 MAX h01houravg/HT1:CALC1.RI01 Hourly 8.2
R39C34 MAX h01hourmax/HT1:CALC1.RI02 Hourly 8.2
R39C51 MAX h01hourmin/HT1:CALC1.RI03 Hourly 8.2
R39C68 MAX h01hoursum/HT1:CALC1.RI04 Hourly 8.2
R41C17 MIN h01houravg/HT1:CALC1.RI01 Hourly 8.2
R41C34 MIN h01hourmax/HT1:CALC1.RI02 Hourly 8.2
R41C51 MIN h01hourmin/HT1:CALC1.RI03 Hourly 8.2
R41C68 MIN h01hoursum/HT1:CALC1.RI04 Hourly 8.2
Table 2-2. Field Definitions for Report “daily” (Continued)
Field Function Field Type Format

R43C17 TOT h01houravg/HT1:CALC1.RI01 Hourly 8.2
R43C34 TOT h01hourmax/HT1:CALC1.RI02 Hourly 8.2
R43C51 TOT h01hourmin/HT1:CALC1.RI03 Hourly 8.2
R43C68 TOT h01hoursum/HT1:CALC1.RI04 Hourly 8.2
Saving Report Configuration

1. On base display, select “File” from top menu bar to pull down File menu.
2. Select “Save” from File menu to save report configuration.
3. Select “Load” from File pull-down menu to configure another report, or select
“Exit” from top menu bar to return to previous I/A Series environment and dis-
play.
Accessing Report Configurator Display

You can use the Password Environment Configurator (PassWd_EnvCfg) to establish the envi-
ronments from which the Report Configurator (RptCfg) is available. For example, you can
make the configurator selectable from the process engineer's environment. For more informa-
tion, refer to the Workstation Configuration document.
To access this configurator from the I/A Series initial environment, see Figure 2-1 in “Config-
uration Overview” on page 5 and proceed as follows:
1. Select 'Sys' from environment menu bar to display System pull-down menu.
2. Select 'Change_Env' from System menu to display Environments menu.
3. From Environment menu, select an environment that has the “Config” menu,
e.g., 'Proc_Eng_Env', to display environment menu bar that provides access to
Report Configurator.
4. Select 'Config' from environment menu bar to pull down the Configurators
menu.
5. Select 'RptCfg' from Configurators menu to call up the Report Configurator Base
Display. Figure 2-2 in “Creating New Report” on page 5 shows this display for a
configured report. For a new configuration, there are no fields on the display.
In the Report Configurator Display, a field is indicated by a series of large dots delimited by
right and left pointing triangles. As much of the field name as fits is shown at the far left of the
first line of a field. A field can consist of multiple lines.
Top Menu Bar Functions

On the Report Configurator Base Display (Figure 2-2 in “Creating New Report” on page 5),
selectable fields on the top menu bar provide access to various program functions. These fields
are:
16
Help displays help text that briefly describes the use of the Report Configurator.
File pulls down a menu that lists options relating to report files. See “File
Menu” on page 17.
Edit pulls down a list of editing options. Depending upon past edits, only some
of these options will be selectable. See “Edit Menu” on page 18.
Field displays a list of currently defined fields in the report so that you can select
one to modify directly. Selecting a field displays the Field Definition win-
dow with the current definition of the selected field.
GoTo pulls down a menu listing two options. See “GoTo Menu” on page 18.
Schedule exits to the Report Scheduler.
Exit exits to the previous I/A Series environment.
File Menu
The File menu includes the following selections:
Load displays a list of configured reports. Selecting a report displays its layout
on the base display.
Print displays the following print options:
Config Info prints configuration file for currently loaded report.
Current Page prints sample output for current page.
All Pages prints sample output for all pages of current report.
Save saves the currently displayed report.
SaveAs saves a new, currently displayed report under the specified file name.
Config displays the report configuration window, which you use to enter general
report parameters and data source definitions.
Clear clears the currently displayed report from the screen. You are asked
whether you want to clear or retain the current data source list.
Delete deletes the selected report file. You are asked to verify the operation.
Top Menu Bar Functions 17

NOTE
Users are responsible for the maintenance of the report file directories. For 50
Series stations, the report files are in /opt/fox/rptwrt/rpt_run/<name>.prn. For
WP20/PW stations, the report files are in the /usr/fox/rptwrt/rpt_run directory.
The contents of the report file directories increase as reports are produced. The
Report Writer provides a feature for archiving selected reports to floppy and an
option to then delete the selected reports. You can manually remove files from
the directories as needed.
Edit Menu
The Edit menu includes the following selections:
Mark allows you to use the cursor to specify a rectangular portion of the display
to be copied or cut.
Cut deletes all text and any fields whose origin is within the marked rectangle.
Saves the deleted elements in the temporary buffer.
Copy copies all text and any fields whose origin is within the marked rectangle to
a temporary buffer.
Paste copies the contents of the temporary buffer to the report at the selected
location.
Cancel cancels a MARK or PASTE operation in progress.
When you first pull down the Edit menu, only “Mark” and “Paste” are enabled. Selecting
either “Mark” or “Paste” displays an instruction for the next step of the operation at the bot-
tom of the screen. As you proceed with the operation, further instructions are displayed.
NOTE
When editing a report file in the Report Writer Configurator, only edit the
report file from one WP at a given time. Editing the same report file from two or
more WPs at the same time yields unexpected results.
GoTo Menu
The GoTo menu includes the following selections:
Page displays a list of current report pages that you can select for display, or
allows the creation of a new report page.
Field displays a list of currently defined fields that you can select to display the
field definition.
18
Text Entry
To enter text anywhere on the base display (Figure 2-2 in “Creating New Report” on page 5),
move the cursor to the desired location and press the left mouse key. This displays a black cur-
sor at that location and allows you to type standard ASCII characters which are displayed on
the screen. During text entry, you can use the Backspace key to back up over typed characters
to retype them. New text always overwrites existing text on the screen. Terminate text entry by
typing a carriage return.
Configuration Windows
The Report Configurator Base Display (Figure 2-2 in “Creating New Report” on page 5) pro-
vides access to two configuration windows:
♦ Report Configuration
♦ Field Definition
On the base display, selecting “Config” from the File pull-down menu calls up the Report
Configuration window as shown in Figure 2-4 in “Creating New Report” on page 5. This
window consists of the following two sections:
♦ File Configuration (File Config)
♦ Data Source Definition
On the base display, positioning the cursor at the location where you want a data value and
pressing the right mouse key calls up the Field Definition window.
These windows contain several soft keys that you use to activate functions on the windows.
One soft key that needs to be mentioned up front is the <> key. You use the <> key to toggle
through several choices that define the allowable data for the adjacent field. The <> key
appears adjacent to the following fields on the above windows:
♦ Report Type
♦ Start day of week (DOW)
♦ Printer
♦ Class
♦ Time Format (only for INFORMIX Table classes)
♦ Field Type
File Configuration Parameters

On Figure 2-4 in “Creating New Report” on page 5, use the File Config section of the Report
Configuration window to specify the characteristics of your report as indicated. The parame-
ters in this section are initially set to default values or strings. You can change a parameter set-
ting by selecting the adjacent field and typing the desired information, or by using the <> key
to view and set alternative data.
The File Config section includes the following parameters:
Text Entry 19
Report Name is not directly modifiable. It is set to the name used to save the configura-
tion file. For new reports, it is not defined until you SAVE the file.
Report Type determines the basic time period covered by a report. It is set using the
adjacent <> key.
Start Hour The hour to use as the start of a day (0 - 23). The start and end times of
all report periods of a day will be offset by this number of hours.
Start DOW The day to use as the first day of the week for determining the start of
weekly reports. It is set using the adjacent <> key.
Shifts/Day The number of shifts in each day. The number must be a divisor of 24.
Printer The printer to which reports and the results of the FILE PRINT function
are sent to. Selecting the <> key calls up a pop-up menu from which you
can select a printer.
Page Width The number of character columns on a report. You should set it to match
the width of the printer to be used (e.g., 80 or 132 characters).
Page Length The number of text lines on a report (e.g., 65 lines).
Horiz. Pan The number of text columns to move when you select the left or right pan
keys, that is, < or > keys.
Vert. Pan The number of lines up or down to move when you select the up or down
pan keys, that is, /\ or \/ keys.
The File Config section includes the following soft keys:
OK saves configuration changes and returns to the base display.

CANCEL discards configuration changes and returns to the base display.
Data Source Configuration

On Figure 2-4 in “Creating New Report” on page 5, use the Data Source Definition section
of the Report Configuration window to define all sources of information to be used in the
report, assigning each source a symbolic name (Mnemonic). Data in your report may be
derived from any or all of the following:
♦ Historian Reduction Groups
♦ Object Manager (instantaneous values)
♦ Single INFORMIX tables
♦ Joined INFORMIX tables
You specify a data source as follows:
1. Select the desired class using the <> key.
20
2. Select the NEXT or PREVIOUS key until a blank Mnemonic appears.

3. Enter the required information for that class of data.
Data sources do not specify compound:block.parameter information, which is done at the
field level.
The Data Source Definition section includes the following parameters:
Mnemonic A name used to reference a particular data source when defining fields.
Class The class of data to be used for this data source. The class determines what
other fields are displayed, that is, required to define the data source:
Historian Class:
Historian Historian database name
Reduc.Group Reduction group name
Reduc.Operation Reduction operation name
Single INFORMIX Table Class:
AP LtrBug Letterbug of Application Processor (AP) on
which the database resides.
Path Full database directory path on the host AP
(e.g., /usr/db/motors.dbs).
Primary Name of the INFORMIX table to use.
Point ID Name of the column (char (x) field) that
contains full point ids, that is, Com-
pound:Block.Parameter (C:B.P).
Value Name of the column (float field) that con-
tains the value of each point.
Time Name of the column (integer field) that
contains the time value.
Time Format Time format that is stored. VENIX is sec-
onds past 1/1/1970, INFORMIX is days
past 1/1/1900.
Joined INFORMIX Table:
AP LtrBug Same as above.
Path Same as above.
Primary Name of INFORMIX table that contains
the Point Id field and a key field.
Point Id Name of column in Primary Table that con-
tains the full C:B.P id of a point.
Configuration Windows 21
Key Name of Column (smallint or integer field)

that contains a unique value for each Point
Id.
Joined Name of INFORMIX table that contains
key, value, and time columns for data sam-
ples.
Join Name of column (smallint or integer field)
that contains value that matches the value in
Key column to associate a sample with a
point id.
Value Same as above.
Time Same as above.
Time Format Same as above.
Object Manager No parameters required.
NOTE
With the V4.0 version of the Report Writer, packed Boolean CP objects are now
supported. To configure a packed Boolean OM variable, enter the variable name
as you would any other OM variable. The packed Boolean value is printed as a
hexadecimal number.
The Data Source Definition section contains the following soft keys:
NEXT displays the next data source in the list of data sources. At the end of the
list, a blank record is displayed.
PREVIOUS displays the previous data source in a list of data sources. At the head of the
list, a blank record is displayed.
SAVE copies any changes made to the display into the data source record in the
list. This will not cause a save to disk until the report package is exited or
the SAVE option is selected from the File menu.
VERIFY determines that the parameters entered for the currently displayed data
source are valid. If unable to verify any data, a warning messages is dis-
played.
DELETE removes the data source record corresponding to the displayed data source
from the data source list and displays the next data source.
Field Definition
To enter a field definition for the base display Figure 2-2 in “Creating New Report” on
page 5, position the cursor at the location where you want a data value and press the right
22
mouse key. This will display the Field Definition window with default values as shown in
Figure 2-5 in “Creating New Report” on page 5.
To edit an existing field, position the cursor anywhere within the field icon and press one of
the mouse keys. Alternately, you can pull down the FIELDS menu and select a field name
from it. In both cases this displays the Field Definition window with all of the selected field's
parameters.
The number of fields that can be configured on a page depends on the memory requirement
of the page. You should configure no more than 99 fields per page.
! CAUTION
If you configure more than 99 fields on a report page, the fields that exceed the
available memory space become “text.”
The first field that exceeds the available memory space causes a “memory allocation error,”
and the field turns to text on the display. To fix your configuration, select “Continue” in the
dialog box and then, delete this text field. Then, save and reload the report configuration. You
may find that other fields now exceed the available memory space and have turned to text.
Remove those text fields and then, save the report configuration.
Parameters on Field Definition Window
Field Name defaults to a unique name generated from the row and column that you
first selected. Once assigned, this name is not changed by the configurator,
even if you change the row and column values in the window. You can,
however, enter a more descriptive name.
Row The row where the field data is displayed or printed. The top row is row
number 1.
Column The column where the field data is displayed or printed. Data is right justi-
fied within the width specified in the Format field (see below). The first
character column is column number 1.
Field Type Period over which data is retrieved for the named data point. Types are
Monthly, Weekly, Daily, Shift and Hourly.
A Field Type which is smaller than the Report Period specified in the
Report Configuration window will produce, depending upon the
sub-period specified, a list, sub-period value, or operation on all sub-peri-
ods.
See “Field Types” on page 3 for more information.
Sub-period These fields are: Week, Day, Shift, and Hour. They allow the selection of a
specific period of time that is a unit of the overall field type, e.g., Day 7 of a
Week, or Hour 24 of a Day.
These fields are only displayed for non-list functions, that is, those without
(L) next to them in the FUNCTIONS menu. Only those fields that are
appropriate for the selected field type are displayed.
Sub-periods of ZERO must be specified in order for a non-list function to

operate on samples that correspond exactly to the values in a List, e.g., an
AVG field at the bottom of a LIST field must have the same Field Type and
0 in the sub-period fields.
Function The function to be performed in the following format:
<func> <data_source>/<point_id>
where point_id is C:B.P for Historian, Object Manager and INFORMIX

classes. All functions default to CALC functions which are in the following
format:
<field1> <op1> <field2> <op2> ... <fieldn>
where fieldx are field names in the report and opx are mathematical opera-
tions from the set (+, -, /, *). Parentheses may be used to impose prece-
dence.
Scale The value that multiplies the end result of the function and each element of
a list.
Discrete You can enter two symbolic labels, e.g, ON and OFF, to be printed instead
Value Labels of numeric values. The first label (0) is printed for any value < 1.0. The sec-
ond label (1) is printed for any value _ 1.0
Format This field allows you to specify the maximum width of a field and the num-
ber of characters to the right of the decimal. The default is 6.2 for a LIST
function, which means a width of 6 with 2 decimal places. A format exam-
ple is displayed, such as 000.00. If you desire no decimal places, you must
specify the zero, that is, “3” is invalid, but “3.0” is correct.
Soft Keys on Field Definition Window
PREVIOUS copies the last entered function into the Function field.
FUNCTION displays a list of available functions. Selecting a function name places it
in the Function box. The absence of a function name specifies the
CALC function, which does not appear in this list. The available func-
tions and their results are:
24
LIST generates a line of data for each occurrence of the Field

Type in the report period.
Example:
Report period = Daily

Field Type = Hourly
Result = 24 lines of data, one for each hour of the day
(See Table 1-1).
OBJ_ gets one point value from the Object Manager when the
MANAGER report executes.
AVERAGE Result depends on the following variables: Report
Period, Field Type, and Sub-period, if relevant:
1. Field Type = Report Period
Result = average of samples for the Report Period.
2. Field Type > Report Period

Result = average of samples for the Field Type to the cur-
rent time
Example:
Report Period = Daily

Field Type = Monthly
Result = average of samples for each day from beginning
of the month to current day
3. Field Type < Report Period

Result depends on the Sub-period:
a. Sub-period = 0
Result = average of the sums of samples for each Field
Type in the Report Period.
Example:
Report Period = Monthly

Field Type = Daily
Sub-period = 0
Result = average of the sums of samples for each day in
the report month.
b. Sub-period not = 0
Result = average of the samples in selected Sub-period’s
Field Type.
Example:

Field Type = Daily
Sub-period = 2
Result = average of the samples for Day 2.
MAXI- Result depends on the following variables: Report
MUM Period, Field Type, and Sub-period, if relevant.
Result = maximum of samples for the Report Period.
Result = maximum of samples for the Field Type to cur-
rent time.
Example:

Result = maximum of samples for each day from begin-
ning of the month to current day.
26

Result depends on the Sub-period:
a. Sub-period = 0
Result = maximum of the sums of samples for each Field
Example:

Field Type = Daily
Sub-period = 0
Result = maximum of the sums of samples for each day
in the report month.
b. Sub-period not = 0
Result = maximum of the samples in selected
Sub-Period’s Field Type.
Example:

Field Type = Daily
Sub-Period = 2
Result = maximum of the samples for Day 2.
MINIMUM Result depends on the following variables: Report
Period, Field Type, and Sub-Period, if relevant:
Result = minimum of the samples for the Report Period.
Result = minimum of samples for the Field Type to cur-
rent time.
Example:

Result = minimum of samples for each day from begin-
ning of the month to current day.

Result depends on the Sub-Period:
a. Sub-Period = 0
Result = minimum of the sums of samples for each Field
Example:

Field Type = Daily
Sub-Period = 0
Result = minimum of the sums of samples for each day
in the report month.
b. Sub-Period is not = 0
Result = minimum of the samples in selected
Sub-Period’s Field Type.
Example:

Field Type = Daily
Sub-Period = 2
Result = minimum of the samples for Day 2.
TOTAL Result depends on the following variables: Report
Period, Field Type, and Sub-Period, if relevant:
Result = sum of samples for the Report Period.
Result = sum of samples for the Field Type to current
time.
Example:

Result = sum of samples for each day from beginning of
the month to current day.
28
3. Field Type < Report period

Result depends on the Sub-Period:
a. Sub-Period = 0
Result = sum of the sums of samples for each Field Type
in the Report Period.
b. Sub-Period not = 0
Result = sum of the samples in selected Sub-Period’s
Field Type.
Example:

Field Type = Daily
Sub-Period = 2
Result = sum of the samples for Day 2.
PAGE_ prints the current page number.
NUMBER
DAY_OF_ prints the day of the month for which the data was col-
MONTH lected. The collection period of the day is from the con-
figured start hour to the start hour plus 23 hours
59 minutes.
DAY_OF_ prints the day of the week for which the data was col-
WEEK lected. The collection period of the day is from the con-
figured start hour to the start hour plus 23 hours 59
minutes.
HOUR_OF prints the hour of the day for which the data was col-
_DAY lected. The collection period is from the start of the hour
to 59 minutes past the hour, e.g., 1:00 to 1:59.
DATE prints the report generation date.
TIME prints the report generation hour.
REPORT_P prints the time interval that the report covers.
ERIOD
FIELDS displays a list of the currently defined fields. Selecting a field copies its
name into the function field. Field names are only meaningful in CALC
functions.
POINTS displays a list of the configured data sources. Selecting a data source dis-
plays a list of valid point ids. For the Historian and Object Manager, you
select a compound from this list. Then, you select a block from a list of
blocks for that compound. Then, you select a parameter from a list of
parameters for that block.
OK saves the field information and places the specified field into the report
template.
DELETE removes the field defined by the displayed parameters from the report
template. You are asked to verify the operation.
CANCEL discards any changes entered in the Field Definition window and returns
to the base display.
Offline Configuration
You can define a report in an ASCII file that you generate offline. To do this, you should use
the Report Configurator to build a template, that is, a <name>.cfg file, that you can copy to
your offline workstation.
! CAUTION
Your offline configuration files can be fatal to the Report Writer. To avoid this,
we strongly recommend that you use the Report Configurator to configure a
report for use as a template for building reports offline. You can generate the
ASCII file for the report entirely offline, but we do not recommend this because
there is no error checking as provided in the Report Configurator.
The format of the report file should match the format of the configuration information print-
out that is generated by the FILE PRINT menu option.
Before running the report, you must load and save the configuration file from within the
report configurator. This is necessary because some of the fields in the <name>.cfg file are cal-
culated. You can fill these fields with zeros when building the report off-line. These fields are
identified below.
You must supply all the initial report configuration variables, each on a new row as in the
example below. The comments after the semicolons should not appear in the configuration
file.
ModCode=0 ; calculated field
RptName=Name
RptType=Monthly ; must be a valid report type
PageLen=65
PageWidth=80
HorizPan=0
VertPan=15
ShiftsPDay=3 ; must be a divisor of 24
StartHour=0
StartDOW=Monday ; must be a valid weekday name
Printer=LP01
30
ArchiveDev=/dev/fh0
The “DATA SOURCES” and “PAGE DEFINITIONS” titles are not required, but they add
to the readability of the configuration file. You define the data sources as follows:
DS=Mnemonic,Class,Host,Historian,\
Path,RedGrp,RedOp,\
DTable,DPidC,DJoinC,JTable,JJoinC,\
TimeC,TimeForm,ValueC
“DS=”, all commas, and the backslash (\) must appear as shown above. All other items corre-
spond to the parameters that are listed under the data source classes previously described.
You must indicate parameters that do not apply to a particular data source by inserting at least
one space in the position of the parameter. For example, you specify the Object Manager as a
data source as follows:
DS=ObjMan,Object Manager, , ,\
, , ,\
, , , , ,\
,,
You define text with all spaces, except trailing spaces, on each line. You do not define blank
lines. For example:
PG#01 L#02=Hello World
“PG#”, “ L#”, and “=” are required. The page number (PG#) and line number (L#) must be
two characters each.
You specify fields as follows:
PG#01
F#01=Name,Row,Col,Type,Format,Scale,ZeroText,OneText,0,0,0,Func
The rule for the page number is the same as for the page number and line number described
above.
The field number may consists of two or three characters. The remaining fields correspond to
the field parameters described in “Field Definition” on page 22. The three zero fields are
defined as follows:
1. PeriodNum – is a function of the field type and report type. If configuring offline,
this value should be set to zero. It will be properly set by the Report Configurator
if the field type and report type are a valid combination.
2. PeriodCnt – is a function of the report type and field type. If configuring offline,
this value should be set to zero. It will be properly set by the Report Configurator
if the field type and report type are a valid combination.
3. MultiRef – is a dynamic flag that allows the Report Run program to use and reuse
previously retrieved data. If configuring offline, this value should be set to zero.
This variable is in configuration record, but is manipulated by the Report Run
module.
Offline Configuration 31
PeriodNum and PeriodCnt are used in the routines that convert between calendar representa-
tion of subperiods (nth week) and the period_count / period_number representation.
The number of fields that can be configured on a page depends on the memory requirements
of the report page being configured. We recommend up to 99 fields per page.
! CAUTION
If you configure more than 99 fields on a report page, the fields that exceed the
available memory space become “text.”
32
3. Report Scheduler
This chapter describes the report scheduler, including accessing the scheduler, top
menu bar functions, parameter fields, soft keys, running, scheduling, archiving,
deleting, restoring and printing reports, and setting archive/restore environments.
The Report Scheduler provides a graphic interface to the “crontab” facility and archiving and
printing functions. The Scheduler display allows the user to:
♦ Schedule the Report Writer runtime routines to execute at regular intervals.
♦ Execute a report on demand.
♦ Archive reports to floppy disk.
♦ Restore archived reports from floppy disk to hard disk.
♦ Print reports on any printer in the network.
♦ Delete reports from hard disk after archiving them.
When a report is executed, either periodically or on-demand, its contents are automatically
stored in files.
Accessing Report Scheduler

You can use the Password Environment Configurator (PassWd_EnvCfg) to establish the envi-
ronments from which the Report Scheduler (RptSched) is available. For example, you can
make the Scheduler selectable from the process engineer's environment.
To access the Scheduler from the I/A Series initial environment display, see Figure 2-1 in
“Creating New Report” on page 5 and proceed as follows:
1. Select 'Sys' from environment menu bar to display System pull-down menu.
2. Select 'Change_Env' from System menu to display Environments menu.
3. From Environment menu, select an environment, e.g., 'Proc_Eng_Env', to display
environment menu bar that provides access to Report Scheduler.
4. Select 'Config' from environment menu bar to pull down the Configurators
menu.
5. Select 'RptSched' from Configurators menu to call up the Report Scheduler Dis-
play. Figure 3-1 shows this display with default entries and scheduled reports.
Alternately, you can select “Schedule” from the top menu bar of the Report Configurator Base
Display (Figure 2-2 in “Creating New Report” on page 5) to call up the Report Scheduler
Display (Figure 3-1).
33
B0193LJ – Rev E 3. Report Scheduler
Help Archive/Restore Select Configure Exit
Report Scheduler
Report Name: odaily
DEMAND
REPORT
Day of the week: Everyday DELETE
Month: EveryMonth SCHEDULE
UPDATE
Day: * Hour: 09 Minute: 15 SCHEDULE
Currently Scheduled Reports
Report DoW Mon Day Hour Min Page
/usr/fox/rptwrt/rpt_run/RunReport mnthly 1
* * * * *
/usr/fox/rptwrt/rpt_run/RunReport weekly 1 1 1 1 1
/usr/fox/rptwrt/rpt_run/RunReport daily
/usr/fox/rptwrt/rpt_run/RunReport odaily * * * * *
* * * * *
Figure 3-1. Report Program Scheduler Display (Typical)
The Report Scheduler Display (Figure 3-1) is an easy to use interactive tool which allows the
user to invoke the Report Writer runtime routines at regularly scheduled intervals. It makes
the crontab file maintenance transparent to the user.
The Report Scheduler Display consists of a top menu bar, top section, and bottom section.
The top menu bar has five (5) selectable fields. The top section has six (6) parameter fields
and five (5) soft keys. The bottom section displays the currently scheduled reports.
When scheduling a report, the user is required to enter the Day, Hour, and Minute fields. If
you wish to wild-card one of these fields, select the field and hit Return/Enter and the field
defaults to an asterisk (*), denoting wild card.
Top Menu Bar Functions

On the Report Scheduler Display (Figure 3-1), selectable fields on the top menu bar provide
access to various program functions. These fields are:
Help displays help text that briefly explains the contents of the current dis-
play and required keyboard entries.
Archive/Restore pulls down a menu listing the following selectable options:
Archive copies the specified reports to the archive
device and provides the option to delete them
from the hard disk.
34
3. Report Scheduler B0193LJ – Rev E
Restore copies reports from the archive device to the

hard disk.
Print displays a list of <name>.prn report storage
directories. Selecting a directory displays a list
showing the ALL option and the report names
that you can select for printing all reports or
one report in the directory.
Set Environment displays a dialog box for defining the floppy
disk drive and the default printer. Use the <>
key to toggle through the disk drive choices or
to display a list of printer choices.
Select pulls down a menu listing the configured reports that you can select
for execution.
Configure exits to the Report Configurator.
Exit exits to the previous I/A Series environment and display.
Parameter Fields
On the Report Scheduler Display (Figure 3-1), the parameter fields consist of four (4) select-
able entry fields, and two other fields that are set via adjacent <> soft keys.
The selectable entry fields are:
Report Name is the filename, date, and time that the runtime routine needs to
run the report.
Day* is the day (1 to 31) of the month on which the report is to run. An
entry greater than the number of days in the selected month
defaults to an asterisk (*). For the “EveryMonth” selection, an entry
greater than 28 defaults to an asterisk (*).
Hour* is the hour (0 to 23) of the day on which the report is to run. An
entry greater than 23 defaults to an asterisk (*).
Minute* is the minute (0 to 59) of the hour on which the report is to run.
An entry greater than 59 defaults to an asterisk (*).
* An asterisk (*) in any of these fields causes the report to execute for every value of that field
(i.e. wild card).
The following fields are set via the adjacent <> soft keys:
Parameter Fields 35
Day of Week is the day of the week on which the report is to run. Select the <> key to
toggle through the choices (EveryDay, Sunday,. . . Saturday). “EveryDay”
causes the report to execute every day.
Month is the month in which the report is to run. Select the <> key to toggle
through the choices (EveryMonth, January, . . . December). “EveryMonth”
causes the report to execute every month.
Soft Keys
On the Report Scheduler Display (Figure 3-1), the selectable soft keys are:
DEMAND immediately executes the report in the Report Name field

REPORT
DELETE removes the current entry in the Report Name field from the
SCHEDULE crontab file. This report no longer executes automatically.
UPDATE adds the current entry in the Report Name field to the crontab file.
SCHEDULE The report executes automatically at the designated time.
<> toggles through choices for the adjacent field, that is, “Day of
Week” or “Month” field.
\/, /\ pages the Currently Scheduled Reports List respectively down or
up.
If you have a report selected from the list of Currently Selected Reports and you want to “Page
Up” or “Page Down,” deselect the selected report (highlighted) by selecting the same report
from the list before paging up or down.
Running Reports on Demand

! CAUTION
Ensure that a report that retrieves Historian data is not running when you select
a similar report to run using the following procedure. (If one report is running,
the second request is ignored.)
To run a report on demand from the Program Scheduler Display (Figure 3-1 in “Accessing
Report Scheduler” on page 33):
1. Select “Select” from top menu bar to pull down list of report names, and then,
select one to enter it in Report Name field. Alternately, you can use keyboard to
enter report name directly.
2. Select EXECUTE PROGRAM key, and then, select Proceed key from dialog box
that appears.
36
This produces a report for the last complete time period corresponding to the report type,
e.g., the last completed Month, Week, Day, Shift or Hour.
Optionally, you can specify a date and/or time, which produces a report for the time period
that includes the specified date/time up to the specified date/time. To specify a time, you need
to specify a date, for example, enter the following in the Report Name field:
mnthly 6-30-91 23:59:59
This produces the “mnthly” report for the period starting from the beginning of the month
and ending on 6-30-91 at 23:59:59.
The full path name for completed report files is:
/usr/fox/rptwrt/rpt_run/<name>.prn(on AP20 and PW)
/opt/fox/rptwrt/rpt_run/<name>.prn(on AP50/51)
The name of the report file indicates the end of the report period. The example above pro-
duces the following file:
/usr/fox/rptwrt/rpt_run/mnthly.prn/06-30-91.23:59(on AP20 and PW)
/opt/fox/rptwrt/rpt_run/mnthly.prn/06-30-91.23:59(on AP50/51)
! CAUTION
You should periodically archive the report files and then, delete them from the
storage directory, e.g., /usr/fox/rptwrt/rpt_run/<name>.prn for 20 Series, or
/opt/fox/rptwrt/rpt_run/<name>.prn for 50 Series. Otherwise, report files can
use too much disk space and cause system problems. See “Archiving, Deleting,
and Restoring Reports” on page 38 for details on how to archive and delete
report files.
Scheduling Reports
To schedule a report from the Program Scheduler Display (Figure 3-1 in “Accessing Report
Scheduler” on page 33):
1. Select “Select” from top menu bar to pull down list of report names, and then,
select one to enter it in Report Name field. Alternately, you can use keyboard to
enter program name directly.
2. Enter desired values in following fields (see “Parameter Fields” on page 35):
♦ Day of Week
♦ Month
♦ Day
♦ Hour
♦ Minute
3. Select UPDATE SCHEDULE key. This displays new schedule in Currently
Scheduled Reports List (local copy) on Scheduler Display.
Scheduling Reports 37
! CAUTION
Ensure that a scheduled report that retrieves Historian data is not running when
another similar report is scheduled to run. Phasing of scheduled reports is
advised. (Only one report may use the Historian interface at the same time.)
To delete a schedule:
1. On Scheduler Display, select schedule from Currently Scheduled Reports List. Use
\/ or /\ key to page list as required.
2. Select DELETE SCHEDULE key, and then select “Delete” key from dialog that
appears. This deletes schedule from Currently Scheduled Reports List (local copy).
If “Update Schedule” is selected, the Report Scheduler Report Name entry field defaults to a
blank field <null>. You should key in a report name or choose a report name from the “Select”
pull-down menu. If a <null> report is scheduled, select the <null> report from the list of Cur-
rently Selected Reports, select “Delete Schedule” and exit the Report Scheduler.
If you have more than one page of scheduled reports and either select “Update Schedule” or
“Delete Schedule,” the Report Scheduler redisplays the Page 1 list of Currently Scheduled
Reports; however, the “Page” indicator is not reset to 1. Select the “Page Up” soft key to reset
the “Page” indicator to 1.
NOTE
The system CRONTAB file is updated when you exit the Report Scheduler.
Archiving, Deleting, and Restoring Reports

To archive and/or delete a report using the Program Scheduler Display (Figure 3-1 in “Access-
ing Report Scheduler” on page 33):
1. Select “Archive/Restore” from the top menu bar to pull down list of options on the
Scheduler Display.
2. Select “Archive” from list of options to display a list of <name>.prn directories.
3. Select a <name>.prn from list of directories to display list of report files in that
directory.
4. Insert floppy disk in default drive.
5. On list of report files, select a file or ALL option to copy one or all files in directory
to floppy disk. This displays dialog box.
6. On dialog box, select “Create” key to create a new floppy disk, or select “Append”
key to append file(s) to floppy disk. If the floppy disk is a VENIX tar disk, the
reports are copied to the disk. Otherwise, the disk is formatted as a tar disk, and
the reports are written to it.
38
NOTE
The Report Writer does not prompt you to insert additional floppies when the
archiving of reports requires more than one floppy.
! CAUTION
The Archive process destroys the contents of any non-tar floppy disk.
7. To delete report from hard disk, select “Yes” key on dialog box that appears when
report(s) have been copied to floppy disk.
To restore report files from floppy disk:
1. Insert archive disk in default drive.
2. Select “Archive/Restore” from the top menu bar to pull down list of options on
the Scheduler Display.
3. Select “Restore” from list of options to display a list of <name>.prn pathnames.
The full pathname for archive report files is:
/usr/fox/rptwrt/rpt_run/<name>.prn./<filename> for 20 Series, and
/opt/fox/rptwrt/rpt_run/<name>.prn./<filename> for 50 Series.
4. Select a <name>.prn from list of pathnames to display list of report files under that
pathname.
5. On list of report files, select a file or ALL option to copy one or all of these files
from floppy disk to hard disk.
Restoring archive report files allows you to reprint old reports.
Printing Reports
To print a report using the Program Scheduler Display (Figure 3-1 in “Accessing Report
Scheduler” on page 33):
Scheduler Display.
2. Select “Print” from list of options to display a list of <name>.prn directories.
3. Select a <name>.prn from list of directories to display list of report files in that
directory.
4. On list of report files, select a file or ALL option to print one or all files in direc-
tory.
Setting Archive/Restore Environment

To set the default printer and archive device using the Program Scheduler Display (Figure 3-1
in “Accessing Report Scheduler” on page 33):
Printing Reports 39
Scheduler Display.
2. Select “Set Environment” from list of options to display Archive/Restore Environ-
ment dialog box.
3. On dialog box, select <> key next to Disk Drive field to toggle it to desired drive.
4. On dialog box, select <> key next to Printer field to display list of available print-
ers.
5. On list of printers, select or enter printer name to display it in dialog box.
6. Select “Accept” key to set default printer and archive device.
40
Index
A
Accessing Report Configurator Display 16
Accessing Report Scheduler 33
Archiving, Deleting, and Restoring Reports 38
C
Components 4
Configuration Procedures 12
Copying Report Configuration 9
Creating New Report 5
D
Data Source Configuration 20
Data Sources 1
E
Edit Menu 18
Editing Report 9
F
Field Definition 22
Field Types 3
File Configuration Parameters 19
File Menu 17
G
GoTo Menu 18
H
Historian Configuration for Report Examples 10
O
Off-Line Configuration 30
Overview 1
41
B0193LJ – Rev E Index
P
Parameter Fields 35
Preface ix
Printing Report Configuration 9
Printing Reports 39
R
Report Configuration 5
Report Scheduler 33
Report Types 3
Revision Information ix
Running Reports on Demand 36
S
Scheduling Reports 37
Setting Archive/Restore Environment 39
Soft Keys 36
T
Text Entry 19
Top Menu Bar Functions 16, 34
The Foxboro Company

33 Commercial Street
Foxboro, Massachusetts 02035-2099
United States of America
http://www.foxboro.com
Inside U.S. 1-508-543-8750 or 1-888-FOXBORO (1-888-369-2676)
Outside U.S. - Contact your local Foxboro Representative.
Printed in U.S.A. 1099

An Invensys company

b0193lj e Report Writer

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

b0193lj e Report Writer

Uploaded by

Copyright:

Available Formats

® B0193LJ

Help Archive/Restore Select Configure Exit

Copyright 1992-1999 by The Foxboro Company

SOFTWARE LICENSE AND COPYRIGHT INFORMATION

2. Report Configuration .................................................................................................. 5

File Configuration ................................................................................................... 13

3. Report Scheduler ....................................................................................................... 33

Sample Daily Report - daily Page 1

0:00 16.47 42.58 51.61 4597.69

Figure 1-1. Sample Daily Report “daily”

Creating New Report

Sys Alarm Help Select

Sys Alarm Help Select

Figure 2-1. Accessing Report Configurator

Help File Edit Field GoTo Schedule Exit

Page 1 or 1 Lines 1-20 of 65 cols. 1-80 of 80 #Fields: 25

Figure 2-2. Report Configurator Base Display - Typical (1 of 2)

Help File Edit Field GoTo Schedule Exit

DAILY AVERAGE R37C17 R37C34 R37C51 R37C68

DAILY MAXIMUM R39C17 R39C34 R39C51 R39C68

DAILY MINIMUM R41C17 R41C34 R41C51 R41C68

DAILY TOTAL R43C17 R43C34 R43C51 R43C68

Page 1 or 1 Lines 1-20 of 65 cols. 1-80 of 80 #Fields: 25

Figure 2-3. Report Configurator Base Display - Typical (2 of 2)

Daily report, daily

Mnemonic: h01hoursum NEXT

Figure 2-4. Report Configuration Window (Typical)

Report Configuration Window

Help File Edit Field GoTo Schedule Exit

PREVIOUS FUNCTION FIELDS POINTS Select Compound

Figure 2-5. Field Definition Window (Typical)

Saving Report Configuration

Loading Report Configuration

Resizing Fields in Report Writer

Copying Report Configuration

Printing Report Configuration

Printing Report Configuration File

Printing Sample Report

Exiting Report Configurator

Historian Configuration for Report Examples

Table 2-1. Reduction Group Specifications

Specification hour_val daily_val

Accessing Report Configurator

Entering Report Name

Data Source Definitions

5. Repeat Steps 1 through 4 for all data sources.

Defining Report Fields

Table 2-2. Field Definitions for Report “daily”

Field Function Field Type Format

Table 2-2. Field Definitions for Report “daily” (Continued)

Field Function Field Type Format

Saving Report Configuration

Accessing Report Configurator Display

Top Menu Bar Functions

Top Menu Bar Functions 17

File Configuration Parameters

The File Config section includes the following soft keys:

OK saves configuration changes and returns to the base display.

Data Source Configuration

2. Select the NEXT or PREVIOUS key until a blank Mnemonic appears.

Key Name of Column (smallint or integer field)

Parameters on Field Definition Window

See “Field Types” on page 3 for more information.

Sub-periods of ZERO must be specified in order for a non-list function to