bristol openenterprise reference guide · reference guide d5092 11-dec-2007 - page 4 reporting...

Reference Guide D5092 11-Dec-2007 Reporting Overview

Remote Automation Solutions Website: www.EmersonProcess.com/Remote

Bristol OpenEnterprise Reference Guide Reporting Overview

Reference Guide D5092 11-Dec-2007 - Reporting Overview


Contents

1 OpenEnterprise Report Suite Overview ................................................................................ 6 1.1 Report Examples................................................................................................................. 6 1.2 The Report Plug-in .............................................................................................................. 6 1.3 The Report Configuration Tool............................................................................................ 6 1.4 The Report Scheduler ......................................................................................................... 7

2 A Simple Report ....................................................................................................................... 9 2.1 Open the Report Configuration Tool ................................................................................... 9 2.2 Report Configuration Tool Interface.................................................................................. 10 2.3 Create a new Report Template......................................................................................... 11

2.3.1 Manual Report Template Creation ............................................................................. 12 2.3.2 General Configuration Page....................................................................................... 12 2.3.3 Report Properties Data Service.................................................................................. 12 2.3.4 Report Properties Report Period ................................................................................ 13 2.3.5 Report Properties Event Logging ............................................................................... 14 2.3.6 Create a Query ........................................................................................................... 15

2.3.6.1 New Query from Context Menu ........................................................................... 16 2.3.6.2 New Query from Menu Bar .................................................................................. 16 2.3.6.3 New Query from Query Manager......................................................................... 17 2.3.6.4 The Query Wizard ................................................................................................ 18

2.3.6.4.1 Query Name Page .......................................................................................... 18 2.3.6.4.2 Query Dataservice Page ................................................................................ 19 2.3.6.4.3 Query Dataset Page ....................................................................................... 20 2.3.6.4.4 Query Signals Page........................................................................................ 21

2.3.6.4.4.1 Signal Browse Dialog ............................................................................... 22 2.3.6.4.5 Query Period Page ......................................................................................... 24

2.3.6.4.5.1 Verifying the Report Period ...................................................................... 24 2.3.6.4.6 Query Transform Page ................................................................................... 25 2.3.6.4.7 Query Output Page......................................................................................... 26

2.3.7 Final Touches - Renaming Sheets ............................................................................. 27 2.3.7.1 Change the Sheet name ...................................................................................... 27 2.3.7.2 Delete the other sheets ........................................................................................ 30 2.3.7.3 Make the headings bold....................................................................................... 30

2.3.8 Test Run the Query .................................................................................................... 30 2.3.8.1 Test Run the Query.............................................................................................. 30 2.3.8.2 The Simple Report Output ................................................................................... 31

2.4 Create the Report.............................................................................................................. 32 2.4.1 Report Configuration General Page ........................................................................... 33 2.4.2 Alias Values Page ...................................................................................................... 34 2.4.3 Publishing Page.......................................................................................................... 35 2.4.4 Formats Page ............................................................................................................. 36 2.4.5 Schedules Page ......................................................................................................... 37 2.4.6 Credentials Page ........................................................................................................ 38



2.4.7 Alarm Conditions Page............................................................................................... 39 2.4.8 Creating a Schedule ................................................................................................... 40

2.4.8.1 Schedule Wizard General Page........................................................................... 41 2.4.8.2 Schedule Type Properties.................................................................................... 42 2.4.8.3 Schedule Associated Reports.............................................................................. 42 2.4.8.4 Alarm Conditions.................................................................................................. 43

3 Advanced Reporting Techniques......................................................................................... 45 3.1 Advanced Report Example ............................................................................................... 45 3.2 The Report Template ........................................................................................................ 46

3.2.1 Advanced - Create the Report Template.................................................................... 46 3.2.2 Advanced - Configure First Query.............................................................................. 46 3.2.3 Advanced - Configure Second Query......................................................................... 48 3.2.4 Initial Preparation of Output Sheet ............................................................................. 50

3.2.4.1 Change Sheet Name............................................................................................ 50 3.2.4.2 Report Title........................................................................................................... 50 3.2.4.3 From and To Values - Inserting Functions........................................................... 51 3.2.4.4 Add the Labels ..................................................................................................... 51 3.2.4.5 Add the Function .................................................................................................. 52 3.2.4.6 Column Headings................................................................................................. 53 3.2.4.7 Report Borders..................................................................................................... 54

3.2.5 Automatic Data Array Naming.................................................................................... 56 3.2.5.1 Example Named Array......................................................................................... 57

3.2.6 Using Array Formulas................................................................................................. 58 3.2.6.1 Get the Data Array Name .................................................................................... 58

3.2.6.1.1 Select the Data Array...................................................................................... 58 3.2.6.1.2 Copy the Data Array Name ............................................................................ 59

3.2.6.2 Select the Target Cell Array................................................................................. 59 3.2.6.3 Build the Array Function....................................................................................... 60

3.2.6.3.1 Get the Source Data Array Name................................................................... 61 3.2.6.3.2 Select Target Cell Range ............................................................................... 62 3.2.6.3.3 Build the Array Function ................................................................................. 62

3.3 The Report Schedule ........................................................................................................ 63 3.3.1 Open the Report Configuration Tool .......................................................................... 63 3.3.2 Create a new Schedule .............................................................................................. 63 3.3.3 Schedule Configuration General Settings .................................................................. 64 3.3.4 Timed Schedule Settings............................................................................................ 65 3.3.5 Associated Reports .................................................................................................... 66 3.3.6 Alarm Conditions ........................................................................................................ 67

3.4 The Report Format............................................................................................................ 68 3.4.1 Open the Report Configuration Tool .......................................................................... 69 3.4.2 Create a new Format.................................................................................................. 69 3.4.3 Format General Settings ............................................................................................ 70 3.4.4 Format Purging ........................................................................................................... 71 3.4.5 Recipient Associations ............................................................................................... 71 3.4.6 Alarm Conditions ........................................................................................................ 72



3.5 The Report ........................................................................................................................ 73 3.5.1 Open the Report Configuration Tool .......................................................................... 74 3.5.2 Create a new Report .................................................................................................. 74 3.5.3 Report General Page.................................................................................................. 75 3.5.4 Report Alias Values .................................................................................................... 75 3.5.5 Report Publishing ....................................................................................................... 76 3.5.6 Report Formats........................................................................................................... 77 3.5.7 Report Schedules ....................................................................................................... 78 3.5.8 Report Credentials...................................................................................................... 79 3.5.9 Report Alarm Conditions ............................................................................................ 80

4 Real World Example Report ................................................................................................. 82 4.1 Raw Water Pumpage........................................................................................................ 82 4.2 Treated Water Pumpage................................................................................................... 82 4.3 Raw Water Turbidity.......................................................................................................... 83 4.4 Raw Water Alkalinity ......................................................................................................... 83 4.5 Settled Water Turbidity...................................................................................................... 83 4.6 Finished Water Turbidity ................................................................................................... 83 4.7 Monthly Pumpage Totals .................................................................................................. 83 4.8 Turbidity Historical Stream................................................................................................ 83

4.8.1 Raw Pumpage ............................................................................................................ 84 4.8.2 Treated Pumpage....................................................................................................... 84 4.8.3 Raw Turbidity.............................................................................................................. 84 4.8.4 Raw Alkalinity ............................................................................................................. 84 4.8.5 Settled Turbidity.......................................................................................................... 84 4.8.6 Finished Turbidity ....................................................................................................... 84 4.8.7 Create the Stream ...................................................................................................... 84

4.8.7.1 Select the Columns and Define the Compressed Values.................................... 86 4.8.7.2 Define the Raw Dataset ....................................................................................... 87 4.8.7.3 Define the Compressed Dataset.......................................................................... 88 4.8.7.4 Select the Signals ................................................................................................ 89

4.9 Turbidity Report Template................................................................................................. 90 4.9.1 Change the First Sheet Name.................................................................................... 92 4.9.2 Configure the Turbidity Query .................................................................................... 93 4.9.3 Turbidity Name, Dataservice and Dataset.................................................................. 93 4.9.4 Turbidity Objects......................................................................................................... 94 4.9.5 Turbidity Query Period................................................................................................ 94 4.9.6 Turbidity Data Transform............................................................................................ 95 4.9.7 Turbidity Query Output ............................................................................................... 96 4.9.8 Prepare the Turbidity Output Sheet............................................................................ 96

4.9.8.1 The Turbidity Report Title .................................................................................... 97 4.9.8.2 Automating the Month and Year .......................................................................... 98 4.9.8.3 Block Borders..................................................................................................... 102 4.9.8.4 Finished Turbidity Modifications......................................................................... 104

4.9.9 Mapping the Turbidity Arrays.................................................................................... 106 4.9.9.1 Getting the Source Array ................................................................................... 106



4.9.9.2 Defining the Target Array................................................................................... 108 4.9.9.3 Including IF Formulas......................................................................................... 108

4.9.9.3.1 Average Without an IF Formula.................................................................... 108 4.9.9.3.2 Creating and Including the IF Formula ......................................................... 109 4.9.9.3.3 Avarage after Including the IF Formula ........................................................ 109

4.9.10 The Finished Turbidity Report Template............................................................... 110 4.10 Turbidity Report Schedule ........................................................................................... 111

4.10.1 Turbidity Schedule Name and Type...................................................................... 112 4.10.2 Turbidity Schedule Type Configuration................................................................. 113 4.10.3 Turbidity Schedule Associated Report .................................................................. 113

4.11 Turbidity Report Format............................................................................................... 114 4.11.1 Turbidity Format Name, Type and Destination ..................................................... 115

4.12 Turbidity Report ........................................................................................................... 116 4.12.1 Turbidity Report General Page ............................................................................. 117 4.12.2 Turbidity Report Publishing Page ......................................................................... 118 4.12.3 Turbidity Report Formats Page ............................................................................. 118 4.12.4 Turbidity Report Schedules Page ......................................................................... 119

5 Index ..................................................................................................................................... 121



1 OpenEnterprise Report Suite Overview The Report Suite enables the creation, scheduling, publication and distribution of reports. The three components of the OpenEnterprise Report Suite are: -

1. The Report Plug-in

2. The Report Configuration Tool

3. The Report Scheduler

1.1 Report Examples To help you in learning how to use the Report Suite to configure real world reports, two example reports are detailed here. The first is a simple example, designed to take you step by step in detail through the process of creating a basic report. The second example shows a more advanced method of report creation using multiple queries.

1. A Simple Report

2. Advanced Reporting Techniques

3. A Real World Report

1.2 The Report Plug-in This is an Excel add-in that enables Report Templates to be configured by directly importing OpenEnterprise historical data into Excel. Each historical data import is associated with a selected cell. A Query is then constructed by means of a wizard. More than one query can be configured within a single Report Template. The Excel file with the configured Report Plug-in Query or Queries is saved, and becomes a Report Template. It can then be used when configuring an OpenEnterprise Report.

The Report Plug-in can be installed on an OpenEnterprise Server as part of the Reporting Suite, but can also be installed separately on a computer that is neither an OpenEnterprise Server or Workstation. This enables any computer to be used to configure Report Templates.

Note: for the Report Plug-in to work, Excel 2003 (Microsoft Office 2003 Professional or standalone Excel 2003) must be installed on the host machine.

1.3 The Report Configuration Tool This tool enables all aspects of report configuration, including access to the Report Plug-in for creation of Report Templates. A configured OpenEnterprise Report must have an associated Template and Schedule, and optionally a number of Formats and Recipients.



The Template defines the data that is in the Report, the Schedule defines when the Report will be run, the Format defines the form in which the Report is to be published, and the Recipient defines where the published report will be delivered.

1.4 The Report Scheduler The Report Scheduler is used to run, publish and deliver all configured Reports. Without it, properly configured reports will not run. It should be configured to run as part of an OpenEnterprise Session, either part of an existing OpenEnterprise Session or a standalone Report Session.



The Report Scheduler's user interface provides the administrative user with information on the report configuration found in the database, statistics on the reports that have been run and events related to the running of reports. This information keeps the administrative user informed of all reporting issues.



2 A Simple Report This example shows how to configure a simple Report that will capture the previous hour's raw data for some Tank Levels. Its main purpose is to walk you through and familiarize you with the process of report creation. This is what the report will look like. You can use any number of analog signals from a raw or compressed dataset in your database to create this report. In this example we are using four signals.

There are three main steps to configuring a report.

1. Step 1 - Open the Report configuration Tool

2. Step 2 - Create and Configure the Report Template

3. Step 3 - Configure the Report

2.1 Open the Report Configuration Tool The Report Configuration Tool resides in the OpenEnterprise Toolbox. To access the Toolbox, select the Windows Start button and select Start>Programs>OpenEnterprise>Toolbox. Then select the Report Configuration Tool, which is circled in the image below.



When you have created the initial Report Template return to the Report Properties Data Service page within this documentation.

2.2 Report Configuration Tool Interface When the Report Configuration Tool first loads, it displays this Welcome page, which provides an initial example of how to create a Report using the Report Configuration tool, but contains no detailed information on the process of creating a Report Template. You can stop this Welcome message appearing the next time you open the Report Configuration Tool by un-checking the Show this form on startup box. Then click the Close button.

When the Welcome page has closed, you will see the Report Configuration Tool's main user interface:-



Note the tree view in the left pain has a list of empty headings underneath the main Report Configuration object. We need to create a new Report, but if you right click on The Configured Reports object, and select New Report, you will get this message:-

So, we first need to create a new Report Template object.

2.3 Create a new Report Template Since we have no existing Report configuration, the first thing we need to do is create a Report Template.

Select the Template icon and right click on the mouse. Then select the New Report Template option from the context menu as shown below. This will open the General Template Configuration page.

Alternatively, you can click the Edit menu and select the New Template option.



2.3.1 Manual Report Template Creation

A new Report Template can also be created manually. Instructions for creating a Report Template manually are given in the Report Plugin documentation.

2.3.2 General Configuration Page

If you are using the Report Configuration tool to configure a new Report Template, the General Template Configuration page is shown. Type the new template's name into the Name: field. The Create button will be enabled. Click the Create... button, circled in the image below. This will launch a new instance of Microsoft Excel as a new OpenEnterprise Report Template.

2.3.3 Report Properties Data Service

When a new Report Template opens for the first time, a Report Properties wizard prompts for some global Report properties. The first Report property required is the Data Service of the OpenEnterprise Server database to import data from. The default setting is rtrdb1. Change this value so that you can connect to your own database. You can test the connection to the data service by clicking the Test Connection button. For the purposes of this example, this is the correct data service, so leaving this setting as it is, we move to the next page by selecting the Next> button.



2.3.4 Report Properties Report Period

The next page is the Report Period page, which defines a default query period for the Report. The default query period is Today. Our query period is for the previous hour, so click on the drop-down Calendar Period list and select the Previous Hour option. Then move to the next page by selecting the Next> button.



2.3.5 Report Properties Event Logging

This page enables us to determine if and how we want our Report Template to log events. Event logging is useful for troubleshooting when creating and running a Report. The default is for Event Logging to be enabled, using the same name as the Report Template, a new Log file being created in the same directory as the actual Template each time it is opened. This is fine, so we will leave the default settings as they are. Click the Finish button to finalize the global Report properties and close the Report Properties wizard.



2.3.6 Create a Query

Once the Report properties have been configured, you will be returned to the open Report Template.



From here you can begin creating a query to import OpenEnterprise historical data by right clicking on a cell and selecting the OpenEnterprise>Import Signal History option. The Query wizard will begin, which enables you to create a query for the Report Template.

You could also use the OpenEnterprise menu on the Excel menu bar, or the Query Manager to import the OpenEnterprise historical data.

2.3.6.1 New Query from Context Menu

Select a cell where you wan to run the query from (usually the top left cell). Then locate the OpenEnterprise option at the bottom of the context menu, and select OpenEnterprise>Import Signal History>New Query, as shown in the image below.

2.3.6.2 New Query from Menu Bar

Select OpenEnterprise>Import Signal History>New Query from the Excel menu bar as shown in the image below.



2.3.6.3 New Query from Query Manager

Select OpenEnterprise>Query Manager from the Excel menu bar as shown in the image below.

Then select the Add button from the Query Manager dialog, as shown here.



2.3.6.4 The Query Wizard

The Query Wizard enables you to create a new query for the Report Template. In our test database, we have four tanks with level signals, which are ramping up and down fairly quickly. We have configured a dataset for these tank levels which takes a raw data sample every minute. This simple query is going to display all level values logged by the Historian for the four tanks during the previous hour.

There are seven pages of the Query Wizard. As you configure each page, select the Next button to move to the next page. The pages are listed down the left hand side. Each time you move on, the next page is highlighted and the previous page name is italicized. The seven pages are:-

1. The Query Name page.

2. The Dataservice page.

3. The Dataset page

4. The Signals page.

5. The Query Period page.

6. The Transform page.

7. The Output and Data Formatting page.

2.3.6.4.1 Query Name Page

This is the first of the Query configuration pages. It enables you to give the new Query a name. The name of each query defaults to Query<n>, where <n> is a unique serial number automatically given to each query as it is configured within the Report Template. This name can be changed if required by entering a new name. We will leave the default Query name in there. Click the Next button to go to the Query configuration Dataservice page.



2.3.6.4.2 Query Dataservice Page

The Query configuration Dataservice page enables you to select the default data service or enter a different service. We will also leave this as it is, since we are actually connecting to the default Report DataService. Click the Next button to go to the Query Dataset Page.



2.3.6.4.3 Query Dataset Page

This is where we select the actual dataset that we want to query. The major historical groups are shown next to a plus sign on the left of the list. In the example below they are listed as "control id = <ControlID>". These represent the historical 'streams' that have been configured in our database.



Raw sample datasets are marked with 0s (zero seconds). Compressed datasets have larger rates than zero.

In this example we have selected the raw dataset for control id 2. You can select any raw dataset that has been configured in your OpenEnterprise database. Select the dataset first, then click the Selected button. This places the selected dataset into the Currently selected data set field.

Now click the Next button to go to the Query Signals Page.

2.3.6.4.4 Query Signals Page

This is where we select the signals to be displayed on the report. The All Signals radio button is selected by default, but we only want a subset of the signals in the dataset we selected, so we have selected the Named Signals Only... radio button. To create a filter, we now need to access the Signal Browse dialog by clicking on the Add Signals... button.



2.3.6.4.4.1 Signal Browse Dialog This dialog enables us to find and select the signals we are interested in. We are looking for all the Tank Level signals in the dataset we selected. The unique Extension for these signals is 'LEVEL', so we type this string into the Extension filter box. Then click the Find Signals button.



All signals having the 'LEVEL' extension are shown in the found signals list.

We can then select the signals we want and click the Add Signals button before closing the dialog by selecting the Close button.



When the Signal Browser dialog has closed, we are returned to the Signal Selector Page. We can see that the signals have now been entered into the Selected Signals list. Click the Next button to go to the Query Period Page.

2.3.6.4.5 Query Period Page

This is where we configure the period covered by this query i.e. how much data do we want to request from the database and display on the report? We set the default Report Period to the Previous Hour option from the Calendar Period drop-down list, so we can leave this as it is. This will retrieve the previous hours worth of data whenever we run the Report. We will leave the Offset from midnight setting to zero.

2.3.6.4.5.1 Verifying the Report Period We can verify that the query period is going to give us the data we want by looking at the If the Report were run on Date/Time fields, then comparing these with the From: and To: fields. We can see that if the Report was run between 1PM and 2PM that the Report would contain data from the previous hour (12PM to 1PM).



2.3.6.4.6 Query Transform Page

The Transform page enables us to define how the data will be transformed before sending it to the Report. We will leave the defaults, which means that the Plug-in will use the Timestamp column itself as timestamp values, and that the timestamps will be displayed in ascending order. We have selected the raw value column for display, have enabled timestamp rounding to the nearest second, and have opted to insert missing records into the Report.



2.3.6.4.7 Query Output Page

The Output page enables us to define where and how the Report data will be output. We will leave the defaults on this page also, meaning that the data will appear on the sheet where the query has been configured. Column widths will be adjusted to fit the data, the object names (the Tank Level signals) will be shown, as will the column headers. Any null values returned will be displayed as an empty cell, but we could choose here to display null values as a string, for instance - 'NO-DATA'.



When we click on the Finish button, a small message box appears informing us that the query was created successfully, and asking us if we want to run the query now.

Click the No button for the moment. We will run our query later, because we have something else to do first.

2.3.7 Final Touches - Renaming Sheets

The report will not look very good if it is called 'Sheet1', and with empty worksheets attached to it, so we need to do a few final things.

2.3.7.1 Change the Sheet name

Right click on the tab at the bottom of 'Sheet1' and select the Rename option...



Type in a more appropriate name for the report...

Now we need to reconfigure the Report Template, because we have changed the name of the worksheet where it outputs its data. First select the OpenEnterprise>Query Manager menu option...

Then select the Query from the Query Manager dialog, and click the Modify button.



Then select the 'Output and Data Formatting' page from the 'Modify Query' dialog, indicated here by the red arrow.

As you can see, the Report Plug-in is expecting to output to 'Sheet1', which no longer exists, so now click the browse button to the right of this field, which we outlined in red here...

This small dialog appears with the new name of the worksheet...



Select the OK button and you will be returned to the Output page. Now you will see the new worksheet name and cell reference (NORTH TANK LEVELS!A1)in place of 'Sheet1!A1' in the Existing Worksheet - cell reference: field.

2.3.7.2 Delete the other sheets

Now delete the other two sheets from the workbook by right clicking on them and selecting the Delete option...

2.3.7.3 Make the headings bold

Finally, we will give all the headings in our report a bold font by selecting the first two rows of the report and clicking the B on the toolbar to make the font bold.

Now we can actually test our simple report.

2.3.8 Test Run the Query

2.3.8.1 Test Run the Query

Once the query has been created, it is time to test it. Select the OpenEnterprise>Run Report option from the Excel menu bar.



2.3.8.2 The Simple Report Output

This is how the Report Template output looks without any further formatting at all. The left column displays the timestamp values. As we asked, the Plug-in has displayed all timestamps, even where there is no corresponding value. The full signal names are printed along the first row, and the columns we asked for are printed below their signal names. Where there is a corresponding value for a timestamp, it is displayed under the column heading for the signal.



Save the Report Template and close Excel. Now that we have created the Report Template, we can go ahead and create the actual Report using the Report Configuration Tool.

2.4 Create the Report We can now continue with creating our Report, because we have created a Report Template for it. When the Report Template is saved and closed, we are returned to the Report Configuration Tool's main interface. The difference is that now we can see our configured Template.

The first thing we should do now is select the "The Configured Reports" icon, right click and then click the "New Report" context menu.



This will open the Report Configuration wizard at the General Page.

2.4.1 Report Configuration General Page

The General Report Configuration page enables us to create a name for the Report, together with a more informative description, and to associate the Report with a Report Template. In our example below we have used the name of the Report Template, but have added "PH" (short for "Previous Hour"). When you have finished the page, select the Next button to go to the next page of the wizard.

Now we need to select the Report Template from the list of Templates to associate it with our Report. Of course there is only the one Template at the moment. When we select it we see this message...



Then the Report Template is added to the non-editable field Selected Template.

Select the Next button to go to the next page of the wizard.

2.4.2 Alias Values Page

The Alias Values page enables us to create, define and delete Aliases. We are going to leave the Aliases as they are, so we click the Next button.



2.4.3 Publishing Page

The Publishing page enables us to define where we want reports to be published initially, before we apply formatting to them and distribute them to Recipients. We will keep all our reports in the Report folder on the D: drive, so we type this path into the default Directory field.

We are not going to purge (delete) reports automatically from this directory as soon as they have been successfully distributed, so we do not check the Purge Reports box. We leave the default option to remove the Report Plug-in from the published report. When you have finished the page, select the Next button to go to the next page of the wizard.



2.4.4 Formats Page

This page enables us to associate a Report Format with our report. Since we have no configured Report Formats at the moment, we will move on to the next page by selecting the Next button.



2.4.5 Schedules Page

This page enables us to associate a Report Schedule with our report. Since we have no configured Report Schedules at the moment, we will move on to the next page by selecting the Next button.



2.4.6 Credentials Page

The Credentials page enables us to specify a particular user to be associated with the running of Reports. For our purposes, we shall accept the default setting. When you have finished the page, select the Next button to go to the final page of the wizard.



2.4.7 Alarm Conditions Page

The Alarm Conditions page enables us to define alarm conditions for our report. We will accept the defaults on this page. Then we click the Finish button to complete the configuration of the report itself. However, if we were to leave the report as it is it would never be run because it has no associated Schedule. So now we need to create a Schedule which we can associate with the report.



2.4.8 Creating a Schedule

Creating a Report Schedule is like creating a report, in that we can begin in two ways. Firstly, by right clicking on the main Report Schedule object in the Report Configuration tools left pane, and selecting the New Report Schedule context menu:-

Or we can select the Edit menu, and choose the same option from the list.



Then the first page of the Schedule creation wizard will appear.

2.4.8.1 Schedule Wizard General Page

The name of the Schedule will be HOURLY, because it will be configured to run every hour. Note we have selected the Timed option from the Schedule Type section. This creates a timed schedule which can be associated with any report. We can move to the next page by selecting the Next> button.



2.4.8.2 Schedule Type Properties

This page enables us to define the properties for the particular Schedule type we have chosen. We have changed the default time unit from 1 day to 1 hour. We have not introduced any offset, so the Schedule will run every hour on the hour. We have left the Time Base settings at the default Local DST adjusted time. We can now select the Next> button to go to the next page.

2.4.8.3 Schedule Associated Reports

This page allows us to select the report object that will be triggered by this Schedule. From here we can associate this Schedule with multiple report objects. Here we have selected the report we have just created from the Available Reports list, and have moved it to the Selected Reports list. We can now select the Next> button to move to the next page.



2.4.8.4 Alarm Conditions

From this page we could define an alarm condition that would be generated if the Schedule failed. This would be generated as well as the alarm condition we created for the actual report itself. We have decided not to generate an alarm condition, so we have left the default settings as shown in the image below. Then we click the Finish button to close the wizard and complete the Schedule configuration process.



We have now created an actual OpenEnterprise report that will run every hour and be deposited in the D:\Reports directory. It will be an Excel file, which will be created with the same name as the report, with the date added at the end in the form YYYYMMDD (e.g. '20060506' = 6th MAY 2006). If the report is run more than once a day, a serial number will be added to the end after the date. Note that the serial numbers begin with a zero, so a file named 'NORTH TANK LEVELS200060506_3.xls' would indicate that it was the fourth report for the day.

If we wanted to publish the report in any other format (e.g. as a PDF file), we would now have to create a Report Format object, and associate it with our report. Furthermore, if we wanted to deliver our report to users in another location on our LAN or WAN, we would need to create a File Copy type Recipient, that copies the Report to the required shared directory on our network.

However, since our report is only a simple one we do not need to do this here. We shall create a Format and Recipient for our next example, which demonstrates more advanced techniques of report configuration and formatting.



3 Advanced Reporting Techniques Many reporting requirements are a lot more complex than the simple report example. What if, for instance, you wanted to set the results for two separate database queries side by side on the page?

What if we wanted to display the monthly average tank level for the current month right beside the corresponding value for last month on the same report?

The extra skills and knowledge required for us to do this are:-

• Creation of multiple queries on different named sheets

• More Excel page formatting skills

• Knowledge of the Plug-in's own cell functions and named arrays

• Use of Excel array formulas to manipulate the named arrays

• Knowledge of how to create a PDF Report Format

Now we can actually look at the Report that will be created using these extra skills.

3.1 Advanced Report Example This report has been published in PDF format. Last month's average value has been placed right alongside this month's value for comparison.

You could not do this using the basic simple query technique, because the results of the two queries would overwrite each other. How do we do it?

What we need is to create the two queries on separate pages (separate worksheets) and then import the results of these queries onto the actual report output page.

We can do this by combining the Report Plug-in's Excel Name functionality together with Excel's Array Functions. Also, we need to associate a Report Format of the PDF type with the report. Let’s break this into the following four main tasks.

1. Create the Report Template.



2. Create a Schedule for the report.

3. Create a PDF Format for the report.

4. Create the Report with its associated Template, Schedule and Format.

3.2 The Report Template These are the steps required to create the Advanced Report Template:-

1. Create a new Report Template.

2. Configure the first Query

3. Configure the second Query

4. Prepare layout on the output sheet

5. Automatic Data Array naming

6. Using Array Functions

3.2.1 Advanced - Create the Report Template

This is the list of tasks required to create the Intermediate Report Template.

1. Open the Report Configuration Tool. Please review the Open the Report Configuration Tool page.

2. Create the Intermediate Report Template. Please review the Create a new Report Template page.

3. Configure the General Template Page. Please review the General Template Configuration Page. This time, make the name of the Template 'MONTHLY TANK LEVELS'.

4. Set the Report Properties. Review the Report Properties Data Service page, entering the correct dataservice. Accept the defaults for the Report Period and Event Logging pages.

When the Report Template is created, we can begin configuring the first query for the report.

3.2.2 Advanced - Configure First Query

These are the tasks required to configure the first query of the Advanced Report. You will be encouraged to review how we created the Simple Report's Query, but please follow the additional instructions on this page that are required for creating this new Query. With the new Report Template open, do the following...

1. Start the Query wizard. Review the Create a Query page, and choose any method to begin the Query wizard.

2. Give the Query a name. On the Query Name Page, delete the default Query name and type a new name - "Last Month" without the quotes.

3. Accept the Report Data Service. On the Query Dataservice Page, accept the Data Service that you configured for the Report (assuming that you configured the correct Data Service there).



4. Select the correct Data Set. Select the correct data set from the Query Dataset Page. For this example query, that will be a compressed data set that is sampled on a daily basis. The compressed data set must be applying an average value to the raw data. The actual data set is shown in the image below.

5. Select the signals. For this particular query, we are using the same signals that we used for the Simple Report. As long as the signals we choose belong to a compressed data set that averages raw values, that will be alright. Review the Query Signals Page and Signal Browse Dialog to see how we filter the signals of interest from the data set.

6. Define the Query Period. We shall have to override the default Report Period, which was accepted as Today, and instead select Last Month from the drop-down list. Review the Query Period Page, if necessary.

7. Select the Average Value. Select the Average value from the Transform page.

8. Send the query results to a Temporary Worksheet. Instead of sending the Query results to the default 'Sheet1!A1' as we did for the Simple Query, we now need to define a Temporary worksheet with the name "LastMonth_data". Review the Output page for the Simple Report if necessary.



When you run this query now, it will be placed on a new sheet that it creates for you, and the sheet will be named "LastMonth_data".

We can now continue by configuring Query 2 for the Advanced Report.

3.2.3 Advanced - Configure Second Query

The second query is almost identical to the first one. You can begin this second query by selecting any cell on the first query page except the first cell, and selecting the New Query option from the context menu. The second query will not overwrite the first one, because we are going to output it to a new temporary worksheet that will be created when this second query is run.

1. Start the Query wizard. Review the Create a Query page, and choose any method to begin the Query wizard.

2. Query Name - This is configured on the Query Name Page, and it should be set to "ThisMonth" for this second query.

3. Accept the Report Data Service. On the Query Dataservice Page, accept the Data Service that you configured for the Report (assuming that you configured the correct Data Service there).

4. Select the correct Data Set. Select the correct data set from the Query Dataset Page. For this example query, that will be a compressed data set that is sampled on a daily basis. The compressed data set must be applying an average value to the raw data. The actual data set is shown in the image below.



5. Select the signals. For this particular query, we are using the same signals that we used for the Simple Report. As long as the signals we choose belong to a compressed data set that averages raw values, that will be alright. Review the Query Signals Page and Signal Browse Dialog to see how we filter the signals of interest from the data set.

6. Define the Query Period - This is configured on the Query Period Page, and should be set to "This Month" rather than "Last Month", as shown in this image.

7. Select the Average Value. Select the Average value from the Transform page.

8. Query Output Location - configured on the Query Output Page, this should be set to "ThisMonth_data" as shown below.

Now we need to prepare the actual output sheet so that the query results are displayed as we want them to appear on the actual published report.



3.2.4 Initial Preparation of Output Sheet

We will now attend to the initial formatting and placement details of the sheet on which we want to place our actual report. These are the tasks required to do this.

1. Change the Output Sheet name

2. Enter the Report Title

3. Enter the From and To values

4. Column Headings

5. Report Borders

Now, before we actually set up the import of the data from the other sheets, we need to know about the extra hidden work that the Report Plug-in does when it runs a query.

3.2.4.1 Change Sheet Name

We first need to change its name, so we right click on the tab and select the Rename option ...

Then we type in the new name, which is Monthly...

3.2.4.2 Report Title

The report title should appear at the top of the page, and be in a large bold font. First, select the first cell of the output worksheet and type in the report title...

Make the font size 14 point, and make its style Bold...



Finally, because the title overwrites cells B, C and D, we will merge cells A to D. Select them first, then right click and select Format Cells... from the context menu. Select the Alignment tab from the Format Cells dialog, and then check the Merge Cells box as highlighted in the example below.

3.2.4.3 From and To Values - Inserting Functions

In our report, we have shown the From and To values for the Report data at the top of the page. To do this we are using a cell formula provided by the Report Plug-in. It is the OEQueryVariable function. It retrieves any alias value from a named query used in the report.

The parameters for the OEQueryVariable function are OEQueryVariable(QueryName as string, VariableName as string). Therefore, we need to provide the query name and the alias name as strings.

3.2.4.4 Add the Labels

First add the labels for the From and To values, making them bold and right aligned...



3.2.4.5 Add the Function

Now select the cell immediately to the right of the From: label and right click on the mouse to reveal the context menu. Select the OpenEnterprise>Insert Function... option, shown in the example below:-

From the Insert Function dialog, select the OEQueryVariable function, then select 'Last Month' from the queryID drop-down list and 'STARTTIME' from the name drop-down list. These options are shown selected in the example below:-



Now click the OK button to insert the function into the selected cell. Help on the actual selected function can be obtained by selecting the 'Help on this function' link underneath the function list on the dialog. Help on all the features of the dialog can be obtained by clicking the Help button on the dialog.

The formula bar at the top of the sheet should now have the following function entered:-

Notice the query name is "Last Month", and the alias we want the value for is "STARTTIME". The Report Plug-in looks for the value in the query named "Last Month". Then it finds the resolved value of the "STARTTIME" alias for that query.

Now select the cell immediately to the right of the To: label and enter the function for the end time of the report like this...

3.2.4.6 Column Headings

We are going to use the first column for timestamps, then for each signal, we need to have a column for the average value of the Tank level for this month and beside it a column for the average value for last month.



Just under the From and To values for the report, we enter the names of the Tanks, followed by the units, followed by the This Week and Next Week headings. We have merged the Tank name and Units fields over two cells, and made them bold and centred. We made the This Month and Last Month headings 8 point and italicized.

Now we can add borders to the output page.

3.2.4.7 Report Borders

Here is a simple technique for adding borders to the final report using Excel 2003. First, select the area that you want to add borders to...



Then, while it is still selected go to the Borders icon on the Toolbar. If the Borders icon is not available enable it by selecting the View>Toolbars>Formatting menu item. Now select the All Borders option shown below...



Finally, select the Thick Box Border option, shown in the example below...

This will cause all the cells in the selected area to have a border, but the outer lines of the selected cells will have a thicker border as shown in this example...

Now we can use Array Formulas to import the data from the two queries into this output sheet.

3.2.5 Automatic Data Array Naming

When the Report Plugin returns data from a query to a worksheet, it automatically names that column of data from the first to the last value as a data array. The basic naming convention it uses is <SheetName>.<ObjectName>.<ColumnName> for a signal array, or <Sheetname>.<ColumnName> for the timestamp array.

This named array of values can then be used in an Excel array formula to apply a formula to each of the values in the named array. Formulas can be applied to this array from other worksheets in the workbook.



3.2.5.1 Example Named Array

The image below is taken from the page which contains the query data for Last Months Tank levels. This first image shows what happens when a group of cells is selected that belongs to a named Data Array, but does not include all of the members of that named array. As you can see, the selected cell becomes the first cell, and its name is entered into the cell name field in the box outlined in red on the image below...

However, when the same group of cells is extended to include the whole of the data array, you can now see that instead of a single cell name in the highlighted field, there is the Data Array Name that was given to the column of data by the Report Plug-in...

We can't read the full name here, so we have to open the Define Name dialog using the Insert>Name>Define item from the Excel menu bar.



The Array Group's full name is LastMonth_data.NORTH_TANK3_LEVEL..average. We can see by looking at the Refers to: field that this name refers to cells B3 to B32 collectively. So now we can see that the Report Plug-in has named all returned columns from our queries so that we can refer to these values from any sheet in the Excel workbook by using this name. Now we can show how these arrays can be used to combine the results from different queries into another single worksheet using an Array Formula.

3.2.6 Using Array Formulas

Now that we know about the named Arrays of the Report Plug-in, we can utilize Excel's Array Functionality to bring those values across from another worksheet. There are three main steps to do this...

1. Get the Data Array name

2. Select the target Cell array

3. Build the Array Function

3.2.6.1 Get the Data Array Name

The Data Array name can get quite long, so it is better to copy it to the clipboard before trying to use it to create the Array Function on the target sheet. These are the steps to accomplish this task...

3.2.6.1.1 Select the Data Array

Click on the ThisMonth worksheet and select the timestamp value column from the first value to the last value. You can tell you have the whole array, by looking at the cell name field, outlined in the image below. When you see the array name appear here, stop extending the selection.



3.2.6.1.2 Copy the Data Array Name

Now click in the field where the array name appears. The array name should now be highlighted in blue...

Select the Ctrl and C keys on the keyboard simultaneously to copy the name to the clipboard.

3.2.6.2 Select the Target Cell Array

Back on the target sheet, firstly click on the cell where you will begin the import of data:-



Now, holding down the [Shift] key on the keyboard, drag the mouse down to cell 40 (to cover the 31 days needed for a month), and leave the cells selected.

3.2.6.3 Build the Array Function

Then go back to the cell value field, and type in the equals sign. Then select the Ctrl and V keys on the keyboard together to paste the data array name containing the Timestamp values from the ThisMonth sheet.

Now, this next instruction is important - to enter the Array Formula correctly, you must select the Ctrl, Shift and Enter keys together. Then Excel will add two curly brackets at either end of the formula, and you will know that the formula has been entered correctly...



Now do the same thing for each of the Tank average value arrays...

3.2.6.3.1 Get the Source Data Array Name

Go to the correct sheet for the source Data Array name and select all the values for the first signal. Here we are getting this months average for TANK3. When you have all the values, the Data Array will appear in the cell name field. Select it and then copy it to the Windows clipboard by pressing Ctrl and C together on the keyboard.



3.2.6.3.2 Select Target Cell Range

Then open the target sheet, and select the same number of cells in the place where you want the source values to appear...

3.2.6.3.3 Build the Array Function

Type the equals sign into the cell value field at the top of the worksheet, and then press the Ctrl and V keys on the keyboard together to paste the copied array name to the cell value field...



Finally, press the Ctrl, Shift and Enter keys together on the keyboard to enter the Array Formula into the selected target range.

3.3 The Report Schedule This is how to create a Report Schedule using the Report Configuration tool.

1. Open the Report Configuration tool

2. Create a new Schedule

3. Configure Schedule Time

4. Associate with a Report

5. Schedule Alarm Conditions

3.3.1 Open the Report Configuration Tool

The Report Configuration Tool resides in the OpenEnterprise Toolbox. To access the Toolbox, select the Windows Start button and select Start>Programs>OpenEnterprise>Toolbox. Then select the Report Configuration Tool, which is circled in the image below.


3.3.2 Create a new Schedule

Select the Schedule icon and right click on the mouse. Then select the New Report Schedule option from the context menu as shown below. This will open the General Schedule Configuration page.



Alternatively, you could click the Edit menu and select the New Schedule option...

3.3.3 Schedule Configuration General Settings

Firstly, we give the new Schedule a name and an informative description. Then we select the desired type of Schedule from the three options before selecting the Next button. The three options are On Demand, Timed or Change of Value. We need a Timed Schedule.



3.3.4 Timed Schedule Settings

We need to run the report, say every day at 6PM, so we select 1 Day as the time period and enter 18:00 in the At field. We will leave the Time Base at Local DST Adjusted. Move on by selecting the Next button.



3.3.5 Associated Reports

We use this page to associate the Schedule with a Report. As we have not yet created our Report object, we cannot do this, so we will just select the Next button.



3.3.6 Alarm Conditions

From this page we could define an alarm condition that would be generated if the Schedule failed. This would be generated as well as the alarm condition we created for the actual report itself. We have decided not to generate an alarm condition, so we have left the default settings as shown in the image below. Then we click the Finish button to close the wizard and complete the Schedule configuration process.



We have now created an actual OpenEnterprise report that will run every hour and be deposited in the D:\Reports directory. It will be an Excel file, which will be created with the same name as the report, with the date added at the end in the form YYYYMMDD (e.g. '20060506' = 6th MAY 2006). If the report is run more than once a day, a serial number will be added to the end after the date. Note that the serial numbers begin with a zero, so a file named 'NORTH TANK LEVELS200060506_3.xls' would indicate that it was the fourth report for the day.

If we wanted to publish the report in any other format (e.g. as a PDF file), we would now have to create a Report Format object, and associate it with our report. Furthermore, if we wanted to deliver our report to users in another location on our LAN or WAN, we would need to create a File Copy type Recipient, that copies the Report to the required shared directory on our network.

However, since our report is only a simple one we do not need to do this here. We shall create a Format and Recipient for our next example, which demonstrates more advanced techniques of report configuration and formatting.

3.4 The Report Format We now need to create a new Report Format object that will convert our Report to PDF format before delivering it to any Recipients. This is done via a wizard and takes the following steps...

1. Open the Report Configuration Tool

2. Create a new Report Format

3. Format General page



4. Purging Page

5. Recipient Associations page

6. Format Alarm Conditions




3.4.2 Create a new Format

Select the Schedule icon and right click on the mouse. Then select the New Report Format option from the context menu as shown below. This will open the General Format Configuration page.

Alternatively, click the Edit menu and select the New Format option.



3.4.3 Format General Settings

On the Format General page, firstly type in the name of the Format, giving it an optional description for easier understanding of what it can be used for.

Select the format type from the Type: drop-down list. Type in the destination - where you want Reports having this Format to be created prior to any final distribution to Recipients.

Type the file name into the File Name: field, adding a space at the end, then select an appropriate Date/Time format to add to the end of the name from the drop-down list off the <<Formats button. Leave the Ensure Unique File Name box checked if there is any chance that the Report filename may be duplicated. Then click the Next button.



3.4.4 Format Purging

We have chosen to delete any Reports created with this format after 7 days. Note this does not purge Reports published in any other format.

3.4.5 Recipient Associations

Any Recipients that we wish to associate with a published Report Format can be chosen here. Since we have not yet created any Recipients we can leave this page by selecting the Next button.



3.4.6 Alarm Conditions

We can create alarm conditions for this Format here, generated on the success and/or failure of the Format creation. We are not going to configure a Format alarm, so click the Next button.



3.5 The Report We now need to create a new Report object that will be associated with our Report Template, Report Schedule and Report Format. This is done via a wizard and takes the following steps...

1. Open the Report Configuration Tool

2. Create a new Report

3. Report General page

4. Report Alias Values

5. Report Publishing Page

6. Report Formats

7. Report Schedules

8. Report Credentials

9. Report Alarm Conditions






3.5.2 Create a new Report

Select the Configured Reports icon and right click on the mouse. Then select the New Report option from the context menu as shown below. This will open the General Report Configuration page.

Alternatively, you could click the Edit menu and select the New Report option.



3.5.3 Report General Page

Type the name of the Report and a more user friendly Description of what the Report does. Then select the correct Template for the Report from the list of available Templates. When this is done, click the Next button.

3.5.4 Report Alias Values

Leave the settings on this page as they are and click the Next button.



3.5.5 Report Publishing

This page enables us to define a directory to which all Published Reports are created. Settings on this page are overridden by settings that are configured for an associated Format. If no settings are defined here, an Excel Report with the Plug-in removed will still be created in the working directory of the Report Scheduler when the Report is run, even though no Formats are associated with this Report.

We will not define any Publishing settings here, so click the Next button.



3.5.6 Report Formats

Select the available PDF Format and transfer it to the Selected Formats list using the > button. Then click the Next button.



3.5.7 Report Schedules

Select the available DAILY Schedule and transfer it to the Selected Schedules list by using the > button. Then click the Next button.



3.5.8 Report Credentials

We are going to use the credentials of the local OpenEnterprise Server administrative user to generate and publish the Report, so click the Next button.



3.5.9 Report Alarm Conditions

We want to raise an alarm if the generated Report encounters any errors Check the Generate Alarm if any Error occurs box. Accept the range of errors and the alarm priority that are provided. Click the Finish button. The Advanced Report is now configured.



4 Real World Example Report This is a real world example of a Report that could be created using the Report Plugin. It is a Report that is required for the Water industry in the USA. It provides daily Turbidity readings of treated water for the previous month. Turbidity is a measure of debris in the water.

Below is an example of a standard Turbidity Report. Any similarity to real place names is not intentional.

4.1 Raw Water Pumpage The volume of raw water in millions of gallons (MGD) that is pumped into the treatment system each day.

4.2 Treated Water Pumpage The volume of treated water in millions of gallons (MGD) that is delivered to storage and distribution each day.



4.3 Raw Water Turbidity The maximum value recorded each day for raw water turbidity.

4.4 Raw Water Alkalinity Maximum daily raw water alkalinity reading.

4.5 Settled Water Turbidity Maximum reading of settled water turbidity before filtration. A separate reading is taken for each basin.

4.6 Finished Water Turbidity Finished daily water turbidity reading after filtration. If there is one filter, a turbidity reading must be taken at 4 hourly intervals, so that there are 6 readings per day. If there are two filters, a combined filter effluent reading is taken at 15 minute intervals.

In OpenEnterprise we would go beyond this, taking a reading every minute. Then instead of having six actual Turbidity readings in the Report, we would show the minimum, maximum and average finished water turbidity values recorded for each day.

4.7 Monthly Pumpage Totals Below the Raw and Treated pumpage values for the month there are cells which calculate the Total, Minimum, Maximum and Average pumpage for the month.

4.8 Turbidity Historical Stream In this example, the signals associated with Turbidity will be part of a single Historical stream, or logging group. The Turbidity signals will be part of a stream that logs values at one minute intervals. The raw values will be stored in a Raw Dataset. A compressed Dataset will be added that is fed from this Dataset, and which provides Minimum, Maximum, Average and Total values on a daily basis for each of the signals in the Dataset. The Compressed Dataset will contain daily compressed values for one month for all the signals related to Turbidity.

The signals that require logging for this Report are:-

1. Raw Pumpage

2. Treated Pumpage

3. Raw Turbidity

4. Raw Alkalinity

5. Settled Turbidity

6. Finished Turbidity

We will use the Historian Configuration Tool to create this Historical stream.



4.8.1 Raw Pumpage

The volume of raw water pumped into the treatment system each day. Signal name: IP1:RAW.PUMP.FLOW.

4.8.2 Treated Pumpage

The volume of treated water delivered to storage and distribution each day. Signal name: IP1:TREATED.PUMP.FLOW.

4.8.3 Raw Turbidity

The Turbidity of the raw water entering the system. If multiple samples are taken, this should be the Maximum value recorded each day. Signal name: IP1:RAW.TURB.VAL.

4.8.4 Raw Alkalinity

The alkalinity of the raw water entering the system. Signal name: IP1:RAW.ALK.VAL.

4.8.5 Settled Turbidity

The turbidity of the raw water entering the system once it has settled. Again, this would be the maximum reading recorded each day. There are two basins, so the two Signal names are: IP1:SETTLED.TURB1.VAL and IP1:SETTLED.TURB2.VAL.

4.8.6 Finished Turbidity

The turbidity of the treated water after passing through the filtration system. Normally, a reading would have to be provided every 4 hours during the day. However, with OpenEnterprise this could be taken more frequently, and a Maximum, Minimum and Average value for each day can be provided. Signal name: IP1:FILTER1.TURB..

4.8.7 Create the Stream

We will use the Historian Configuration Tool to create the Turbidity historical stream, which we will use for the Report. Follow these steps:-

1. With the database running, go to the Start button and select the Toolbox application. On Windows XP this would be Start>All Programs>OpenEnterprise>Toolbox.

2. Login, then double click on the Historian icon within the Toolbox window.



3. To create a new Logging Stream click the Add button on the Historian Configuration Tool:-

4. Select the realanalog table as the source table from the list at the top of the 'Logging Group' page of the wizard. Leave 'name' as the name column.

5. Enter a number for the Group ID that no other logging group has:-



6. Enter the estimated number of signals that will be in the group. If in doubt enter slightly more than you expect. Also remove the check from the 'Log All Objects' box.

Then click the [Next] button - .

4.8.7.1 Select the Columns and Define the Compressed Values

Now we need to select the columns that we want to log historically, and check the compressed values that we will want to log also.

1. Select the readvalue column from the 'Available Fields' list.

2. Then click the double arrow button -

3. The readvalue field will automatically be entered into the Analog part of the 'Fields to be logged' section, with the 'Raw' compression rate selected.

4. We will need to also log Maximum, Minimum, Average and Total compression values for our signals. Select each option so that it turns blue with a cross in the middle:-



To select the 'Total' compression option, click the right scroll bar, highlighted above. The 'Total' option is last in the list:-

The 'Total' compression rate adds all 'Raw' values for logged signals in the group over a given period. This will be used to provide the final daily Raw and Treated water pumpage.

Now click the [Next] button -

4.8.7.2 Define the Raw Dataset

1. First, accept the default settings on the 'Logged Fields' page:-

Click the [Next] button on this page - .

Now we come to the 'Define Datasets' page where we must define the actual 'Datasets' that will belong to this 'Logging Group', or 'Historical Stream'. The 'Datasets' that we define determine the size of the log files that the Historian creates to store the logged historical values for the Stream.

2. Click the [Add] button on the 'Define Datasets' page -

3. Define the polling rate of the Raw Dataset by setting it to '1 minute' as shown:-



Leave the 'Starting From:' box checked. You can change start time for the raw dataset, or leave it as it is.

4. Set the 'Keep For At Least' period to '1 Day', and the 'Maximum Unsaved Data' period to '1 Hour'. These values are used to calculate the 'BufferSize' and 'BufferCount' values of the Dataset.

5. Define the Log file directory by using the 'Browse' button:-

Click the [OK] button -

4.8.7.3 Define the Compressed Dataset

1. The Raw Dataset now appears in the window on the 'Define Datasets' page.

We now need to create the Compressed Dataset, which will hold the Maximum, Minimum, Average and Total values. With the Raw Dataset selected, click the [Add] button again -

2. This time, the 'Fed From Dataset' field has '0s' in it. This shows us that the current Dataset will be fed by values from the Raw Dataset, and the Historian will apply the selected compression to these values.

3. Set the Polling Rate for the Compressed Dataset to '1 Day' as shown:-



Leave the 'Starting From:' box checked. If you changed the start time for the raw dataset, change the start time for the compressed dataset to match it.

4. Set the 'Keep For At Least' and 'Maximum Unsaved Data' fields to '2 Months' and '2 Hours' respectively:-

This will allow us to store two month's worth of data in the Compressed Stream.

5. Define the Log Directory again:-

Then click the [OK] button -

At this point, we should configure archiving for the Logging Group, but to save time, we will move on and just create the Logging Group. For more information on configuring archiving behaviour, see the documentation for the Historian Configuration Tool.

4.8.7.4 Select the Signals

1. Accept the defaults on the 'View Names' page:-

Click the 'Next' button -

2. On the 'Select Objects' page, use the 'name' filter to create a filter for the signals list, then click the 'Refresh' button:-



3. When you have finished, you should have all the signals for the Group selected in the right pane:-

Click the [Next] button, then the [Finished] button on the 'Summary Page'.

4.9 Turbidity Report Template To configure an OpenEnterprise Report, you must use the Report Configuration Tool to create a Report Template.



1. With the database running, go to the Start button and select the Toolbox application. On Windows XP this would be Start>All Programs>OpenEnterprise>Toolbox.

2. Login, then double click on the Reporting icon within the Toolbox window.

3. Right click on the 'Templates' icon, then select the 'New Report Template' context menu option.

4. Type the name of the Report Template then click the [Create] button:-



The Report Properties wizard opens. Accept the defaults by clicking the [Next] button on all 3 pages.

5. Excel will then be available with the Report Plugin added. We can continue configuring the Report by configuring the Query for the Report.

4.9.1 Change the First Sheet Name

1. Before configuring the Report Query, it may be a good idea to change the name of the first worksheet, since we will be using this sheet to output the results of the Turbidity Query. First, from the Excel menu bar, select Format>Sheet>Rename.



2. Type in the new name of the sheet.

4.9.2 Configure the Turbidity Query

1. We are going to use the first Sheet of the Report for the actual displayed output of the report, so click on Sheet2, and ensure the first cell in the sheet is selected. Then from the Excel menu bar select OpenEnterprise>Import Signal History>New Query...

2. This opens the New Query wizard.

4.9.3 Turbidity Name, Dataservice and Dataset

1. Firstly, type in the name of the Query that will define the Turbidity Report:-

Avoid spaces in the name. Click the [Next] button to go to the 'Dataservice' page.

2. Accept the default Database and click the [Next] button on the 'Dataservice' page.

3. On the 'Dataset' page, open the Turbidity Stream, and select the Daily Dataset. Then click the [Select] button. The selected dataset should be in the 'Currently selected data set' field. Now click the [Next] button to go to the 'Objects' page.



4.9.4 Turbidity Objects

1. On the 'Signal Selector' page, since we require all the signals which are in the Dataset to create the Report Template, leave the 'All signals' option selected.

2. Click the [Next] button.

4.9.5 Turbidity Query Period

1. Check the 'Override default report period' box, then select the LastMonth period from the Calendar Period drop-down list.



2. Then click the [Next] button.

4.9.6 Turbidity Data Transform

1. Select the Minimum, Maximum, Average and Total values from the 'Available Columns' list and add them to the 'Display Columns' list.




4.9.7 Turbidity Query Output

1. We need to change the Query output sheet to be a temporary worksheet. Temporary worksheets do not appear in the actual Report when it is published by the Report Scheduler. We do not want the raw data to be shown in the Report. Select the 'Temporary worksheet' radio button and type a name for the temporary sheet as shown below.

2. To finish configuring the query, click the [Finish] button on the 'Output' page. We can now begin preparing the Turbidity Report Sheet. This is the first sheet, which we re-named 'Monthly Turbidity Report'.

4.9.8 Prepare the Turbidity Output Sheet

Here are some of the Excel procedures required to create and modify the main Report page.

1. Merge Cells and Center the Report Title



2. Change the Month and Year Options

3. Create Block Borders

4. Modify the Finished Turbidity Section

4.9.8.1 The Turbidity Report Title

1. The Report Title is centered along a number of merged cells. To do this, first select all of the Cells across the top of the Report. Then right click and select the 'Format Cells' option, shown below.

2. Now, on the 'Alignment' tab, set the Horizontal and vertical alignment to Center, and check the 'Merge Cells' box. Then click the [OK] button.



3. Type the Report title into the merged fields:-

4. Then select the font size and type:-

4.9.8.2 Automating the Month and Year

1. In most Reports of this type, the Month and Year are contained in selectable Excel lists. The Month and Year must be selected manually from the Lists:-



2. With our OpenEnterprise Report we could eliminate this necessity, by having the Report's month and year entered automatically using the Report Plugin's 'Insert Function' context menu. Here's how to do it.

3. Remove the lists by selecting each list. Then from the Excel menu bar select the Data>Validation option.

4. To remove the list, select the Settings tab and then select 'Any Value' from the 'Allow' drop-down list.



5. Now to add the OpenEnterprise Functions which contain the Date information for the used Query, select the target cells where the lists were, right click and select the OpenEnterprise>Insert Function option.

6. Select the 'OEQueryVariable' function, then select the queryID - in this case 'Last_Month', then the variable name - 'STARTTIME', or 'ENDTIME'.

7. Change the format for the Month value field to display the text for the month of the Query. Right click on the cell and select the 'Format Cells' option from the context menu. Then create a 'Custom' Category that just displays the text of the month:-



8. Change the format for the Year value field to display the text for the year of the Query. Right click on the cell and select the 'Format Cells' option from the context menu. Then create a 'Custom' Category that just displays the text of the year:-



4.9.8.3 Block Borders

This subject has already been dealt with on the Report Borders page. However, here is another method:-

1. Select the group of cells that requires a border:-

2. Right click and select the 'Format Cells' option:-



3. Select the 'Borders' Tab and configure the border for your selection as required:-



4.9.8.4 Finished Turbidity Modifications

The standard Turbidity Report requires that six actual Finished Turbidity readings be entered for each day at 4 hourly intervals. An OpenEnterprise automated Report is able to collect and present this information in a better way by automating the data collection at regular, shorter intervals throughout the day (say, one minute intervals), and presenting this as Maximum, Minimum and Average readings for each day. Here's how to modify the Output Sheet to do this:-

1. Select the last three of the Finished Turbidity columns on the Report Output sheet:-

2. Right click whilst these cells are selected and choose the 'Delete' option from the context menu:-



3. On the Delete dialog, choose the 'Entire Column' option:-

4. There are now only 3 Finished Turbidity columns, which will be used for the Minimum, Maximum and Average values. The whole Report has been resized horizontally.



4.9.9 Mapping the Turbidity Arrays

Having created the major visual elements of the Turbidity Report, we need to map the data from the Query that we created on Sheet2 to the appropriate columns on the main output page (Sheet1). These are the steps required to complete this task:-

1. Get the Source Array

2. Define the Target Array

3. Dealing with Blank fields

4.9.9.1 Getting the Source Array

Do the following for each of the source Data Arrays in the Turbidity Report Query for Last Month's daily values.

1. Select the whole of the source column (31 cells). Here we have the totals for the Raw Pumpage selected from the Query sheet:-



2. Click on the Data Array name at the top of the Sheet. Ensure the whole thing is selected as shown:-

3. Press CTRL and C on the keyboard to copy this name to the clipboard.



4.9.9.2 Defining the Target Array

Now select the Report Output page (this is usually the first worksheet). We have renamed this to 'Monthly Turbidity Report'.

1. Select the cells on the output sheet that correspond to the Source Data Array that was selected. In the example we have chosen the Raw Pumpage results:-

2. Click on the 'fx' field on the Excel toolbar and press CTRL and V on the keyboard to paste the Source Data Array formula into the selected Target cells.

3. The value copied is in gallons per day. We need to make it display as MGD (millions of gallons per day), so we need to divide by one million:-

4. Finally, we must press the SHIFT, CTRL and ENTER keys together on the keyboard. This action enters the formula on the Target Array as a Data Array formula. You will now see the curly brackets entered around the Array.

4.9.9.3 Including IF Formulas

Problems may arise when some of the elements of a Data Array contain no data. This will affect the average, and you may not want null values to be taken into account by the averaging formula. For instance, some months will have less than 31 days worth of data. On these months, the null value for the 31st day will affect the monthly averages.

In this case, the IF formula can be used to display null entries as text rather than as the usual numerical zero (0.0). Text entries are ignored by the averaging formula.

4.9.9.3.1 Average Without an IF Formula

If some of the elements of a numerical Data Array return null values, Excel by default enters a zero value into the cell. If another cell calculates an average from that Data Array, it will think those were actual zero values, rather than null values. Consequently, the average will be lower than expected:-



4.9.9.3.2 Creating and Including the IF Formula

1. Select the whole Data Array as shown:-

2. Modify the Data Array to include the IF formula. First click inside the formula field then make the modifications:-

This will cause Excel to write the text "X" into the cell if its value is not greater than zero.

3. Finally, press the SHIFT,CTRL and ENTER keys on your keyboard together. This will enter the curly brackets at the start and end of the formula, which mark it as a Data Array:-

4.9.9.3.3 Avarage after Including the IF Formula

Now when a null value is encountered, the IF formula ensures that Excel types an "X" into the cell rather than a zero value. Then, the average formula ignores that cell when calculating the average.



4.9.10 The Finished Turbidity Report Template

The Turbidity Report Template is now finished, and this is the result after running the Query.



4.10 Turbidity Report Schedule We shall create a schedule for the Turbidity Report that runs on the first day of every month. The resulting Report will display the Turbidity data for the previous month. It will also create a duplicate Excel version of the file in one folder, with the Plugin component removed, and another PDF version of the Report in a different shared folder.

1. First, open the Report Configuration Tool, which resides in the OpenEnterprise Toolbox. To access the Toolbox, select the Windows Start button and select Start>Programs>OpenEnterprise>Toolbox. Then select the Report Configuration Tool, which is circled in the image below.



2. When the Report Configuration Tool is loaded, select the Schedule icon and right click on the mouse. Then select the 'New Report Schedule' option from the context menu as shown below. This will open the 'General Schedule Configuration' page.

3. Alternatively, you could click the Edit menu and select the New Schedule option...

4.10.1 Turbidity Schedule Name and Type

1. On the General page of the Schedule wizard, type the Schedule Name into the Name field.



2. Select the 'Timed' Schedule Type, as shown in the image below.

3. Click the 'Next' button.

4.10.2 Turbidity Schedule Type Configuration

1. On the Schedule Type page, check the Repeating box, then choose 'Every 1 Month'. Set the 'At' value to 1 AM as shown.

.

2. Set the Offset to be the First Day of the Month.


4.10.3 Turbidity Schedule Associated Report

1. We haven't yet created the Report, so we cannot select our associated Report yet.




3. Accept the defaults on the Alarm Conditions page, which is no Alarm Conditions and click the 'Finish Button' to close the Report Schedule wizard.

4. The new 'Monthly Turbidity Report' Schedule should now be displayed under the Schedules icon in the Report Configuration Tool.

4.11 Turbidity Report Format Now we can create a Turbidity Report Format, which will publish the Report in Rich Text Format.

1. First, open the Report Configuration Tool, which resides in the OpenEnterprise Toolbox. To access the Toolbox, select the Windows Start button and select Start>Programs>OpenEnterprise>Toolbox. Then select the Report Configuration Tool, which is circled in the image below.

2. When the Report Configuration Tool is loaded, select the Formats icon and right click on the mouse. Then select the 'New Report Format' option from the context menu as shown below. This will open the 'General Schedule Configuration' page.



3. Alternatively, you could click the Edit menu and select the New Format option...

4.11.1 Turbidity Format Name, Type and Destination

The General Page of the Report Format wizard enables us to give the Format a Name, specify the Format Type, and define the directory where Reports created in this Format will be stored.

1. Type the Format Name into the 'Name' field:-

2. Select the 'Rich Text Format' option from the 'Type' drop-down list:-

3. Use the [Browse] button to define the destination directory for this Format.



4. Type the name of the formatted file and use the Format button to add other information to the file name.

5. Now accept the defaults on the Purging, Recipients and Alarm Conditions pages of the Report Schedule wizard.

6. The new Turbidity Report Format should now be listed under the Formats icon in the Report Configuration Tool:-

We can now create the actual Turbidity Report.

4.12 Turbidity Report Now we have all the necessary Reporting objects to create the actual Monthly Turbidity Report. These are the steps required to begin.



1. The Report Configuration Tool resides in the OpenEnterprise Toolbox. To access the Toolbox, select the Windows Start button and select Start>Programs>OpenEnterprise>Toolbox. Then select the Report Configuration Tool, which is circled in the image below.

2. Select the 'Configured Reports' icon and right click on the mouse. Then select the 'New Report' option from the context menu as shown below. This will open the 'General Report Configuration' page.

3. Alternatively, you could click the Edit menu and select the 'New Report' option.

4.12.1 Turbidity Report General Page

On the Report General page set the following options:-

1. Type the Report Name into the 'Name' field:-



2. Select the 'Monthly Turbidity Report' Template:-


4.12.2 Turbidity Report Publishing Page

1. Click the [Next] button on the 'Alias Values' Page, since we are not configuring any Aliases.

2. On the 'Publishing' Page, type the location for all published Turbidity Reports. This location will override the default location, which is in the OpenEnterprise bin directory.

3. Accept the other defaults on this page and click the [Next] button.

4.12.3 Turbidity Report Formats Page

1. Select the 'Turbidity Rich Text Format' which we configured before. In the image below there is also a 'Daily Turbidity - PDF Format' object. We could also provide a Daily Turbidity Report, but we would need to configure another query on our Turbidity Report Template, which returns all available Turbidity data for the current month. We would also need to adjust the output page.



2. Accept the rest of the defaults on this page and select the [Next] button.

4.12.4 Turbidity Report Schedules Page

1. Select the 'Monthly Turbidity Report' Schedule that we created earlier.


3. Accept the defaults on the 'Credentials' and 'Alarm Conditions' pages to finish the Turbidity Report configuration.

4. The 'Monthly Turbidity Report' should now be displayed under the Reports icon, with its associated Template, Schedule and Format.



That is the configuration for the Turbidity Report completed.



5 Index A Advanced Report .................... 46, 66, 72, 78 Advanced Report Format .......................... 72 Advanced Report Schedule ...................... 66 Advanced Report Template ................ 46, 47 Alarm Conditions Page ............................. 37 Alias Values Page ..................................... 32 Array Function........................................... 63 Automatic Data Array Naming .................. 58 Avarage after Including ........................... 119 Average Without...................................... 118

B Block Borders .......................................... 111 Build .......................................................... 63

C Cell Array Name........................................ 61 Change.................................................... 101 Change Output Sheet Name..................... 52 Column Headings...................................... 56 Columns .................................................... 94 Compressed Dataset ................................ 96 Compressed Values.................................. 94 Configure........................................... 30, 101 Configure First Query................................ 47 Configure Second Query........................... 49 Configuring .................................................. 5 Context Menu............................................ 13 Create................8, 12, 47, 67, 73, 79, 92, 99 Creating............................................. 38, 118 Credentials Page....................................... 36

D Data Format ............................................ 105 Dataservice ............................................. 102 Dataset .................................................... 102 Define ............................................ 94, 95, 96 Defining ................................................... 117

F

Final Touches ............................................24 Finished Turbidity Modifications ..............113 Finished Turbidity Report ........................119 Finished Water Turbidity............................90 First Sheet Name.....................................101 Formats Page ............................................34

G General Template Configuration Page........9 Getting .....................................................115

I IF Formula .......................................118, 119 IF Formulas..............................................117 Including ..........................................117, 118 Initial Preparation.......................................51 Intermediate...............................................47

M Mapping ...................................................115 Menu Bar ...................................................14 Month.......................................................107 Monthly Pumpage Totals...........................90 More Advanced Report..............................45 Multiple Queries Example..........................45

N New Format ...............................................73 New Query...........................................13, 14 New Report............................................8, 79 New Report Template..................................8 New Schedule............................................67

O Open ..........................................5, 66, 72, 79 OpenEnterprise Reporting Overview...........1 Output Sheet......................................51, 106

P Prepare ....................................................106 Publishing Page.........................................33

Q Query12, 14, 15, 16, 17, 18, 21, 22, 23, 28, 101, 103 Query Dataservice Page ...........................16



Query Dataset Page.................................. 17 Query Manager ......................................... 14 Query Name Page .................................... 16 Query Output Page ................................... 23 Query Period Page.................................... 21 Query Signals Page .................................. 18 Query Transform Page.............................. 22 Query Wizard ............................................ 15

R Raw Alkalinity ............................................ 91 Raw Dataset.............................................. 95 Raw Pumpage........................................... 91 Raw Turbidity ............................................ 91 Raw Water Alkalinity ................................. 90 Raw Water Pumpage ................................ 89 Raw Water Turbidity.................................. 90 Real World Examples................................ 89 Renaming Sheets...................................... 24 Report1, 2, 5, 6, 9, 10, 11, 30, 41, 47, 52, 56, 66,

69, 72, 74, 75, 76, 77, 79, 80, 81, 82, 83, 84, 85, 86, 99, 106, 119, 121, 124, 127, 128, 129, 130

Report Alarm Conditions ........................... 86 Report Alias Values................................... 81 Report Borders.......................................... 56 Report Configuration General Page.......... 30 Report Configuration Tool .2, 5, 6, 66, 72, 79 Report Configuration Tool Interface............ 6 Report Credentials .................................... 85 Report Format Alarm Conditions page ..... 77 Report Format General page .................... 74 Report Formats ................................. 83, 129 Report Formats Page.............................. 129 Report General Page ........................ 80, 128 Report Plug-in ............................................. 1 Report Properties Data Service .................. 9 Report Properties Event Logging.............. 11 Report Properties Report Period............... 10 Report Publishing Page .................... 82, 129 Report Purging Page................................. 75 Report Recipient Associations page ......... 76

Report Scheduler.........................................2 Report Schedules ......................................84 Report Template ..................................47, 99 Report Title ........................................52, 106 Reports page .............................................69

S Schedule35, 38, 39, 40, 41, 42, 67, 69, 70, 84, 121, 122, 12Schedule Alarm Conditions .................42, 70 Schedule Associated Reports ...........41, 123 Schedule Configuration General page ......67 Schedule Reports page .............................69 Schedule Type Properties .........................40 Schedule Wizard General Page ................39 Schedules Page.................................35, 130 Select.............................................62, 94, 97 Settled Turbidity.........................................91 Settled Water Turbidity ..............................90 Signal Browse Dialog ................................19 Signals .......................................................97 Simple Report ........................................5, 28 Simple Report Output ................................28 Source Array............................................115 Stream .......................................................92

T Target Array.............................................117 Target Cell Array........................................62 Test Run ....................................................28 Timed Schedule page................................68 To Values...................................................53 Treated Pumpage......................................91 Treated Water Pumpage ...........................89 Turbidity .... 99, 106, 121, 123, 128, 129, 130 Turbidity Arrays........................................115 Turbidity Data Transform.........................104 Turbidity Format General Page ...............125 Turbidity Historical Stream ........................90 Turbidity Name ........................................102 Turbidity Objects......................................103 Turbidity Output .......................................105 Turbidity Query ........................................101



Turbidity Query Period ............................ 103 Turbidity Report....................................... 127 Turbidity Report Format .......................... 124 Turbidity Schedule Name........................ 122 Turbidity Schedule Type Configuration... 122 Type ........................................................ 122

U Using Array Formulas ............................... 60 Using This Help File .................................... 1

Y Year......................................................... 107

Reference Guide D5092 11-Dec-2007 Reporting Overview

Emerson Process Management Remote Automation Solutions 1100 Buckingham St Watertown, CT 06795 T 1 (860) 945 2200 F 1 (860) 945 2278 www.EmersonProcess.com/Remote [email protected]

Emerson Process Management Remote Automation Solutions Blackpole Road Worcester, WR3 8YB T 44 (0) 1905 856848 F 44 (0) 1905 856930 www.EmersonProcess.com/Remote [email protected]

© 2007 Remote Automation Solutions, division of Emerson Process Management. All rights reserved.

NOTICE Remote Automation Solutions (“RAS”), division of Emerson Process Management shall not be liable for technical or editorial errors in this manual or omissions from this manual. RAS MAKES NO WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE WITH RESPECT TO THIS MANUAL AND, IN NO EVENT SHALL RAS BE LIABLE FOR ANY INCIDENTAL, PUNITIVE, SPECIAL OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF PRODUCTION, LOSS OF PROFITS, LOSS OF REVENUE OR USE AND COSTS INCURRED INLCUDING WITHOUT LIMITATION FOR CAPITAL, FUEL AND POWER, AND CLAIMS OF THIRD PARTIES. Bristol, Inc., Bristol Babcock Ltd, Bristol Canada, BBI SA de CV and the Flow Computer Division are wholly owned subsidiaries of Emerson Electric Co. doing business as Remote Automation Solutions (“RAS”), a division of Emerson Process Management. ROC, FloBoss, ROCLINK, Bristol, Bristol Babcock, ControlWave, TeleFlow and Helicoid are trademarks of RAS. AMS, PlantWeb and the PlantWeb logo are marks of Emerson Electric Co. The Emerson logo is a trademark and service mark of the Emerson Electric Co. All other trademarks are property of their respective owners. The contents of this publication are presented for informational purposes only. While every effort has been made to ensure informational accuracy, they are not to be construed as warranties or guarantees, express or implied, regarding the products or services described herein or their use or applicability. RAS reserves the right to modify or improve the designs or specifications of such products at any time without notice. All sales are governed by RAS’ terms and conditions which are available upon request. RAS does not assume responsibility for the selection, use or maintenance of any product. Responsibility for proper selection, use and maintenance of any RAS product remains solely with the purchaser and end-user. Engineered and supported by:

Remote Automation Solutions, Bristol Babcock Ltd. Blackpole Road, Worcester, WR3 8YB, UK Reg office: 2nd Floor, Accurist House, 44 Baker Street, London, W1U 7AL Registered in England and Wales, Reg No. 2580226 VAT Reg No. GB 880 9839 67

bristol openenterprise reference guide · reference guide d5092 11-dec-2007 - page 4 reporting...

Documents