Working With The Indico Report Brochure

Introduction Working with the Indico Report Swedish Meteorological and Hydrological Institute, SE-601 76 Norrköping, Sweden Page 1 (16) Phone: +46-11 495 8000, Fax: +46-11 495 8001 Volume 4 Airviro User’s Reference Working with the Indico Report How to get the most out of your data stored in the Time Series Database of the AIRVIRO system The Airviro User’s Reference Airviro version 3.20 Working with Indico Report How to get the most out of your data stored in the Time Series Database of the AIRVIRO system Amendments Version Date changed Cause of change Signature 3.00.11 May 2004 New module GS 3.11.20 Oct2007 Upgrade GS 3.12 January 2009 Upgrade GS 3.20 June 2010 Upgrade GS Swedish Meteorological and Hydrological Institute, SE-601 76 Norrköping, Sweden Page 3(16) Phone: +46-11 495 8000, Fax: +46-11 495 8001 Contents 4.1 Introduction to Indico Report ............................................................ 5 4.1.1 What is Indico Report? .......................................................................................... 5 4.1.2 How does Indico Report client work? ................................................................... 5 4.2 Getting started ....................................................................................... 6 4.2.1 Overview of the Indico Report main window ........................................................ 6 4.3. The Main Menu of the Indico Report module.............................. 6 4.3.1. General Concepts .................................................................................................. 7 4.3.2. Database Concepts ................................................................................................ 7 4.3.3. The Report Wizard Subwindow ............................................................................ 8 4.3.4. Basic Concept of Report Configuration ................................................................ 8 4.4. Default Report Types ............................................................................... 9 4.4.1 Average .................................................................................................................. 9 4.4.2. Cumulative .......................................................................................................... 10 4.4.3.General ................................................................................................................. 10 4.4.4. Macro .................................................................................................................. 10 4.4.5. Plain .................................................................................................................... 10 4.5. Examples ................................................................................................ 10 4.5.1. Example 1: Producing Daily Summaries ............................................................ 11 4.5.2. Example 2: Making Cumulative Instances ......................................................... 13 4.5.3. Example 3: Using the General Processor ............................................................ 15 Introduction Working with the Indico Report Swedish Meteorological and Hydrological Institute, SE-601 76 Norrköping, Sweden Page 5 (16) Phone: +46-11 495 8000, Fax: +46-11 495 8001 4.1 Introduction to Indico Report Indico Report is - together with Indico Administration and Indico Validation - one of the three main tools in Airviro Air Quality Management, intended for acquiring, storing, editing, presenting, analyzing, reporting and exporting time series data. PI: Remove this Indico Report makes it easier the making of reports to present Airviro data. 4.1.1 What is Indico Report? Indico Report is a powerful tool for reporting data stored in the time series database. With Indico Report is possible to create reports that can be automatically executed at a specified interval such as at the end of every day. Typically this would be a summary table of some kind that is automatically sent as email or printed. There are many different types of reports to be used. A set of five standard output formats (called process types) is provided. PI: Remove this The approach is very object orientated. With Indico Report, you can: Create different kind of reports. Assess capture PI: Remove this and status of the data. Autmotically run reports at specified intervals. Reports can be sent to a mailbox, printer, screen or file. Use Indico Macros to create reports. PI: Remove this Automatically update reports as new data arrive. An experienced user will be able to use the Airviro system as an integrated monitoring system, i.e. extract valuable information from the measured data and use it to evaluate dispersion calculations. 4.1.2 How does Indico Report client work? Airviro has is a web based user interface. Airviro can be used from a PC or any other device running Internet Explorer 6 or later and Firefox. After logging in on Airviro the Indico Report module can be selected. All data processing is made on the Airviro server and the results are transferred to the web browser. The Airviro User’s Reference Airviro version 3.20 Page 6(16) June 2010 Please note that JAVA JRE (run time plugin) must be installed and enabled in the web browser. 4.2 Getting started After logging in the application by entering a username and password, the user is presented with a list of all available Domains (if none has being previously selected and stored), By selecting a Domain the top menu list will be refreshed to show all available Airviro Modules. After you have selected a module to work with, you can change the domain selecting the Domain menu ( Figure 4.2.1.1) All the examples explained here are based on the Airviro (Göteborg) Reference System, included in all Airviro systems delivered. Here you will find two years of hourly data, meteorological and ambient air measurement. 4.2.1 Overview of the Indico Report main window After Indico Report has been selected, the user will see a list of menus on the left side of the window. To successfully complete the set up for a report, it is advisable to work through the menus sequentially, from Domain down to Output, because some settings may depend on previous choices. Figure 4.2.1.1 Domain 4.3. The Main Menu of the Indico Report module The main window contains different menus: Main menu Working with Indico Report Swedish Meteorological and Hydrological Institute, SE-601 76 Norrköping, Sweden Page 7(16) Phone: +46-11 495 8000, Fax: +46-11 495 8001 DOMAIN This allows to select the Project with which is wanted to work. i.e. REF. REPORT Includes three different sub-menus, Edit, New and Delete. Allows the user to edit, define or delete Reports. OUTPUT Allows the user to display the report choosing from different available output options (mail, files, printer, screen) 4.3.1. General Concepts Domain... is the first menu, which takes you to a subwindow where you can select the domain for which the report will be made. The next menu is Report... which is divided in three submenus Load, New and Delete each one of them takes you to different subwindows where you can Define New Reports, Edit or Delete existing ones. In the Output... sub window you can preview or run an existing report. 4.3.2. Database Concepts When working with Indico Report from Airviro you are accessing the time series database, so it is important to understand how a time series is defined. A time series contains measurement observations. The following components must be defined in order to define a time series: station : It defines from which measurement site the data is being collected parameter: It defines which parameter is being measured, e.g. gas concentration, air temperature, wind direction, etc. The Airviro User’s Reference Airviro version 3.20 Page 8(16) June 2010 instance This is used to differentiate among several measurements of the same parameter at the same site. In the case of DOAS measurements, the instance indicates which path (light beam) has been used for the measurements. In the case of meteorological mast measurements, the instance should indicate the height at which the measurement has been made. This component can also be used to differentiate between measured values and calculated values for a parameter (in which case the instance might instead be named CAL). attributes This component describes the available properties of the measurement. In the case of DOAS measurements, this could be value, standard deviation, light intensity or status. All of these properties belong to the same observation. 4.3.3. The Report Wizard Subwindow The Report Wizard sub window is designed to be as versatile as possible, by incorporating the preferences of different customers. To open this option, select the New menu under the Report on the left side. 4.3.4. Basic Concept of Report Configuration Report Types or Instances At the top you can create, select or delete report instances. Instances contain references to the report type and also configurations for these. It is possible to copy the configuration of an old report instance by first loading it and then pressing the New button. The current instance is saved with the Apply button. Report type Each instance is linked to one report type. To select a report type from a list is the first step in Report Wizard. Go there by clicking New on the Report. When a new Report type has been selected you must go through the entire wizard configuration clicking the Next... button. The input data requested is different for each report type. For each new instance you must go through all these steps once - but if you need to reconfigure anything you may step back, simply by pressing Back button and then choosing another choice. Once you have gone through all the wizard steps, at the final step you have press the Apply button in order to save the report configuration. A message saying that “Report saved” will be shown. Output Main menu Working with Indico Report Swedish Meteorological and Hydrological Institute, SE-601 76 Norrköping, Sweden Page 9(16) Phone: +46-11 495 8000, Fax: +46-11 495 8001 Report output can be sent as email, saved as a file or printed. In case of an email the destination email address is entered in the text box. In case of a file the full path of the filename is entered in the text box. -------------------------------------------------------------------------------------------------------- HINT: When you press the Preview button, the output configuration is NOT used, instead it is shown on your screen in an appropriate viewer. The Execute button will generate the output to the output destination that has been specified in the report setting. -------------------------------------------------------------------------------------------------------- Schedule The default is None which means that no automatic report will be made. To make a report Output must be used. You can also select to automatically run the instance at certain intervals or events - in this case having output to a file normally does not make sense. Execution Execution can basically take place in three slightly different ways: 1. When you press the Preview button in the Output window a new window opens, showing some status information on the progress while the report is generated, when this is finished, the data produced will be shown on screen. 2. When you press the Execute button, as in the previous case, a new window opens to show the progress while the report is generated, then the report will be sent to the Output destination specified in the configuration (screen, file, or email). 3. Instances that are saved with a schedule (for automatic execution) will be executed on batch, without showing the progress information window. Note: logging out or closing the progress window will abort the execution. 4.4. Default Report Types 4.4.1 Average Displays the selected time series data together with the average value and the standard deviation. Up to eight time series can be selected. You also write a title and select a format. PI: Remove this - if you have a PostScript printer then you will have better-looking printer output. If you have specified hourly values then the instance will be for the previous day, if you have specified daily values then the instance will be for the The Airviro User’s Reference Airviro version 3.20 Page 10(16) June 2010 previous month. It is also possible just to indicate a specific number of hours back in time. 4.4.2. Cumulative Produces a more complex output of cumulative ratios, data capture and maximum and average values. PI: Remove this To use this, all selected time series should share the same parameter type. You set up the cumulative ratios by first choosing a number of levels, the distance between each level and the value for the first level. Alternatively you can specify 8 levels. The percentage of data that is below that level is calculated for each level. The result is a table showing percentile values. Again, if you have specified hourly values then the instance will be for the last day, if you have specified daily values then the instance will be for the previous month. It is also possible just to indicate a specific number of hours back in time. 4.4.3.General It uses a saved Indico macro and produces a listing of data in a tabular format. You can choose a day, week, month, quarter or year. The instance will then be for the day, week, etc. previous to the specified date. When specifying a macro; title, restrictions and time series will be used to generate the output. The unit slot in the variable selection will be used for heading each one of the columns. When specifying the setup you can select the time period and resolution to be used. The higher resolution depends on which database you have available, e.g, it could be 5 minute, quarter hourly, etc. The resolution or the time period is used for computing the total averages, maximum, minimum and standard deviation values that appear at the bottom of the table. An additional summary is also given for the resolution of the table. 4.4.4. Macro It uses a saved Indico macro, keeping all the same information except the time period, which can be specified by the number of hours worth of data that you want to include in the graph. In this case the printout is graphical, and you can select output format. The stop time of the graph will be the end of the specified time period unless a number of hours forward has been specified. 4.4.5. Plain It lists the data that you have selected for a specified number of hours. The stop time will be the specified time. Output can be plain ASCII text, SKV format (e.g. for importing to certain spreadsheet programs) or Airviro standard format. 4.5. Examples Main menu Working with Indico Report Swedish Meteorological and Hydrological Institute, SE-601 76 Norrköping, Sweden Page 11(16) Phone: +46-11 495 8000, Fax: +46-11 495 8001 4.5.1. Example 1: Producing Daily Summaries Suppose that some of your real time data comes from an open path-measuring site (such as an Opsis analyser). With this data you do not only need to keep an eye on the data values but also the standard deviations, light levels and status values associated to the data. It is possible to print a daily summary for each one of the substances measured at the site, and in this example a table for NO2 data will be created. First select Report and then New. Now, in the Report Type subwindow..., select Average from the list and click on Next. A new window appears, where you have to choose a time period for your report: daily, monthly, or specified if you want to set the number of hours back for your report. Then press Next to continue. Select the time series you are interested in, time period could be requested in some cases depending on whether your selected data consists of hourly, daily values, etc. Choose an Opsis Station (in this case Jarntorget), the Parameter (NO2), the Instance (001) and the Attribute (value). Then select the other Attributes (Std dev, light and status). Now the four relevant time series for path 1 have been selected. Click on Next to continue through the wizard entering Report title, data capture limit and exceedance. In next step you select the output format: plain text or PostScript. PI Remove this: PostScript looks a lot better, but you can only use it if the printer supports PostScript Level 2. Click on Next, now you have to set up an instance. Under Destination choose Mail and specify your email address so that the report output will be sent to you when it is executed. Finally click Next and save the report entering a name for your instance. It is quite important to give it a meaningful name especially if you intend to create a lot of other instances. This one will be called opsis_daily_no2. Preview. The data used for this example had information with bad status values. The table ignores missing data and calculates the standard deviation and average value of the data that is present, however data with bad status is included unless otherwise is specified in a special resource file (ask your system administrator). These values are only relevant for the actual data values, as the standard deviation of the standard deviation is not too meaningful. Once you are satisfied with your instance you might decide that you want a similar table to be made every day. To print it automatically once a day, choose Daily. Schedule. The report output will be automatically sent out at a specified time every night. The default time for daily instances is at fifty minutes past midnight, but this can be modified. The Airviro User’s Reference Airviro version 3.20 Page 12(16) June 2010 Main menu Working with Indico Report Swedish Meteorological and Hydrological Institute, SE-601 76 Norrköping, Sweden Page 13(16) Phone: +46-11 495 8000, Fax: +46-11 495 8001 Title: Järntorget NO2 analysis Period: 91051201 - 91051224 Date: 940420 4.5.2. Example 2: Making Cumulative Reports Create a new instance called cumulative_so2. Select the cumulative report type. PI Remove this , and you will see that this time you must choose time series for the same parameter. Select one of the available Reports (daily, monthly or specified) and Click on Next... to start defining the report. The Time Series... sub window appears where you can select the time series that you are interested in. The Airviro User’s Reference Airviro version 3.20 Page 14(16) June 2010 Choose some SO2 time series. In this example the SO2 levels from Molndal’s three Opsis paths are used. Next you are asked to specify how many limits to use. In order to appreciate the cumulative approach it is best that the distance between limits is not too large so you will need quite a few - say 15. Now you must specify the distance between limits. This depends on the range of your data but you can choose a size of 10 for now and change it later if you need to. Next you must specify the start limit, i.e. the level that you would like for the first limit. Enter 0. Finally you will be asked for a table title and you must also select an output format - those beginning with PS are PostScript formats, in particular the PostScript grey scale format looks very good. Title: SO2 levels at Mölndal Period: 89031301 - 89031324 Date: 940110 If you are using the reference database then you can look at the days with data for Molndal station. Choose None: under Schedule and press the Next button. Save the report. To visualize the report go to the Output menu, enter the date 890314 in the Time Period textbox and click on Preview, your instance will be run as if today’s date were 14 March 1989 so it will use data from 13 March 1989. The data on that day had significantly higher values than usual and it is also interesting to see the big difference between the three different Opsis paths even though they are relatively close to each other. Main menu Working with Indico Report Swedish Meteorological and Hydrological Institute, SE-601 76 Norrköping, Sweden Page 15(16) Phone: +46-11 495 8000, Fax: +46-11 495 8001 Although this cumulative option might sound a bit complicated it is really quite simple. If you look at the results for path 1 you will see that: All values are greater than 0 µg/m3 62% of values are greater than 10 µg/m3 42% of values are greater than 20 µg/m3 4% of values (i.e. one value) are greater than 50 µg/m3. None of the values are greater than 60 µg/m3. For path 3 the values are much higher and there is a maximum value of 130 µg/m3. Title: SO2 levels at Mölndal Period: 89031301 - 89031324 Date: 940420 Gray levels: Here you can see two different examples of outputs. The first one is a plain output - it is made up of ASCII texts and symbols and can be printed out to any printer. The second is a PostScript output, which has a much better quality. In this particular case it is possible to show the percentages as a grey scale. 4.5.3. Example 3: Using the General Processor The Airviro User’s Reference Airviro version 3.20 Page 16(16) June 2010 First use Indico Presentation to define a new macro, such as a time series with 2 plot variables, x1 and x1+5. Put a title on the graph, as this will then be used as a title for the instance. Save the macro as general_macro (choose Macro…Save.. under the main menu on the left menu bar). Now go back to the Report Module. Click on New.... and choose the General report type, then, click on the Next... button, which enables you to choose different options for the content and format. First select the macro on which the instance is going to be based on (look for the macro general_macro in the macro list). Next you select the time period - in this example choose Week. Next you select the time resolution for the calculations, so choose hour. Click Next (in a weekly table daily values are displayed but you could use another resolution such as hourly or five minute values to calculate the mean, standard deviation, max. and min. values). In the next step you select an output format - select PostScript if your system can handle it, otherwise select plain. This example shows calculated NO2 levels compared with the actual levels. Finally you are prompted to enter the destination and schedule and then to enter a name. Write example_general and click on Apply. Comparison of calculated and actual NO2 levels Column 1 : 94+.0698*x1-0.117*x3+1030/(1+x1*x1)-222/ln(1+x1) Column 2 : x5 Computation: Average, 0% data capture