timeview dbi user guide - isodaq.co.uk · user level timeview timeview dbi 1. user (default) view...

TimeView DBI User Guide

August 2013

- 2 -

Offices also at:

Exeter: +44 (0)1884 841473 Reading: +44 (0)1189 331325 Sheffield: +44 (0)1433 639409

Hydro-Logic Ltd. Registered in England number 1287366

Stirling: +44 (0)1786 477410 Registered Office: Old Grammar School, Church Street, Bromyard, Herefordshire, HR7 4DP. VAT number 388 7002 27

ISO9000certificated

CONTENTS

1. QUICK START - 3 -

2. USAGE - 4 -

2.1 ACCESS - 4 - 2.2 MAIN PAGE - 5 - 2.3 TREE VIEW - 6 - 2.4 MAPS TAB - 6 - 2.5 CHARTS TAB - 11 - 2.6 EXPORT - 12 - 2.7 CALCS TAB - 13 -

2.7.1 Introduction to Derivations - 13 - 2.7.2 Use of the Derivations Interface - 13 - 2.7.3 Arithmetic Operators - 17 - 2.7.4 Conditional Operators - 17 - 2.7.5 Standard Functions - 17 - 2.7.6 Constants - 19 - 2.7.7 Lookup Tables - 20 -

2.8 TABLE TAB - 21 - 2.8.1 Use of the Lookup Tables Interface - 21 -

3. PERFORMANCE - 22 -

3.1 INTERNET - 22 - 3.2 LOCAL PLATFORM - 22 - 3.3 SERVER - 22 -

LIST OF FIGURES Figure 1: Help Button - 3 - Figure 2: Link from TimeView to TimeView DBi - 4 - Figure 3: TimeView DBi Main Page - 5 - Figure 4: Logger Station Selection - 6 - Figure 5: Selecting a Parameter - 7 - Figure 6: Date Range Selection - 8 - Figure 7: Refresh Chart control in Chart Type panel - 8 - Figure 8: Chart Type Selection - 9 - Figure 9: Large Size Chart - 10 - Figure 10: Charts Tab - 11 - Figure 11: Charts Tab Refresh Charts control - 11 - Figure 12: Export Chart Data to CSV control - 12 - Figure 13: Typical Downloaded File List - 12 - Figure 14: Calcs Tab Initial View - 14 - Figure 15: New, Delete and Edit Buttons - 15 - Figure 16: Calcs Tab with Derivation Editor Showing - 16 - Figure 17: Table Tab View - 21 -

- 3 -

Offices also at:




ISO9000certificated

1. QUICK START

• TimeView DBi is the long term database extension to TimeView, allowing the time series data to be held, viewed, and downloaded indefinitely, for any number of loggers.

• There is no need for locally loaded software or individual user licences, and the database server is hosted on the Web, reducing IT complexity and costs.

• TimeView DBi is normally entered via TimeView itself, with similar user access levels. • There is a simple and intuitive interface, based on various Tab views. • The data viewed default to the latest available, but any period can be selected for display. • There is a simple Map pin interface for selecting a chosen station (logger), or the station

can be selected from a tree view on the left of the page. • Any parameter at a station can be selected to graph for the chosen period, and graphs can

be reconfigured or expanded by clicking on them. • On the Charts tab, multiple selection of parameters from any number of stations (including

selecting all) is possible, to view graphs synchronised by date • The Charts tab comes with a multiple CSV download function which is easy and fast,

allowing long periods of record to be downloaded as a single file. • TimeView DBi includes Derivations, with time series maths and lookup table conversions. • There is also an option for a CSV Import tab to allow manually-downloaded data to be

added from non-telemetry Isodaq loggers. • TimeView DBi can be branded with your own corporate logo. • There is an initial licence and setup charge, and then an annual fee for hosting, supporting

and maintaining TimeView DBi over a standard contract period. • Since end customers own the licence and the data they can choose to implement

TimeView DBi on their own or third party platforms, following the initial contract period. • We specialise in bespoke features and interfaces to exactly fit organisational requirements,

and are always pleased to discuss these with customers. Most modern PC and Laptop browsers are suitable for use with TimeView DBi, which was designed for Internet Explorer version 8 or above. It can also be accessed via many mobile devices. The demonstration version is available at: http://www.timeviewdbi.net/ The design of TimeView DBi aims for simplicity and intuitive control. This document therefore provides an overview of the facilities available. This document can be found by clicking the question mark button in the top right of TimeView DBi.

Figure 1: Help Button

- 4 -

Offices also at:




ISO9000certificated

2. USAGE

2.1 ACCESS Access to TimeView DBi is normally via TimeView itself. There is an entry in the menu on the left hand side of the main TimeView page.

Figure 2: Link from TimeView to TimeView DBi

Upon clicking the link in the menu, if TimeView DBi has been commissioned for the account, then a new browser tab is opened and the long term data is shown in TimeView DBi. If there is no TimeView DBi database commissioned for a particular account, then the demonstration version is opened instead, showing a small network managed by Isodaq Technology, with the user in Intermediate Level mode, to be able to try out some of the functionality. Normally, user access levels in TimeView DBi closely reflect the access rights of the same user in TimeView. These are summarised in the table below:

User Level TimeView TimeView DBi

1. User (Default) View only, no exports or configuration

View only, no exports, imports, derivations or configuration

2. Intermediate As user but can also export As user but can also export 3. Manager As Intermediate but can also

reconfigure loggers and alarms As Intermediate but can also

reconfigure loggers and alarms

As Intermediate but can also import, and create and edit

derivation scripts

4. Administrator As manager, but can also manage user accounts

Account management is normally dealt with in

TimeView. Other TimeView DBi access is the same as

Manager. 5. Super User As Intermediate, but also has

access to some special account information

Same as Intermediate.

- 5 -

Offices also at:




ISO9000certificated

2.2 MAIN PAGE

Figure 3: TimeView DBi Main Page

The default TimeView DBi main page features a tree view of the logger stations on the left hand side, with a default tab showing the logger positions on a map. Please note that the system can be configured to show a different tab upon entry if preferred (e.g. the Charts tab). Users can supply their logo for customisation in the top left of the TimeView DBi pages. Throughout TimeView DBi, the main way to select the period of data to display is in the date range boxes in the header of the page.

- 6 -

Offices also at:




ISO9000certificated

2.3 TREE VIEW

Figure 4: Logger Station Selection

Logger Stations can be selected by clicking on the tree view of logger stations on the left, or by clicking on a map pin. Clicking on the tree view automatically highlights and repositions to the logger station location on the map. It also opens the list of parameters at that location in the tree view.

2.4 MAPS TAB Clicking on a map pin has the same effect as clicking on a logger station in the tree view, selecting and opening the list of parameter details for that logger station in the tree view. Loggers with no latitude and longitude information entered in TimeView will not appear as map pins but can still be selected using the tree view.

- 7 -

Offices also at:




ISO9000certificated

Figure 5: Selecting a Parameter

Clicking on the name of a parameter on the tree view will then display a graph for the period shown at the top. The graph automatically scales, and a summary of the number of readings is shown, together with the Mean, Maximum and Minimum values in the period displayed.

- 8 -

Offices also at:




ISO9000certificated

Figure 6: Date Range Selection

A date picker calendar appears when clicking in the date range fields, allowing zooming of the graph. Please note that the Refresh Chart control in the Chart Type panel below the map must be clicked once changes to the date range have been completed.

Figure 7: Refresh Chart control in Chart Type panel

- 9 -

Offices also at:




ISO9000certificated

Figure 8: Chart Type Selection

The Chart Type panel itself can also be used to change between various chart types such as line and column, and to alter the totalising interval used with a column chart. This can be very useful for visualising different totals with parameters such as rainfall, but may not be appropriate for parameters such as temperature which do not lend themselves to totalising. Note that the radio buttons have to be set to custom for any chart type changes to take place on refresh. The totalising feature for Column type charts can be very useful:

• All values within the chosen intervals are totalised, whether positive or negative. • The boundary for intervals is dependent on the start date and time of the period selected. • It is therefore possible to view different types of daily totals, for example, starting at either

the calendar day (00:00) or the UK water day (09:00) simply by changing the From value. • Similarly monthly or annual figures can be viewed based on the calendar (1st January) or

another reporting period start such as 1st September. • The Mean, Maximum and Minimum summary displayed will then provide information about

the totalised data rather than the raw data, which can very quickly calculate the wettest and driest day or month in a period using rainfall or flow data etc.

Please remember to click on the Refresh Chart control in this panel once any changes have been made in order to change the appearance of the chart.

- 10 -

Offices also at:




ISO9000certificated

Figure 9: Large Size Chart

Clicking on any chart shown on either the Map or Charts tab will result in a larger version of the chart being shown in a separate browser tab. This can be very useful for copying into reports or saving for other purposes. Please note that when there are a small to medium number of data points displayed, hovering over a point on the chart will show the details of the reading. Where there are a large number of data points displayed, it is best to export the chart details and view the individual readings in a CSV file using a tool such as Microsoft Excel.

- 11 -

Offices also at:




ISO9000certificated

2.5 CHARTS TAB

Figure 10: Charts Tab

The alternative Charts tab can be selected by clicking on the word Charts at the top of the main panel, and you can return to the Map tab by clicking on the word Map. The charts to be shown on the Chart tab are selected by ticking the parameter boxes in the tree view, and any number of Station/Parameters can be selected at one time. Then click on the Refresh Charts control.

Figure 11: Charts Tab Refresh Charts control

Charts auto-scale the vertical axis according to the range of values displayed by all of the charts for the same parameter. Charts scale the horizontal axis according to the date range selected at the top of the page. By changing the date range and clicking on Refresh Charts, all of the charts will zoom in a synchronised fashion to the new period for display. To quickly select all parameters in the tree view, click on the tick control, next to the Refresh Charts control. All Parameters can be turned off for display by clicking on the cross control.

- 12 -

Offices also at:




ISO9000certificated

2.6 EXPORT

Figure 12: Export Chart Data to CSV control

At the bottom of the Charts tab there is a control which exports the recorded data for all of the charts being viewed. Depending on which browser and version is being used, the user will probably be invited to save, save as, or open the resulting zip file, which will contain all of the individual CSV files of data.

Figure 13: Typical Downloaded File List

By combining the Select All feature in the Charts tab with the Date Range selection tool, it is very quick and easy to download a continuous record for any given period for all Station/Parameters, if so required. These exported CSV files are in Isodaq CSV format, and can be loaded into Microsoft Excel or other software packages for detailed examination or other processing.

- 13 -

Offices also at:




ISO9000certificated

2.7 CALCS TAB The Calcs tab is the equivalent of the Derivations feature in Hydrolog4, which allowed calculations to be carried out on one or more time series in order to produce a calculated time series, and indeed, many of the exact same functions are supported. This makes it a very powerful feature for data preparation and analysis, without needing to load the data into a spreadsheet and apply the calculations by hand. In the current version of TimeView DBi, Derivations can only be applied to produce Isodaq CSV format files, as in the Export functionality described above. Therefore additional processing or charting can be carried out in a spreadsheet if so desired. 2.7.1 Introduction to Derivations Derivation calculations are scripted, and the Station/Parameter combinations to be used are represented in the script by placeholders such as #1 (e.g. Upper Barn Rainfall) and #2 (e.g. Lower Bridge Water Level). The Station/Parameters to use are selected by the user when the script is run. Scripts are saved and therefore can be reused any number of times, for any Station/Parameter combination e.g. White Barn Rainfall, Red Bank Water Level. The general script syntax is: Result := formula e.g. Result := #1 + 1 This example would take the first time series from a Station and Parameter selected by the user, and add one to each value in the period specified, putting the output in a CSV file. e.g. Result := #1 - #2 This example would take the pairs of values at each time step for the period specified and the two Station/Parameter combinations selected by the user, and subtract the value of the second Station/Parameter at each time step from the first Station/Parameter value. Below is an imaginary case in which the original flow of a river can be estimated by removing the flow of a tributary from the river flow measured downstream of the confluence. Time #1 e.g. River Flow

(Downstream of Confluence)

#2 e.g. Stream Flow Result (River Flow before Confluence)

01:00 10 2 8 02:00 12 2.5 9.5 03:00 14 2.75 11.25 2.7.2 Use of the Derivations Interface To create and use derivation calculations the Calcs tab can be selected by clicking on the word 'Clacs' at the top of the main panel, this will present you with the main view of the Calcs tab. The Stations List box shows which station and parameter combinations will be used in the calculations. To add parameters select them in the tree view by ticking the check box and clicking

- 14 -

Offices also at:




ISO9000certificated

the arrow to the left of the Station List box. These can then be rearranged with the up and down arrows to the right of the box. To remove parameters un tick the check box and click the arrow again.

Figure 14: Calcs Tab Initial View

Selecting one of the existing calculations in the Saved Calculations box will display a preview of it in the Calculation Preview box. This will tell you the name of the calculation, how many inputs it requires, a brief description (If one was given during creation) and the calculation itself. The Time Interval Transformation option will change to Standard for multiple stations or As Source if a single station is being used. The As Source option is only available when working with a single input time series for the calculation. The output is then simply created with the same time-stamps as the input. The Standard Interval option determines a different time interval output from the calculation. For example if it is set to 30 minutes then the calculation is applied at every 30 minute time slot, regardless of whether the input time series are at 30, 15 or 5 minute intervals. The Aggregate Type option allows the user to select if the values should be averaged or totalled. This option is usually dependant on the type of data being analysed, and is not used for the As

- 15 -

Offices also at:




ISO9000certificated

Source time interval option. Finally to run a calculation click the Calculate button at the bottom of the page, your browser will then prompt you to download a .CSV file. To create new calculations and edit or delete old ones the three buttons between the Saved Calculations box and the Preview Calculations box are used.

Figure 15: New, Delete and Edit Buttons

Create a new calculation by clicking the top button, this will open the Derivation Editor panel below the main view. The new calculation must have a name that does not contain spaces or special characters, optionally a short description can also be provided. The number of inputs option is very important as this determines how many station/parameter combinations have to be provided for that calculation. It can not be a negative number and must be less then 100. The Function text box is where the user can write the calculation and can refer to the helpful information on the left for what is available to use. Only one calculation can be written in the box but it can be separated in to separate lines. Once save is clicked it will reformat your calculation to one line and store it in the list of saved calculations. Editing a calculation is exactly the same as creating a new one except the Derivation Editor panel will already have the information of the calculation entered. Delete a calculation by selecting it from the list and pressing the delete button.

- 16 -

Offices also at:




ISO9000certificated

Figure 16: Calcs Tab with Derivation Editor Showing

Calculations can also be tested during creation/editing, the Function Test panel on the right allows the user to provide a value for each input the calculation requires. To do this select the input from the list, enter a number in the box and click set value. The test button will run the calculation using the values provided and display a result.

- 17 -

Offices also at:




ISO9000certificated

2.7.3 Arithmetic Operators The following arithmetic operators are available. The table below also shows the order of calculation. Operator Definition Order of Calculation + Addition 4 - Subtraction 4 * Multiplication 3 / Division 3 ^ Power 2 () Brackets 1 An example of a function using some of these operators is shown below: e.g. Result : = (#1^2 + #2) / (#3 - 2) This example would take the power specified for the first Station/Parameter, add it to the value of the second Station Parameter, and then divide it by the result of subtracting the constant value 2 from the third Station Parameter. This would be done for every step of the time series to produce the output. 2.7.4 Conditional Operators

Three conditional operators are available: IF, ELSEIF, ELSE. The operators must be combined logically to form a simple conditional statement. e.g. IF (#1 < 2) THEN RESULT := #1 + #2^2 ELSEIF (#1 < 3) THEN RESULT := #1 + #2 ELSE THEN RESULT := #1 + #3^3 This example would return the added values of the first and second Station/Parameters if the value of the first Station Parameter is less than 2 etc. The test is made for each time step in the period selected, so the condition actually executed could be different for each one. The ELSEIF is not mandatory in a conditional statement, but it is good practice to always include an ELSE to catch cases where the other possible branches in the conditional statement are not met. Please note the need for the THEN keyword in the syntax. 2.7.5 Standard Functions

Functions are generally expressed by a keyword and then various arguments within brackets, as shown in the examples below.

- 18 -

Offices also at:




ISO9000certificated

Function Definition Example ABS Absolute value (i.e. remove negative) Result := ABS(#1) ARCTAN Arctangent Result := ARCTAN(#1) COS Cosine Result := COS(#1) DIFF The difference between two values

given as value one – value two Result := DIFF(#1, 10) if value at #1 is –2, result is -12

EXP Exponential function (e.g. EXP(2) = e2) Result := EXP(#1) FRAC Fractional component without the integer

component Result := FRAC(#1) if value at #1 is 66.666, Result is 0.666

INT Integer component Result := INT(#1) if value at #1 is 66.666, Result is 66

INTEPV An integrator calculation based on a revolving meter, comparing the previous value with the current one

HL_ME_INTEPREV if value is 0.5 & previous value is 0.6 Result = -0.1

INTENX An integrator calculation based on a revolving meter, comparing the next value with the current one

HL_ME_INTEPREV if value is 0.5 & next value is 0.6 Result = -0.1

LOOKUP Compares a value against a two-dimensional lookup table and returns the matching result. Values below the lowest in the table return the lowest result, and those above the top value return the highest result. Values that do not match exactly return a result based on linear interpolation

HL_RS_LOOKUPFN and HL_PP_U450

LN Natural logarithm Result := LN(#1) LOG Logarithm to base 10 Result := LOG(#1) NEXT Returns the time-series value following

the current one Result := NEXT(#1)

PREV Returns the time-series value preceding the current one

Result := PREV(#1)

SQR Square Result := SQR(#1) SQRT Square root Result := SQRT(#1) An example combining some functions might be: RESULT := SQRT(#1) + INT(#2)

- 19 -

Offices also at:




ISO9000certificated

2.7.6 Constants Constants differ from functions in that they must always be used before the formula itself and provide information or values that the functions will themselves use. A good example is a lookup table name that will then be used by the Lookup function to calculate the required value.

Constants Definition Example MAX The maximum value to which a circular (clock-

face) meter will read, and after which the value shown will return to the starting value. Used by the INTEPV and INTENX functions.

HL_ME_INTEPREV

TABLENAME The name of a table that will be used by the LOOKUP function. Must only be specified as a name and not including a file path or extension. The actual file extension must be either GRH or CSV and the files must be have already been loaded in order to work.

HL_RS_LOOKUPFN and

HL_PP_U450

START The starting value for a circular (clock-face) meter to which it will reset itself after reaching the maximum value. Used by the INTEPV and INTENX functions.

HL_ME_INTEPREV

An example of the use of a TABLENAME will be seen in the section on Lookup Tables, below.

- 20 -

Offices also at:




ISO9000certificated

2.7.7 Lookup Tables These are used in Derivations to estimate one value from another using a Table. They utilize the TABLENAME and LOOKUP key words, whose syntax is as follows : TABLENAME(#1) := FLOWVOL RESULT := LOOKUP(#1) The constant expression TABLENAME declares that values should be obtained from a lookup table called “FlowVol.grh”, which should have been loaded to the web site. The function LOOKUP will interpolate between values in the first column of the table to derive an estimate of the corresponding value in the second column. eg. the text in “FlowVol.grh” is shown below :

Table to define a relationship between Flow, Volume Lookup, 0, 0 0.01, 0.135 0.02, 0.191 0.03, 0.235 0.04, 0.272 0.05, 0.306 0.06, 0.336 0.07, 0.365 0.08, 0.392

If a flow of 0.02 is passed in, a volume of 0.191 is returned. If a flow of 0.045 is passed in, a volume of 0.289 is returned by linear interpolation (i.e. half way between 0.272 and 0.306). Lookup tables may be compiled by users using Notepad or another suitable text editor. Text lines before the work “Lookup” are ignored & may be used for comments. Table files should always have an extension of CSV or GRH.

- 21 -

Offices also at:




ISO9000certificated

2.8 TABLE TAB The Tables tab allows the user to upload, view and delete lookup tables that are used in derivation calculations. 2.8.1 Use of the Lookup Tables Interface The lookup table interface can be accessed by clicking the 'Table' tab. The Lookup Tables box shows all currently uploaded tables, if the user selects one than the Table Contents box will show the contents of the lookup table. This is very useful to refer to before using a calculation that uses a lookup table. To delete tables select it from the Lookup Tables box and click the delete button (a red X when the mouse is over it).

Figure 17: Table Tab View

To upload a new lookup table click the Choose File button, this will bring up a File Explorer so you can navigate to the lookup table on your machine. Once selected click the Upload button, this will upload the lookup table and add it to the list. It can now be used in derivation calculations.

- 22 -

Offices also at:




ISO9000certificated

3. PERFORMANCE

3.1 INTERNET TimeView DBi is hosted on the internet and accessed via a Web Browser, so performance of display, upload and download will be subject to the local area network and ISP performance levels.

3.2 LOCAL PLATFORM TimeView DBI uses client scripting to reduce round trips to the server and optimise performance. The capabilities of the local PC or Laptop being used may therefore have an effect on the speed.

3.3 SERVER TimeView DBi is normally hosted on shared servers or the Cloud. While everything has been done to obtain optimum performance, this does mean that the application is subject to the service levels of the hosting providers. Extensive load testing has indicated that performance is very appropriate under normal circumstances, however upgrades to dedicated servers or running TimeView DBi locally on client infrastructure are cost options which we are happy to discuss.

timeview dbi user guide - isodaq.co.uk · user level timeview timeview dbi 1. user (default) view...

Documents