Thanks to visit codestin.com
Credit goes to www.scribd.com

0% found this document useful (0 votes)
562 views54 pages

9720137-002 Triconex Report Generator User's Guide 4.14.0

Uploaded by

usebio64
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
562 views54 pages

9720137-002 Triconex Report Generator User's Guide 4.14.0

Uploaded by

usebio64
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 54

Triconex® Report Generator

User’s Guide

Triconex Report Generator


Version 4.14.0

Assembly Number 9700137-002


September 2015
Information in this document is subject to change without notice. Companies, names and data used in
examples herein are fictitious unless otherwise noted. No part of this document may be reproduced or
transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express
written permission of Invensys Systems, Inc., now part of Schneider Electric.

© 2014–2015 Invensys Systems, Inc. All rights reserved.

Triconex, Tricon, Trident, and TriStation are trademarks of Schneider Electric SE, its subsidiaries and
affiliates. All other brands may be trademarks of their respective owners.

Document Number 9720137-002, Rev 0


Printed in the United States of America.
Contents

Preface v
New Features in Triconex Report Generator 4.14.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Summary of Sections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Product and Training Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
We Welcome Your Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii

Chapter 1 Getting Started 1


Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Installing Triconex Report Generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Installation Prerequisites and System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Installing the Report Generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Upgrading from Previous Versions of the Report Generator . . . . . . . . . . . . . . . . . . . . 7
Starting the Report Generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Getting to Know the Report Generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Uninstalling the Report Generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Chapter 2 Using the Triconex Report Generator 19


Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Specifying Directory Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Generating Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Viewing a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Printing a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Saving a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Opening Project Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Opening a TriStation 1131 Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Opening a Triconex Safety Validator Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Updating the Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Chapter 3 Types of Reports 33


Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Default Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Peer-to-Peer Duplicate ID Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Peer-to-Peer Function Block Usage Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Peer-to-Peer Configuration Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Tagname Cross Reference Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Custom Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Adding a Custom Report Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Index 43

Triconex Report Generator User’s Guide, 4.14.0


iv Contents

Triconex Report Generator User’s Guide, 4.14.0


Preface

Triconex® Report Generator is an application used for generating reports using configuration
information available in TriStation™ 1131 project files.

New Features in Triconex Report Generator 4.14.0


Triconex Report Generator version 4.14.0 is a significant release that includes the following new
features:
• Addition of a new report that lists duplicate Send and Receive identifiers used in the
Peer-to-Peer function blocks in a TriStation 1131 project file (.pt2).
• Ability to automatically create the test project (.tsvproj) and configuration (.tscfg) files
required by Triconex Safety Validator.
• Ability to open TriStation 1131 and Triconex Safety Validator project files directly from
Report Generator.
• Other minor fixes and enhancements.

Summary of Sections
• Chapter 1, Getting Started— Describes how Triconex Report Generator works, and
provides instructions for installing and starting the Report Generator.
• Chapter 2, Using the Triconex Report Generator— Explains how to view and export
reports, and specify directory locations in the Report Generator. Also describes how to
open project files directly from the Report Generator.
• Chapter 3, Types of Reports— Provides information about the default and custom
reports that can be generated using the Report Generator.

Related Documents
• TriStation 1131 Developer’s Guide
• TriStation 1131 Libraries Reference
• TriStation 1131 + ArchestrA Integration Guide
• Triconex Safety Validator User’s Guide
• Product Release Notices for specific Tricon, Trident, Tri-GP, and TriStation 1131 versions

Triconex Report Generator User’s Guide, 4.14.0


vi Preface

Product and Training Information


To obtain information about Triconex products and in-house and on-site training, see the
Invensys® website or contact your regional customer center.

Website
http://www.iom.invensys.com

Technical Support
Customers in the U.S. and Canada can obtain technical support from the Global Customer
Support (GCS) center at the numbers below. International customers should contact their
regional support center.
Requests for support are prioritized as follows:
• Emergency requests are given the highest priority
• Requests from customers with a support agreement and customers with purchase
order or charge card authorization are given next priority
• All other requests are handled on a time-available basis
If you require emergency or immediate response and do not have a support agreement, you
may incur a charge. Please have a purchase order or credit card available for billing.

Telephone
Toll-free number 866-746-6477, or
Toll number 508-549-2424 (outside U.S.)

Fax
Toll number 508-549-4999

Website
http://support.ips.invensys.com/ (registration required)

Triconex Report Generator User’s Guide, 4.14.0


Preface vii

We Welcome Your Comments


To help us improve future versions of Triconex documentation, we want to know about any
corrections, clarifications, or further information you would find useful. When you contact us,
please include the following information:
• The title and version of the guide you are referring to
• A brief description of the content you are referring to (for example, step-by-step
instructions that are incorrect, information that requires clarification or more details,
missing information that you would find helpful)
• Your suggestions for correcting or improving the documentation
• The version of the Triconex hardware or software you are using
• Your name, company name, job title, phone number, and e-mail address
Send e-mail to us at:
[email protected]
Please keep in mind that this e-mail address is only for documentation feedback. If you have a
technical problem or question, please contact the Global Customer Support (GCS) center. See
Technical Support on page vi for contact information.
Or, you can write to us at:
Attn: Technical Publications — Triconex
Invensys Systems, Inc.
26561 Rancho Parkway South
Lake Forest, CA 92630
USA
Thank you for your feedback.

Triconex Report Generator User’s Guide, 4.14.0


viii Preface

Triconex Report Generator User’s Guide, 4.14.0


1
Getting Started

Overview 2
Installing Triconex Report Generator 4
Starting the Report Generator 8
Getting to Know the Report Generator 9
Uninstalling the Report Generator 17

Triconex Report Generator User’s Guide, 4.14.0


2 Chapter 1 Getting Started

Overview
Triconex Report Generator is a software application that allows you to generate reports for one
or more Triconex controllers based on configuration information contained in input files
opened in the Report Generator.
You use TriStation 1131 project files (.pt2) as input files for the Report Generator.
Note Only project files created in TriStation 1131 4.0 and later are supported.
When an input file is opened in the Report Generator, the configuration information available
in the input file is copied to a report database. When you generate a report, the Report Generator
organizes the information in the report database, based on report templates on your PC.
The Report Generator then displays the reports within the Report Generator window. Reports
can also be exported to a pre-determined folder, depending on the option you select when
generating the reports. For more information on the options available when generating a report,
see Generating Reports on page 23.
The following diagram depicts how the Report Generator generates reports based on
configuration information available in the input file(s).

Report
Database

Direct view
TriStation 1131 Input Triconex Output
project file (.pt2) Report
Report Generator
Exported report
(.pdf or .xls)

Figure 1 How the Triconex Report Generator Works

The following four standard reports (known as default reports) are available in the Report
Generator:
• Peer-To-Peer Duplicate ID report
• Peer-To-Peer Function Block Usage report
• Peer-To-Peer Configuration report
• Tagname Cross Reference report

Triconex Report Generator User’s Guide, 4.14.0


Overview 3

In addition to these default reports, the Report Generator also supports custom reports that are
created using the SAP® Crystal Reports® software; this software must be purchased separately.
For more information about default and custom reports, see Types of Reports on page 33.
When you open a TriStation 1131 project file (.pt2) as the input file, the Report Generator also
automatically creates the associated test project (.tsvproj) and configuration (.tscfg) files. These
files are required by Triconex Safety Validator for creating automated test cases.
Note The Test Project (.tsvproj) and Configuration (.tscfg) folders are available only when you
open a Tricon project. If you open a Trident or Tri-GP project, these folders will be
disabled.
For more information, see the Triconex Safety Validator User’s Guide.
Note Throughout this guide, the term TriStation 1131, unless specified otherwise, refers to
TriStation 1131 version 4.14.0.

Triconex Report Generator User’s Guide, 4.14.0


4 Chapter 1 Getting Started

Installing Triconex Report Generator


The Report Generator can be installed on any PC that has a compatible version of TriStation
1131 installed. It can be installed using a standalone setup program, or as part of the TriStation
1131 installation via the TriStation 1131 setup program.
When you install the Report Generator as part of a TriStation 1131 installation, the most up-to-
date version of the Report Generator that was available at the time the specific TriStation 1131
version was released is installed. However, because the Report Generator is a separate
application, you can purchase and install an updated version at any time, without having to also
update your TriStation 1131 installation (as long as the TriStation 1131 and Report Generator
versions are compatible).
Note The Report Generator is only installed with TriStation 1131 version 4.13.0 and later. It is
not installed with earlier versions of TriStation 1131.
To install the Report Generator, you must be logged into Windows® as a user with
administrator privileges. If you do not have administrator privileges, contact your network
administrator for assistance.
Topics include:
• Installation Prerequisites and System Requirements on page 4
• Installing the Report Generator on page 5
• Upgrading from Previous Versions of the Report Generator on page 7

Installation Prerequisites and System Requirements


A compatible version of TriStation 1131 must be installed on the PC where you are installing the
Report Generator. If you are installing Report Generator 4.14.x, the PC where you are installing
the Report Generator must have TriStation 1131 4.14.0 installed.
If you install the Report Generator using the standalone setup program, you will be prompted
to install the TriStation 1131 version compatible with the version of the Report Generator you
are trying to install. The TriStation 1131 setup program automatically installs the necessary
prerequisites. For example, if you are trying to install Report Generator 4.14.0 using the
standalone setup program, you will be prompted to install TriStation 1131 4.14.0. The TriStation
1131 4.14.0 setup program automatically installs the prerequisites applicable to Report
Generator 4.14.0.
System requirements for the Report Generator are the same as for TriStation 1131. For
information about the TriStation 1131 system requirements, see the TriStation 1131 Developer’s
Guide.
If you are installing the Report Generator along with TriStation 1131, the hard drive space
requirements for TriStation 1131 apply. If you are installing it on a PC that already has TriStation
1131 installed, the additional disk space required for the Report Generator is approximately 15
MB.

Triconex Report Generator User’s Guide, 4.14.0


Installing Triconex Report Generator 5

Installing the Report Generator


The Report Generator can be installed using either of the following methods:
• Installing the Report Generator via the TriStation 1131 Setup Program
• Installing the Report Generator via the Standalone Setup Program

Installing the Report Generator via the TriStation 1131 Setup Program
When you install the TriStation 1131 software, the TriStation 1131 4.14.0 setup program displays
a list of features you can choose to install along with TriStation 1131. To install the Report
Generator, you must select the Report Generator check box.

If you did not select the Report Generator check box during TriStation 1131 installation, you can
install it at any time using the Modify option in the TriStation 1131 setup, which allows you to
install additional TriStation 1131 features.
Note Installing the Report Generator using the Modify option in the TriStation 1131 setup
program only installs the most up-to-date version of the Report Generator available
when the specific TriStation 1131 version was released. A more recent version of the
Report Generator may be available via a standalone setup program, which can be
purchased separately. For more information, contact the Global Customer Support
(GCS) center.
For detailed information about installing TriStation 1131, and modifying an existing TriStation
1131 installation, see the TriStation 1131 Developer’s Guide.

Triconex Report Generator User’s Guide, 4.14.0


6 Chapter 1 Getting Started

Installing the Report Generator via the Standalone Setup Program


If you purchase an updated version of the Report Generator separately, you are provided with
a separate Report Generator installation CD, containing a setup program that only installs the
Report Generator files.

Procedure
1 Log on as an administrator or as a user with administrator privileges.
2 Close all open applications.
3 Insert the Triconex Report Generator CD in the CD-ROM drive., The installation should
start automatically. If it does not, browse to locate the setup.exe file on the CD, and then
double-click setup.exe to start the installation.
4 Follow the installation wizard instructions.
5 If prompted to install required prerequisite components, click Install Prerequisites.
Setup will automatically install all necessary prerequisites.
You must install all required prerequisite components before the Report Generator
setup can continue. For more information about a selected prerequisite, double-click the
prerequisite name.
Invensys recommends installing the Report Generator in the TriStation 1131 default
destination folder, which is:
C:\Program Files\Triconex\TriStation 1131 4.x.x.
Note For systems running 64-bit versions of Windows (Windows 7, Windows Server®
2012 R2, or Windows Server 2008 R2), the default folder is:
C:\Program files(x86)\Triconex\TriStation 1131 4.x.x.
6 Continue to follow the installation wizard instructions.
7 To complete the installation, click Finish.
Note If you installed the Report Generator using the standalone setup, you are not required
to restart your PC before running the Report Generator. However, if you installed it
using the integrated setup, you may need to restart the PC. For more information, see
the TriStation 1131 Developer’s Guide.

Triconex Report Generator User’s Guide, 4.14.0


Installing Triconex Report Generator 7

Upgrading from Previous Versions of the Report Generator


If you are upgrading from a previous version of the Report Generator, please note the following:
• At any point, you can have only one version of the Report Generator installed.
However, you do not need to manually uninstall the existing Report Generator before
installing a newer version. The setup program associated with the newer version
automatically uninstalls the older version. For example, if you have previously
installed Report Generator 4.13.0, this version is automatically uninstalled when you
install Report Generator 4.14.0., If you are installing the Report Generator using a
standalone (Report Generator only) setup program, you must first ensure that a
compatible version of TriStation 1131 is installed. See the Product Release Notice for
Triconex Report Generator 4.x on the Global Customer Support website for detailed
compatibility information.
• Since the prerequisites for the Report Generator are the same as for TriStation 1131, you
do not need to install the prerequisites before upgrading to a newer version of the
Report Generator. When you install a compatible version of TriStation 1131, the
TriStation 1131 setup program installs the prerequisites applicable to the version of the
Report Generator you are installing. For more information, see Installation
Prerequisites and System Requirements on page 4.
• Controller information appearing in the Controllers pane of the Report Generator at the
end of the last session before the upgrade automatically re-appears in the new version.
Additionally, directory locations specified for custom and/or exported reports in the
existing version are automatically retained in the new version.

Triconex Report Generator User’s Guide, 4.14.0


8 Chapter 1 Getting Started

Starting the Report Generator


To launch the Report Generator, on the Start menu, select Programs > Triconex > Triconex
Report Generator. The main window appears.

Figure 2 Triconex Report Generator Main Window

Triconex Report Generator User’s Guide, 4.14.0


Getting to Know the Report Generator 9

Getting to Know the Report Generator


The Triconex Report Generator user interface is designed to view reports in the Report
Generator window, and if desired, save them to the specified directory location. The user
interface is divided into eight major areas:
1 Main Menu
2 Main Toolbar
3 Application Workspace
4 Reports Pane
5 Reports Toolbar
6 Bookmarks Pane
7 Messages Pane
8 Status Bar

The following sections describe each of these areas in detail.


Note Some areas of the Report Generator user interface can be hidden or shown as desired,
using the options available in the main menu and the main toolbar. For more
information, see Main Menu on page 10, and Main Toolbar on page 10.

Figure 3 Report Generator Sections

Triconex Report Generator User’s Guide, 4.14.0


10 Chapter 1 Getting Started

Main Menu
The Report Generator’s main menu includes options that allow you to open input files or
folders, specify directory locations for the Report Generator files, delete controllers, close
reports, show or hide the different areas in the Report Generator main window, and access the
Report Generator Help. The following menus are available:
• File: Has options that allow you to open an input file or folder, and to exit the Report
Generator.
• Tools: Has options that allow you to specify directory locations, and delete one or more
controllers from the Report Generator.
• Report: Has options that allow you to generate reports, and close the selected report, or
all reports in the Reports pane.
• View: Has options that allow you to show or hide the Application Workspace,
Messages pane, main toolbar, and Status Bar.
• Help: Has options that allow you to access the Report Generator Help, and get
information about the Triconex Report Generator version installed on your system.

Main Toolbar
The Report Generator’s main toolbar provides tools that allow you to quickly perform tasks that
you can also perform using the Report Generator main menu. It also allows you to generate
reports based on the settings selected in the Report Selection pane.
Note The Report Generator’s main toolbar is different from the Reports toolbar that appears
at the top of the Reports pane. For information about the Reports toolbar, see Bookmarks
Pane on page 14.
The following table describes the tools available in the main toolbar:

Toolbar Button Description


Open File Allows you to browse and select an input file.
If multiple input files are available in the same location,
you can select multiple files by holding down the CTRL key
while clicking each file you want to open.
Open Folder Allows you to browse and select an input folder.
Once you select the folder, all compatible files in the
selected folder are opened.
Options Allows you to specify the directory locations for custom
report templates and exported reports.

Delete Node(s) Deletes the selected controller(s) from the Controllers pane.
Depending on whether you select a single controller or
multiple controllers, the name and appearance of the
button changes.
View in Report Generator Displays the report in the Report Generator window
without saving the report.

Triconex Report Generator User’s Guide, 4.14.0


Getting to Know the Report Generator 11

Toolbar Button Description


View and Export to PDF Displays the report in the Report Generator window, and
also saves it as a PDF file.

View and Export to Excel Displays the report in the Report Generator window, and
also saves it as a spreadsheet (.xls) file.
Workspace View Toggles on and off to show or hide the Application
Workspace.
Messages View Toggles on and off to show or hide the Messages Pane.

Application Workspace
The Application Workspace, which is located below the Report Generator’s main menu, allows
you to select the controllers you want to run reports for, and the reports you want to run for the
selected controllers.
The Application Workspace consists of the Controllers pane and the Report Selection pane.

Controllers Pane
The Controllers pane, which is selected by default when
you open the Report Generator, displays the name(s) of
controller(s) currently open in the Report Generator,
along with the name(s) of the associated input file(s).
Within each controller, the following three folders are
created:
• Project File (.pt2): Double-clicking this folder
launches TriStation 1131 and opens the project
file.
• Test Project (.tsvproj): Used by Triconex Safety
Validator to store the path of the configuration
(.tscfg) file, and information about test suites.
• Configuration (.tscfg): Used by Triconex Safety
Validator to store the information about
controllers and tagnames that is required to run
test cases.
For more information about the folders, see Opening
Project Files on page 31.
In the first controller listed in the above figure, TRINODE254 is the name of the controller, and
P2P_MAX254FB is the name of the input file containing configuration information for this
controller.
Note By default, controller and input file names are capitalized in the Controllers pane. The
actual controller or input file name may use upper case, or lower case, or a combination
of both.

Triconex Report Generator User’s Guide, 4.14.0


12 Chapter 1 Getting Started

To populate information in the Controllers pane, you must first open an input file or folder in
the Report Generator. Regardless of the order and manner in which input files are opened,
controller and input file name combinations are always arranged in alphabetical order. For
more information about opening input files or folders, see Preparing for Report Generation on
page 23.
Once the controller names appear, you can select one or more controllers, and then perform
various operations, such as generating and exporting reports, and deleting the selected
controller(s). You can also perform these operations for all controllers by selecting the Triconex
Controllers check box at the top of the Controllers Pane.
Note Only one operation can be performed at a time for the selected controller(s).
The Report Generator retains the controller information appearing in the Controllers pane at the
end of each session. When you re-open the Report Generator, the controller information that
was retained at the end of the previous session automatically reappears in the Controllers pane.

Report Selection Pane


The Report Selection pane appears in the Application
Workspace, to the right of the Controllers pane. It allows you
to select the report(s) you want to run for the selected
controller(s).
The drop-down list at the top of the Report Selection pane
allows you to select a report type. The default selection in this
list is Default reports, which are based on pre-defined report
templates available with the Report Generator installation. If
you want to run a custom report, you must select User
Reports. Once you select the report type, you can then run one
or more reports from the selected category.
You can choose to only view the reports, or to both view and
save the reports. For more information about the options
available when generating a report, see Generating Reports
on page 23.

Reports Pane
During report generation, if you choose to view the report(s) in the Report Generator window,
the report is displayed in the Reports pane. For more information on how to view a report, see
Viewing a Report on page 26.
Reports, once generated, appear as tabbed windows in the Reports pane. If you generate
multiple reports simultaneously, the order of the report tabs will be the same as the order of the
reports in the Report Selection pane. The tab associated with the first report is selected by
default. You can navigate to the desired report by clicking the corresponding tab.

Close a report by clicking the Close button on the tab specific to the report you want to close.
Commands to close a single report, and all reports, are also available in the Report menu.
You can perform other report-related tasks, such as exporting, printing, refreshing, and copying
report data, using the Reports toolbar. For more information, see Reports Toolbar on page 13.

Triconex Report Generator User’s Guide, 4.14.0


Getting to Know the Report Generator 13

If a report contains data for multiple controllers, you can use the Bookmarks pane to quickly
navigate between data related to different controllers. For more information, see Bookmarks
Pane on page 14.

Reports Toolbar
The Reports toolbar allows you to perform various actions on the report currently being viewed
in the Reports pane.

Reports Toolbar Button Description


Export Report Exports only what is currently displayed in the Report
Generator window, and saves the report as a PDF or
spreadsheet (.xls) file on your hard drive.
Use of this button is not recommended. Instead, see
Generating Reports on page 23 for information about
the preferred method for generating reports.
Print Report Prints the report.

Refresh Refreshes the report data if the associated input file is


modified and re-imported.
Copy Copies selected text from the report.
You can copy multiple cells by holding down the
CTRL key while clicking each cell you want to copy
content from.
Toggle Group Tree Opens the Bookmarks pane that allows you to easily
navigate to configuration information related to
different controllers.
If the Bookmarks pane is already open, clicking the
Toggle group tree button closes the Bookmarks pane.
Find Text Allows you to find specific text in a report.

Zoom Provides options to enlarge or decrease the report


view.

In addtion to the tools described above, the Reports toolbar also includes the following page
navigation buttons that allow you to easily navigate in the selected report.

Page Navigation Button Description


Next Takes you to the next page of the report.

Previous Takes you to the previous page of the report.

Last Takes you to the last page of the report.

Triconex Report Generator User’s Guide, 4.14.0


14 Chapter 1 Getting Started

Page Navigation Button Description


First
Takes you to the first page of the report.

Specific page Allows you to specify a page number and


navigate to the specified page.

Bookmarks Pane
If a single report has configuration information for multiple controllers, the Bookmarks pane
allows you to easily navigate to information related to specific controllers. It displays a list of
controller(s) associated with the report, and the corresponding input file names, similar to the
list displayed in the Controllers pane (see Controllers Pane on page 11 ). When you click a
controller name, you are taken to the specific page or location within the report that has
information about the selected controller.

Bookmarks
Pane

Figure 4 Bookmarks Pane

When the Tagname Cross Reference report is open, the Bookmarks pane also displays a plus (+)
symbol to the left of each controller name. Clicking this symbol displays a list of tagnames, and
clicking a tagname in the list takes you to the exact page or location in the report where the
specific tagname is referenced.
When you are viewing a report, the Bookmarks pane is open by default. You can close it at any
time by clicking the Toggle Group Tree button in the Reports toolbar. If the Bookmarks pane
was previously closed, clicking the Toggle Group Tree button reopens the pane.

Triconex Report Generator User’s Guide, 4.14.0


Getting to Know the Report Generator 15

Messages Pane
The Messages pane, which appears below the Application Workspace and the Reports pane,
displays a log of events that occurred in the current Report Generator session, along with the
time the event occurred, in the year/month/date/hour/minute/second format.
Events displayed in the Messages pane include:
• Successful launch of the Report Generator.
• Successful entry of logon credentials for project files.
• Completion of data parsing for an input file.
• Successful generation of a report.
• Deletion of one or more controllers from the Report Generator.
• Closure of one or more reports.
• Errors that occur when performing an action in the Report Generator (for example,
opening a project file, entering logon credentials, generating a report, etc.).
If you initiated an operation in the Report Generator, and further action is needed from you to
complete the operation, the Messages pane also indicates the action you need to take. For
example, if you need to enter logon credentials to open a project file, the Messages pane displays
the entry “Enter logon credentials for xxx” (where xxx is the controller and input file you are
trying to open). Once you enter the logon credentials, and the Report Generator successfully
reads the information contained in the input files, the Messages pane displays further entries
indicating the completion of these events.
At any time, you can clear the log displayed in the Messages pane, or save the log for the current
session. You can perform these actions by right-clicking the Messages pane, and then selecting
the desired command.
Note When you exit the Report Generator, the log for the session is cleared automatically, and
cannot subsequently be retrieved, unless you save the log before exiting the Report
Generator.

Triconex Report Generator User’s Guide, 4.14.0


16 Chapter 1 Getting Started

Status Bar
The Status Bar at the bottom of the Report Generator window displays updates about events as
they occur in the Report Generator. For example, if you generate a Peer-to-Peer Configuration
report for node 254 that is associated with an input file named A1, the following updates appear
in the Status Bar during the report generation process:
• Beginning report generation for TRINODE254_A1.
• Generating report Peer-to-Peer Configuration Report.
• Creating a Peer-to-Peer Configuration Report report.
• Loading the Peer-to-Peer Configuration Report report for controller
TRINODE254_A1.
• Report generation for TRINODE254_A1 is complete.

The Status Bar only displays one event at a time. If you want to view and/or save a log of all the
events that occurred in the current Report Generator session, you can do so using the Messages
pane. For more information, see Messages Pane on page 15.

Triconex Report Generator User’s Guide, 4.14.0


Uninstalling the Report Generator 17

Uninstalling the Report Generator


The Triconex Report Generator can be uninstalled via the Windows Control Panel, the
TriStation 1131 Install CD, or the Report Generator Install CD.
You can choose the option convenient to you, depending on which installation CD you have,
and depending on whether you want to uninstall just the Report Generator, or both TriStation
1131 and the Report Generator.
• If you want to uninstall TriStation 1131 along with the Report Generator, you can do so
using the Remove option in the TriStation 1131 setup program, or using the Windows
Control Panel. The Remove option in the TriStation 1131 setup program is the preferred
option, as it allows you to uninstall both applications simultaneously.
• If you want to uninstall only the Report Generator, you can do so using the Remove
option in the Report Generator setup program (the preferred option), or using the
Windows Control Panel.
The following sections describe how to uninstall the Report Generator using the Windows
Control Panel, and using the Report Generator Install CD. For detailed information about
uninstalling the Report Generator using the TriStation 1131 Install CD, see the TriStation 1131
Developer’s Guide.

Uninstalling the Report Generator via the Report Generator Install CD


1 Log on as an administrator or as a user with administrator privileges.
2 Close all open applications.
3 Insert the Triconex Report Generator Install CD in the CD-ROM drive.
The installation should start automatically. If it does not, browse to locate the setup.exe
file on the CD, and then double-click setup.exe to start the installation.
The Modify, Repair, or Remove installation screen appears.

Triconex Report Generator User’s Guide, 4.14.0


18 Chapter 1 Getting Started

4 Select Remove, and then click Next.


5 When prompted to confirm the uninstallation, click Uninstall.
6 Click Finish to complete the uninstallation process.

Uninstalling the Report Generator via the Control Panel


1 Log on as an administrator or as a user with administrator privileges.
2 From the Start menu, click Control Panel, and then click Programs and Features., The
procedure to navigate to Programs and Features may vary, depending on your
operating system and Start menu settings. For more information, refer to the user
documentation specific to your operating system.
3 Select Triconex Report Generator 4.14.0, and then click Uninstall.
4 Follow the on-screen instructions to confirm the deletion of the Report Generator and all
its components.
5 Click Finish to complete the uninstallation process.
Note If you are uninstalling both the Report Generator and TriStation 1131 using the Control
Panel, it is recommended that you uninstall the Report Generator before uninstalling
TriStation 1131.

Triconex Report Generator User’s Guide, 4.14.0


2
Using the Triconex Report Generator

Overview 20
Specifying Directory Locations 21
Generating Reports 23
Opening Project Files 31

Triconex Report Generator User’s Guide, 4.14.0


20 Chapter 2 Using the Triconex Report Generator

Overview
This chapter explains how to view, print, and export reports using the Triconex Report
Generator. It also explains how to specify directory locations for Report Generator files, and
how to open project files directly from the Report Generator.
Reports are generated in the Report Generator using data imported into a report database. You
can generate reports for a single controller, or for multiple controllers simultaneously. Once you
select the controller(s), you can select the report(s) you want to run for the selected controllers.
You can either view the reports without saving them, or view and save the reports at the same
time. In addition, you can specify the directory locations where custom report templates and
exported reports should be saved.
Note The procedures in this chapter assume you have already started the Report Generator.
For more information, see Starting the Report Generator on page 8.

Triconex Report Generator User’s Guide, 4.14.0


Specifying Directory Locations 21

Specifying Directory Locations


The Triconex Report Generator setup program automatically creates default folders for the
report database, the default and custom report templates, and the reports you export from the
Report Generator.
If desired, you can change the default directory locations for the following:
• Custom reports: The default directory location for custom (user) report templates is:
C:\ProgramData\Triconex\Triconex Report Generator\UserReport.
Custom report templates are not available by default in the Report Generator. You must
create custom report templates using the SAP® Crystal Reports® software (which can be
purchased separately), and then place them in the specified directory location.
• Exported reports: The default directory location for exported reports is:
C:\ProgramData\Triconex\Triconex Report Generator\Export.
Reports are saved in the default exported reports directory only if you choose to export
the report during report generation. If you first choose to view the report, and then
export it from the Reports pane, the report will not be saved in the default directory.
Instead, you will be prompted to specify the location where the report should be saved.
For more information, see Saving a Report on page 28.
You cannot change the default directory locations for the following:
• Report database: The default directory location for the report database files is:
C:\ProgramData\Triconex\Triconex Report Generator\Database\.
• Default reports: The default directory location for default report templates is:
C:\ProgramData\Triconex\Triconex Report Generator\Report\.

You must ensure that the report database files and default report templates remain in the
default directory locations.
• If you move or delete a default report template from the default directory, the report
will not be available for selection in the Report Generator.
• If you delete a report database file, reports may not be generated properly.
This procedure explains how to change the default directory locations in the Report Generator.

Triconex Report Generator User’s Guide, 4.14.0


22 Chapter 2 Using the Triconex Report Generator

Procedure
1 On the Tools menu, click Options.
The Options dialog box appears, displaying the directory locations where the Report
Generator files are currently saved.

2 Click the browse button corresponding to the directory location you want to change.
Note If you change the custom (user) reports directory location, you must copy any
existing custom report templates to the new location. If a template does not exist
in the specified directory, the corresponding report will not appear in the list of
available custom reports.
3 Browse to the desired location, and then click OK.
4 Click Save to save your changes and close the Options dialog box.

Triconex Report Generator User’s Guide, 4.14.0


Generating Reports 23

Generating Reports
This section describes how to view, print, and save reports in the Report Generator.
Topics in this section include:
• Preparing for Report Generation on page 23
• Viewing a Report on page 26
• Printing a Report on page 27
• Saving a Report on page 28

Preparing for Report Generation


To generate reports using the Report Generator, you must first copy the input file(s) to the PC
where the Report Generator is installed, and then open the input file(s) in the Report Generator.
Note This section only describes preparatory steps that apply to both default and custom
reports. If you want to generate custom reports, you must also add the corresponding
custom report templates to the Report Generator. For more information, see Custom
Reports on page 41.
An input file is a TriStation 1131 project file (.pt2) that contains the configuration information
for a Triconex controller.
Before you use a project file with the Report Generator, you must ensure that all programs
within the project have been successfully compiled. If one or more programs in the project have
compiler errors or warnings, reports generated using the project file may contain invalid data.
For more information about compiling a program, see the TriStation 1131 Developer’s Guide.
Note Only project files created in TriStation 1131 4.0 and later are supported.
Opening the input files in the Report Generator imports the project information into the report
database used for generating reports.
You can open one or more individual input files, or open all compatible files in a folder
simultaneously.
When you open the input file(s), the controllers configured in the input file(s), along with the
name of the corresponding input file(s), appear in the Controllers pane (see Controllers Pane on
page 11). Once the controller names appear, you can then select one or more controllers and
generate the desired report(s).
Additionally, the following three folders are created within each controller:
• Project File (.pt2): Double-clicking this folder launches TriStation 1131 and opens the
project file.
• Test Project (.tsvproj): Used by Triconex Safety Validator to store the path of the
configuration (.tscfg) file, and information about test suites.
• Configuration (.tscfg): Used by Triconex Safety Validator to store the information
about controllers and tagnames that is required to run test cases.

Triconex Report Generator User’s Guide, 4.14.0


24 Chapter 2 Using the Triconex Report Generator

For more information about these files, see Opening Project Files on page 31.
Note The Test Project (.tsvproj) and Configuration (.tscfg) folders are available only when you
open a Tricon project. If you open a Trident or Tri-GP project, these folders will be
disabled.
If the file name and node number associated with an input file you are opening matches those
of an input file already open in the Report Generator, the report database is updated with
information from the new input file. If you already generated a report using the previous input
file, you must refresh the report, or generate a new report to view updated report data.
Controller and input file name combinations are always arranged in alphabetical order,
regardless of the order in which you open the input file(s), and regardless of whether you open
individual files or entire input folders. Each time you open an input file or folder, the list of
controllers appearing in the Controllers pane is refreshed, and the controller and input files
names re-arranged.
The following sections explain how to open an individual input file, or all input files contained
in a folder.

Opening an Input File


1 On the File menu, click Open File, and then browse to select the desired file.
You can select multiple files by holding down the CTRL key while clicking each file you
want to open.
2 Click Open.
3 Enter the logon name and password associated with the TriStation 1131 project file, and
then click Log On.
If you select multiple input files, you will be prompted to enter the logon information
for each file separately.
Note If the Triconex Single Logon service is installed, and you are trying to open a
project file that you closed less than 10 minutes ago, you will not be prompted to
enter the logon name and password. For more information on the Triconex
Single Logon service, see the TriStation 1131 Developer’s Guide.
4 Review the Messages pane to verify that the appropriate communication module is
being used to connect to the controller. By default, the NET 2 port for the selected
communication module is used.
To select a communication module or network port other than the default, right-click the
Configuration (.tscfg) folder, and then click Update Configuration. For more
information, see Updating the Configuration on page 32.
The controller name(s) associated with each compatible input file in the folder appears
in the Controllers pane.

Triconex Report Generator User’s Guide, 4.14.0


Generating Reports 25

Opening All Compatible Input Files in a Folder


1 On the File menu, click Open Folder, and then browse to the folder containing the files
you want to open.
2 Click Select Folder.
3 Enter the logon name and password associated with each of the TriStation 1131 project
files in the folder, and then click Log On.
You will be prompted to enter the logon information for each file separately.
Note If the Triconex Single Logon service is installed, and the folder contains one or
more project files that you closed less than 10 minutes ago, you will not be
prompted to enter the logon name and password for those files.
4 Review the Messages Pane to verify that the appropriate communication module is
being used to connect to the controller. By default, the NET 2 port for the selected
communication module is used.
A separate message appears for each input file you are opening.
To select a communication module or network port other than the default, right-click the
Configuration (.tscfg) folder, and then click Update Configuration. For more
information, see Updating the Configuration on page 32.
The controller name(s) associated with each compatible input file in the folder appears
in the Controllers pane.
Notes
• The Open Folder option only populates controller information from input files that are
directly available in the selected folder. If the input files are in a subfolder, you must
select the specific subfolder containing the input files, and then click OK.
• The Open Folder option can only be used to open all compatible input files within the
folder. If you want to select only some of the files in the folder, use the Open File option
instead.

Triconex Report Generator User’s Guide, 4.14.0


26 Chapter 2 Using the Triconex Report Generator

Viewing a Report
This procedure explains how to view a report in the Report Generator window. To view a report
in PDF format or Microsoft Excel®, see Saving a Report on page 28.

Procedure
1 In the Controllers pane, do one of the following:
• To run a report for all controllers in the
Controllers pane, select the Triconex Controllers
check box at the top of the pane.
• To run a report for one or more selected
controllers, select the check box(es) for the
specific controller(s).
2 In the Report Selection pane, do one of the following:
• To view a default report, go to step 3.
• To view a custom report, select User Reports in
the report type drop-down list, and then go to
step 3.
3 Select the check boxes for the report(s) you want to
view. To view all available reports, select the Select
All Reports check box.
Note If a report is not listed, the report template
may have been deleted or moved from the
directory location specified in the Report
Generator options. Check to make sure the
correct directory location has been specified
in the Report Generator options, and that all
report templates have been copied to that
location. For more information, see
Specifying Directory Locations on page 21.
4 In the drop-down list next to the Generate button,
select one of the following options, depending on
what you want to do:
• To view the report without exporting it, select
View in Report Generator window.
• To view the report, and export it to a PDF file,
select View and Export to PDF.
• To view the report, and export it to a spreadsheet
file (.xls), select View and Export to Excel.
Note If you choose to view the report without exporting, but later decide you want to
export it, you can do so using the Export Report button on the Reports
Toolbar. For more information, see Saving a Report After Report Generation on
page 30.

Triconex Report Generator User’s Guide, 4.14.0


Generating Reports 27

5 Click Generate.
The selected report(s) are generated, and appear as tabbed windows in the Reports pane.
If you chose to also export the report(s), the report(s) are also saved in the specified
directory location.

Note If a report contains data for multiple controllers, you can use the Toggle Group Tree
command in the Reports pane to quickly navigate between data related to different
controllers. For more information about the commands available in the Reports pane,
see Getting to Know the Report Generator on page 9.

Printing a Report
This procedure explains how to print a report.

Procedure
1 Generate the report that you want to print, choosing an option that will allow you to
view the report in the Report Generator window. For instructions, see Viewing a Report
on page 26.
2 Click the Print button on the Reports toolbar.
Note Only one report can be printed using a single print command. If multiple reports
are open in the Reports pane, a separate print command must be initiated for
each report that needs to be printed.
3 Select the desired properties for your printer (number of copies, page orientation, etc.).
4 Click OK to print the report.
Note You can also print a report by exporting it to a PDF file, and then opening the PDF file
from the directory location specified for exported reports. For more information, see
Saving a Report on page 28.

Triconex Report Generator User’s Guide, 4.14.0


28 Chapter 2 Using the Triconex Report Generator

Saving a Report
Reports can be saved (exported) to PDF and Microsoft Excel formats. You can choose to save a
report when generating the report, or save it after viewing it in the Report Generator window.

Saving a Report During Report Generation


This procedure explains how to save a report at the time of report generation.

Procedure
1 In the Controllers pane, do one of the following:
• To run a report for all controllers in the
Controllers pane, select the Triconex Controllers
check box at the top of the pane.
• To run a report for one or more selected
controllers, select the check box(es) for the
specific controller(s).
2 In the Report Selection pane, do one of the following:
• To save a default report, go to step 3.
• To save a custom report, select User Reports
from the report type drop-down list, and then go
to step 3.
3 Select the check boxes for the report(s) you want to
save. To save all available reports, select the Select All
Reports check box.
Note If a report is not listed, the report template
may have been deleted or moved from the
directory location specified in the Report
Generator options. Check to make sure the
correct directory location has been specified in
the Report Generator options, and that all
report templates have been copied to that
location. For more information, see Specifying
Directory Locations on page 21.
4 In the drop-down list next to the Generate button,
select one of the following options, depending on the
format you want to save the report to:
• To save the report as a PDF file, select View and
Export to PDF.
• To save the report as a spreadsheet file (.xls),
select View and Export to Excel.
5 Click Generate to save the report(s).

Triconex Report Generator User’s Guide, 4.14.0


Generating Reports 29

The report is saved in the specified directory location in addition to being displayed in
the Report Generator window. For more information about directory locations, see
Specifying Directory Locations on page 21.
When the report has been saved, a message appears in the Messages Pane at the bottom
of the Report Generator window, indicating where the report was saved.

About the Default File Name Format for an Exported Report


If you choose to export a report at the time of report generation, the default file name of the
saved report will be divided into different parts, each part providing information about the
report. Each of these parts is separated by an underscore (for example,
TRINODE06_EXMODBUS_Tagname Cross Reference Report_2014_09_17_15_16_38).
The following describes each of these parts in detail:

Item Description Example


Controller name The name of the controller as it appears TRINODE06
in the Controllers pane.
Input file name The name of the TriStation 1131 project EXMODBUS
file as it appears in the Controllers pane.
Report name The default name of the report. Tagname Cross Reference Report
Time stamp The date and time when the report was 2014_09_17_15_16_38
generated, in the
year_month_day_hour_minute_second
format.

Note The default file name format described above does not apply to reports that are saved
after they are viewed, using the Export button on the Reports toolbar. In this case, the
file name will be the same as the report name (for example, Tagname Cross Reference
Report). If you want to use a different name, you can specify it when saving the report,
or rename the report once it is saved.

Triconex Report Generator User’s Guide, 4.14.0


30 Chapter 2 Using the Triconex Report Generator

Saving a Report After Report Generation


This procedure explains how to save a report if you did not choose to export the report when
generating it. The report must be open in the Report Generator window for you to be able to
save it.

Procedure
1 In the Reports pane, click the tab specific to the report you want to save.

2 On the Reports toolbar, click the Export button .


3 Enter a name for the report being saved. By default, the name will be the default name
of the report (for example, Tagname Cross Reference Report).
4 Browse to the location where you want to save the report.
5 In Save as type, select PDF or Microsoft Excel, depending on the format you want to save
the report to.
6 Click Save to save the report and close the Export Report dialog box.
Note Only one report can be saved using a single export command. If you need to save several
reports, it is recommended that you regenerate the reports, selecting an option that not
only displays the reports in the Report Generator window, but also saves (exports) them
to the specified directory location. For more information, see Saving a Report During
Report Generation on page 28.

Triconex Report Generator User’s Guide, 4.14.0


Opening Project Files 31

Opening Project Files


If you need to edit a TriStation 1131 project or a Safety Validator test project, you can save time
by starting TriStation 1131 or the Safety Validator directly from the Report Generator.
Topics in this section include:
• Opening a TriStation 1131 Project on page 31
• Opening a Triconex Safety Validator Project on page 32
• Updating the Configuration on page 32

Opening a TriStation 1131 Project


When you open a project file that was created using TriStation 1131 version 4.x, it will
automatically be converted to version 4.14.x. This procedure explains how to open a TriStation
1131 project directly from the Report Generator.

Procedure
1 In the Controllers pane, under Triconex Controllers, double-click the Project File (.pt2)
folder corresponding to the controller node.
2 When prompted, enter the logon name and password associated with the project file,
and then click Log On.
TriStation 1131 opens, displaying the project file.
If you want to open the folder where the project file is stored, right-click the Project File (.pt2)
folder, and then select Open File Location.
Note If you make changes to a project file in TriStation 1131, you need to update the
configuration file in the Report Generator. For more information, see Updating the
Configuration on page 32.

Triconex Report Generator User’s Guide, 4.14.0


32 Chapter 2 Using the Triconex Report Generator

Opening a Triconex Safety Validator Project


To open a Triconex Safety Validator project directly from Report Generator, in the Controllers
pane, under Triconex Controller, double-click the Test Project File (.tsvproj) folder
corresponding to the node.

The Triconex Safety Validator opens, displaying the associated test project file.
Note If the Triconex Safety Validator does not open, it is likely because the application is not
installed on your computer. Install the Safety Validator if needed, and then try again. For
installation instructions, see the Triconex Safety Validator User’s Guide.
If you want to open the folder where the test project file is stored, right-click the Test Project File
(.tsvproj) folder, and then select Open File Location.

Updating the Configuration


If you make changes to the TriStation 1131 project file, the Configuration (.tscfg) folder in the
Report Generator will appear red, indicating that the configuration file is not up-to-date. You
must update the configuration file to ensure that the latest project information is available in the
Safety Validator.
Note If you do not update the configuration file, test cases in the Safety Validator may fail or
show incorrect results.

Procedure
1 Right-click the Configuration (.tscfg) folder, and then click Update Configuration.
2 When prompted, enter the logon name and password associated with the TriStation
1131 project file, and then click Log On.
The Select Communication Module dialog box appears.
3 Select the communication module and network port information that you want to export
to the configuration file.
4 Click OK.
The configuration file is updated with the tagnames and controller information from the
TriStation 1131 project file. A confirmation message is displayed in the Messages pane
once the update is completed.

Triconex Report Generator User’s Guide, 4.14.0


3
Types of Reports

Overview 34
Default Reports 35
Custom Reports 41

Triconex Report Generator User’s Guide, 4.14.0


34 Chapter 3 Types of Reports

Overview
The Report Generator allows you to generate two types of reports:
• Default Reports: Reports based on pre-defined report templates available in the Report
Generator. The following four default reports are available:
— Peer-To-Peer Duplicate ID report
— Peer-To-Peer Function Block Usage report
— Peer-To-Peer Configuration report
— Tagname Cross Reference report
• Custom Reports: Reports based on custom Crystal Report templates; these are not
available by default in the Report Generator, and must be created separately using the
SAP Crystal Reports software.
Reports, once generated, can be viewed in the Report Generator, and if desired, also saved in
PDF format or Microsoft Excel. For more information, see Generating Reports on page 23.
This chapter describes each of the default reports, and explains how to use custom reports with
the Report Generator.
Topics in this section include:
• Default Reports on page 35
• Custom Reports on page 41

Triconex Report Generator User’s Guide, 4.14.0


Default Reports 35

Default Reports
Default reports are reports based on Crystal Report templates that are included with the
Triconex Report Generator.
When you install the Report Generator, the default report templates are automatically copied to
the following directory location:
C:\ProgramData\Triconex\Triconex Report Generator\Report\.

Note The directory location for default reports cannot be changed. You must ensure that all the
report templates remain in the default directory location. If you delete or move a report
template from the default directory, the report will not be available for selection in the
Report Generator.
The following sections provide more information about each of the default reports:
• Peer-to-Peer Duplicate ID Report on page 35
• Peer-to-Peer Function Block Usage Report on page 37
• Peer-to-Peer Configuration Report on page 39
• Tagname Cross Reference Report on page 40

Peer-to-Peer Duplicate ID Report


The Peer-to-Peer Duplicate ID report provides information about any duplicate Send and/or
Receive identifiers (IDs) configured in the function blocks within a TriStation 1131 project file.
In a Peer-to-Peer configuration, Triconex controllers exchange data by using Send and Receive
function blocks configured in their TriStation 1131 applications. Each Peer-to-Peer function
block has a Send ID (SENDID) and a Receive ID (RECVID) to identify the function block that
sends data and the function block that receives data.
Each function block must have a unique Send ID and Receive ID. Function blocks configured
with duplicate Send or Receive IDs do not constitute a valid configuration. The Peer-to-Peer
Duplicate ID report helps identify duplicate Send and Receive IDs by listing only those function
blocks from a project file that have a Receive or Send ID that matches that of another function
block in the project file. The report lists all the Receive function blocks first, followed by the Send
function blocks.

Triconex Report Generator User’s Guide, 4.14.0


36 Chapter 3 Types of Reports

The following figure illustrates how to identify duplicate Send and Receive IDs in a
configuration using the Peer-to-Peer Duplicate ID Report.
Note Although this sample report has multiple sets of duplicate Send and Receive IDs, only
one set of duplicate Send IDs and Receive IDs has been highlighted for each function
block type.





  
  
  !  
     !      
         
       
  ! "  



   $%& ""#"


 #$ ## #     Receive function
 #$ %## # &    blocks with duplicate
 #$
 #$
##
#
##
' #



'
Receive IDs
' 
 #$ ## # (  ( (
 #$ ## ' #    ( Receive function
   $%&
" blocks with duplicate
 #$ %## # &  ' ( Send IDs
 #$ %##
# )  ' (
 #$ %## # *  ' (
Send function blocks
with duplicate
 #$ %## ' #   ' (&
 #$ ##+ #   & &
 #$ ##
#  ) & Receive IDs
 #$ ##
' # '  , ,
 #$ %##
' # ,  , , Send function blocks
with duplicate Send
IDs

1 2% 3
'-'- '. .',/ 0

Figure 5 Peer-to-Peer Duplicate ID report

The Peer-to-Peer Duplicate ID report provides the following information about each function
block included in the report:
• Program name
• Function block name
• Sheet number
• Node number
• Receive ID
• Send ID
For detailed information about Peer-to-Peer function block parameters, including Send and
Receive identifiers, see the TriStation 1131 Libraries Reference.

Triconex Report Generator User’s Guide, 4.14.0


Default Reports 37

Peer-to-Peer Function Block Usage Report


The Peer-to-Peer Function Block Usage report provides information about all Peer-to-Peer
function blocks contained in the project file, including the parameters and tagnames associated
with each function block.
Note The Peer-to-Peer Function Block Usage report is generated only if the input file includes
at least one Peer-to-Peer (Send/Receive) function block. If the input file does not have a
Peer-to-Peer function block, the report is not generated, and an error message appears
in the Messages pane, stating that the data required to generate the report is unavailable.
For a complete list of Send and Receive function blocks, see the Communication Guide for
your controller. For detailed information on each Send and Receive function block, see
the TriStation 1131 Libraries Reference.


 
  

  
  
  !   
     !      
         
       
)%-%  )).)%-%..(.)). 0 #

   !

  . .1 .
 !" # ! 4 !.&%.!.%#!
    .
 $%&'(
)%**)%+,  !-

 !.!.  !.!.

 !.!.  !.!.


 !.!./  !.!./

 !.!.  !.!.

  !.!.   !.!.


 !.!.2 
 !.!.2
  !.!.3   !.!.3

  !.!.   !.!.

  !.!.   !.!.

 !.!.  !.!.

4 *7-(
)%!""55//6 )-&

Figure 6 Peer-to-Peer Function Block Usage Report

The following information is included in the Peer-to-Peer Function Block Usage report:
• Node name and number
• Maximum number of Sends and Receives allowed for the controller (based on
controller type)
• Name of the project file, with the version number of the downloaded and current
version
• Number of Send and Receive function blocks configured in the project
• Details associated with each Peer-to-Peer function block in the project file, including:
— Function block name

Triconex Report Generator User’s Guide, 4.14.0


38 Chapter 3 Types of Reports

— Function block instance name


— Peer-to-Peer type (Send/Receive)
— Program and sheet containing the function block
— Tagnames associated with the function block; local variables are identified with a *
symbol to the left of the tagname
— Various parameters configured for the function block
The data represented in the function block parameters may vary, depending on whether it is a
Send block or a Receive block. For example, for a SEND function block, the Send/Recv Node
field in the report specifies which controller receives data from this function block, and for a
RECEIVE function block, it specifies which controller sends data to this function block.
Where applicable, the report also displays additional function block parameters. For example,
the Send Flag (SENDFLG) parameter is listed for all Send function blocks. If this parameter’s
value is true, a send is initiated. If the value is false, a send is not initiated even if the Send
function block is executed. For detailed information about Peer-to-Peer function block
parameters, see the TriStation 1131 Libraries Reference.

Triconex Report Generator User’s Guide, 4.14.0


Default Reports 39

Peer-to-Peer Configuration Report


The Peer-to-Peer Configuration report displays details associated with the communication
modules (slots) configured for Peer-to-Peer communication in the selected controller.
Note If Peer-to-Peer communication has not been configured for at least one module (slot) in
the controller, the Peer-to-Peer Configuration report is not generated, and an error
message appears in the Messages pane, stating that the data required to generate the
report is unavailable. For more information about configuring Peer-to-Peer
communication, see the TriStation 1131 Developer’s Guide.


  



 


   
 

 





  
 
    
     ! "  ! # !$
%&  (  ! )*+  ! )*+
 ,!.

'   ,- $     ,- $    

01  )*+  / 


 )*+  / 
 )*+  / 
/ )*+/  / 

)*+
 / 
 )*+  / 
* )*+*  / 
2 )*+2  / 
+ )*++  / 
) )*+)  / 
 )*+  / 
 )*+  / 
 )*+  / 
/ )*+/  / 

)*+
 / 
 )*+  / 
* )*+*  / 
2 )*+2  / 
+ )*++  / 
) )*+)  / 
 )*+  / 
 )*+  / 
 )*+  / 
/ )*+/  / 

)*+
 / 
 )*+  / 
* )*+*  / 
2 )*+2  / 
+ )*++  / 
) )*+)  / 
/ )*+/  / 
/ )*+/  / 

!&2&
 2 3 12

Figure 7 Peer-to-Peer Configuration Report

The following information is included in the Peer-to-Peer Configuration report:


• Node name and number
• Name of the input file
• Controller’s platform name (for example, Tricon EP, which represents a Model 8120E
Enhanced Performace Main Chassis)
• Details of each port configured for Peer-to-Peer configuration, including the port
number (NET 1/NET 2), and the destination node number, IP address, and UDP port.

Triconex Report Generator User’s Guide, 4.14.0


40 Chapter 3 Types of Reports

Tagname Cross Reference Report


The Tagname Cross Reference report provides detailed information about each tagname
contained in an input file, such as:
• Program name and sheet number containing the tagname
• Data type of the tagname
• Names of the groups the tagname belongs to
• Area, Line of Equipment (LoE), and Safety Instrumented Function (SIF) the tagname is
associated with
• Equipment name and description of the tagname, if available
• Scope of the tagname (global or local)
• Initial value used for the tagname when the system starts up
• Application type (Safety/Control) associated with the tagname
• Whether features such as Multiple Writes and Shared Read are enabled for the tagname
For more information about tagname properties, see the TriStation 1131 Developer’s Guide.


    

   

 
  

    




   

 




      

! !
!!"
 "% '#.) /+)
 ##-+. #.
 #$# /+)   *+,

() %)(# '+    &


',,+.. *0+.
'#() 

! !
!1$!"
 "% '#.) /+)
 ##-+. #.
 #$# /+)   *+,

() %)(# '+    &


',,+.. *0+.
'#() 

! ! !!"


 "% '#.) /+)
 ##-+. #.
 #$# /+)   *+,

() %)(# '+    &


',,+.. *0+.
'#() 

! ! !1$!"


 "% '#.) /+)
 ##-+. #.
 #$# /+)   *+,

() %)(# '+    &


',,+.. *0+.
'#() 

! !!!"
 "% '#.) /+)
 ##-+. #.
 #$# /+)   *+,

() %)(# '+    &


',,+.. *0+. '#() 

+ ,
  
2  3

 4
)56

Figure 8 Tagname Cross Reference Report

Triconex Report Generator User’s Guide, 4.14.0


Custom Reports 41

Custom Reports
If you want to organize the information available in the input files to suit the specific needs of
your organization, you can create custom report templates using the SAP Crystal Reports
software, and then use those templates with the Report Generator. For more information about
creating report templates, refer to the SAP Crystal Reports documentation.
Note The Crystal Reports software is not included with TriStation 1131 or the Report
Generator, and must be purchased separately.

Adding a Custom Report Template


To generate a custom report, you must first add the custom report template to the Report
Generator.

Procedure
1 In the Crystal Reports software, create a custom report and save it in a file with the
extension .rpt.
2 Put the .rpt file in the User Reports directory. For more information on directory
locations, see Specifying Directory Locations on page 21.
The next time you open the Report Generator, the report will be included in the User
Reports list. If the report is added while the Report Generator is open, you must close
and re-open the Report Generator to view the report in the list.
Note A report appears in the Custom Reports list, and is available for selection in the
Report Generator, as long as the corresponding report template exists in the
directory location specified for custom reports. If you delete or move a template
from the folder, the report will not be available for selection in the Report
Generator.

Triconex Report Generator User’s Guide, 4.14.0


42 Chapter 3 Types of Reports

Triconex Report Generator User’s Guide, 4.14.0


Index

A function blocks, report for 37


adding templates 41
Application Workspace 11 G
generating reports 23
B Global Customer Support (GCS) vi
Bookmarks pane 14
I
C input files 2, 7, 23
compatibility installing
file formats, exported reports 28 prerequisites 4
TriStation 1131 2, 4, 7 standalone 6
configuration file, Safety Validator 23 system requirements for 4
controller configuration, report for 39 upgrade 7
with TriStation 1131 5
Controllers pane 11
custom reports
adding templates for 41 L
default directory for 21 log, events 15
described 41
customer support vi M
main menu 10
D main toolbar 10
default directory, installation 6 Messages pane 15
default reports
directory location for 21 O
Peer-to-Peer Configuration Report 39 opening
Peer-to-Peer Duplicate ID report 35 input files 24
Peer-to-Peer Function Block Usage report 37 project files 31
Tagname Cross Reference report 40 test project files 24
directory locations 7, 21, 22 Triconex Safety Validator 31
disk space 4 TriStation 1131 31
duplicate Send/Receive IDs, report for 35
P
E PDF 28
events log, saving 15 Peer-to-Peer Configuration Report 39
exported reports Peer-to-Peer Duplicate ID report 35
default directory for 21 Peer-to-Peer Function Block Usage report 37
default file name format 29 printing reports 27
supported file formats 28 project files 2
see also reports

R
F
report database, default directory for 21
file formats, supported 28
file name format, default 29

Triconex Report Generator User’s Guide, 4.14.0


44 Index

Report Generator U
default directories 21 uninstalling 17–18
described 2 upgrading 7
disk space required 4
generating reports 23
installing 4 V
opening input files and folders 24 version change 7
starting 8 viewing reports 26
uninstalling 17
upgrading version of 7 W
user interface 9 website, Triconex vi
Report Selection pane 12
reports
adding custom templates for 41
closing 12
custom 21, 41
default 21, 35–40
exporting 28
file formats 28
generating 23
input files 2, 23
navigating multiple controller data 27
printing 27
saving 28
types of 34
viewing 26
Reports pane 12
Reports toolbar 13

S
saving reports 28
spreadsheet format 28
Status bar 16

T
Tagname Cross Reference report 40
templates, custom report 41
toolbar buttons
main toolbar 10
Reports toolbar 13
training information vi
Triconex Safety Validator
configuration file, updating 32
opening 31
test project files 23
TriStation 1131
compatibility 2, 4, 7
modifying setup to install Report Generator 5
opening 31
project files 23, 24
types of reports 34

Triconex Report Generator User’s Guide, 4.14.0


Invensys Systems, Inc.
10900 Equity Drive
Houston, TX 77041
United States of America
http://iom.invensys.com

Global Customer Support


Inside U.S.: 1-866-746-6477
Outside U.S.: 1-508-549-2424
Website: http://support.ips.invensys.com

You might also like