XLReporter for DeltaV Analyze€¦ · · 2015-03-25XLReporter for DeltaV Analyze Guide - 9 -...

XLReporter for

DeltaV Analyze

Version 3.00

SyTech, Inc.

The Complete Reporting Solution

Information in this document is subject to change without notice. SyTech assumes no responsibility for any errors or omissions that may be in this document. 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 prior written permission of SyTech, Inc. Copyright 2000 - 2015 SyTech, Inc. All rights reserved. XLReporter is a trademark of SyTech, Inc. DeltaV, DeltaV Analyze are trademarks of Emerson Process Management. Microsoft® is a registered trademark of Microsoft, Inc. All registered names are the property of their respective owners.

XLReporter for DeltaV Analyze Guide - i -

Contents

XLReporter for DeltaV Analyze 3

Introduction ................................................................................................................................3 Software Requirements ..............................................................................................................4 Exporting ....................................................................................................................................4 Reporting ....................................................................................................................................4

Report Automatically ...................................................................................................4 Publish Automatically ..................................................................................................5 Report On-demand .......................................................................................................6

Alarm System Performance Reporting .......................................................................................6

Getting Started 7

Installation ..................................................................................................................................7 XLRproject_DV .........................................................................................................................7 Registration ................................................................................................................................7 Upgrading ...................................................................................................................................7

Upgrading DeltaV Analyze Only .................................................................................7 Upgrading XLReporter or Both ...................................................................................8

Exporting 9

Select a Database........................................................................................................................9 Configure Labels ........................................................................................................................9

Configure Alarm Statistic Folders ............................................................................. 10 Configure the Database ............................................................................................................ 11 Schedule ................................................................................................................................... 11

Configuration ............................................................................................................. 11 Starting Schedule ....................................................................................................... 11 Exporting Existing Reports ........................................................................................ 11

Reporting 12

Out of the Box .......................................................................................................................... 12 Reporting Automatically .......................................................................................................... 12 Reporting Interactively ............................................................................................................. 12

XLReporter for DeltaV Analyze Reference Guide 14

Overview .................................................................................................................................. 14 User Interface ........................................................................................................................... 14

Menus ........................................................................................................................ 14 Popup Menu ............................................................................................................... 14

Dialogs and Tabs ...................................................................................................................... 15 Database Connect Dialog ........................................................................................... 15 Alarm Rate/Priority Labels Dialog ............................................................................ 15 Folder Dialog ............................................................................................................. 15

Messages and Troubleshooting ................................................................................................ 16

Technical 17

Runtime .................................................................................................................................... 17 Registry .................................................................................................................................... 17

- ii - DeltaV Analyze

Database Schema ..................................................................................................................... 17 Database Views .......................................................................................................... 17 Database Tables ......................................................................................................... 17

XLReporter for DeltaV Analyze Guide - 3 -

XLReporter for DeltaV Analyze

Introduction XLReporter for DeltaV Analyze consolidates DeltaV Analyze Alarm Statistics to a relational database and produce customized reports, spanning multiple days for various alarm parameters.

The two main components of XLReporter for DeltaV Analyze are the export component for exporting DeltaV Analyze Alarm Statistics reports to a database and the reporting component for producing reports from the information in the database. The key benefits of the exporting component are:

• The Alarm Statistics reports are exported to the database automatically and in the background. • Alarm Statistics reports already produced prior to using XLReporter can be included in the

export procedure. • Historization provides new KPIs for system-to-system trend analysis.

The key benefits of the reporting component are: • Fast Start Excel templates are provided to accelerate template design. • Built-in tools in Excel are provided to create custom templates. • Templates can be used to produce reports automatically or on demand. • Reports can be published in Excel, PDF and HTML formats. • Reports can be distributed by Email and FTP. • Dashboard capability provides users across the network to access the data easily for their own

purposes.

The components of XLReporter for DeltaV Analyze are delivered as part of XLReporter Professional or XLReporter Team edition. The Professional edition provides automatic reporting and publishing. On-demand reports and dashboards are available from the station where the software is installed. The Team edition extends the on-demand and dashboard capability of the Professional to Users across the network.

- 4 - XLReporter for DeltaV Analyze Guide

Software Requirements The following software is required for all editions:

• Microsoft Windows Operating System • Microsoft Excel 2007 Service Pack 3 and above for report template design and export • .NET 3.5 framework

The following software is required for the Team edition on the server:

• Internet Information Services

The software can be used in evaluation mode with some restrictions. The evaluation license allows up to 15 data connections, so not all fields may be updated in the reports. In addition, only one report is exported on each execution of the scheduler. When purchased, the product is registered with a software key, removing the evaluation restrictions.

Exporting The information contained in your DeltaV Analyze Alarm Statistics reports is locked in worksheets. The export feature stores the report information to a relational database. For example, if you are currently producing Alarm Statistics reports each day, then the raw data in the database will consist of daily records. It is recommended that Alarm Statistics reports are created periodically, e.g., daily. During the export, the export function maintains a database table containing the “header” information of the Alarm Statistics reports. These are:

• Data Source • Group Name • Area

Consolidated reports can use this information as additional filtering parameters. From the data in the database, consolidated weekly, monthly, quarterly and yearly reports can easily be created, using the filters above. For example, if your facility has three Areas, you would be able to produce consolidated reports for one or all areas.

Reporting

Report Automatically XLReporter uses Excel as its “design studio” to design report templates. Database information is selected from lists so the user does not require any SQL programming knowledge. The templates can be scheduled to produce reports automatically using the report naming convention specified in the template.


Publish Automatically XLReporter provides a number of automatic publishing options such as:

• Excel Workbook • PDF • E-mail • Web Pages • FTP • Printer


Report On-demand In addition to automatic reporting, XLReporter also provides on-demand reporting locally from where it is installed or from remote clients (Team edition). On-demand reporting empowers the user since they can select their own reporting parameters and view the results immediately. XLReporter provides templates that can be used “out of the box”. The user can also use their own Excel template, customize the provided templates or create their own from an empty worksheet.

Alarm System Performance Reporting The EEMUA-191 Edition 3 describes two alarm system performance scatter charts. XLReporter provides these charts in the Alarm Performance template.

The calculation in this template relies on identifying the “Acceptable” and “Unacceptable” alarm rate KPIs. This is performed DeltaV Transfer application by selecting Database, Labels. The first label entered in the grid must be the “Acceptable” alarm rate label and the second label in the grid as the “Unacceptable” alarm rate label. All other labels can be entered in subsequent rows.


Getting Started

Installation The components of XLReporter for DeltaV Analyze are installed as part of the XLReporter installation and are made visible in XLReporter’s Project Explorer for projects that are configured to interface to DeltaV data sources. In a separate install, a project called XLRproject_DV is provided that has been configured to export and report “out of the box”. This project is provided on the installation CD or can be downloaded from www.TheReportCompany.com.

XLRproject_DV Copy the project XLRproject_DV to the drive where XLReporter is installed. From the Windows Start Menu, open the Project Explorer by selecting XLReporter, Project Explorer. To make the project active, select File, Open, click More Projects, and select the project folder e.g., c:\XLRproject_DV.

Notice the DeltaV Transfer feature located at the bottom of the tree in the left pane of the display.

Registration Before proceeding you must register the product. From the Project Explorer, select Registration.

Enter your information and click Start Trial to start the evaluation of XLReporter for 2 hours. When the evaluation period has expired, click the Extend Trial pushbutton for additional time. When you purchase the product, a software key is made available to you. This is entered by clicking Enter Key.

Upgrading If XLReporter for DeltaV Analyze is installed and operational, upgrading must be considered if either a version change of XLReporter or DeltaV Analyze occurs.

Upgrading DeltaV Analyze Only


Upgrade Transfer Configuration The configuration must be updated for the new version. To do so, open the DeltaV Transfer application from the Project Explorer and select File, Save. The configuration is updated as part of saving the configuration. Remove All Alarm Statistic Reports After the configuration is updated any Alarm Statistic Reports from the previous version of DeltaV Analyze must be removed from any Folder referenced in the DeltaV Transfer application.

Upgrading XLReporter or Both Update Project Files New project files must be installed to your existing project. The new files are available on the XLReporter installation CD under the Tools folder under DeltaV Analyze, Upgrade Files, or can be downloaded from our website. Copy these files and paste them into the Input directory of the existing project. For example, if your project is named XLRproject_DV and located on the C: drive, you would paste the files to C:\XLRproject_DV\Input. Update Database The current database must also be upgraded for the new version. Open the DeltaV Transfer application. You are notified that an update is required. Click Yes to the prompt so that the database is updated. Select File, Save to complete the upgrade. Update Templates New templates are provided to take advantage of the new KPIs and metrics included in DeltaV Analyze. These are located on the CD in the Tools folder under DeltaV Analyze, Upgrade Templates or can be downloaded from our website. If you wish to use the new templates, copy the files and paste them into the Input directory of the existing project. Be aware that if you have customized the templates provided in the previous version of XLReporter in any way, they will be overwritten.


Exporting

Select a Database The setup of the export component requires the specification of a database where information from Alarm Statistics reports will be stored. This information is configured in the DeltaV Transfer component. In the left pane of the Project Explorer, double click DeltaV Transfer. If a database connection has not been previously configured, a dialog opens requesting information about the database connection.

Select your database where you would like your data to be stored. The DeltaV Analyze application provides a Microsoft SQL database which can be connected to using Windows Authentication. Based on the SQL security settings, all users under “Messenger Users” local user group have full access to the database. The local system administrator account can add new user to the “Messenger Users.” Part of the local group is two Analyze specific accounts; DeltaVAdmin and MessengerDBUser. If the local system administrator or custom user is working, no passwords are necessary. After selecting your database, test the connection and click OK to return to the DeltaV Transfer dialog.

Configure Labels Since the labels for Alarm Priority and Alarm Rate are configurable by the user, they need to be also be specified in XLReporter. From the DeltaV Transfer, select Database, Labels to open Alarm Rate/Priority Labels dialog.


• Enter all the labels used in Alarm Statistics reports. It is very important that you match the labels exactly.

• Note that the labels can only be 32 characters in length. • If you plan on using the alarm system performance template, you must pay particular attention

to the order in which the Alarm Rate labels are listed. For more information, see the Alarm System Performance Reporting section in the XLReporter for DeltaV Analyze chapter above.

• Click OK.

Configure Alarm Statistic Folders The main display of the DeltaV Transfer program is used to configure the folders where Alarm Statistic reports are stored.

Under Folders, specify the folders where your current Alarm Statistics reports are located. If you are saving the reports to multiple folders, configure each folder in a separate row.

• Highlight an empty row and click browse […] to open the Folder display.


• Under Folder, set Specific to the folder where the reports are located. • Click OK to return to the DeltaV Transfer window.

An optional Archive To setting can be specified to indicate the folder every Alarm Statistics report is moved to after its content has been exported to the database. To specify click the row under the Archive To column and click browse [..] to select a folder. If this setting is left blank, an archive folder is created under the Folder setting and used.

Configure the Database When the setup is complete, click File, Save which performs the following:

• If they do not already exist, the tables and views are created in the database, including the user selectable labels that will be used for the exporting and reporting functions.

• Any report templates provided in the project are updated with the specified database connection.

• If the Archive To setting is left blank, the archive sub folder is created for each configured row.

Click File, Exit to close the DeltaV Transfer window.

Schedule

Configuration To specify the frequency at which the Alarm Statistic file folders are monitored and exported, a schedule is provided. From the Project Explorer, expand Schedules and double click DV_Export. A Time Based schedule performs the export Daily at 00:15:00. If you need to edit this for your application,

• Double click the schedule. • Change the settings and click OK.

Starting Schedule The scheduler is started and stopped either from the Scheduler menu option or automatically, if configured as a Windows Service. See the Reference Guide for more information. With the schedule running, the following actions are performed:

• Each folder configured in the DeltaV Transfer application is examined for Alarm Statistics report files.

• If a file is found, its content is “normalized” and exported to the selected database so that it is available for reporting.

Exporting Existing Reports It is possible to backfill the database with your existing Alarm Statistics reports. From the Project Explorer, expand Schedules and double click DV_Export. Highlight the schedule line that performs the export

• Right click and select Execute, Specific Date. • Click OK without changing the date and time to start the export.


Reporting

Out of the Box The project XLRproject_DV contains a set of reporting templates that can be used “out of the box” with no additional configuration. The templates can all be used interactively and can be configured to produce reports automatically. The templates have the following variables in common (see the filter tab of the database groups).

• StartDate • EndDate • Area • Datasource • Groupname

Before a template can produce a report, these variables require values. In interactive reporting, this is done manually. In automatic reporting, this is performed using the Set command.

Reporting Automatically The schedule DV_Auto is provided to produce a weekly report automatically from the ExtendedKPI template for every Area, Datasource and Groupname.

Before the template is updated using the UpdateBook command, a Set command assign values to the variables. The {DATE} setting represents the date when the schedule is activated which is why the StartDate is set to the date less 7 days (-7D). The % setting is used to include all. Automatically generated reports can be saved in Excel, HTML and/or PDF format. They can also be automatically emailed, sent to a printer or FTP server. XLReporter also has a tool to create a web site from reports produced as web pages.

Reporting Interactively Interactive reports are provided; Alarm Indicators, Alarm Performance, Alarm Volume, Extended KPI. To use the templates, double click Interactive Reports from the Project Explorer.


• Select a report from the top of the left pane. • Enter dates in the Date panel, • Enter values for the parameters Data Source, Group Name and Area, • Click Refresh .

The values of the parameters can contain the wild card %. For example, to select the Groups starting with the letter B, the values of B% would be entered. In the following, a brief description of the templates is given.

• Alarm Indicators Charts average and peak time of acknowledged alarms, alarm active time, alarm suppressed time and standing alarms in 4 panes. Data is available in Data worksheet.

• Alarm Performance EEMUA-191 Edition 3 - Scatter Diagram #1 - Steady State Alarm System Performance and Scatter Diagram #2 – Upset State Alarm System Performance.

• Alarm Volume Scattered chart of average and peak 10 minutes alarm rate.

• Extended KPI

Consolidated Alarm Statistics reports for DeltaV Analyze Alarm Statistics reports. When a report has been generated, it can be saved locally or on the server.

• Clicking Save on the menu bar. Interactive Reporting does not require an installation of Excel and yet it provides the user with the Excel experience. You can Freeze Panes and Zoom In/Out and use a context sensitive keypad. The application can be launched from a DeltaV display for easy access, see the Team Guide for more information. For mobile devices, the application can be used on a Windows tablet.


XLReporter for DeltaV Analyze Reference Guide

Overview The exporting component is configured from the DeltaV Transfer application. From the Project Explorer, double click DeltaV Transfer.

User Interface

Menus File

Save This saves the current configuration and creates the export tables in the database selected. Exit This closes the application.

Database Labels This specifies the Alarm Priority and Alarm Rate labels found in the DeltaV Analyze Alarm Statistic Reports. Connect This connects to a database where the Alarm Statistic Reports data is exported to. Reset This deletes any existing data from the connected database.

Popup Menu Delete This deletes the row selected in the grid.


Dialogs and Tabs

Database Connect Dialog This dialog is described in the Database Management chapter of the Reference Guide.

Alarm Rate/Priority Labels Dialog This dialog is opened by selecting Database, Labels.

Enter all the user selectable labels for Alarm Priority and Alarm Rate from DeltaV Analyze Alarm Statistics reports. Note that the labels can be a maximum of 32 characters in length.

Folder Dialog This dialog is opened by clicking the pushbutton on a row in the grid.

Select the folder where the DeltaV Analyze reports are located and specify the file filter.


Messages and Troubleshooting The following messages may be displayed when using the DeltaV Transfer application. An update is required to the database. Would you like to update now? This message indicates the current database for alarms must be upgraded for the new version of XLReporter. The database is updated by selecting Yes. The installed version of DeltaV Analyze is not supported. Cannot continue. This message indicates that XLReporter cannot work with the installed version of DeltaV Analyze. Failed to update the labels in the database. This message indicates that the Alarm Priority and Alarm Rate labels configured cannot be written to the database. In the DeltaV Transfer application, select Database, Labels to configure the labels. The field is too small to accept the amount of data you attempted to add. Try inserting or pasting less data. This message indicates that an Alarm Priority or Alarm Rate label contains more than 32 characters. In the DeltaV Transfer application, select Database, Labels to re-configure the labels to be less than 32 characters. Folder or Filter cannot be blank. This message indicates that the Folder and/or Filter settings are blank when saving the configuration. For each configured row in the grid a Folder and Filter must be configured and at least one row must be configured in order to save the configuration. File does not exist in the project, cannot continue. If you are upgrading, please update your project with the files provided. This message typically indicates you have upgraded to the latest version of XLReporter, but have not added the files provided for the upgrade to your project. See the Upgrading from an earlier version of XLReporter section above for information on the files. If you are not upgrading, this message indicates that necessary files are missing from your project. To correct this issue, replace the existing project with the project from the XLReporter CD, or download the project from our website.


Technical

Runtime The project XLRproject_DV monitors a configured location for new Alarm Statistic reports and when detected, the report content is exported to a database. When a new Analyze Alarm Statistics report is detected, its name is stored in an internal XLReporter Register (RG099) which is used in the normalization routines of a workbook called _DV_Export. All the information from the Alarm Statistics report is copied to the _DV_Export book which has been pre-configured to perform the export to the database. By using the intermediate workbook _DV_Export, no changes are required to the Alarm Statistic reports either by XLReporter or the users. The exporting procedure is performed automatically.

Registry When the DeltaV Transfer application is opened, the installed version of DeltaV Analyze is read from the registry. The key below is used for the version:

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\ {D251661A-2F89-4E11-B234-BE0DFC2DD342}\DisplayVersion

For DeltaV Analyze version 2, the value is 1.01.0000 For DeltaV Analyze version 3, the key will have a value of 3.0.0000

Database Schema

Database Views The following database views are provided for reporting purposes. It is suggested that the User use them to obtain information from the database. vAlarmDisabled (Alarms Disabled During the Reporting Period) vAlarmFloods (Alarm Floods During the Reporting Period) vAlarmPriority (AlarmPriority worksheet) vAlarmRate (AlarmRate worksheet) vKPI (Alarm KPIs) vTopAlarmSources (Top Twenty Alarm Sources table) vTopHighAvgActivation (Top Twenty Modules with the Highest Average Activation Time table) vTopHighAvgSuppression (Top Twenty Modules with the Highest Average Suppression Time) vTopShortAvgActivation (Top Twenty Modules with the Shortest Average Activation Time table)

Database Tables The main table is tblMain. The content of this table is read from the header of the report and will be used to populate lists from which the user can select report parameters. tblMain MainID Number StartDate Date/Time


DataSource Text GroupName Text Area Text tblAlarmDisabled ID Number Node Text Description Text TimesDisabled Number TotalDisableTime Number DisabledFlag Number AlarmArea Text tblAlarmPriority ID Number AP1 Number AP2 Number AP3 Number AP4 Number AP5 Number AP6 Number AP7 Number AP8 Number AP9 Number AP10 Number AP1 1 Number AP1 2 Number tblAlarmPriorityLabel AP1 Text AP2 Text AP3 Text AP4 Text AP5 Text AP6 Text AP7 Text AP8 Text AP9 Text AP10 Text AP1 1 Text AP1 2 Text tblAlarmRate ID Number AR1 Number AR2 Number AR3 Number AR4 Number AR5 Number AR6 Number AR7 Number AR8 Number


AR9 Number AR10 Number AR11 Number AR12 Number tblAlarmRateLabel AR1 Text AR2 Text AR3 Text AR4 Text AR5 Text AR6 Text AR7 Text AR8 Text AR9 Text AR10 Text AR11 Text AR12 Text tblKPI ID Number AverageRate Number Peak10minCount Number Peak10minDate Date/Time AverageTimeToAck Number PeakTimeToAck Number PeakTimeToAckTag Text AverageTimeActive Number PeakTimeActive Number PeakTimeActiveTag Text AverageTimeSuppressed Number PeakTimeSuppressed Number PeakTimeSuppressedTag Text StandingCount Number TotalNewAlarms Number TotalAlarmFloods Number TotalAlarmSuppressions Number TotalStaleAlarms Number AverageRatePerDay Number AverageRatePer10min Number PercentHoursOver30Alarms Number PercentFloodCondition Number Top10AlarmSource Number ChatteringFleetingSources Number AverageFloodAlarms Number AverageNonFloodAlarms Number tblTopAlarmSources ID Number Node Text Description Text


Quantity Number AlarmArea Text tblTopHighAvgActivation ID Number Node Text Description Text TimesActive Number TotalActiveTime Number AlarmArea Text tblTopHighAvgSuppression ID Number Node Text Description Text TimesSuprsd Number TotalSuprsdTime Number SuprsdFlag Number AlarmArea Text tblTopShortAvgActivation ID Number Node Text Description Text TimesActive Number TotalActiveTime Number AlarmArea Text tblAlarmFloods ID Number FloodDateTime Date/Time Duration Number Quantity Number AlarmArea Text

XLReporter for DeltaV Analyze€¦ · · 2015-03-25XLReporter for DeltaV Analyze Guide - 9 -...

Documents

Transcript of XLReporter for DeltaV Analyze€¦ · · 2015-03-25XLReporter for DeltaV Analyze Guide - 9 -...