Experion PKS/PMD

PMD server/PlantScape server

Report building
Overview

This training course will provide an overview of all the standard preformatted reports available
with Experion PKS/PMD. These same reports will be supported in the forth coming release of
Experion PKS. Configuration of Free Format and Excel custom reports will also be covered in
this training module.
This training course is intended for members of the Honeywell engineering community who have
no experience using the report features.
Some of the more commonly used standard reports will be explained in more detail with screen
captures of the output format. Standard reports are included with all systems and should always
be considered when reports are required for a project deliverables.

Pulp, Paper, and Printing PMD report building

30-May-03 2
Page 2
Use of reports

• Reports are typically used for:

– Analyzing alarms and events
– Analyzing system activities
– Performing routine tasks
– Searching for points with specific attributes
• Reports may be requested and printed on demand, and/or scheduled to be generated
at pre-defined times.
• Output of reports can be sent to printers, text files or to operator Station displays.
• There are two types of Reports:
– Standard Reports, which are preformatted reports provided with system to obtain
information about alarms, events, points and etc.
– Custom Reports, which can obtain almost any kind of information stored in the server
database

Pulp, Paper, and Printing PMD report building

30-May-03 3
Page 3
 Standard Reports
Overview

Pulp, Paper, and Printing PMD report building

30-May-03 4
Page 4
Report types

The following three pre-formatted standard report types are available to analyze
alarm and event information from the server database:

• Alarm/Event
– Used to analyze alarms and events that occurred during a user defined time period.
This information is extracted from the server Event file.
– The number of events that can be stored in the file is determined by the database sizing.
When this file becomes full, the oldest event is discarded in order to add a new event.
– Of the three reports, the Alarm/Event report is the most commonly used by plant
operators.
– This report can be configured to capture the system alarms and
output them to a designated alarm printer on a scheduled basis.
• Alarm Duration
– Used to produce reports on how long nominated points were in an alarm condition.
This report also uses the information from the server Event file.
• Sequence of Events (Plant Scape property)
– Enables entries to be selected from the server’s Sequence of Event file. This file is
similar to the server Event file.
– This report can only be used with the RTU’s, that have the time stamp events capability.

Pulp, Paper, and Printing PMD report building

30-May-03 5
Page 5
Report types (2)

• Point Attribute Report (Plant Scape property)

– Used to produce a list of points that have certain attributes such as:
off scan, alarm inhibited, bad PV, or in-manual-mode.
• Point Cross Reference Report (Plant Scape property)
– Used to determine where points are referenced in the system such as:
custom displays, reports, point detail and trend groups.
• Down Time Analysis Report (Plant Scape property)
– Used to list and sort down time delays that occur during a time span.
– The Down Time Analysis licensed option must be installed in ordered to configure this
report.
• Batch Report (Plant Scape property)
– Used to collect history for a set of points.
– Also used to list events for an area for the duration
of a production run.

Pulp, Paper, and Printing PMD report building

30-May-03 6
Page 6
 Report Configuration
Overview

Pulp, Paper, and Printing PMD report building

30-May-03 7
Page 7
Configuration (1)

Start here to configure reports from the operator station:

Select Configure, then

Reports

Pulp, Paper, and Printing PMD report building

30-May-03 8
Page 8
Configuration (2)

Left mouse click on

the report number
to call up the reports
configuration page.

Pulp, Paper, and Printing PMD report building

30-May-03 9
Page 9
Configuration (3)

The Definition tab is used

to select the report type
and to define the
request method.

Pulp, Paper, and Printing PMD report building

30-May-03 10
Page 10
Configuration (4)

1. If you do not have a printer

configured on your system. The
output of the report can be
displayed on the Station display,
when the report is requested..

2. Note the PlantScape Station security level

below. Reports can be requested and
viewed using the operator (OPER) level
security, but to configure or modify
configured reports you must change
to the engineer (ENGR) level or higher.

Pulp, Paper, and Printing PMD report building

30-May-03 11
Page 11
Configuration (5)

The Content tab is different

for each report type and it is
used to define the point data
that the report will contain.

Pulp, Paper, and Printing PMD report building

30-May-03 12
Page 12
Configuration (6)

The Scripting tab allows you to

extend the functionality of your If you want to learn
system. more about scripting
(A script is a mini-program left mouse click on the
that performs a specific task.) “Scripting Help”.

Pulp, Paper, and Printing PMD report building

30-May-03 13
Page 13
Configuration (7)

The report scripts (other than library scripts)

are event-driven.
They only run when the associated A script engine is a software module
event occurs for example, that interprets a script and performs
a script can be ran its instructions.
“OnCompletion” of a report generation
or
on a “OnTimer” event

Warning:
The server report scripting has been optimized for relatively short scripts (less than 30 lines), and is not
designed for implementing control strategies (these should be done in the controller).
If a task is computationally intensive, or requires extensive file handling, you should write a special
application in Visual C/C++ or Visual Basic.
Pulp, Paper, and Printing PMD report building
30-May-03 14
Page 14
Configuration (8)

Once the report is configured it will appear on the Report Summary page. To delete a report from
the system, change the “Report Type” on the “Definition” tab to “None”.

Pulp, Paper, and Printing PMD report building

30-May-03 15
Page 15
 Learn different ways to
request reports

Pulp, Paper, and Printing PMD report building

30-May-03 16
Page 16
Report requesting

After you have configured reports for your system, operators and
others can request these reports on demand, by using one of the
following methods:
– Clicking on the “Request” button on the “Definition” or “Content” tab, when viewed
from the Configuration > Reports menu.
– Clicking on the “Request” button when viewed from the View > Report Summary menu.
– Clicking on a configured pushbutton on a custom display.
– By typing the command “pr nnn” in the Station command zone where (pr = print report,
and nnn = the report number)

Note: When a report is requested the text output is sent to a file even if the report
is configured to be sent to a printer or display. The report files can be found under
the “Honeywell/server/report” directory. The file format is : RPTnnn.HTM, where
the nnn = the report number.

Pulp, Paper, and Printing PMD report building

30-May-03 17
Page 17
Pushbutton in Display Builder (1)

1. Add a pushbutton .

2. Double click on the

pushbutton to view the
properties.

3. From the “Behaviours” tab,

select the “Display link” option.

Pulp, Paper, and Printing PMD report building

30-May-03 18
Page 18
Pushbutton in Display Builder (2)

4. From the “Link” tab,

Define file name and path.

Pulp, Paper, and Printing PMD report building

30-May-03 19
Page 19
Report requesting

If you know the report number you

want to request, type the “pr nnn” in the
Station command zone.
(nnn = the report number)

Pulp, Paper, and Printing PMD report building

30-May-03 20
Page 20
Status

Note: When a report is requested the

“Request in progress”
will appear in the Station message
zone area.

Pulp, Paper, and Printing PMD report building

30-May-03 21
Page 21
Report file locations

Location of report files:

After the report is requested the information contained in the report is saved on the PMD server
in the “Honeywell\server\report” directory.

Pulp, Paper, and Printing PMD report building

30-May-03 22
Page 22
 Standard Pre-Formatted
Reports Lab

Pulp, Paper, and Printing PMD report building

30-May-03 23
Page 23
Alarms and events

Pulp, Paper, and Printing PMD report building

30-May-03 24
Page 24
Alarms and events (2)

1. Set the relative time

period to e.g. 10 minutes.
Left mouse click
on the “Request”
button above.

Pulp, Paper, and Printing PMD report building

30-May-03 25
Page 25
Alarms and events (3)

Note the report time

period and
the point
information shown.

Pulp, Paper, and Printing PMD report building

30-May-03 26
Page 26
 Alarm duration

Pulp, Paper, and Printing PMD report building

30-May-03 27
Page 27
Alarm duration (2)

Lets change the time

period to 24 hours.

Pulp, Paper, and Printing PMD report building

30-May-03 28
Page 28
Alarm duration (3)
Alarm Duration Report

Note how long

the point has been
in alarm.
This information
can be very useful
to operators when
trouble shooting
problems in their plants

Pulp, Paper, and Printing PMD report building

30-May-03 29
Page 29
Custom reports

If the pre-formatted reports does not

meet your project requirements, then
lets talk about custom reports.

Pulp, Paper, and Printing PMD report building

30-May-03 30
Page 30
Custom report types

Unlike the pre-formatted reports, these reports can be used to write information to the server
database. These custom configuration files should be stored in the “Honeywell\server\user”
directory.
The are three custom report types:
Free Format Report
– The Free Format configuration file is a text file that can be configured using Notepad.
– It uses the Free Format Writer Option to access the server database information.
– For simple applications this report can be used instead of custom
application software.
– You can use the Free Format reports to:
• Get values from point parameters
• Perform calculations
• Retrieve historical data to determine minimums, maximums,
summations, and standard deviations.
Microsoft Excel Report
– Microsoft Excel can use the Microsoft Excel Data Exchange or the ODBC driver
as a vehicle to read and write information to the server database.
– Microsoft Excel must be purchased and installed first before using this report type.
– Beware, Microsoft Excel reports can be resource intensive.

Pulp, Paper, and Printing PMD report building

30-May-03 31
Page 31
Custom report types (2)

ODBC Data Exchange Report

– This report is used to transfer data between the server database and
ODBC compliant databases (i.e. Microsoft SQL, Oracle, Microsoft Access and Sybase 10).
– The ODBC Data Exchange licensed option must be purchased and installed to use this
report type.
– This report feature has some of the same capabilities as Microsoft Excel Data Exchange.

Pulp, Paper, and Printing PMD report building

30-May-03 32
Page 32
ODBC vs. Excel reports

Differences between ODBC and Excel Data Exchange

Operation Excel Data Exchange ODBC
Point Data Read/Write Read Only
History Read Read
Database Files Read/Write No Access
Events No Access Read Only
Security None PlantScape User Security

Pulp, Paper, and Printing PMD report building

30-May-03 33
Page 33
 Free Format Reports

Pulp, Paper, and Printing PMD report building

30-May-03 34
Page 34
Free format report

The PlantScape on-line Knowledge Builder tool is a good resource for

information on Free Format Reports. Some of the information found in KB have
been included in this course material.
Below is the list of definition file entries used with the Free Format report type:

A - (Acquired Field Value)

B - (Start of Report Body)
C - (Calculated Variable Definition)
D - (History Standard Deviation)
F - (Fetch From Point)
G - (Give to Point)
L - (History Maximum and Minimum)
M - (Operating System File Definition)
P - (Perform Calculation)
R - (Read From File)
T - (Totalize History)
W - (Write to File)
X - (Demand Point Processing)

Pulp, Paper, and Printing PMD report building

30-May-03 35
Page 35
Pushbutton in Display Builder (1)

Here is a Free Format Report example from Knowledge Builder

*This is an example free format report
*Get the Point ID
F 1 01IT1LEVEL NAME A10
*
*Get the last 10 history values and store at
*index 20..
F 20 01IT1LEVEL PV F8.3 H1M(1) 10
*Get the maximum and minimum of these values and store at 50,51 respectively
L 50 01IT1LEVEL PV F8.3 H1M(1) 10
*Store these values in user table 254 record 3 words 1,2
W 50 254 3 1 RL
W 51 254 3 4 RL
*Calculate the standard deviation for these history 10 values
D 52 01IT1LEVEL PV F8.3 H1M(1) 10

Pulp, Paper, and Printing PMD report building

30-May-03 36
Page 36
Pushbutton in Display Builder (1)

Free Format Report example continuation:

*Calculate the sum of these history 10 values
T 53 01IT1LEVEL PV F8.3 H1M(1) 10
*Take an average of these values and store it at index
1 C 11 F8.3 P 11 = ($53)/10
P 70 = 1
P 71 = 2
P 72 = 3
P 73 = 4
P 74 = 5
P 75 = 6
P 76 = 7
P 77 = 8
P 78 = 9
P 79 = 10
*Store the result in the SP of a point
G 11 01OT1LEVEL SP
*
*Read some text from a file
M SEQ 501 0 c:\reports\freeformat\ffrdata.in
R 40 254 3 1 F8.3 RL F8.2
*2345678901234567890123456789012345678901234567890
B:

Pulp, Paper, and Printing PMD report building

30-May-03 37
Page 37
Project example

* Set Station Fudge Factor Points to zero at the end of each gas day (9:00 am).
* This is done in a scheduled daily Free Format report. 1. The value stored
C 1 I1 in index 1 is
*
defined as an
P1=0
********************* integer.
*
G 1 A1A-SFPV-FF SP 2. Here, a calculation
G 1 ALX-SFPV-FF SP is performed, where
G 1 ANKP-SFPV-FF SP zero is assigned
G 1 ANK-SFPV-FF SP
to index 1.
G 1 B1A-SFPV-FF SP
G 1 BENP-SFPV-FF SP 3. The set point of the
G 1 BEN-SFPV-FF SP follow points
*
B
get assigned
The following Station Fudge Factor Points are now to the value that is
reset to zero: stored in index 1.
*
Primary Stations:
A1A-SFPV-FF SP 4. When the report
ALX-SFPV-FF SP runs at 9:00 am
ANKP-SFPV-FF SP
ANK-SFPV-FF SP
everyday, here
B1A-SFPV-FF SP is the report output
BENP-SFPV-FF SP information
BEN-SFPV-FF SP generated from the
* report.
Pulp, Paper, and Printing PMD report building
30-May-03 38
Page 38
Configuration of free report

After a Free Format definition text file is configured using Notepad, you can then select the “Free Format”
report type from the Station report configuration page as shown below:

Pulp, Paper, and Printing PMD report building

30-May-03 39
Page 39
Configuration of free report (2)

Next, from the “Content” tab, enter the file name in

the Definition File Path as shown below:
Note:You do not need to
specify a file path,
if you have saved the
file in the default directory
“Honeywell\server\user”.

Pulp, Paper, and Printing PMD report building

30-May-03 40
Page 40
 Microsoft Excel Reports

Pulp, Paper, and Printing PMD report building

30-May-03 41
Page 41
MS Excel reports

Microsoft Excel reports are configured to run from the operator station like other
standard reports. Microsoft Excel Data Exchange or the ODBC driver is used to
access data in the server database from Microsoft Excel. When the report runs this
data is refreshed and a copy of the data is saved in the “Honeywell\server\report”
directory.

With Microsoft Excel Reports you can:

– Get values from point parameters
– Perform calculations on those points
– Retrieve historical data to determine summations, maximums, minimums, and standard
deviations
– Retrieve alarms and events
– Generate graphs and tables
– Store new values or calculations in the server database. Provided you install Microsoft Excel
Data Exchange with the "write" option enabled.
– Read/write access to PlantScape database files (user files)

Pulp, Paper, and Printing PMD report building

30-May-03 42
Page 42
MS Excel data exchange vs. ODBC
Driver
Points to consider when choosing between Microsoft Excel Data Exchange
and the ODBC Driver are:
– Microsoft Excel Data Exchange is a licensed option for PlantScape, and the PlantScape
ODBC driver is standard.
– They have different installation requirements
– Microsoft Excel Data Exchange can access all information in the server database, the
ODBC Driver can only access point, history, event, and some access control data.
– Microsoft Excel Data Exchange can write to the server database.
– The ODBC Driver follows the same security conventions as other reports. Microsoft
Excel Data Exchange has no security.

Pulp, Paper, and Printing PMD report building

30-May-03 43
Page 43
MS Excel reports properties

Using Microsoft Excel Data Exchange:

– Real time point value and history information can be captured
from PMD server database and displayed in an Excel spreadsheet.
– Data can be retrieved from server by using either
the Microsoft Excel Data Exchange Wizard, or through cell formulas.
The captured data can be static or dynamically updated, and can consist
of either point parameter or historical data from any server database on the network.
– Once the data has been captured you can create charts to display
and analyze the data with Microsoft Excel's toolset.

Pulp, Paper, and Printing PMD report building

30-May-03 44
Page 44
MS Excel reports

Using the Microsoft Excel Data Exchange Wizard:

The following procedures explain how to capture point or history
values and display them in Microsoft Excel spreadsheet using the
Microsoft Excel Data Exchange Wizard.
1. Start Microsoft Excel before beginning any of these procedures
2. Open the worksheet in which you want your data displayed.
3. Highlight the cell that is to be the starting point for the data.

Pulp, Paper, and Printing PMD report building

30-May-03 45
Page 45
MS Excel data exchange (1)

To display a particular point parameter from the server:

1. Start Microsoft Excel and open the worksheet in which you want your data displayed.
2. Highlight the cell for the starting point for the data.
3. Select Tools > Microsoft Excel Data Exchange > Wizard.

Pulp, Paper, and Printing PMD report building

30-May-03 46
Page 46
MS Excel data exchange (2)

4. Select “Get point values from server(s)” and click on the “Next” button to specify the target point
parameters:

Pulp, Paper, and Printing PMD report building

30-May-03 47
Page 47
MS Excel data exchange (3)

5. Enter the name of the PMD server, point ID and parameter as shown below.
You can add or remove point parameters as required.
6. Click the “Add” button

Pulp, Paper, and Printing PMD report building

30-May-03 48
Page 48
MS Excel data exchange (4)

7. Select from the option shown below and click Finish.

Display Server Name - Inserts the name of the PMD server into a cell on your Excel worksheet.

Display Point ID - Inserts the name of the Point ID into a cell on your Excel worksheet.

Display Parameter - Inserts the parameter name into a cell on your Excel Worksheet.

Paste Values - When unchecked, it inserts updateable values in your Microsoft Excel Worksheet.
When checked, it inserts fixed values into your Microsoft Excel Worksheet. Fixed values cannot be updated.
Minimize number of server calls
This option is only available when you choose to get history values from the server.
When it is unchecked Microsoft Excel queries the server separately for every cell that it fills with
data on your worksheet. When checked Microsoft Excel uses as few queries as possible.
This means just one query per server. It is important to check “minimize number of server calls”when the
values in the Microsoft Excel worksheet automatically updates.
Pulp, Paper, and Printing PMD report building
30-May-03 49
Page 49
Data in excel sheet (1)

Note the data, that is displayed

on your worksheet.

Pulp, Paper, and Printing PMD report building

30-May-03 50
Page 50
Data in excel sheet (2)

If you de-select the

options as shown below, the
PV value will only be displayed
on the sheet.

Note: To view continuously updating data, make sure the “Paste values” is unchecked.

Pulp, Paper, and Printing PMD report building

30-May-03 51
Page 51
Historical information (1)

Retrieving Historical Information:

You can insert a sequence of historical data into your Microsoft Excel worksheet, where
each cell contains a single sample from history.
1. Select Tools > Microsoft Excel Data Exchange > Wizard to start the wizard.
2. Select Get history values from server(s).

Pulp, Paper, and Printing PMD report building

30-May-03 52
Page 52
Historical information (2)

You can specify the desired historical values to be retrieved for a selected point.
Note: Make sure that your History type selection matches the history collection for the points on the
server. If you select a history collection that is not configured for that point, Microsoft Excel will
displays an error code instead of the data.

The Offset option below is the number of samples relative to "now." You can select this option to see a
continuous updated sequence of values.
The Date/Time option below is used to specify a sequence of values from a fixed period of time.

or

Pulp, Paper, and Printing PMD report building

30-May-03 53
Page 53
Historical information (3)
Here is an example of
history retrieved by
“Offset”

Here is an example of
history retrieved by
“Time and Date”

Pulp, Paper, and Printing PMD report building

30-May-03 54
Page 54
Excel reports help

You can also find more information

about the user defined functions
from the Microsoft Excel Help .

Pulp, Paper, and Printing PMD report building

30-May-03 55
Page 55
Excel report configuration (1)

After the Microsoft Excel file is configured, you can then select the Microsoft Excel report type from the
Station report configuration page as shown below:

Pulp, Paper, and Printing PMD report building

30-May-03 56
Page 56
Excel report configuration (2)

From the “Content” tab enter the file name in the Definition File Path as shown below:

Note:You will need to

specify the file path
if the file is not saved in
the default directory
“Honeywell\server\user”.

Pulp, Paper, and Printing PMD report building

30-May-03 57
Page 57