M2M Data - Web Interface. User s Manual Revision 3 - Nov 2017

Transcription

1 M2M Data - Web Interface User s Manual Revision 3 - Nov 2017

2 Contents Overview and Design Concepts... 2 Getting Started... 3 Control Items... 5 Display Panels... 6 Data Pages... 6 Data Points... 7 Alarms Reports DGLUX Watch List Graphical Views Excel Reports

3 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 or SMS. Also available from the M2M system are many different kinds of reports that can be scheduled on a recurring basis or only run when a user requests the data. The reports can also be ed 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 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. Data Points can be configured 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. 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. We 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. 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. 2

4 Events M2M Data - Web Interface User Manual - Rev 3 Nov 2017 An Event is the occurrence of a defined condition within the system. Once an Event has been detected, it is acted upon by handlers. An Event Handler is a defined behaviour that is to be performed upon the raising of a particular event, such as sending an or setting the value of a settable point. An Alarm is an Event with an alarm level. When your application has an unacknowledged alarm, 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). 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. 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 use the Graphical Views of points. 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. The Data Point Details page allows you to thoroughly examine a single Data Point. A Data Point can be selected using the filtering input in the upper right corner of the display. You can filter the list and get a dropdown by typing either the point's Name or Device Name(case sensitive). The results will update as you type. 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. Getting Started Data from the several of our data logger units can be viewed on the M2M web interface in chart, table and graphical format. The data can also 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: You will first encounter the Message Board with any important system announcements. The Message Board will also contain links to the Terms and Conditions, the User Manual, Contact Details and a link to continue on to the Log in Page. Follow the link to the Log in Page and log in with the username and password you have been given. 3

5 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 / antivirus software that you use. 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 show scroll bars. The display works best if the windows size is such that all items can be seen without scroll bars. 4

6 This graphical data display has many features within itself. The features and clickable items are listed here: Data Pages Control Items Data Pages Control Items The Control Items will show the user currently logged into the web site, 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: and click the icon with the chain to Make this my default page. Make this my default page Delete my default page 5

7 Display Panels The display panels are bespoke configurations and will show a combination of graphical images representing the data to provide the latest readings from the data logger. The screen shot below shows another example of a bespoke graphics display. Data Pages The data pages are accessible from the icons shown above the graphical display as shown here; Alarms Watch Lists Data Points Help Reports DGLUX Module Excel Reports Graphical Displays or at the bottom of the display as shown in the screen short below. Data Points Excel Reports Alarms Watch Lists 6

8 Data Points M2M Data - Web Interface User Manual - Rev 3 Nov 2017 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 General Section Real-Time History Section Statistical Section Date / Time Controls History Chart / Download Section Events Section User Access Section 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 7

9 General Section M2M Data - Web Interface User Manual - Rev 3 Nov 2017 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. Refresh You can also move to another data point by choosing the available data points (channels) from the drop down list in the upper right part of the real time history section. There are also arrow icons to move to previous and next data point. Data Point List 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 right corner of this section. Get Statistics 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. Get Data 8

10 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. Download Events Section This section will list any alarms or events that have taken place for this channel. User Access Section This section will list users that have access to this data point as well as the access type. 9

11 Alarms The Alarms page will provide details of any alarms that have occurred. You will be able to acknowledge the alarms and see the duration of the alarms as well as which user has acknowledged the alarms. Help Legacy Alarms Page Column Headings Date Picker Acknowledge Silence Export Sort Add Comment Acknowledged 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. Acknowledge 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. d. This column allows you to show all alarms as well. Selecting All will show alarms that have occurred and been acknowledged in the past. 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. Silence / Un-silence 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. 10

12 Reports M2M Data - Web Interface User Manual - Rev 3 Nov 2017 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 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. Help Export Data Do Not Purge Export Events Refresh Report Icon Report Link New Report Export User Comments View Charts Delete Report 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 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. The M2M system will automatically purge all reports after 1 week to avoid an excess amount of report data being stored on the web server. Any reports that have been ticked as do not purge will still be purged. 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. 11

13 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. 12

14 9. New Report allows the creation of new reports. a. This opens a new section called Report Criteria. Save Report Criteria Delete Report Run Now Copy Delete Test Add Delete 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. 13

15 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 ing Although reports cannot be explicitly shared within the system, they can be implicitly shared by creating a mailing list to which to send the generated report instance. The content of the is the same as the "report chart" window opened from within the Report queue panel. To include the CSV export file with the , check the Include tabular data box. Some systems may not allow the chart images to be included in the report. Select the recipients to which to send the report . Recipients can be mailing lists, system users, or free-form addresses. Click the test icon to send a test message to the selected recipients. Important: Report instances that are ed 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. Help Points Watch List Watch List Controls Consolidated Chart Date picker and download controls 14

16 Functions: M2M Data - Web Interface User Manual - Rev 3 Nov 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. Trend Icon Toggle Copy Add Filter Name Permissions Delete Report Watch List Name Export Value Time Include Point Details Move Up / Down Delete from list 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 15

17 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. Help Date picker and download controls 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. Header Controls 16

18 Excel Reports M2M Data - Web Interface User Manual - Rev 3 Nov 2017 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. 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 / inprogress reports table. 17

19 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. 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. All Excel Reports will be purged after 1 day to prevent an excessive amount of data being stored on the server. 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. 18

20 Rollup M2M Data - Web Interface User Manual - Rev 3 Nov 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. 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. 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: 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. Reports can be ed and will contain the generated Excel file (optionally compressed). Select the recipients to which to send the report . Recipients can be mailing lists, system users, or free-form 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. 19

21 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, 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 20