m2m data - web interface - omni instruments

M2M Data - Web Interface User’s Manual Revision 2 - Apr 2016

1

M2M Data - Web Interface User Manual - Rev 2 – Apr 2016

Tel: +44 845 9000 601 Fax: +44 845 9000 602 [email protected] www.omniinstruments.co.uk

Contents Overview and Design Concepts ........................................................................................................................................ 2

Getting Started ................................................................................................................................................................. 4

Control Items .................................................................................................................................................................... 6

Display Panels ................................................................................................................................................................... 7

Data Pages ........................................................................................................................................................................ 8

Data Points.................................................................................................................................................................... 9

Alarms ......................................................................................................................................................................... 12

Reports ....................................................................................................................................................................... 13

DGLUX ......................................................................................................................................................................... 16

Watch List ................................................................................................................................................................... 16

Graphical Views .......................................................................................................................................................... 18

Excel Reports .............................................................................................................................................................. 23

Help ............................................................................................................................................................................. 28

2



Overview and Design Concepts

M2M System Overview Our M2M system uses various data loggers that report either directly to the web server or to an intermediary server that mainly performs SMS functions before passing the data to the web server. The web server uses several databases to manage the data along with a third party web application called Mango Automation. Mango Automation is licensed for our use from Infinite Automation Systems Inc. Once the data has been collected and scaled on the web server, the data is then displayed in several formats such as a graphical display, charts and statistical details. The users can log into the web site from any location and view or download the available data as required. The M2M system can be configured to provide alarms via email or SMS. Also available from the M2M system are many different kinds of reports that can be schedule on a recurring basis or only run when a user requests the data. The reports can also be emailed to anyone that needs to get the data.

Navigation Overview Functionality in this application is primarily accessed using the controls in the header. Depending on the permissions granted to your user account, you will see various icons underneath the application logo. When you hover over these icons with your mouse, you will see an overlay message with a short description of what the icon is for. Beside the header controls, at the right-hand side of the header, is the username of the user who is currently logged in, with buttons to define that user's home page and to log out.

Data Sources

Data Sources are fundamental to the operation of this application. A Data Source is a "place" from which data is

received. Virtually anything can be a Data Source, insofar as the communications protocol is supported by the application. Here are some examples:

1. If you have a Modbus network accessible via RS232, RS485, TCP/IP, or UDP/IP, you can create a Modbus Data Source that will poll the network for data on an interval you can define.

2. If you have equipment or an application that can send data over HTTP you can start an HTTP Receiver Data Source that will listen for incoming connections and route the data to the appropriate points.

3. For hardware that supports SNMP, start an SNMP Data Source. Values can be polled on an interval schedule, or traps can be received for report-on-exception.

4. Data can be read and updated in a SQL data base external to the system.

5. Data can be generated either randomly or predictively using a Virtual Data Source.

Data values that are received or collected by a Data Source are stored within Data Points. Every Data Source has a contextual help button that explains the properties necessary to configure the Data Source, as well as general descriptions and any caveats.

Data Points

A Data Point is a collection of associated historical values. For example, a particular point might be a temperature

reading from a room, while another point could be the humidity reading from the same room. Points can also be control values, such as a switch to turn a piece of equipment on or off. There are many attributes that are used to control the behaviour of points, but can be separated into two groups. First,

there is the concept of a Point Locator. Locators are used by Data Source to determine how to "find" the data for the

particular point. For instance, the Point Locator of an SQL Data Point indicates the table and field names with which to find its specific value from the query. Second, Data Point attributes also determine many other aspects of the point, such as its name; how/when it should be logged into the database, how long to keep logged data, how to render values for display, and how to chart values. These attributes are common to all Data Points, although a particular data type may or may not have them all.

You can also configure Data Points with Event Detectors, which are used to detect conditions of interest in points'

values, such as the value being too high/low for too long, changing too often, not changing at often enough, etc.

3



Data Types There are five supported data types:

1. Binary values have only two states, referred to in the system as the zero value and the one value. You can use a

Text Renderer to convert the display of binary values to whatever alternate labels you need, such as "on/off", "high/low", "started/stopped", etc.

2. Multistate values have multiple distinct states. Values are primitively represented as integers (e.g. 0, 1, 2, 7, ...),

but also have Text Renderer options to convert these values to appropriate textual representations such as "on/off/disabled", "cool/heat/off", or anything else.

3. Numeric values are decimal values represented in the system with a floating point variable. Temperature,

humidity, price, and altitude are examples of numeric values. Text Renderers can be used to determine display features like how many decimals places to display, whether to separate thousands (with commas or dots), and

whether a suffix should be displayed (e.g. °F, kW/h, moles, etc.). The "Range" type of Text Renderer can be

used to convert ranges of numeric values into text labels.

4. Alphanumeric values are simply strings of characters, such as the O/S description of an SNMP source.

5. Image values are binary representations of image data. They are stored in files on the host file system (i.e. not in

the database) and are cached in memory as necessary for performance purposes. Renderers can be used to create scaled images - such as thumbnails - for presentation.

Monitoring

Monitoring of points within the system can be done in a few ways. You can use the Watch List to dynamically create

tabular lists of points including their values, last update times, and charts of historical information (if the point is configured to support this). Values and charts are updated in real time without having to refresh your browser window. Charts of multiple points can also be displayed on demand.

You can also create Graphical Views of points using drag and drop functionality to position graphical representations of

points on an arbitrary background image. Animated images can be used to create highly dynamic visualization of system behaviour, and, like the watch lists, values are updated in real time without a browser refresh. These views can subsequently be marked as "public" to be reused on public web sites.

Automatic monitoring is possible through the script engines in both the Meta Data Source and Scripting Data

Source setting values to a point with Event Detectors for the conditions being watched for, as with creating a Multistate

Meta Data Point with configured Event Detectors and Event Handlers. As the M2M system is fundamentally modular and largely open source, automatic monitoring of every aspect is available to be encoded.

Control

Control of external systems can is achieved through points which are "settable" (aka writable or output). A settable point

can be set to a user-defined value, such as a thermostat setting or equipment control switch. Both watch lists and graphical views provide simple means by which to input a value to set. The Point Locator for a settable point determines how the Data Source sets the value within the external equipment.

You can also use the Scripting Data Source to write control logic to automatically write values to any settable point.

Events

An Event is the occurrence of a defined condition within the system. Both system-defined and user-defined events are

available. System-defined events include Data Source operation errors, user logins, and system start up / shutdown. User-defined events include Point Event Detectors (see "Event Detectors" above), and events defined in modules. There are also "audit events", which are raised when users make changes (additions, modifications, deletions) to runtime-affecting objects including Data Sources, Data Points, Point Event Detectors, Event Handlers, and many events defined by modules.

Once an Event has been detected, it is acted upon by handlers. An Event Handler is a user-defined behaviour that is to

be performed upon the raising of a particular event, such as sending an email or setting the value of a settable point.

An Alarm is an Event with an alarm level. When your application has (an) unacknowledged alarm(s), you will see a flag

icon ( ) and an associated description (or count) near the centre of the header area. The colour of the icon(s) will indicate the severity of the alarm(s).

4



The levels of alarm are:

1. Information

2. Urgent

3. Critical

4. Life safety

You can click on the icon or the description to go to the list of active alarms.

Graphic Dashboards The M2M service has three modules for creating graphic representations of your data:

1. Graphic Views offers a simple way to use images, graphics and animations to create dashboards and HMIs.

With drag and drop simplicity, you quickly get your page online.

2. JSP Pages allow you to write custom JSP pages using HTML and JavaScript that use your real time and

historical data. This allows for complete customization of dashboards, mobile apps, HMIs and GUIs.

3. DGLux is a powerful drag and drop dashboard building tool like no other. DGLux provides dynamic, high-end

graphic web pages and GUI's that impress and excite user involvement. This powerful tool is included and you

can find further information at http://infiniteautomation.com/index.php/software/dglux.

Getting Started Data from the GRD GPRS and ERD Ethernet units can be viewed on the M2M web interface in chart, table and graphical format. The data can a lso be downloaded as a CSV file. The web interface provides a data panel where customers can view a customised web interface showing data from all their remote locations. The channel scaling, reports, alarm levels, and alarm recipients are set from our web control page removing the need to dial up units or visit sites for reprogramming. Go to the site at: http://31.193.131.54:8080/login.htm (a domain name is scheduled on future updates) and log in with the username and password you have been given.

The log in page will indicate if the browser version is supported or not. Most browsers will work but some will work better than others. It is recommended that you add this address to your trusted sites and any ad blocking / anti-spyware / anti-virus software that you use.

http://infiniteautomation.com/index.php/software/dglux

http://31.193.131.54:8080/login.htm

5



On first logging in to the site you will see a graphical display showing the data from your remote units. The graphical display can be customised to your specification with different backgrounds, gauges, text effects and more.

The display will automatically adjust itself to the size of the browser. However with a smaller window some of the display items will begin to overlap as shown below.

If this happens to your display, expand the browser window until all the display items are clearly visible. You may need to adjust the screen resolution.

6



This graphical data display has many features within itself. The features and clickable items are listed here:

Control Items The Control Items will show the user currently logged into the web site (scored out for this manual), the log out button, the audio control icon and the home page icon.

The speaker icon will mute and unmute the audible alarms. Audible alarms will depend on alarm settings and sound device in the PC / tablet that is viewing the display. The home page icon will take you back to the graphics display page. The home will also give you the opportunity to

“Delete my default page” or “Make this my default page”. If you delete your default page, the default page that will

appear when you log in will be the help page. To restore the graphical display as your default page, navigate to this address: http://31.193.131.54:8080/views.shtm?&showHeader=false&showFooter=false&showControls=false

and click the icon with the chain to “Make this my default page”.

Data Pages Control Items

Display Panels

Delete my default page Make this my default page

7



Display Panels The display panels are bespoke configurations and will show a combination of graphical images representing the data as well as a text display and graphs to provide the latest readings from the data logger. There are also other options such as a calendar showing the current date and a live 5 day forecast display for the selected area.

Some data displays may be built with individual panels, an example is shown below.

8



In each of these individual panels a title bar is shown with the data channel name. When the mouse pointer hovers over the title bar for each panel several small icons will be visible.

1. Menu – Does not perform any function, it just denotes that the menu has appeared.

2. Collapse – will collapse / minimise the data panel

3. Maximise – will force the data panel to take the full screen

4. Close – will close the data panel

Once either of the Collapse or Maximise functions is triggered, a restore function becomes available. The icons or will be seen depending on the function first triggered. Hovering over the icon will display its intended function. Please be aware that using any of these functions will change the layout of the screen. To return to the initial display, refresh the page from the browser’s refresh function.

Data Pages The data pages are accessible from the icons shown above the graphical display.

Alarms

DGLUX Module

Watch Lists

Graphical Displays

Reports

Help

Menu

Collapse

Maximise

Close

Data Points

Excel Reports

9



Data Points The Data Points page shows details of the data from each channel of the data logger. The details include the latest reading details, statistics and recent history over a selectable time period. The page also shows a graph with the ability to select the time period displayed as well as the ability to download the historical data to CSV or Excel formats. This page will also display recent alarms and the users that have access to the data point. Important Note: All the data loggers will be set to GMT time and not adjust for daylight savings time. The data displayed and downloaded will also be set to GMT time

You can also add notes to the data points by clicking the icon next to “User notes” in the upper right corner of the page.

Be aware that notes added here cannot be removed by the user.

The different sections of the data point page are: 1. General Section 2. Statistical Section 3. Real-Time History Section 4. Date / Time Controls Section 5. History Chart / Download Section 6. Events Section 7. User Access Section

General Section

Statistical Section

Real-Time History Section

History Chart / Download Section

Events Section

Date / Time Controls

User Access Section

10



General Section The General Section as the name suggests will provide the general information such as Channel name Data Source name. The latest reading will be displayed along with the time stamp of the latest reading. There is a refresh icon that can be clicked to refresh the reading to the latest if the display has become stuck.

You can also move to another data point by choosing the available data points (channels) from the drop down list in the upper part of the real time history section. There are also arrow icons to move to previous and next data point.

Be aware that you cannot edit the data point or its data source. When either of the edit icons are clicked you will get a permission denied message. This is done to prevent damage to the data logging system.

Statistical Section The Statistical Section provides a display of several statistics regarding the channel data. The statistical period is set using the time controls in the upper left corner of this section.

Real-Time History Section The Real-Time History Section shows the most recent readings from the data logging channel. You can choose how many recent records to display.

Refresh

Data Point List

11



History Chart / Download Section Just under the Real-Time History Section you will find the section for the charts and downloads. This section gives the ability to chart and download historical data according to the date and time range chosen. The

default chart view will be the last hours’ worth of readings.

Set the date and time range for specific time periods and the chart will automatically update. You can save the graph as an image by using the right click options. This section allows you to download the displayed data as a CSV file or Excel file for local storage and use in spread sheet analysis. It is highly recommended that your data is downloaded and stored locally for your use. The online system is set to purge the data from the web servers semi-annually.

Events Section This section will list any alarms or events that have taken place for this channel.

User Access Section This section will list that have access to this data point as well as the access type.

Download

12



Alarms The Alarms page will provide details of any active alarms and give the ability to search for previous alarms. You will be able to acknowledge the alarms and see the duration of the alarms as well as which user has acknowledged the alarms.

Functions:

1. Help - The help icon on this page provides very good information regarding the functions on the alarms page.

2. Legacy Alarms Page – opens a page for searching the alarms in an older style and is not needed on this system.

3. Column Headings – Alarms are searchable by various identifiers. Either start typing or choosing the desired

information to view the required alarms.

4. Sort – The word does not appear to be clickable but will change the sorting direction of the alarms listed when

clicked.

5. Date picker – Select the data range of the alarms you wish to search and also clear the date range if required.

6. Acknowledge – allows you to acknowledge all the alarms in the view or to acknowledge individual alarms.

a. The image above shows an unacknowledged alarm as well as an acknowledged alarm with the details of which user acknowledged the alarm and when.

b. Click the green arrow to acknowledge the alarm. Acknowledging an alarm automatically silences the alarm.

c. You cannot un-acknowledge an alarm.

7. Silence – allows you to silence all the alarms in the view or to silence individual alarms.

a. The image below shows an alarm that has been silenced as well an alarm that has not been silenced.

b. Click the speaker icon to silence or un-silence an alarm.

8. Export – Clicking either the word or the down arrow will export the alarm data to a spreadsheet.

9. Status – this column will indicate if an alarm is active or if it has been returned to normal as well as the time the

alarm had returned to normal condition.

10. Add Comment – comments can be added to individual alarms. Please be aware that comments added cannot be

removed.

Help Legacy Alarms Page

Column Headings

Sort

Date Picker

Acknowledge

Acknowledged

Silence

Acknowledge

Silence / Un-silence

Export

Add Comment

13



Reports The Reports page allows you to create, schedule and send customised reports from the M2M system. You can regularly send the historical data or other system information to one or more email addresses. The page will show the Report queue which is a list of reports that have previously run and any reports currently running. The page also shows a list of Report Templates that have been created and saved.

Functions:

1. Help – The help icons on this page provides very good information regarding the functions on the reports page.

2. Do Not Purge – this tick mark will allow a report that has been run in the past to be saved until manually deleted.

When creating a report template (discussed later in this guide) there are options to purge the reports after a set period of time. It is recommended that reports be set to purge no later than 6 months to avoid an excess amount of report data being stored on the web server.

3. Export Data – allows the report data to be downloaded directly and opened in a spread sheet.

a. Note: The time displayed on the report may initially show only minutes and seconds in the time stamp

data cell, as shown in the image below. Notice though that the function bar shows the full date and time.

b. Reformatting the time column to display dd/mm/yyy hh:mm will show the actual date and time of the readings in the data cells.

4. Export Events – If events are included in the report this icon allows the events to be downloaded directly.

5. Export User Comments – if comments are included in the report this icon allows the comments to be

downloaded directly.

Help

Do Not Purge

Export Data

Export Events Refresh

View Charts

Export User Comments

Report Icon

Report Link

Delete Report

New Report

14



6. View Charts – this icon opens a new web page displaying the chart data from the report.

7. Delete Report – manually deletes the report from the report queue.

8. Report Icon / Report Link – both of these functions will open the report page that allows the report to be edited or

instantly run outside of its scheduled time.

a. This opens a new section called Report Criteria.

15



9. New Report – allows the creation of new reports.

a. This opens a new section called Report Criteria.

Report Criteria

Editing report template details The Report Name is used to visually reference the template. It is recommended that a unique name be used for each report, but it is not required. Use the Points list to select the points to include in the report. To add a point, select it from the list and click point name. To delete an existing point, click the delete icon associated with the point. Map Key values are used in custom templates to allow the point statistic object to be used in the template. Colour values can be an HTML-style hex, or any colour name in the HTML specification. For example, "#2468AC", "red", and "dodgerblue" are all valid values. These colours are used in the chart details of the report. Weight represents the weight of the chart stroke, or the width of the line. The value must be greater than 0. Consolidated chart determines if the point will appear on the report's consolidated chart or not. Check the box to have it appear. The Date range is used to determine what values to select for the report. The range can be relative or absolute. In most cases a relative range is appropriate. Relative date ranges can be either based upon "previous" data or "past" data. A past range includes the given time period ending now. A previous range also includes the given time period, but its end time is quantised to correspond to the period type. For example, if the period type is "Hour(s)" and number of periods is 1, and the report runs at 18:05, the time span that will be used is from 17:00 (inclusive) to 18:00 (exclusive). If the number of periods were, say, 3, the time span would be from 15:00 to 18:00. Similarly, "Month(s)" starts the time span at midnight on the first day of the previous month and ends it on the last day of the previous month (when the number of periods is 1). Other period types work the same. A week starts on Monday at midnight in accordance with ISO standards.

Delete Report

Run Now

Save

Copy

Delete

Add Delete Test

16



Report scheduling Reports can be scheduled to run automatically. Use the Run every... selection to determine a simple time event upon which it should run, or define a Cron pattern for more specific control. (See the "Cron patterns" help documentation for more information.) Time events occur at the beginning of the given period. Weeks start on Monday in accordance with ISO standards. A Run delay can be applied if data expected on the report tends to be collected later than the absolute run time. Scheduled reports for disabled users do not run.

Report emailing Although reports cannot be explicitly shared with the system, they can be implicitly shared by creating a mailing list to which to send the generated report instance. The content of the email is the same as the "report chart" window opened from within the Report queue panel. To include the CSV export file with the email, check the Include tabular data box. Some email systems may not allow the chart images to be included in the report. Select the Email recipients to which to send the report email. Recipients can be mailing lists, system users, or free-form email addresses. Click the test icon to send a test message to the selected recipients. Important: Report instances that are emailed and run on a schedule are automatically deleted immediately after being sent.

DGLUX The DGLUX module is the module that allows the supplier to build customised graphical displays. The module may only show a blank screen as it is not used directly by the end user. The graphical display has been imported into the main M2M pages as described earlier in this guide. Access to this module must remain however to allow the main graphic display to function.

Watch List The Watch List page gives the ability to see several data points simultaneously to give an overall system picture. This page also provides a consolidated chart that can have several data points charted simultaneously for data comparison.

Points Help Watch List

Consolidated Chart

Watch List Controls

Date picker and download controls

17



Functions:

1. Help – all the question mark icons on this page refer to the Watch List help files and provide very good

information on the use of watch lists and the associated graph.

2. Points – this section provides the list of available data points.

a. The image above shows “tree” view.

b. There is also a “look up” view to provide a search function.

c. This section allows the selection of the data points to be added to the watch list.

i. Data points with grey arrows to the right of the name are already added to the current watch list.

ii. Data points with green arrows are available to be added to the current watch list.

3. Watch List – This section lists all of the data points that have been added to the current watch list. There are

several functions contained within this section.

a. Recent Trend – Hovering over the trend icon to the left of the data point name will display a small chart

showing very recent trend data for that channel.

b. Filter By user – when creating several watch lists you can assign specific user permissions. This control

gives a drop down list of users that have access to these watch lists.

c. Watch List name – is a drop down list of all the drop lists that is available to view.

d. Value – most recent data point value.

e. Time – time of the most recent value.

f. Include – tick to include this data in the consolidated chart.

g. Point Details – will take you back to the point details page.

h. Move Up / Down – click these small arrows to rearrange points in the watch list.

i. Delete from list – click this to remove the data point from this watch list. Will not delete the data point

from the system, only this watch list.

j. Name – will allow the editing of the watch list name

Trend Icon

Filter

Watch List Name

Value

Time

Include Point Details

Move Up / Down

Delete from list

Name

Permissions

Toggle

Copy

Add

Report

Export

Delete

18



k. Permissions – will allow users to be added or removed from permission to see the watch list. Be careful

not to remove everyone.

l. Toggle – will toggle all data points in the watch list onto or off of the consolidated chart

m. Copy – allows you to copy the watch list and create a duplicate available for editing.

n. Add – allows you to create a new watch list.

o. Delete – allows you to delete the watch list. This does not affect the data points, only this list.

p. Report – This function is not available due to system variations. To create reports use the Excel reports

module described later in this guide.

q. Export – creates a script code to export this watch list to another M2M data server.

4. Consolidated chart –This chart will show the data from several data points as selected from include tick box in

the controls portion.

5. Date picker and download controls – Set the date and time range for specific time periods or chose the

“Inception” tick box to set the start time to the very first historical record on file and choose the “Latest” tick box

to set the stop time to the latest record. Once the time period is set, click the “Get Chart” icon to display the

charted data. You can set your download type as either “Excel” or “CSV” and then click the “Download Chart

Data” icon to get the data in the requested format.

6. Help – The Help icon will give some helpful information about using the watchlist charts.

It is highly recommended that your data is downloaded and stored locally for your use. The online system is set to purge the data from the web servers semi-annually.

Graphical Views The Graphical Views button will return the page to opening graphical view without the address tags that would hide the Header, Footer and Control buttons.

Date picker and download controls

Help

Controls

Header

19



The M2M site has 2 types of graphical displays. The primary graphical format is using a 3rd party application that is linked to the M2M site called DGLUX. The DGLUX display can only be built by the supplier. It has many functions to provide a very powerful bespoke graphical display. The secondary graphical display is native to the M2M site. The secondary display can be fully used by the customer to create simple graphical displays. Graphical Views Controls

Functions:

1. Help – the question mark icon on this page refer to the Graphical Views help files and provide very good

information on the use and editing of graphical views.

2. View List – is a drop down list of all graphical views you have permission to read or edit.

3. Edit View – allows you to edit the currently selected graphical view. This will not appear unless you have

permission to edit the view.

4. Copy View – allows you to copy the graphical view. If you do not have permission to edit the view then a

“Permission Denied” message will be displayed.

5. New View – takes you to the view edit page and allows you to create a simple graphical view.

Help View List

Copy View

New View

Edit View

View Properties

View Permissions

View Components

20



View Properties All graphical views have a name by which they are referred within lists of graphical views. This name should, but is not required to, be unique. The Anonymous access attribute determines whether users who have not logged in may access the view.

1. Edit means that anonymous users can set the values of settable points in the view.

2. Read means that anonymous users can access the view, but not set point values.

3. None means that anonymous users may not access the view.

A view may optionally have a Background image upon which its components are superimposed. Users can use any type of image displayable within a browser for the background image, including GIF, JPEG, and PNG. Permissions Views may be shared with other users by allowing either Read or Edit level permission. Enter user group names as a comma delimited list into either section.

1. Read - this permission allows users in these groups to view your list

2. Edit - this permission allows users in these groups to view and edit your list

View Components

View components can be added to a view by selecting the type of component from the list, and clicking the icon.

New components default to being displayed in the centre of the view, but can be repositioned by dragging and dropping them anywhere within the bounds of the background. Note that point views can overlap one another. During view editing, components are written in the order in which they are defined. This may affect how components will overlay each, when overlap occurs.

Static content

Select the HTML component type to add static content. By default the icon represents the content. (This icon will be used whenever no content is defined.) Since these components are independent of the values of points, they are rendered once at the load of the view and remain unchanged from then on. Drag the element to the required location. To edit, hover over the content to expose the editing controls. Different component types will have different controls. Hovering over the control icon will show the name of its function.

21



To change the content, click the ( ) icon and enter any valid html. The content will be written verbatim into the view, so any valid HTML (including JavaScript content) can be used. Style classes from CSS files can be referenced, or styles can be defined directly. For example, to add a label the following could be used: <span style="background-color:yellow;font-size:25px;font-weight:bold;border:2px solid orange;">My label</span> This would result in the following: My label Static content can also reference content on other servers. For example, external images can be placed on your views: <img src="http://bluebrain.epfl.ch/webdav/site/bluebrain/shared/21june_06_singleNeuron_200.jpg"/> This would display:

Point components All other component types in the component list depend on one or more points for their rendering. Once a component

has been added to the view, its default representation is the generic point icon ( ). This will be the case until the component has enough information to properly render. Required information depends upon the component type. The view editing page behaves similar to the view page in that the current value of the point is displayed and updated so that users can see exactly how the point will appear on the view.

Point component rendering The rendering of a point component can be changed by hovering over the component to display the editing controls.

The controls shown in the view editing page differ from those in the view page except for the information control ( ), which displays the current value and last change time for the point.

Attributes of the point view can be set by clicking on the point view edit icon ( ). When clicked, an editing panel will be displayed that allows attributes of the point to be overridden within the context of the graphical view. For example, if a point is normally settable, it can be altered so that it is not settable within the view (although non-settable points cannot be made settable). This panel is also where the point or points that back the component can be set. Only points with a data type appropriate to the component will be presented in the point list.

The graphical rendering of a component can be changed by clicking on the graphical rendering icon ( ). When clicked, a panel will be displayed allowing the rendering attributes of the component to be edited.

22



For example:

1. The Analog graphic component can be used to visually quantize a numeric point. Using the Min and Max values,

the images are uniformly distributed over the numeric range and displayed appropriately.

2. A Binary Image graphical renderer applies only to binary points, and allows the one of two images to be

displayed depending upon the current value of the point. Animated images are supported, so animations can be used to visually indicate when a piece of equipment as running vs. when it is not.

3. The textual representation of a point can also be displayed over the images by selecting the Display Text option.

4. A Simple point displays only the textual representation of the point.

5. The Dynamic graphic component is similar to the analogue image renderer in that it can visualize a numeric point, but instead of choosing one out of a set of images it dynamically draws the indicator of the value. For example, the pointer can be drawn on a single dial image. To add a new dynamic renderer, add a new subdirectory to the graphics directory and put the static image and an appropriate info file there. Then, add a rendering function to the resources/view.js file. The function must be named according to the name given to the subdirectory. See the Dial graphic as an example.

6. A Server-side script component can be used to define your own rendering logic.

The scripting language used here is JavaScript, also known as ECMAScript. There are, however, no "window" or "document" objects available since the script is evaluated on the server rather than the browser. Instead, the current value of the point is available via the value var, and the timestamp of the sample is given in the time var.

In addition pointComponent and point vars are also defined, with analogous values, and "htmlText" and "renderedText" represent rendered versions of the value.

Finally, "events" provides a list of active events for the point, and "hasUnacknowledgedEvent" is a Boolean value indicating whether at least one of the active events is not acknowledged.Any value can be returned from the script, but it will be written verbatim to the point view content, so valid HTML is the most useful.

Script content (in <script> tags) can also be included, and will be detected and executed in the browser.

For example, the following will conditionally display a blinking message when the binary point has the value "1" (translated to "true" for the script):

if (value)

return '<blink><span style="background-color:orange;font-size:15px;font-weight:bold;">Warning: point is ON</span></blink>';

return "";

Note that, on the editing page, if a script returns no content, the icon will be displayed so that the controls can still be exposed upon hover.

The timestamp of the sample is provided in milliseconds since Jan 1, 1970. It can be converted to an ECMA Date object with the following code:

var d = new Date();

d.setTime(time);

The Date object "d" can then be used as necessary in remainder of the script.

Point views can be deleted by clicking the delete point view icon , which is exposed on hover.

Saving graphical views All changes to graphical views are saved only when the Save button is clicked. If incorrect changes have been made to a view, they may be aborted by clicking the Cancel button. To delete the entire view, click the Delete button.

23



Excel Reports Excel Reports use templated Excel files to fill in areas linked to data points and date ranges. The following paragraphs will explain how to setup an Excel file for use in the Excel Reports module. After the file is uploaded to the server, M2M will extract the necessary information and provide a way to link the ranges to data points and date ranges.

Creating Excel Templates

Named Ranges Named ranges are a way to link a cell or group of cells to a name. This module supports named ranges that are individual cells, column groups or row groups. M2M data can only be filled in horizontally or vertically. To create a named range simply select the cells desired and enter a name into the 'Name box' at the left end of the formula bar. When configuring a template in M2M all named ranges will be available to link to a data point. M2M can insert various types of data into an Excel named range. Some are single cell while others require a column or row.

Single Cell Data

Single cell data can be assigned into cells by creating a named range with a .{data_name} postfix. For example to insert the XID for a data point one would use the named rangevoltage.xid. Then via the M2M template configuration page one can link a data point to a named range of voltage. This will allow any named range that starts with voltage prefix to be filled in the available single cell data. The following are lists of available single cell data: For any point:

xid - The XID of the linked point name - The name of the linked point deviceName - the device name of the linked point

For Numeric Points:

firstValue - The first value of the time period firstTime - The date of the first value of the time period lastValue - The last value of the time period lastTime - The date of the last value of the time period minimumValue - The statistical minimum value of the time period minimumTime - The date of the statistical minimum value of the time period maximumValue - The statistical maximum value of the time period maximumTime - The date of the statistical maximum value of the time period average - The statistical average value of the time period integral - The statistical integral value of the time period sum - The statistical sum of the time period count - The count of samples within the time period delta - The statistical delta of the values in the time period

For Binary and Multistate Points: Note that there is also a Multiple Cell area for the Starts and Runtimes list.

firstValue - The first value of the time period firstTime - The date of the first value of the time period

24



lastValue - The last value of the time period lastTime - The date of the last value of the time period count - The count of samples within the time period

For Alphanumeric Points:

firstValue - The first value of the time period firstTime - The date of the first value of the time period lastValue - The last value of the time period lastTime - The date of the last value of the time period count - The count of samples within the time period changes - The number of changes within the time period

Multiple Cell Data

Multiple cell data can be assigned into cells by creating a named range of multiple cells in a column or row. M2M will overwrite any data in the range and also expand the range to fit the report data. This means that no cells below a column range or to the right of a row range should be used in your template as they may be overwritten. M2M will copy the cell style when it fills down. Point Timestamps The point timestamps can optionally be written into a named range. Point timestamp named range should be group of cells in a column or row. The named range is assigned to a Time Series on the template configuration page Point Values Point values can optionally be assigned to a column or row named range. Binary and Multistate Points A table of starts and runtimes can be filled in for these points, the available ranges are:

starts - The number of times this state happened in the period runtime - The total duration of this state in the period proportion - The proportion to the total time that was spent in this state startsAndRuntimeValue - The value of the state

Referenced Formula Expansion M2M will search for and expand any ranges that contain formulas that reference ranges that are assigned to the template.

Hints Use named ranges whenever possible. This will ensure that any references are retained when the data in inserted and the range expands or retracts. For example the following formula $A$3*$B$4 can be expressed by a_range*b_range. It is also recommended to use named ranges for Chart data and time ranges.

25



Excel Report Templates The Report templates tab provides the definition of how to create report instances.

Add a new report template, click the icon. To edit an existing template, click the template's row in the "Report templates" table. The table is sortable by name and owner. A template Owner is the user who created the template.

Copy a report by clicking the icon. This will load in the settings from the previous template and allow you to save the new copy. The copy must be saved before it becomes a new template.

Delete a report by clicking the icon.

Run a report by clicking the icon. This will immediately schedule a new report. The status of the new report will be shown in the Finished / in-progress reports table. The report will be run in the background and when finished be available for viewing.

Run a report with specific dates and override its date settings by clicking the icon. This will pop up a window to enter date ranges prior to scheduling the new report. The status of the new report will be shown in the Finished / in-progress reports table.

Report Setup Report templates provide the definition of how to create report instances. Templates are used hold all the settings for generating a report. The only variation on this is when a report is run from the page where dates and rollups can be set when it is run.

Report Name

The template's name is used to visually reference the template. It is recommended that a unique name be used for each report, but it is not required. The report template's name will be used as the name for all generated reports.

Export ID (XID) It is recommended that the Report Name be copied into this field.

26



Template This is the Excel file that will be used to determine the available named ranges that will be filled in with data by M2M.

Prevent purge

Tick this setting to prevent any generated reports from being purged.

Edit permission This is a list of user groups that define which users can edit this template from the users available under the current log in credentials.

Report read permission This is a list of user groups that define who can view any generated reports from the users available under the current log in credentials.

Time Periods Time periods are groups of points linked to time ranges and rollups. Each time range will generate statistics and extract point values over this time range using the rollup (if provided). Name

Each time period is given a name to help identify it on the Run now popup. Time Period

This is used to determine what values to select for the report. The range can be relative or absolute. In most cases a relative range is appropriate. Relative date ranges can be either based upon "previous" data or "past" data.

1. Past range includes the given time period ending now. For example: a report that will run at 1300 and is set to “Past”, “1” and “Days”, will show the

data from 1300 the day before the report ran up to and excluding 1300 on the day the report ran.

2. Previous range also includes the given time period, but its end time is quantized to correspond to the period type.

For example, if the period type is "Hour(s)" and number of periods is 1, and the report runs at 18:05, the time span that will be used is from 17:00 (inclusive) to 18:00 (exclusive).

If the number of periods were, 3, the time span would be from 15:00 to 18:00. Similarly, "Month(s)" starts the time span at midnight on the first day of the previous month and ends it on the last day of the previous month (when set to 1). Other period types work the same. A week starts on Monday at midnight (00:00) in accordance with ISO standards.

3. Current range quantizes the time to the start of the selected period type until the moment the report is run.

4. Ago range quantizes the time to the start of the selected period which is that many periods ago and quantizes the time to the end of that period. So for example you can query on the entire month that was 2 months ago, so if today is in January 2 months ago would be the entire month of November last year.

Rollup This is a way to group point data into discrete intervals. This is useful for many purposes including reducing the amount of data that the report will generate

Location for time values

This is the named range into which the timestamps will be placed. This range must be a group of contiguous cells (i.e. part of a column or row). M2M will expand or reduce this named range to fit all the data for the report.

27



Add a point When you add a point the point will appear in the table for that time range. (If Add to all time periods is

checked the point will end up in all created time periods). After adding the point the named range must be set. This range must be a contiguous set of cells (i.e. part of a row or column). It is worth noting that additional ranges can be created based on the assigned range. For example assigning the range: 'last_month_voltage' to a point in a Time Series will make the statistics for that point available in any ranges defined like 'last_month_voltage.average' or 'last_month_voltage.sum' See the Excel Template File setup help for more information.

Schedule Reports can be scheduled to run automatically. The Schedule uses Cron expressions. Cron (Command Run On) is a time-based job scheduler in Unix-like computer operating systems. Cron jobs are used to schedule jobs (commands or shell scripts) to run periodically at fixed times, dates, or intervals. Enter a custom Cron expression or use the Cron builder tool to generate the appropriate pattern. Scheduled reports for disabled users do not run. The default setting for the Cron expression is to run the first day of each month at 00 hours, 00 minutes and 0 seconds otherwise shown as 00:00.00. You cannot choose “Don’t care” for both the “Day of the Month” and the “Day of The Week” setting. Changing either of the “Day” settings will force a change in the other “Day” setting.

Email Reports can be emailed and will contain the generated Excel file (optionally compressed). Select the Email recipients to which to send the report email. Recipients can be mailing lists, system users, or free-form email addresses.

Finished /In-Progress Reports The finished report list is a sortable list of all reports that have been run. The table is colour coded based on the state of the report. Clicking a row in the table will select the report, to select multiple rows use the shift or control keys while clicking rows. The Delete all failed button will remove all failed reports from the system. The Delete selected button will delete any selected reports. List of report instances:

Export ID (XID) - is the export id for the report Report Name - is the name of the report and will be the same as the Template Name State - will be one of Running, Finished, Failed, Email Failed, or Queued. Owner - the user who generated the report Run time start - the time at which the report was run Duration - the total time it took to run the report Prevent purge - a settable checkbox that when set will prevent the report from being purged. Report read permission - the permissions for users who can view the report

- downloads the report

- views the report in HTML

- deletes the report instance

28



Help M2M Data is a powerful data logging and display tool for a wide variety of applications. The web site software is an application package called Mango Automation and is sourced from Infinite Automation Systems Inc. Working in conjunction with our suppliers, it's our aim to make sure you get the help you need as fast as possible. There are several options for you to learn about Mango and a few things you can do if you run into trouble.

First Line Support If you need one-on-one or immediate support, please can contact us directly with any questions regarding the M2M Data

system and its associated data loggers. Contact us through our website: http://www.omniinstruments.co.uk, email:

[email protected] or call (+44) 845 9000 601.

Mango Wiki See the suppliers Wiki for a step by step walk through and tutorials.

Access the Wiki here: http://infiniteautomation.com/wiki/doku.php?id=gettingstarted

Mango Contextual Help

Helpful details can be found throughout the application using contextual help, indicated by the help icon . Click on this icon wherever it appears to get more information on the feature you are using.

Online Support Forum - Tutorial and User Help A forum specifically addressing the Mango application can be found at: http://infiniteautomation.com/forum/. The forum is very active and is a good place to seek answers to your Mango questions. This way others can benefit and Mango can grow as a community. You will also find many tutorials and user help sections, and you can use the search tool to find what you are looking for. If it doesn't seem like your question has been asked, start a new thread and we will happily respond as fast as possible. Please be aware that when using the forum, many of the questions and answers refer to using Mango with full programming access and may not apply to your environment.

http://www.omniinstruments.co.uk/

mailto:[email protected]

http://infiniteautomation.com/wiki/doku.php?id=gettingstarted

http://infiniteautomation.com/forum/

m2m data - web interface - omni instruments

Documents