B0193CW

REV G

I/A Series
Operator Action Journal
September 28, 2007
Operator Action Journal
Report Printer

Historian Log

L P00

Printer

Enabled
Disabled

Report Duration
From

DMWP50:DMWP50

Earliest available

Historian

qualdb

Printer Log
To

Latest available

Enabled
Disabled

Report Filters
Workstations/DMs
Compounds
Blocks

*
*

Printer

LP00

File to Create/Print
File

DMWP50.oaj

Report File Actions

Create File
Print File
Create & Print
Done

Cancel

Invensys, Foxboro, FoxView and I/A Series are trademarks of Invensys plc, its subsidiaries, and affiliates.
All other brand names may be trademarks of their respective owners.
Copyright 1990-2007 Invensys Systems, Inc.
All rights reserved

SOFTWARE LICENSE AND COPYRIGHT INFORMATION

Before using the Invensys Systems, Inc. supplied software supported by this documentation, you
should read and understand the following information concerning copyrighted software.
1. The license provisions in the 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, Invensys Systems, Inc. will no longer provide you
with support services and assumes no further responsibilities for your system or its
operation.
2. All software issued by Invensys Systems, Inc. and copies of the software that you are
specifically permitted to make, are protected in accordance with Federal copyright
laws. It is illegal to make copies of any software media provided to you by
Invensys Systems, Inc. for any purpose other than those purposes mentioned in the
software license.

Contents
Figures..................................................................................................................................... v
Preface................................................................................................................................... vii
Revision Information .............................................................................................................. vii
Reference Documents ............................................................................................................. vii
1. Introduction ...................................................................................................................... 1
External Interface ...................................................................................................................... 1
2. Principles of Operation ..................................................................................................... 3
Enabling the Operator Action Journal at Boot Time ................................................................. 3
Journal Configuration ...............................................................................................................
Printer Log ......................................................................................................................
File to Create/Print ..........................................................................................................
Historian Log ..................................................................................................................
Report Printer .................................................................................................................
Report Duration ..............................................................................................................
Report Filters ...................................................................................................................
Report File Actions ..........................................................................................................

4
5
6
6
7
7
7
7

Data Recording and Storage ...................................................................................................... 8

Origins of Operator Actions ............................................................................................ 9
Packed Boolean Database Changes .................................................................................. 9
Logged Operator Actions ............................................................................................... 10
Operation ............................................................................................................................... 10
Index .................................................................................................................................... 13

iii

B0193CW Rev G

iv

Contents

Figures
2-1.
2-2.
2-3.

Operator Action Journal Configuration Selections (Solaris) .......................................... 4

Operator Action Journal Configuration Selections (Windows) ...................................... 5
Printer Selection ............................................................................................................ 6

B0193CW Rev G

vi

Figures

Preface
This document provides information on the Operator Action Journal. The document applies to
both the Nodebus and Mesh I/A Series systems and is intended for the use of process control
engineers and other qualified and authorized personnel.

Revision Information
For I/A Series V8.3 software (for workstations with Windows or Solaris operating systems), the
following changes were made:
Chapter 2 Principles of Operation
Changed Figure 2-2

In File to Create/Print on page 6, added Note

In Print File process has been started on the AP or WP. on page 11,
replaced 5.25 by 3.50 inch diskette.
Entire Document
Windows NT has been replaced by Windows.

Reference Documents
Refer to the following documents for additional information:
Historian (B0193BL)
Process Operations and Displays (B0193MM)
Workstation Alarm Management (B0193RV)
Display Engineering for FoxView Software and Display Manager Software
(B0193MQ)
INFORMIX SQL
ACE Reports
Relational Database Management System
Most documents with B0 numbers are available on the I/A Series Documentation CD. Refer to
I/A Series Documentation CD K0173TQ for V6.x and V7.x systems and I/A Series Documentation CD K0173WT for V8.x systems. The latest revisions of most of these documents are available through the Global Customer Support Center webpage
(http://support.ips.invensys.com). Global CSC can be contacted at +1-508-549-2424 (worldwide) or +1-866-746-6477 (US, Canada toll-free)

vii

B0193CW Rev G

viii

Preface

1. Introduction
This section provides information about the use of the Operator Action Journal on Windows or
Solaris platforms and its external interface to FoxView software or Display Manger.
The Operator Action Journal is a record of specific operator actions taken during process control
operations. These actions generally consist of manipulating certain control processor (CP), and
gateway parameters as well as application processor (AP), application workstation (AW), and
workstation processor (WP) shared variables. Actions of this type are the ramping or direct data
entry of point values, toggling points, changing block statuses, acknowledging block alarms, and
horn muting. Operator action reporting is limited to operator actions from FoxView software,
Display Manager software, and Alarm Manager. Also logged are environment change actions,
scripts, applications, and invoking other applications such as configuration.
Solaris
Operator actions recorded in the Operator Action Journal may be configured for printing on a
system printer as they occur, or they may be stored in the Historian database for retrieval at a later
date, or both. Figure 2-1 on page 4 shows the Operator Action Journal configuration selections
(Solaris).
Windows
Use a Windows application workstation with Historian. Windows operating system does not support printing reports. You can read report information in Historian. Figure 2-2 shows the Operator Action Journal Configuration Selections (Windows).

External Interface
The process engineer must interface with the FoxView application or Display Manager in order to
generate log data and request reports for the Operator Action Journal, as follows:
You must notify the FoxView application/Display Manager whenever the logging of
operator actions is to be started or stopped, and specify to which system printer the
data is to be sent and in which Historian database the actions are to be stored, as
applicable.

If logging is configured, all actions that affect the control processor are logged at a
printer and/or to the Historian for later retrieval.
You retrieve the data by requesting generation of the ASCII Operator Action Journal
file through the FoxView application/Display Manager. This is a printable file that
may be printed locally at a system printer or at an external printer. To generate the file,
the time interval of the report and the report filter options must also be specified.

B0193CW Rev G

1. Introduction

2. Principles of Operation
This section contains information on the principles of operation behind the Operator Action
Journal including enabling the journal at boot time, journal configuration, operation, data
recording and storage.

Enabling the Operator Action Journal at Boot Time

When the workstation boots up, action journal reporting is disabled. To enable this feature at
boot time, you must change the OJLOG variable in the following file depending on the platform:
Legacy Station Type

Network Station Type

AW51/WP51

Solaris based
MESH or Nodebus
Wkstation
Solaris based
Nodebus Wkstation
Windows based
MESH or Nodebus
Wkstation
Legacy
Nodebus Wkstation
Legacy
Nodebus Wkstation
Legacy
Nodebus Wkstation

AW50/WP50
WP70

PW
WP30
WP20

File
/usr/fox/wp/data/init.user

/usr/fox/wp/data/init.user
/usr/fox/wp/data/init.user

/usr/fox/hi/init.glbls
/usr/fox/hi/gc4_glbls
/usr/fox/hi/gc3_glbls

For more information on the creation and usage of the init.user or init.glbls files, refer to
Display Engineering for FoxView Software and Display Manager Software (B0193MQ).
Add the following variables in the appropriate file associated with the station types listed above,
and then reboot the processor. The variable OJLOG has the following format:
OJLOG=[E,D]<printer>,[E,D]<historian>
gctsize=14
dmtlist=OJLOG

where:
E = Enable
D = Disable
<printer> = name of the printer (for example, LP01)
<historian> = name of the historian (for example, hist01)

B0193CW Rev G

2. Principles of Operation

This enables or disables the logging of the historian or printer. For example, to enable historian
logging without printer logging, define OJLOG as follows:
OJLOG=DLP01,Ehist01
NOTE

You must reboot the processor after editing the init.user or init.glbls file.
See Display Engineering for FoxView Software and Display Manager Software (B0193MQ) for
more information on modifying init.user or init.glbls.

Journal Configuration
Before operator actions can be logged, the process engineer must specify the printer and/or Historian to which the recorded data will be sent and then enable one or both of these options. Also,
before a report file can be generated, the duration of the requested report must be specified. If the
report file is to be printed through the configurator, the system printer for the journal printout
must also be specified.
To set these report options:
1. Select Config from the Display Manager or FoxView top menu bar.
2. Select OperActJournal from the pull-down menu.
The system presents a display showing the current state of the journal configuration and the various options available for starting and stopping operator action logging, setting log configuration
parameters, generating a report file, and printing a report. See Figure 2-1.

2. Principles of Operation

B0193CW Rev G

Operator Action Journal

Report Printer

Historian Log

L P00

Printer

DMWP50:DMWP50

Enabled
Disabled

Report Duration
From

Earliest available

To

Latest available

Historian

qualdb

Printer Log
Enabled
Disabled
Report Filters
Workstations/DMs
Compounds
Blocks

*
*

Printer

LP00

File to Create/Print
File

DMWP50.oaj

Report File Actions

Create File
Print File
Create & Print
Done

Cancel

Note that Workstations/DMs applies to FoxView software as well as the

legacy Display Manager software.
Figure 2-1. Operator Action Journal Configuration Selections (Solaris)

B0193CW Rev G

2. Principles of Operation

Figure 2-2. Operator Action Journal Configuration Selections (Windows)

Printer Log
Clicking on Enabled or Disabled in the Printer Log box starts or stops the logging operator actions to a printer. Current status is indicated by a solid circle next to Enabled or
Disabled. See Figure 2-1 or Figure 2-2.
Clicking on Printer calls up a menu of available printers (printer configuration table)
from which a specific printer can be selected.
Figure 2-3 shows a sample printer configuration table. This table overlays the main display and may list up to ten printers. Selecting a printer from the table causes the name of
that printer to appear in the Printer Log box. Click on the stop sign to cancel the printer
menu.
NOTE

If printing is enabled, FoxView displays the name of the printer in the status bar.

2. Principles of Operation

B0193CW Rev G

Printer Selection Menu

Selected Printer: LP72
LP72
LP73

0006 Color Ink-Jet Printer

0010 Color Inkjet Printer

Figure 2-3. Printer Selection

File to Create/Print
Solaris
This block shows the current selected operator action file name to be printed (through
Report Printer) or to be created (through Report File Actions) as shown in Figure 2-1.
NOTE

Reports are not supported on Windows operating system.

Enter another report file in the IO field or select another file using the File button.
NOTE

On the Operator Action Journal configuration screen on Nodebus and Mesh

Solaris workstations, selecting the File button shows the contents of the local disk,
not the associated hosting AP. Normally, the local directory is empty since OAJ
reports are generated and stored on the hosting AP disk.

NOTE

On Solaris 10 Mesh workstations, the Create and Print action can be performed
only from the workstation where AIM*AT software has been installed. See
Figure 2-1.

Historian Log
Clicking on Enabled or Disabled in the Historian Log box starts or stops the process of
logging operator actions to the Historian. See Figure 2-1. Current status is indicated by a
solid circle next to Enabled or Disabled. FoxView displays the name of the historian to
which it is logged. Select the local historian.
Clicking on Historian in the Historian Log box calls up a menu (configuration table)
containing the names of the current Historian databases and their associated APs, PWs,
and so on. Selecting one of these names causes that Historian to be selected and its name
to appear in the Historian Log box.

B0193CW Rev G

2. Principles of Operation

Report Printer
Solaris
Selecting Printer in the Report Printer box calls up a configuration table of available
printers. Selecting a printer from this table sets that printer for printing journal reports.
See Figure 2-1.
NOTE

This setting does not affect the printer selected for logging.

Report Duration
Click on the Earliest Available or Latest Available fields to include the oldest or
most recent logged actions, respectively. Enter dates as MM-DD-YY HH:MM; for example, 12-25-98 23:59.
The default duration causes the entire contents of the Operator Action Journal file to be
reported.

Report Filters
Enter filter patterns in the Report Filters box to select the workstation letterbugs, compound names, and block names that are to be in the report. Filter options can be set to
exclude certain logged entries. A filter on workstation letterbug GC3E03, for example,
includes in the report only those entries that were logged against a workstation with the
letterbug GC3E03. Similarly, filter options can be used to exclude entries based on the
compound or block names. The default filter option excludes nothing from the report
(each data entry field is an asterisk). These options are:
* matches all characters (excludes nothing)
? matches a single character
[..] matches specified characters.
Examples:
To print all logged data
workstation: *
compound: *
block: *
To print action from workstation starting with WPl
workstation: WPl*
compound: *
block: *
To print all action for blocks starting with A or B, and third and fourth characters
FT:
block: [A,B]?FT*

Report File Actions

Solaris
8

2. Principles of Operation

B0193CW Rev G

Use the Report File Actions button selections to specify the actions to be taken for the
Report File. The Report File is stored on the logical host, in directory /usr/fox/reports.
The file name is <DMNAME>.oaj. This is an ASCII file.
NOTE

A create request or print request must not already be in progress when this request is
made.
The following selections are possible:
Selecting Create File initiates generation of the journal report file.
Selecting Print File initiates printing of the journal report file.
Selecting Create & Print initiates both of the above.
The request is acknowledged by an overlay at the display.

Data Recording and Storage

When the Operator Action Journal feature is enabled, all operator actions within the Display
Manager, FoxView, and the Alarm Manager that change parameters in the process database are
logged to a printer and/or to the specified Historian database. These operator actions include toggling points, ramping or direct data entry of new point values, changing block statuses, acknowledging block alarms, and other actions such as horn muting.
Information logged as a result of each database change includes:
Name of the Display Manager, FoxView, or Alarm Manager that requested the database change
Compound:Block.Point for which the change was made
The old value TO new value text for non-packed boolean
Current mask and data value for packed boolean/long.
NOTE

Enabling or disabling the journal feature for one Display Manager/FoxView does
not affect other Display Managers/FoxViews. When changes are made in journaling, the associated Alarm Manager is also affected.
Following is an example of an Operator Action Journal report.

B0193CW Rev G

Operator
Tue Aug
08-02-97
08-02-97
08-02-97
08-02-97
08-02-97
08-02-97
08-02-97
08-02-97
08-02-97
08-02-97
08-02-97
08-02-97
08-02-97
08-02-97
08-02-97
08-02-97
08-02-97
08-02-97
08-02-97

2. Principles of Operation

Action Journal Report

1 1997 17:04:05 Page
1
07:57:08 GC3E31 SCRIPT /usr/fox/hi/init.cmds
07:57:15 GC3E31 ChgEnv Init_Env ->Init_env
07:58:19 GC3E31 ChgEnv Init+Env ->Proc_Eng_Env
08:00:34 CG3E31 UC01_LEAD
:SINE
.OUT
16.18
08:00:54 GC3E31 UC01_LEAD
:SINE
.MA
Manual
08:00:57 GC3E31 UC01_LEAD
:SINE
.LR
Remote
08:01:01 GC3E31 UC01_LEAD
:SINE
.MA
Auto
08:01:05 GC3E31 UC01_LEAD
:SINE
.LR
Local
08:01:35 GC3E31 UC01_LEAD
:SINE
.OUT
81.05
08:02:14 GC3E31 UC01_LEAD
:SINE
.INHIB Set
08:02:19 GC3E31 UC01_LEAD
:SINE
.INHIB Reset
08:03:22 K1WP51 UCO1_LEAD
:SINE
.INHALM V=0002
08:03:41 K1WP51 UCO1_LEAD
:SINE
.INHALM V=0003
08:03:41 K1WP51 ALL_TYPES
:MCIN
.CINMSK V=a8000001
08:03:41 K1WP51 ALL TYPES
:MCIN
.CINMSK V=00000000
08:04:02 GC3E31 UC01_LEAD
:SINE
.INHIB Set
08:04:15 GC3E31 UC01_LEAD
:SINE
.INHIB Reset
08:05:16 GC3E31 SCRIPT /usr/fox/config/AlarmPanel_Cfg
08:06:53 GC3E31 SCRIPT /usr/fox/tmplts/butreload

to 46.18
to Auto
to Local
to Manual
to Remote
to 44.4
to Reset
to Set
M=0002
M=0001
M=a8000001
M=a8000001
to Reset
to Set

Origins of Operator Actions

Actions from user-built graphics, default displays, group displays, or external sources such as
script files are logged regardless of the origin of the request. The origin of the action is not logged.
For example, an operator may select a user-defined button that has been configured to run a
script. The script may modify any number of process database points. The journal records an
entry for each process database change, but does not indicate that the changes were the result of
running a script.

Packed Boolean Database Changes

Two data types are associated with packed Boolean values:
Boolean integers (16 Boolean packed values in a single integer)
Packed Boolean long integers (32 Boolean values in a single integer).
If the journal is on while packed Boolean bits are being set or reset, the Display Manager or FoxView creates the Operator Action Journal description fields, V=value and M=mask, where mask is
the mask applied to the parameter, in hexadecimal notation, and value is the new value in hexadecimal notation.
When the data type is PACKED_LONG, mask and value are 8-character fields. When the data
type is PACKED_BOOLEAN, mask and value are 4-character fields.
Below are several examples of Operator Action Journal messages regarding the setting of packed
Boolean bits:

10

2. Principles of Operation

B0193CW Rev G

Resetting the HIHIABS alarm bit in INHALM (packed Boolean data type):
2-28-96

12:30:22 GC3E31 UC01_LEAD

:SINE .INHALM V=FC00

M=0220

Setting Contact #1 in parameter CINMSK (packed long data type):

2-28-96

10:44:21 GC3E31 Cname

:Bname

.CINMSK

V=81380049

M=80000000

Interpret the messages as follows:

Begin by checking the mask to identify which bits have changed (which are set and
which are reset).
Next, look at the data value portion to determine whether they are set to 0 or to 1.

Logged Operator Actions

In addition to process database changes, the following operator actions are logged:
Running scripts
Executing the Display Manager command applic or wp_applic/run
setting/ramping

Changing environments
Muting horns.
These additional operator actions have been included in log data because they may be useful in
analyzing a journal report and reconstructing events.
The operator action data file may contain up to 500 entries for each Historian database. (The
number of entries is set when the Historian is configured.) When the file becomes full, new
entries overwrite the oldest ones.

Operation
To access the Operator Action Journal configuration menu, select Config from the top menu bar,
then OperActJourn.
To enable logging of operator actions to a system printer:
1. Click on Printer in the Printer Log box. A table of up to 10 available printers
appears.
2. Select the desired printer from the table. The printer ID (for example, LP03) appears
next to the Printer field in the Printer Log box.
3. Click on Enabled in the Printer Log box to enable logging of operator actions to the
system printer.
To enable logging of operator actions to the Historian:
1. Click on Historian in the Historian Log box. A table of available Historians
appears.
2. Select Historian from the table. The Historian name appears next to the Historian
field in the Historian Log box.
3. Click on Enabled in the Historian Log box to enable logging of operator actions to
the Historian. (The Historian must be running for operator actions to be logged.)
To generate an ASCII report of operator actions:
1. Set the Station, Compound, and Block options in the Report Filters box.
11

B0193CW Rev G

2. Principles of Operation

2. Set the Earliest and Latest available dates/times in the Duration box.
3. Select Create File in the Report File Actions box. (A generation request or print
request must not be in progress when this selection is made.) The following appears as
an overlay on the display:
Create File process has been started on the Application Processor.
Continue

To print the generated file at a system printer:

1. Click on Printer in the Report Printer box. A list of available printers appears.
Figure 2-3 on page 7 shows an example of this table.
2. Select the desired printer from the table.
3. Click on Print File in the Report File Actions box. (A previous generation or
print request must not be in progress at this time.) The following appears as an overlay on the display:
Print File process has been started on the AP or WP.

Continue

To print the generated file at a nonsystem printer, copy the generated file to a 3.50
inch diskette. The file may be printed to a PC printer the same way as any text file.
To create and print the file with a single action, click on Create & Print in the Report File
Actions box. The following appears as an overlay on the display:
Create & Print process has been started on the Application Processor.

Continue

The Done button exits the configurator, saving any configured information, such as logging of
printer or historian name. Click the Done button for settings changes to affect the Display Manager or FoxView.
The Cancel button exits the configurator without saving any configured information.
NOTE

When requesting an Operator Action Journal report, you are notified that the
requested action has been initiated, but not when action has been completed.
Therefore, if a report is to be generated and printed, it is recommended that you use
the Create & Print function rather than the Create File and Print File functions separately.

12

Index
C
Configuration selections 4
Duration 7
Historian Log 6
Printer Log 5
Report File Actions 7
Report Filters 7
Report Printer 7
Configuring the journal 4
Create and print report file 11
D
Data recording and storage 8
Database changes 8
Duration 7
E
Enable logging 10
External interface 1
G
Generate ASCII report of operator actions 10
H
Historian Log 6
J
Journal configuration 4
L
Logging information 8
O
Operation 10
Operator Action Journal configuration selections 4
Operator Action Journal report
example 8

13

B0193CW Rev G

Index

P
Principles of operation 3
Print the generated file 11
Printer Log 5
Printer selection 6
R
Report File Actions 7
Report Filters 7
Report Printer 7
S
Specifying Historian 4
Specifying printer 4

33 Commercial Street
Foxboro, Massachusetts 02035-2099
United States of America
www.foxboro.com
Inside U.S.: 1-866-746-6477
Outside U.S.: 1-508-549-2424 or contact your local Foxboro representative.
Facsimile: 1-508-549-4999
Printed in U.S.A.

0907