System 800xA Training

Chapter 21 Simple Reports

TABLE OF CONTENTS

Chapter 21 Simple Reports ..................................................................................................................................................... 1

21.1 General Information ................................................................................................................................................... 2
21.1.1 Objectives ............................................................................................................................................................ 2
21.1.2 Legend................................................................................................................................................................. 2
21.1.3 Reference Documentation .................................................................................................................................... 2
21.2 DataDirect .................................................................................................................................................................. 3
21.2.1 Introduction ......................................................................................................................................................... 3
21.2.2 Set Up for Every User .......................................................................................................................................... 3
21.2.3 User Interface in MS Excel................................................................................................................................... 8
21.3 Reports ....................................................................................................................................................................... 9
21.3.1 Common Controls ................................................................................................................................................ 9
21.3.2 Reports with Process Data .................................................................................................................................. 10
21.3.3 Reports with Historical Data............................................................................................................................... 11
21.3.4 Reports with Alarms and Events......................................................................................................................... 12
21.4 Scheduled Reports .................................................................................................................................................... 13
21.4.1 Report Templates ............................................................................................................................................... 13
21.4.2 Scheduling Reports ............................................................................................................................................ 14
21.4.3 Running Jobs ..................................................................................................................................................... 17
21.5 Snapshot Reports ...................................................................................................................................................... 18
21.5.1 Installing Snapshot Report Extension ................................................................................................................. 18
21.5.2 Creating Snapshot Report Folders....................................................................................................................... 20
21.5.3 Creating Snapshot Report Templates .................................................................................................................. 21
21.5.4 Present the Results ............................................................................................................................................. 26

Chapter 21 - 1
T360-21 Simple Reports - RevB

21.1 General Information

21.1.1 Objectives
On completion of this chapter you will be able to:
• Create simple reports based on MS Excel Data Access
• Setup a scheduled task to generate scheduled reports
• Use Snapshot reports

21.1.2 Legend
> Indicates when you go from one menu to a sub-menu
Italic Indicates object and file names
“ “ Indicates dialog box buttons, tabs, menus etc.
Bold Indicates important topics
Indicates start/explanation of student activity

21.1.3 Reference Documentation

3BUF001094 System 800xA Information Management
Data Access and Reports

Chapter 21 - 2
 System 800xA Training

21.2 DataDirect

21.2.1 Introduction
DataDirect (Excel Data Access) is an add-in for Microsoft Excel designed to retrieve
data (real-time data, historical values, lab data, batch information, and event
information) from System 800xA.
This functionality is one of the basic system functionalities, although it is part of the
Information Management software package. This means that it can be installed along
with the core system without installing IM, and that it doesn’t require additional
licensing. Nevertheless when installed in systems with IM some of its features are
enhanced (data access from non 800xA nodes, extended amount of historical values,
etc).
NOTE! Data Direct can run in any system node.

21.2.2 Set Up for Every User

21.2.2.1 Configuring the Add-In

The DataDirect add-in is integrated into Microsoft Excel on a user-basis. Initially, the
DataDirect add-in tools are only available for the user that installed the DataDirect
software. Logging onto the computer as a different user requires the add-in tools for
that user to be manually added.
NOTE! It is mandatory to perform this procedure for the service
account since this account is used for scheduled reports.

1. Log on as the desired user and start MS Excel.

Chapter 21 - 3
T360-21 Simple Reports - RevB

2. Click on the “Office” button in the upper right hand corner and select “Excel
Options” from the bottom of the menu.

3. Select “Add-ins” from the pane on the left. Then press the “Go” button in the
right pane.

Chapter 21 - 4
 System 800xA Training

4. Press the “Browse” button, and browse to the ABBDataDirect.xla file located
in:
C:\Program Files\ABB Industrial IT\InformIT\DataDirec\Bin:

This makes the DataDirect add-in available in the following dialog.

5. Make sure the “DataDirect” check box is checked, then press “OK”.

6. Once the add-in is enabled, the Data Direct toolbar will be available.

Chapter 21 - 5
T360-21 Simple Reports - RevB

21.2.2.2 Security Settings

In order to enable the DataDirect macros the security level must be changed to low.
This procedure has to be followed for every user and every node where DataDirect is
going to be run.

1. Click on the “Office” button in the upper right hand corner and select “Excel
Options” from the bottom of the menu.

2. Select “Trust Center” from the pane on the left, then press “Trust Center
Settings”.

3. Select “Macro Settings” from pane on the left and check “Enable all Macros”.

Chapter 21 - 6
 System 800xA Training

21.2.2.3 Calculation Strategies

The retrieval of system data is performed by executing DataDirect functions in the
Excel environment. These executions are calculations and by default the system is set
to calculate automatically.
In the case of DataDirect this behavior could be negative, since automatic calculation
updates the contents of the tables when the file is opened. To avoid this, the
calculations need to be configured as “Manual”.

1. Click on the “Office” button in the upper right hand corner and select “Excel
Options” from the bottom of the menu.

2. Select “Formulas” from the pane on the left, then check “Manual” in
Calculation options.

Chapter 21 - 7
T360-21 Simple Reports - RevB

21.2.3 User Interface in MS Excel

The system information is accessed through programmable functions in MS Excel.
These functions can be invoked manually or by accessing the Data Direct interactive
tools. To do so open the “DataDirect” menu or click on the DataDirect Toolbar
buttons.

Button Function
Same as accessing the menu DataDirect > Login. Logging is only
required when retrieving data remotely from a non 800xA node

Same as accessing the menu DataDirect > Industrial IT Process

Values. It opens the real time data access dialog

Same as accessing the menu DataDirect > Industrial IT History

Values. It opens the historical data access dialog

Same as accessing the menu DataDirect > Industrial IT Alarm and

Events. It opens the alarm and events data access dialog

Access the options menu to define how the data is going to be

presented, or which functionalities are to be available in the menu or
the toolbar.
Show the Help

Chapter 21 - 8
 System 800xA Training

21.3 Reports
DataDirect is mainly used to create reports. These can be created as:
• one time reports to show and store data from the instant they were created
• reusable reports to allow the user to reload the enclosed data when required
Operators can view reports from their Operator Workplaces by simply browsing report
archives via the Plant Explorer. Reports can be automatically generated and sent to
multiple output destinations such as printers, files etc.

21.3.1 Common Controls

DataDirect functions can be manually typed into the worksheet cells or they can be
invoked by using DataDirect dialogs. Dialogs help the user find the information within
the system structure and define the way the data is going to be presented.
There is one dialog for each type of report (process data, historical data and alarm &
events), but they all share a set of common controls:

The “Start Cell” input field defines the cell position where the result data will be
filled. If the “Insert” checkbox is selected, instead of filling the cells new rows will be
inserted.

Chapter 21 - 9
T360-21 Simple Reports - RevB

The “Output” options are used for:

• “Formula” = the destination cell will be filled with the function required to
retrieve the specified data. This means that if a calculation is executed the data
will be updated.
• “Data Only” = the numeric value of the property at the moment of configuration
will be written in the cell, and it cannot be modified by a calculation.

The “Item List” will show the available information for the selected object. The
contents of this list will change according to the data type:
1. Process Data will show every OPC property
2. Historical will show only the properties that are being logged by a Log
Configuration aspect
3. Alarm and Events Dialog will show only the Alarm & Event lists and alarm
lines
NOTE! It is recommended to avoid using the “Get Current
Value” option, since it delays the population of the table.

21.3.2 Reports with Process Data

A Process Data report is used to get real time values from the system. The Process
Data dialog can be accessed by clicking on the “IIT Process Value” button.

Chapter 21 - 10
 System 800xA Training

In the following example the In.Value property of the object Sxx_LT1 was selected,
and in the output options the object name and timestamp were enabled.

21.3.3 Reports with Historical Data

A Historical Data report is used to show historical values of a property. The Historical
Data dialog can be accessed by clicking on the “IIT History Value” button.

If a property is being logged using different logs they will be available to be chosen.

The “Retrieval Information” section defines how the historical data is going to be
treated before being added to the report:
• “Raw Data” = only the first points in the time window will be included
• “Interpolated Data” = the user can select a calculation algorithm (for example time
average) to process all the points in the time window and reduce them to the
amount of points defined by “Nr of Values”

Chapter 21 - 11
T360-21 Simple Reports - RevB

If the “Start” and “End” times are static, the report will always show data from that
fixed time window. If they are dynamic the time window will be relative to the
calculation time, so the data will change for every calculation.

21.3.4 Reports with Alarms and Events

An Alarm and Event report is used to show historical events from an alarm & event
list or alarm line. The Alarm and Event dialog can be accessed by clicking on the “IIT
History Value” button.

The time span needs to be specified like the time window for historical data).

F Exercise 21.1

Chapter 21 - 12
 System 800xA Training

21.4 Scheduled Reports

The 800xA’s scheduling functionalities can be used to execute reports, among other
operations. To do so a job needs to be created. This job will execute an action which
will use a report template created using Data Direct. A schedule will define when the
job executes the report action.
It’s basically the same concept as scheduling a project backup, what you have learned
in previous courses.

21.4.1 Report Templates

Whenever the report job is executed it searches for a report to use as template. There
are two ways to use a template: as a windows file or as a system object. The first
option is simpler, but the second one improves the maintenance of the template
(allows versioning, saves the template in the Full Backup), etc.
The report templates are generic type objects located in the Scheduling Structure
under the Reports object.

Each report has a File Viewer aspect that attaches the 800xA system object with
windows files.

The “public document” is the file shown by the File Viewer’s “Main View”, while the
work document is the file that is going to be linked to the report template object.

Chapter 21 - 13
T360-21 Simple Reports - RevB

21.4.2 Scheduling Reports

Scheduling of reports is implemented as Job Description objects which are created in
the Scheduling Structure (one schedule per job). Every report job description must
contain an Action and a Scheduling Definition aspect to define what to do and when to
do it.
1. Add a new object to the Scheduling Structure under Schedules and Jobs.

2. Add an Action aspect to the newly created job.

3. The Action aspect has to be configured to execute a report.

Chapter 21 - 14
 System 800xA Training

4. Define the report template path and choose “Windows files”:

5. Browse to the report template and click “Open”.

6. Define the output options: save the reports as files, sent them directly to a
printer or send them as e-mails.

7. Define report files paths and the max. number of files. The path can be defined
to include the timestamp in the format C:\filename <TimeStamp>.xls.

NOTE! The path is the local disk on the node where the
Scheduler Service is running.

Chapter 21 - 15
T360-21 Simple Reports - RevB

8. Select the Scheduling Definition aspect of the job object.

9. The job can be configured to run with any frequency or to be triggered by an

expression. A time window can also be set up to be the only moment in which
the job can run. The schedule must also be assigned to a Scheduler Service
Group.

Chapter 21 - 16
 System 800xA Training

21.4.3 Running Jobs

Jobs run when they are scheduled to do so or when they are manually run by pressing
the “Run Now” button on the Scheduling Definition aspect.
When a job is running a Running Job object is automatically created under Running
Jobs in the Scheduling Structure. When the job is finished this object disappears.
The status of the job can be identified by its icon color:
• Green: Running / Paused

• Blue: waiting to be executed

• Red: failed
(if a job fails a log is available to find out the reason)

Chapter 21 - 17
T360-21 Simple Reports - RevB

21.5 Snapshot Reports

Snapshot Reports is a search engine for System 800xA, with the following functions:
• Find information in the 800xA system such as:
- Valves in area 15 that are closed and in manual mode
- I/O modules with forced I/O signals available
- The values of MV, OP and SP present for all PID objects
- Types of valves in control systems that are in a closed position
- Objects where the Operators Note has been changed/edited during the last
8hours
• Presents the search result in a list format. The list can be used as snapshot report
and exported to MS Excel.
NOTE! Snapshot Reports are a separate licensable option.

21.5.1 Installing Snapshot Report Extension

1. Log in as the Service account.

2. Launch the Installation Wizard and select “Snapshot Reports”. Click “Install”
and follow the instructions to complete the installation.

NOTE! When the installation dialog prompts for the type of

installation choose “Typical”.

Chapter 21 - 18
 System 800xA Training

3. Open the Configuration Wizard on the Primary Aspect Server and select
“System Administration > System Extension Load” to load the system
extensions.

4. Mark the Snapshot Reports for 800xA to the right list and click “Next”.

5. The installation can be verified by browsing to Library Structure.

Chapter 21 - 19
T360-21 Simple Reports - RevB

21.5.2 Creating Snapshot Report Folders

Creation of new Snapshot folders can be of interest if you want to differentiate
template categories or create dedicated folders for specific search areas.
1. Browse to the Library Structure and create a new object under Snapshot
Reports Templates.

2. Give the new folder an appropriate name and press “Create”.

3. A new folder is now created and ready to be filled with new snapshot
templates or Snapshot Report Viewer aspects.

Chapter 21 - 20
 System 800xA Training

21.5.3 Creating Snapshot Report Templates

Templates are used to define the search criteria. They consist of a configuration part
and a search part (separate tabs in the same window). Templates are created in the
Library Structure.
Templates can be used by one or several SnapshotReportView aspects in order to
perform dedicated searches during runtime.

1. Right-click on the snapshot report template folder where a new template needs
to be created and create a new SnapshotReportTemplateCategory aspect

Give it a meaningful name. In this example we want to search for all forced
I/O signals, therefore the name is “Forced IOs”

2. Double-click on the new aspect to view the configuration view.

Conditional search of property values is possible:

- operators: =, !=, > ,< or blank
- AND or OR combination of property conditions

Chapter 21 - 21
T360-21 Simple Reports - RevB

3. As Aspect Category, select the Hardware Unit aspect.

4. In the Properties window, select the Forced parameters and use the “>>”
button to select the Forced parameters for presentation.

5. In the Search where, select “In Structure” and search in the Control Structure.

Chapter 21 - 22
 System 800xA Training

6. Select the “Search” tab and press the “Search” button to verify the search
result.

7. Save the template using the “Apply” button. If required, press the “To Excel”
button to export the result.

Chapter 21 - 23
T360-21 Simple Reports - RevB

21.5.3.1 Further Examples

Search for “PID loop in Manual mode”

Chapter 21 - 24
 System 800xA Training

Search for “Operator notes changed during last 8 hours”

Search for “New objects created in the last 24 hours”

Chapter 21 - 25
T360-21 Simple Reports - RevB

21.5.4 Present the Results

The SnapshotReportViewer aspect is used to define the contents of the snapshot
report. In the configuration part you can use predefined templates. Several search
templates can be used in a combined search.
It can be configured to search:
• in a dedicated 800xA Structure e.g. Control Structure, Functional Structure
• from the object where it is placed (that is from the object and below)
• from a dedicated object in a suitable 800xA Structure

The aspect can be placed on:

• object types in the Object Type Structure, thus provide the Snapshot Report
Viewer aspect to be inherited to each instance of this type
• an object in any 800xA Structure where the search actually are going to be used

It can be accessed by the Operator or Maintenance personnel through aspect links, the
context menu of objects including a SnapshotReportView aspect or through drop-
down lists in the header of the Operator Workplace.

Chapter 21 - 26
 System 800xA Training

The search result is then presented in a separate window in a List View format.

Some features:
• Object context menu available
• Can be sorted via left click in the column header
• Can be written to Excel for further processing or storage

Chapter 21 - 27
T360-21 Simple Reports - RevB

Chapter 21 - 28