How it Works
Sper scientific
Loading...
Raphael
Instruction Manual
104 pgs4.61 Mb0

Sper scientific Raphael Instruction Manual

Download
Page 1
Raphael™ Remote Monitor
870001
Instruction Manual
Page 2
2 3
Contents
NOTICES .................................................................................................5
GLOSSARY ............................................................................................. 6
INTRODUCTION ....................................................................................7
PRODUCT OVERVIEW ..........................................................................8
Raphael™ Kits ....................................................................................10
User Interface ...................................................................................... 11
INSTALLING THE RAPHAEL™ KIT ................................................... 12
SPER SCIENTIFIC WEB-BASED DATA MANAGEMENT SYSTEM ....14
Account roles ...................................................................................16
Organization roles ............................................................................ 16
USING THE SPER SCIENTIFIC VISUALIZATION WINDOW ..............18
Setting Time Range .........................................................................22
Setting Time Frame ..........................................................................22
Using the Zoom and View tools .......................................................23
GENERATING REPORTS....................................................................25
Page 3
3
MANAGING SITES ...............................................................................31
Changing the Site Name and Organization .....................................32
Changing the Site Location .............................................................. 34
MANAGING DEVICES .........................................................................35
Setting the Device Reporting Intervals ............................................. 36
Setting the Device Transmission Intervals .......................................38
Setting the Device Sampling Interval ...............................................39
MANAGING DATA STREAMS .............................................................44
Sorting the Samples table ................................................................ 49
Hiding Samples in the Samples table ..............................................50
Filtering the Samples table ..............................................................50
Accessing the Threshold View .........................................................51
Changing Threshold Settings ........................................................... 53
Adding a New Threshold ..................................................................56
Setting Threshold Actions ................................................................57
Hiding Bad Samples of Raw Data .................................................... 65
Changing the Conversion Formula ..................................................67
Limiting Display of Engineering Values ............................................ 70
MANAGING ORGANIZATIONS ...........................................................71
Page 4
4 5
MANAGING USERS .............................................................................74
MANAGING USER GROUPS ..............................................................80
SHARING SITES AND ACCOUNTS .....................................................85
SETTING PERSONAL PREFERENCES ............................................89
Changing your own password .......................................................... 90
MAINTENANCE ....................................................................................93
Battery Replacement Instructions ....................................................93
TROUBLESHOOTING .........................................................................95
Raphael™ device does not turn on .................................................. 95
FAQ ........................................................................................................96
SPECIFICATIONS ................................................................................99
Raphael™ Mechanical Drawings ......................................................101
APPENDIX A: Connector 42-00009 datasheet ......................................102
WARRANTY ........................................................................................104
Page 5
5
Raphael™ Remote Monitor - 870001
Copyright ©2017 by Sper Scientic
ALL RIGHTS RESERVED
Printed in the USA
The contents of this manual may not be reproduced or transmitted in any form or by any means electronic, mechanical, or other means that do not yet exist or may be developed, including photocopying, recording, or any information storage and retrieval system without the express permission
from Sper Scientic.
Sper Scientic LTD.
8281 E. Evans Rd., Suite #103, Scottsdale, AZ 85260 Tel: (480) 948-4448 Fax: (480) 967-8736 Web: www.sperscientic.com | www.sperdirect.com
NOTICES
© Copyright 2017 Sper Scientic
Trademark Acknowledgments
Raphael™ is a trademark of Sper Scientic.
All other trademarks are property of their respective owners.
FCC Notice
Contains FCC ID: QIPPXS8
This device complies with Part 15 of the FCC Rules. Operation is subject to the following two conditions:
(1) this device may not cause harmful interference, and
(2) this device must accept any interference received, including interference that may cause undesired operation.
Compliance Information
The Raphael™ device complies with the following radiated emission standards:
• ETSI EN 301 489-1/-17 Class B
• CFR 47 FCC Part 15 Subpart B Class B
The Raphael™ device complies with Immunity per ETSI EN 301, CE.
Page 6
6 7
GLOSSARY
Term Explanation
API Application Programming Interface.
A set of routines, protocols, and tools for building software and applications
Cloud Computing
Internet-based computing, providing shared resources, data and information to computers and other devices on-demand.
SCADA Supervisory Control And Data Acquisition.
A system for remote monitoring and control.
UI User Interface
Page 7
7
INTRODUCTION
Scope
This document is intended for users, installers and integrators of Raphael™ Kits.
Reimagine Remote Monitoring
Rather than sending technicians to periodically environmental measurements, Raphael™ streams the data to you. Raphael™ transmits the data to our secure cloud server via global GSM cellular. You are then able to access it, in real time, from any computer with an internet connection.
Our sophisticated cloud based software allows you to easily view, and analyze, data and graphs from multiple sensors and locations simultaneously. You see data, changes and problems as they happen, rather than after the fact. All data is highly encrypted so that only you will be able to access it. If required, the system will also send you SMS or E-mail alerts when a threshold is crossed.
Raphael™ is an autonomous, stand-alone system. Together with our cloud based subscription software you have a complete, ready to go, solution for remote monitoring. The system is easily scalable up to an entire smart water network and comes with a built in interface for SCADA systems.
Housed in a rugged waterproof case Raphael™ will stand up to many years
in the eld even in harsh conditions. Special military grade batteries and
unique power usage algorithms enable the unit to work autonomously for years of typical use. Optional connections for AC power are also available.
Raphael™ is available in standard congurations, but can be customized
to work with any sensors you require. Simply place Raphael’s™ sensors wherever environmental monitoring is needed and let the data come to you.
Page 8
8 9
PRODUCT OVERVIEW
Sper Scientic’s Raphael™ is a remote infrastructure monitoring tool that delivers eld data to decision makers. It is an all-inclusive, plug-and-play
system, including batteries, SIM card, sensors, and installation hardware.
After learning your specic needs, Sper Scientic pre-integrates the
appropriate sensors with the Raphael™ data collection, storage and communication device which is then installed onto existing infrastructure.
The data collected from the sensors is stored on Sper Scientic’s secure
private cloud server, and/or can be integrated directly into your on­premises servers.
A Sper Scientic web-based data management system enables you to congure the device over-the-air and program various parameter
threshold levels for email and/or SMS alerts, visualize data in real-time, and produce reports for presentation and analysis. Using
Sper Scientic’s API, data can be integrated directly into your SCADA
systems, business intelligence or other analytic software.
Figure 1: Sper Scientic Raphael™ system
Page 9
9
Agriculture
• Wells, Canals, Runo󰀨, Irrigation
Aquaculture
• Marine & Freshwater
Environment
• Precipitation, Temperature, Microbial Contamination, Climate & Microclimate Analysis Ecosystem Health
Industrial & Commercial
• Power Plants, Manufacturers, Boilers & Chillers, Storage Tanks
Oil & Gas Industry
• Upstream, Midstream & Downstream
Water Infrastructure
• Clean Water, Dirty Water, Rivers, Lakes, Streams
Sample Raphael™ Applications
Anywhere You Need to See Important Readings
Page 10
10 11
Raphael™ Kits
Each Raphael™ Kit, composed of a Raphael™ device and smart
sensors, is targeted at a specic need in the infrastructure sector. The
intended usage dictates the type of sensors included in the kit. Sper
Scientic o󰀨ers various kits in each of the following categories:
• Water Quality
• Environmental Quality
• Oil & Gas
Raphael™ Device
The Raphael™ device periodically samples the connected sensors and transmits the data to
the Sper Scientic cloud or to your on-premises
server. The device supports 2G, 3G, LTE (4G), CDMA, LPWAN, Satellite, and Bluetooth low­energy networks, and can interchangeably use the strongest available cellular signal.
The Raphael™ device is powered by a eld-
replaceable internal battery that provides 3,500+ transmissions. Alternatively, the device can be connected to an external battery, solar panel or permanent power source.
The Raphael™ device can be mounted in various ways, including:
• A󰀩xed to a pipe, using the supplied zip ties
• A󰀩xed to a wall, using the supplied four screws and anchors
• Hung on a wall, using one of the supplied screws and anchors
Sensor Integration
Each Raphael™ device has three sensor connector ports and supports any combination of the following types of sensors:
• Modbus
• Analog
• Digital
The specic types of sensors and sensor connectors in a kit depend on
the kit type.
Page 11
11
User Interface
The data collected by the Raphael™ device and transmitted to the Sper
Scientic cloud can be viewed in the Sper Scientic web-based data
management system. This system enables:
• Visualizing data in real-time
• Generating reports for presentation and analysis
• Dening threshold levels for E-mail and/or SMS alerts for
various parameters
• Over-the-air remote device conguration
• Receiving battery level notications for predictive
maintenance scheduling
Figure 2: Sper Scientic web-based data management system
Page 12
12 13
INSTALLING THE RAPHAEL™ KIT
Assembling the Raphael™ Kit
The assembly instructions depend on the type of Raphael™ Kit. Refer to the Quick Start Guide corresponding to your kit type.
Connecting to an External Power Source
If you wish to connect the Raphael™ device to an external power source, follow these guidelines:
• Use a 42-00009 (SAL - 8 - RSC3-S) CONEC connector (refer to
Appendix A: Connector 42-00009 datasheet).
• Perform power connector assembly as illustrated in Figure 3.
Figure 3: Power connector assembly instructions
• Use a cable with a round and even cross-section having the
following specications:
• Cable wire cross section surface area: 0.14-0.5 mm
2
• Wire gauge: AWG 26-20
• Cable diameter Ø: 4-5.5m
Page 13
13
Turning the Raphael™ On
The Raphael™ device is delivered in hibernation mode. To turn it on, press the magnetic activator, provided in the Raphael™ Kit, onto the icon appearing on the Raphael™ device.
The Raphael™ device turns on and performs a 10-minute calibration process, after which it starts operating in normal mode.
Note... Every time you press on the icon with the magnetic activator, the device performs a calibration process.
Figure 4: Turning Raphael™ device On
Page 14
14 15
SPER SCIENTIFIC WEB-BASED DATA MANAGEMENT SYSTEM
The Sper Scientic data management system provides the following:
•
Visualization window – enables viewing your site deployment from
the macro to the micro level
• Reports window – enables generating reports and exporting them for
viewing and sharing
• Devices window – enables you to view and manage all your Sites,
Devices and Data Stream congurations.
• Account window – enables you to manage all Organizations, Users
and User Groups.
Accessing the Data Management System
To access the Sper Scientic data management system:
•
Navigate to Sper.Ayyeka.com and enter your Sper Scientic credentials.
The Initial Visualization window appears.
Understanding Sites’ Hierarchy
Your system (also called an account) is organized hierarchically as follows:
• Account
• Organization(s)
• Site(s)
• Device(s)
• Data Stream(s)
Page 15
15
Figure 5: Account hierarchy
In the example shown above, the Springeld Water Company account
consists of two organizations, Organization 1 and Organization 2. Each organization manages several sites, where each site includes multiple devices. Each device is connected to various sensors (Pressure, Conductivity, etc.), each of which is sending the device a stream of sampling data.
Every account’s hierarchy is pre-dened to match the actual
deployment of its devices and their sensors. The only hierarchy changes an account owner can make is to add organizations, and unassign/assign sites to organizations.
Note...
The Organization level is optional. If no organizations are dened, all
sites are grouped directly under the Account level. This is common in small accounts.
The Device level is also optional. Data streams can be grouped directly under the site level, for example if there are very few devices in a site.
Page 16
16 17
Understanding User Roles
The system supports two sets of roles: Account roles and Organization roles.
• Account roles give permissions with regards to all account assets.
• Organization roles give permissions with regards to a specic
organization’s assets.
Account roles
Each role level is given the permissions given to lower-level roles, plus some additional permissions. The roles, from lowest to highest, include:
• No role – Can receives threshold alerts from account devices.
• Account Operator – Can also view sites and streams of this account.
• Account Analyst – Can also generate reports.
• Account Engineer – Can also manage all sites and streams of
this account.
• Account Administrator – Can also set device conguration for all
devices in this account.
• Account Owner – Can also manage all users, groups and
organizations of this account.
Organization roles
Each role level is given the permissions given to lower-level roles, plus some additional permissions. The roles, from lowest to highest, include:
• No role – Can receives threshold alerts from organization devices.
• Organization Operator – Can also view sites and streams of
this organization.
• Organization Analyst – Can also generate reports.
• Organization Engineer – Can also manage all sites and streams of
this organization.
• Organization Administrator – Can also set device conguration for all
devices in this organization.
• Organization Owner – Can also manage all users and groups of
this organization.
Page 17
17
Getting Started
After becoming acquainted with the Sites’ Hierarchy and the available User Roles, it is recommended to perform the following to set up your account:
1. If you are an account owner you may wish to create or edit organizations. Refer to Managing Organizations.
2. Create or edit users, giving them the necessary permissions. Refer to Managing Users.
3. Create user groups, which dene who receives alerts when data
thresholds are exceeded. Refer to Managing User Groups .
4. View your sites (groups of Raphael™ devices), and edit their settings if necessary. Refer to Managing Sites.
5. Manage the various data streams received from each specic sensor:
• Trim the raw data; then view the formula for converting raw data
into engineering units, and edit if necessary. Refer to Viewing and
Editing the Treatment of Raw Data.
• View the samples table, and hide values that are not real values.
Refer to Viewing and Filtering Samples.
• Set thresholds. When a threshold is exceeded, an alert is sent to
the corresponding user group, and certain data stream actions can be taken. Refer to Setting Data Stream Thresholds.
6. View the settings of your devices, and modify if necessary. Refer to
Managing Devices.
Page 18
18 19
USING THE SPER SCIENTIFIC VISUALIZATION WINDOW
Click the Visualization tab to display the initial Visualization window.
Figure 6: Initial Visualization window
Page 19
19
The Visualization window is composed of a sidebar, Sites Tree pane and a right pane.
• Side bar – links to the 4 main views: Visualization, Reports, Devices,
Account. The available views depend on your permissions (role).
• Sites Tree pane – lists all Raphael™ sites and their data streams:
The Sites Tree pane includes also a search box, which you can use to search for your sites. If there are more than 5 search results, the
results will not be displayed. In that case you need to rene your
search criteria.
• Right pane - shows a zoomed-out map displaying clusters of data
streams. Using the zoom controls, you can zoom in for greater detail, down to an individual site and its data streams.
Page 20
20 21
Viewing Site Information
1. To view the data from a specic Raphael™ site, click the site in the
left pane or on the map. The right pane refreshes to show the site and its data streams.
Figure 7: Viewing an individual site
2. To view the data sent from a specic data stream, click the data
stream in the Sites Tree pane or on the map.
The right pane splits, displaying the data as a chart in the bottom half of the pane.
Page 21
21
Figure 8: Viewing an individual data stream
Page 22
22 23
Understanding the Data Stream Chart
Hovering over a point in the chart displays a tool tip with the following information:
• Timestamp
• Site name
• Type of data stream (such as Pressure, Level, etc.)
• The reading
Setting the Time Range
You can set the start and end date for the chart by clicking the Range drop-down and setting the dates.
Setting the Time Frame
You can set the time frame shown in the window by selecting the desired time frame in the Time Frame selector.
Page 23
23
Using the Zoom and View tools
You can adjust the view using any of the following tools, appearing to the right of the chart:
Zoom to initial view (1 week)
Pan left
Pan right
Zoom in
Zoom out
Download as .png. This opens the graph as a png le in a
new browser tab.
Page 24
24 25
Comparing Data Streams
You can also compare the readings obtained from multiple data streams
by displaying them in same chart. Up to ve data streams of up to two di󰀨erent types can be displayed in the same chart.
To compare data streams:
1. Click the rst data stream in the Sites Tree pane. The right pane splits, displaying the data in a chart in the bottom half of the pane.
2. Click the second data stream in the Sites Tree pane. The data appears in the same chart in the bottom half of the right pane.
3. Repeat step (2) as desired. If you select more than ve data streams in all, or more than two di󰀨erent types of data streams,
the data from the additional data streams will appear in a new tab.
The following example shows a comparison of two data streams from the same site.
Figure 9: Comparing two data streams
Page 25
25
GENERATING REPORTS
Using the Reports tab you can easily create various types of reports, and export them to Excel.
Figure 10: Reports Tab
You can create the following types of reports:
• Stream History Report
• Aggregation Report
• Custom Stream History Report
Page 26
26 27
Stream History Report
This type of report displays the history of one or more data streams of a particular type.
To create a Stream History report:
1. Click Reports in the side bar.
2. In the Stream History Report pane, select the stream type, the
specic streams you wish to view, and the reporting time period.
Figure 11: Stream History Report - Dening Report Criteria
3. Click Export to Excel. A CSV le is created, showing the history of the selected streams during the selected time period.
Figure 12: Stream History Report - Example
Page 27
27
Aggregation Report
The Aggregation report enables viewing a statistical analysis of the
readings obtained in one or more data streams of a specic type.
To create an Aggregation report:
1. Click Reports in the side bar.
2. In the Aggregation Report pane, select the stream type, the
specic streams you wish to analyze, and the reporting time period.
3. Select the aggregation period - from 10 min intervals to 1
month intervals.
4. Specify the type of statistical analysis: Sum, Average, Min, Max or Standard Deviation.
5. Specify Separate Streams if you wish to generate a separate
analysis for each of the specied streams. For example, if you specied 2 streams and chose Average, then:
• Choosing Separate Streams will provide the average of all Stream1 recorded values in one column, and the average of all Stream2 recorded values in a second column.
• Not choosing Separate Streams will provided an average of all Stream1 and Stream2 recorded values, in a single column.
Figure 13: Aggregation Report - Dening Report Criteria
Page 28
28 29
6. Click Export to Excel. A CSV le is created, showing the results of the statistical analysis for the selected period. For example, the report shown below displays, for each day in the period:
• The Average of recorded values over all selected streams
• The Minimum recorded value over all selected streams.
• The Maximum recorded value over all selected streams.
Figure 14: Aggregation Report - Example
Custom Stream History Report
This type of report enables customizing the display of any data streams’
history. You can set which elds will appear in the report, how the elds
should be delimited, etc. This is very useful if you need to export data
from the report into a system that supports a specic data structure only.
To create a Custom Stream History report:
1. Click Reports in the side bar.
2. In the Custom Stream History Report pane, select the specic streams you wish to view, and the reporting time period.
Figure 15: Custom Stream History Report - Dening Streams
and Time Period
Page 29
29
3. Click Advanced Settings to dene the type of information to include in the report, as well as how it will be displayed.
Figure 16: Custom Stream History Report – Specifying Fields
and Method of Display
a. Set the Format Delimiter.
b. Set the Text Qualier.
c. Specify whether to Remove Header Row.
d. Specify whether to Round Sample Time to Closest Minute in
the timestamp, and whether to Add Minute.
e. For each data eld you wish to include in the report:
• Select the eld in the Data Fields drop-down.
• If a format drop-down appears, select a format. Note that you
can edit the format directly in the window.
• Click Add Field.
f. In the Fields Order section, you can change the order in which
columns will appear, by dragging and dropping column titles.
g. Optionally click Save as Default Settings; the settings you
dened will become the new default settings for the Custom
Stream History Report.
Page 30
30 31
4. Click Export to Excel. A CSV le is created, showing the history of the selected streams during the selected time period.
For example, for the settings dened in Figure 16, the resultant CSV le is as follows:
Figure 17: Custom Stream History Report - Example
Page 31
31
MANAGING SITES
A site is a group of devices in close proximity. This section describes how to view and edit site information.
Viewing a Site
To view site information:
1. Click Devices in the sidebar.
2. In the Sites Tree pane, click the site name.
Figure 18: Selecting a site
The site’s location and information appears in the right pane. This includes:
• The site name, the organization to which it belongs, and its latitude
and longitude coordinates.
• A map view, showing the location of the site. You can change the
view by clicking the layers icon at the top right corner of the view.
• A street view from Google of the site’s location.
Page 32
32 33
Editing a Site
Changing the Site Name and Organization
You can change a site’s name and the organization to which it belongs.
To change a site’s name and organization:
1. Click Devices in the sidebar, and click the site name in the Sites Tree pane.
2. In the right pane, click Actions under the site icon, and select Edit.
Figure 19: Selecting to edit a site
Page 33
33
The Site Name Conguration window appears.
Figure 20: Changing site name or organization
3. In the Site Name Conguration window, you can:
• Change the name of the site.
• Change the organization to which the site belongs. Note that a
site can belong to only one organization.
4. Click Submit.
Page 34
34 35
Changing the Site Location
You can change the site’s location by dragging and dropping it in the
map, or by entering coordinates in the Coordinates elds.
To change a site’s location:
1. Click Devices in the sidebar, and click the site name in the Sites Tree pane.
Figure 21: Changing site location
2. In the map appearing in the right pane, you can do any of the following:
•
Drag and drop the site icon in the map.
• Edit the coordinates displayed in the Coordinates elds.
The coordinates originally displayed are the site location as transmitted by the devices in the site.
Note... Do not edit the HDOP eld. It is reserved for future use.
Page 35
35
MANAGING DEVICES
You can view and change device settings such as the device reporting rate, and view varied device history and health information.
To view and edit device settings:
1. Click Devices in the sidebar.
2. In the Sites Tree pane, click the device name.
Figure 22: Selecting a device
Device information and conguration options appear in the right pane.
This includes:
• The device’s serial number, part number, its site name, last
transmission time, hardware version and rmware version, Sper Scientic ID and ICC ID (=ID of the SIM card).
• The ability to send various commands to the device.
• Stream management information – an overview of the mapping of
physical streams to logical channels.
Page 36
36 37
• Several tabs, enabling:
• Managing Device Conguration
• Viewing the Files Sent and Received by the Device
• Viewing the Device Event Log
• Viewing the Commands Sent to the Device
• Viewing the Health of the Device
• Viewing Device GPRS Information
Managing Device Conguration
The device’s Conguration tab enables viewing and changing device
conguration denitions. With the exception of the actions described in the following sub-sections, we recommend not changing these denitions without consulting with Sper Scientic by contacting
RaphaelSupport@sperscientic.com.
Setting the Device Reporting Intervals
The device reporting interval denes how often the device reports the
data gathered by its sensors.
For every device you can set 3 transmission intervals: Normal, Event and Emergency. Transmission interval Normal is the default interval. Transmission intervals Event and Emergency are two alternate intervals.
Data is always transmitted at the Normal rate, unless you specify a di󰀨erent
rate – either Event or Emergency – when readings fall within a threshold range (as described in Setting a Threshold’s Transmission Interval).
When setting transmission intervals, keep in mind that very short transmission intervals consume a large amount of power and network resources.
To view or set the device reporting intervals:
1. Click Devices in the sidebar.
2. In the Sites Tree pane, click the device name.
3. In the right pane, click the Conguration tab.
The currently-dened reporting intervals are displayed.
Page 37
37
Figure 23: Viewing the dened transmission intervals
4. Click inside the box of the transmission interval you wish to change. For example, to change the Normal transmission interval, click inside the green box.
A Select Transmission Interval for Normal window appears, with a slider for setting the interval length.
Figure 24: Changing a transmission interval using the slider
5. Set the transmission interval time, and click Submit.
Page 38
38 39
Note that the slider enables choosing from among the default intervals. If you wish to set the interval to a value that does not appear in the slider, refer to Setting a Device Transmission Interval to a Custom Setting.
Note also that the changes won’t take e󰀨ect and won’t be visible on
this screen until the Raphael™ next communicates with the server.
Setting a Device Transmission Interval to a Custom Setting
To set a device transmission interval to a custom setting:
1. Click Devices in the sidebar.
2. In the Sites Tree pane, click the device name.
3. In the right pane, click the Conguration tab.
The currently-dened transmission intervals are displayed (Figure 23).
4. Scroll to the bottom of the Conguration tab, and click Advanced Device Conguration to expand this section.
The device conguration tree is displayed.
Figure 25: Selecting the device transmission interval parameter
Page 39
39
5. To change the device’s Normal transmission interval (in minutes), in
the Device Conguration tree select GSM > GSM_PRIORITY > 0 > home_interval_minutes and then:
a. To the right of the conguration tree, select the drop-down arrow
adjacent to the current value.
b. Select Set Setting.
c. In the Send New Value window, enter the desired value in the New
Value eld, and click Submit.
Note...
It is recommended not to set a value below 10 minutes, since this will drain the battery.
Figure 26: Send New Value window
6. To change the Event transmission interval (in minutes), select GSM > GSM_PRIORITY > 1 > home_interval_minutes and follow the instructions in the sub-steps of step 5.
7. To change the Emergency transmission interval (in minutes), select GSM > GSM_PRIORITY > 2 > home_interval_minutes and follow the instructions in the sub-steps of step 5.
Setting the Device Sampling Interval
For help, please contact RaphaelSupport@sperscientic.com.
Viewing the Files Sent and Received by the Device
To view the les sent and received by the device:
1. Click Devices in the sidebar.
2. In the Sites Tree pane, click the device name.
3. In the right pane, click the Device Reports tab.
Page 40
40 41
Figure 27: Device – Device Reports tab
The report lists, for each event in which les were received from or sent
by the device, the number of Files Received from the device (such as
les containing sensor readings), and Files Sent to the device (such as les containing device conguration changes).
Viewing the Device Event Log
To view the device event log:
1. Click Devices in the sidebar.
2. In the Sites Tree pane, click the device name.
3. In the right pane, click the Log tab. The Log appears, listing all device activity.
Figure 28: Device – Log tab
Page 41
41
Viewing the Commands Sent to the Device
To view the commands sent to the device:
1. Click Devices in the sidebar.
2. In the Sites Tree pane, click the device name.
3. In the right pane, click the Commands tab.
Figure 29: Device – Commands tab
The table lists all the commands sent to the device. These mainly include
device conguration changes.
Page 42
42 43
Viewing the Health of the Device
To view the health of the device:
1. Click Devices in the sidebar.
2. In the Sites Tree pane, click the device name.
3. In the right pane, click the Health tab.
Figure 30: Device – Health tab
This tab is intended for device troubleshooting, to help identify the possible source of issues.
Page 43
43
Viewing Device GPRS Information
To view the device GPRS information:
1. Click Devices in the sidebar.
2. In the Sites Tree pane, click the device name.
3. In the right pane, click the GPRS Sessions tab.
Figure 31: Device – GPRS Sessions tab
This tab lists information about each data transmission session during which the device transmitted data over the mobile network.
Page 44
44 45
MANAGING DATA STREAMS
Each data stream shows the actual data received from a specic sensor connected to a specic Raphael™ device.
Viewing a Data Stream
To view data stream information:
1. Click Devices in the sidebar.
2. In the Sites Tree pane, click the data stream name.
Figure 32: Selecting a data stream
Data stream information appears in the right pane. This includes:
• The stream’s name, the site’s name, the stream’s type, sampling
interval, sample value scale, status, source, and last sample value.
• A graph depicting the samples’ trend in the past 48 hours.
• Three tabs, enabling:
• Viewing and Filtering Samples
• Viewing and Editing the Treatment of Raw Data
• Conguring Data Stream Thresholds
Page 45
45
Editing a Data Stream
To edit a stream’s settings:
1. Click Devices in the sidebar, and click the stream name in the Sites Tree pane.
2. In the right pane, click Actions underneath the graph, and select
Edit Stream.
Figure 33: Selecting to edit a data stream
The Stream Name and Type Configuration window appears.
Page 46
46 47
Figure 34: Changing stream settings
3. Optionally change the Stream Name.
4. Optionally change the Engineering Units that appear in the Sites Tree pane and in reports.
Note...
Keep in mind that if you want the nal values (derived by converting the raw value into engineering units) to be correctly expressed in a specic
engineering unit (for example in inches rather than feet), you need to edit the formula for converting raw data into engineering units. Refer to Changing the Conversion Formula.
5. Optionally change the Sample Value Scale, which species how many decimal points to display after a whole value. This enables you to set the level of accuracy when displaying values in the Sites Tree pane and in generated reports.
6. Click Submit.
Page 47
47
Hiding a Data Stream
An account owner can hide a stream from other account users. A hidden stream is only visible to account owners. At any time, the account owner can un-hide a hidden stream and make it visible again to all account users.
To hide a stream:
1. Click Devices in the sidebar, and click the stream name in the Sites Tree pane.
2. In the right pane, click Actions underneath the graph, and select
Hide from Users.
Figure 35: Selecting to Hide a Stream
A conrmation window appears.
Page 48
48 49
Figure 36: Conrm hiding a stream
3. Click Submit.
An indication appears, adjacent to the stream name, indicating the stream will be hidden from other account user from their next login, and will be visible to the account owner(s) only.
Figure 37: Indication of a hidden stream
4. To un-hide a stream:
a. Click Devices in the sidebar, and click the stream name in the
Sites Tree pane.
b. In the right pane, click Actions underneath the graph, and
select Show To Users.
The stream will now be visible to all account users from their next login.
Page 49
49
Viewing and Filtering Samples
You can view the samples taken by a specic sensor.
To view samples:
1. Click Devices in the sidebar, and click the stream name in the Sites Tree pane.
2. In the right pane, select the Samples tab.
Figure 38: Samples table
The samples table shows, for each reading taken in the past:
• The sampling date and time
• The raw value
• The nal value after converting the raw value to engineering units
• The Hidden/Visible status of the sample
Sorting the Samples table
You can sort the entries in the table by a specic column. To do so, click the
column head and then click the arrow appearing to the right. The samples are sorted in descending order. Click again to sort by ascending order.
Page 50
50 51
Hiding Samples in the Samples table
You may wish to change the status of some samples to Hidden, for example because you know they do not represent the true state of the body being sampled. Hidden samples appear neither in the Visualization window nor in reports.
Hiding a single sample
To hide a single sample:
1. In the samples table (Figure 38), double-click the word Visible in the line corresponding to the data point you wish to hide.
2. In the drop-down menu, select Hidden.
Hiding samples from an entire period
To hide samples from a certain period:
1. In the samples table (Figure 38), select Hide Samples.
2. In the drop-down menu, enter the start and end dates, and click Submit.
Figure 39: Hiding samples
The status of all samples from the specied period changes to Hidden.
Filtering the Samples table
To display samples only from a certain period:
1. In the samples table (Figure 38), select Show Samples.
2. In the drop-down menu, enter the start and end dates, and click
Submit. Only samples from the specic period are displayed in
the table.
Page 51
51
Conguring Data Stream Thresholds
A key feature of the Sper Scientic system is the ability to congure
multiple thresholds for any data stream, and specify actions such as alerts when data samples cross a threshold.
Thresholds are congured using ranges of values bound by a lower and upper limit. Let’s say you want to congure thresholds for a Temperature data stream. You can dene a Low threshold of 0-40°F, a Normal
threshold of 40-120°F, and a High threshold of 120-250°F. For each threshold range, you can congure Actions the Raphael™ device should perform when data samples cross into a threshold range, such as modifying the sampling or transmission frequency, or sending email and/ or SMS alerts to certain users.
Accessing the threshold view
In a nutshell:
1. Click Devices in the sidebar.
2. In the Sites Tree pane select the stream.
3. In the right pane select the Thresholds tab.
4. If the Thresholds slider is OFF , click it to switch Thresholds to ON .
To view or set a data stream’s thresholds:
1. Click Devices in the sidebar, and click the stream name in the Sites Tree pane.
2. In the right pane, select the Thresholds tab.
3. If the Thresholds slider is in the OFF position , click it to switch Thresholds to ON .
A graph appears, showing the data stream values for the past week (use the Time Frame slider to zoom in or out).
The thresholds dened for this data stream are displayed below
the graph.
By default, the system creates three ranges for each data stream: Low, Normal and High. The thresholds cover the entire spectrum of actual stream values collected by the device.
Page 52
52 53
Figure 40: Thresholds view
You can:
• Change threshold settings by:
• Changing a threshold’s name
• Changing a threshold’s range
• Setting a threshold’s False Alarm Filter
• Add new thresholds
• View or change threshold actions, such as:
• Setting whether to transmit data immediately
• Setting a Threshold’s Transmission Interval
• Setting a Threshold’s Sampling Interval
• Dening a Threshold’s Alert Recipients
• Setting Resultant Sampling Actions
Note...
All threshold conguration changes will take e󰀨ect after the device next
communicates with the server.
Page 53
53
Changing threshold settings
You can change the following threshold settings:
• Changing a threshold’s name
• Changing a threshold’s range
• Setting a threshold’s False Alarm Filter
Changing a threshold’s name
In a nutshell:
1. Click Devices in the sidebar.
2. In the Sites Tree pane select the stream.
3. In the right pane select the Thresholds tab.
4. If the Thresholds slider is OFF , click it to switch Thresholds to ON .
5. In the threshold denition area, click the current name, adjacent to the ag, and overwrite it with the new name.
6. Save changes by clicking .
It is recommended to give each threshold an appropriately descriptive name because in the threshold alert text, the threshold name is the only indication of the reason why the alert was sent, as shown below.
Figure 41: Example alert text
Page 54
54 55
To change a threshold’s name:
1. In the threshold denition area, click the pencil icon .
Figure 42: Threshold denition area
2. Overwrite the current name with the new name.
3. Save changes by clicking .
Changing a threshold’s range
In a nutshell:
1. Click Devices in the sidebar.
2. In the Sites Tree pane select the stream.
3. In the right pane select the Thresholds tab.
4. If the Thresholds slider is OFF , click it to switch Thresholds to ON .
5. In the threshold denition area:
a. Set the threshold’s upper limit by editing it directly.
b. Set the threshold’s lower limit by editing the upper limit of the
threshold to its left.
6. Save changes by clicking .
The thresholds mechanism works as follows:
• Thresholds cover the entire spectrum of actual stream values
collected by the device.
• Thresholds are organized in ascending order, from the lowest
(left-most), to the highest (right-most).
• Only a threshold’s upper limit is editable. A given threshold’s lower
limit is the upper limit of the preceding threshold.
• The lower limit of the lowest (left-most) threshold is not-editable, and
is set by the system depending on the given stream’s lowest value.
Page 55
55
• The upper limit of the highest (right-most) threshold is not-
editable, and is set by the system depending on the given stream’s highest value.
Therefore, to set a threshold’s range of values:
1. Set the threshold’s upper limit by editing it directly.
2. Set the threshold’s lower limit by editing the upper limit of the threshold to its left.
3. Save changes by clicking .
Alternatively, you can drag the dotted lines, representing the thresholds’ upper and lower limits, in the threshold graph (Figure 40). The ranges of the relevant thresholds are updated accordingly.
Setting a threshold’s False Alarm Filter
In a nutshell:
1. Click Devices in the sidebar.
2. In the Sites Tree pane select the stream.
3. In the right pane select the Thresholds tab.
4. If the Thresholds slider is OFF , click it to switch Thresholds to ON .
5. In the threshold denition area, click the value of the False Alarm
Filter, and overwrite it with the new value.
6. Save changes by clicking .
The false alarm lter is intended to help ensure that threshold alerts are
not sent for very short data spikes. For example, if you set this value to 120 seconds, that means no threshold alerts will be sent if stream samples are within the threshold for less than 2 minutes.
Note that in order for the false alarm lter to be meaningful, its value should
be set no higher than the threshold’s Sampling Interval.
Page 56
56 57
To set a threshold’s false alarm lter:
1. In the threshold denition area (Figure 42), click the value adjacent to False Alarm Filter.
2. Overwrite the current value with the new value.
3. Save changes by clicking .
Adding a new threshold
In a nutshell:
1. Click Devices in the sidebar.
2. In the Sites Tree pane select the stream.
3. In the right pane select the Thresholds tab.
4. If the Thresholds slider is OFF , click it to switch Thresholds to ON .
5. In the threshold denition area:
a. Click or to add a threshold before (to the left) or
after (to the right) an existing threshold.
b. Edit the threshold as desired. Refer to:
• Changing a threshold's name
• Changing a threshold's range
• Setting a threshold's False Alarm Filter
• Setting Threshold Actions
6. Save changes by clicking .
You can dene more thresholds in addition to the three thresholds the
system creates by default. A new threshold is always inserted in between two existing thresholds. It can be inserted anywhere between the very lowest and very highest thresholds. The maximum number of thresholds
for a data stream is eight thresholds.
Page 57
57
To add a new threshold:
1. Determine where you want to insert the new threshold, and then in the threshold denition area (Figure 42) click either or to add a threshold before (to the left of) or after (to the right of) an existing threshold.
2. Edit the threshold as desired. Refer to:
• Changing a threshold’s name
• Changing a threshold’s range
• Setting a threshold’s False Alarm Filter
• Setting Threshold Actions
3. Save changes by clicking . The changes will go into e󰀨ect the next time the device communicates with the server
Setting Threshold Actions
In a nutshell:
1. Click Devices in the sidebar.
2. In the Sites Tree pane select the stream.
3. In the right pane select the Thresholds tab.
4. If the Thresholds slider is OFF , click it to switch Thresholds to ON .
5. In the threshold denition area, click Actions.
6. In the threshold actions window, set any of the following:
• Setting whether to transmit data immediately
• Setting a Threshold’s Transmission Interval
• Setting a Threshold’s Sampling Interval
• Dening a Threshold’s Alert Recipients
• Setting Resultant Sampling Actions
7. Save changes by clicking .
For each threshold, you can dene what actions the device should take
when stream samples fall within the range of the threshold.
Page 58
58 59
To set threshold actions:
1. In the threshold denition area (Figure 42), click Actions.
The thresholds actions view is displayed.
Figure 43: Threshold Actions view
In the Threshold actions window, you can set any of the following:
• Setting whether to transmit data immediately
• Setting a Threshold’s Transmission Interval
• Setting a Threshold’s Sampling Interval
• Dening a Threshold’s Alert Recipients
• Setting Resultant Sampling Actions
Page 59
59
Setting whether to transmit data immediately
In a nutshell:
1. Click Devices in the sidebar.
2. In the Sites Tree pane select the stream.
3. In the right pane select the Thresholds tab.
4. If the Thresholds slider is OFF , click it to switch Thresholds to ON .
5. In the threshold denition area, click Actions.
6. Under Transmit Data, check the Immediately box if you want the device to transmit data immediately when a stream sample crosses into this threshold.
7. Save changes by clicking .
In the Transmit Data section, specify whether the device should transmit data immediately when a stream sample crosses into this threshold, or whether the device should wait until the next scheduled transmission time.
Note that the system automatically checks the Immediately box if you
specify that users should be notied when samples enter the threshold
range (see Dening a Threshold’s Alert Recipients).
Page 60
60 61
Setting a Threshold’s Transmission Interval
In a nutshell:
1. Click Devices in the sidebar.
2. In the Sites Tree pane select the stream.
3. In the right pane select the Thresholds tab.
4. If the Thresholds slider is OFF , click it to switch Thresholds to ON .
5. In the threshold denition area, click Actions.
6. Under Transmission Interval, select either Normal, Event
or Emergency.
7. Save changes by clicking .
To change the Normal, Event and Emergency transmission intervals of a device, refer to Setting the Device Transmission Intervals.
A transmission interval denes how often the device transmits data
gathered by its sensors.
Every device has three congurable transmission intervals: Normal,
Event and Emergency. Transmission interval Normal is the default interval. Transmission intervals Event and Emergency are two alternate
intervals. Data is always transmitted at the Normal rate, unless a di󰀨erent rate is specied– either Event or Emergency – when stream samples fall
within a certain threshold range.
Note that you can set the Normal, Event and Emergency transmission intervals of a device. For instructions, refer to Setting the Device Transmission Intervals.
To set the device transmission interval when samples are within a threshold range:
1. In the transmission Interval section of the threshold’s Actions view (Figure 43), select a transmission interval from the drop-down list: Normal, Event or Emergency.
2. Click to save your settings.
Page 61
61
Keep in mind that very short transmission intervals consume a large amount of power and network resources.
Note also that whenever a device is scheduled to transmit data, it transmits all the data it stored since its previous transmission. Thus if you set the device to transmit at the Emergency rate for a certain threshold, then whenever the threshold is reached and the device transmits at the Emergency rate, it will transmit data from all its data streams, not only from
the stream for which you dened the threshold.
Setting a Threshold’s Sampling Interval
In a nutshell:
1. Click Devices in the sidebar.
2. In the Sites Tree pane select the stream.
3. In the right pane select the Thresholds tab.
4. If the Thresholds slider is OFF , click it to switch Thresholds to ON .
5. In the threshold denition area, click Actions.
6. Under Sampling Interval, enter a value in seconds.
7. Save changes by clicking .
The sampling interval denes how often the device samples a data
stream. You can specify the sampling interval for the time periods when stream samples fall within a threshold range.
To dene the stream sampling rate when samples are within a threshold range:
1. In the Sampling Interval (sec.) section of the threshold’s Actions view (Figure 43), select or enter a sampling interval, in seconds.
2. Click to save your settings.
Page 62
62 63
Dening a Threshold’s Alert Recipients
In a nutshell:
1. Click Devices in the sidebar.
2. In the Sites Tree pane select the stream.
3. In the right pane select the Thresholds tab.
4. If the Thresholds slider is OFF , click it to switch Thresholds to ON .
5. In the threshold denition area, click Actions.
6. Under Notication Actions:
a. Select a group.
b. Select whether to send an email or SMS.
c. Click Add.
7. Repeat the previous step for every additional group you want to add.
8. Save changes by clicking .
You can dene which user groups will receive an alert whenever a
stream sample crosses into a threshold range. All members of the groups you specify will receive the alerts.
Note that to use this feature you need to rst dene user groups, as
described in Managing User Groups.
To dene which groups will receive alerts when samples enter a threshold range:
1. In the Notication Actions section of the threshold’s Actions view (Figure 43), perform the following:
a. Select a group in the drop-down list.
Page 63
63
b. Select an alert medium – email or SMS. The message will be
sent to the mobile phone number or email address dened for
each of the group’s users (refer to Adding a User).
c. Click Add.
2. Repeat the previous step for every group to which you want to send a threshold alert.
3. Click to save your settings.
Setting Resultant Sampling Actions
In a nutshell:
1. Click Devices in the sidebar.
2. In the Sites Tree pane select the stream.
3. In the right pane select the Thresholds tab.
4. If the Thresholds slider is OFF , click it to switch Thresholds to ON .
5. In the threshold denition area, click Actions.
6. Under Stream Sampling Actions:
a. Select a data stream.
b. Select an action: Pause, Resume, Single or Pause Single.
c. Click Add.
7. Repeat the previous step for every additional group you want to add.
8. Save changes by clicking .
You can instruct a device to take a certain action for a specic data
stream, whenever a stream sample crosses into a threshold range.
Page 64
64 65
To set stream sampling actions when samples enter a threshold range:
1. In the Stream Sampling Actions section of the threshold’s Actions view (Figure 43), perform the following:
a. Select a data stream in the drop-down list.
b. Select one of the following actions:
• Pause – Instructs the device to pause sampling the selected data stream.
• Resume – Instructs the device to resume sampling the selected data stream.
• Single – Instructs the device to take a single sample of the selected data stream immediately and then resume the regular sampling schedule for the selected data stream.
• Pause Single – Instructs the device to immediately take one sample of the selected data stream, and then pause sampling of this data stream.
c. Click Add.
2. Repeat the previous step for every data stream for which a certain sampling action should be takenwhenever data crosses into the threshold you are setting.
3. Click to save your settings.
Page 65
65
Viewing and Editing the Treatment of Raw Data
To view or edit the treatment of raw data:
1. Click Devices in the sidebar, and click the stream name in the Sites Tree pane.
2. In the right pane, select the Conguration tab.
Figure 44: Selecting a stream’s Conguration tab
In the Conguration tab you can perform the following:
• Hiding Bad Samples of Raw Data
• Changing the Conversion Formula
• Limiting Display of Engineering Values
Hiding Bad Samples of Raw Data
You can set the minimum and maximum values for raw data. Raw data that is outside this range will be discarded. This is useful in cases where you know that values outside this range are not real values, caused for example by the sensor being disconnected from the Raphael™ device.
Page 66
66 67
To hide bad samples of raw data:
1. Click Devices in the sidebar, and click the stream name in the Sites Tree pane.
2. In the right pane, select the Conguration tab.
3. In the Conguration tab (Figure 44), click the frame under
(1) Hide Bad Samples.
Figure 45: Selecting to change the Bad Samples lter
The Bad Samples Filter Conguration window appears.
Figure 46: Bad Samples Filter Conguration window
4. In the top two elds of the Bad Samples Filter Conguration window, set the minimum (left eld) and maximum (right eld)
values for raw data.
5. Click Update old samples to retroactively update old samples according to the new minimum and maximum values. You can update samples up to two weeks back.
Page 67
67
Changing the Conversion Formula
You can change the formula used to convert raw data into engineering units if the formula being used is linear.
To change the formula for converting raw data to engineering units:
1. Click Devices in the sidebar, and click the stream name in the Sites Tree pane.
2. In the right pane, select the Conguration tab.
3. In the Conguration tab (Figure 44), click the frame under (2) Convert To Eng. Units.
Figure 47: Selecting to change the conversion formula
The Stream Eng. Units Converter Conguration window appears.
Page 68
68 69
Figure 48: Raw Data Converter conguration – direct editing
4. Dene the formula for converting raw data to engineering units in
either of the following ways:
• Edit the existing formula, as shown in Figure 48.
• Click the beaker to dene the formula by entering a pair of (Raw value, Final value) values. The system will compute the actual formula.
Page 69
69
Figure 49: Raw Data Converter conguration – by extrapolation
5. Click Update old samples to retroactively update old samples according to the new conversion formula. You can update samples up to two weeks back.
6. Click Submit.
Page 70
70 71
Limiting Display of Engineering Values
You can dene how to round up and round down engineering values
for display.
To limit the display of engineering values:
1. Click Devices in the sidebar, and click the stream name in the Sites Tree pane.
2. In the right pane, select the Conguration tab.
3. In the Conguration tab (Figure 44), click the frame under (3) Limit
Sample. The Final Value Clamping Conguration window appears.
Figure 50: Final Value Clamping Conguration window
4. Perform the following:
a. In the left eld, enter a value for rounding up. For example, if
you enter 0, all negative values will display as 0.
b. In the right eld, enter a value for rounding down. For example,
if you enter 145, then all values above 145 will display as 145.
5. Click Update old samples to retroactively update old samples according to the new clamping values. You can update samples up to two weeks back.
6. Click Submit.
Page 71
71
MANAGING ORGANIZATIONS
An account owner can add or edit organizations.
Note...
If you are setting up your account and intend to add organizations, it is recommended to do so before creating users. This will enable you to create users in their appropriate organizations
Adding an Organization
An account owner can create organizations and assign to them sites.
To add an organization
1. Click Account in the sidebar.
2. In the right pane, select the Organizations tab.
3. Click + Add Organization.
Figure 51: Selecting to add an organization
The Create Organization window appears.
Page 72
72 73
Figure 52: Create Organization window
4. In the Create Organization window:
a. Enter a name for the organization.
b. Optionally enter a description.
c. Specify which sites you are assigning to the organization.
Figure 53: Assigning sites to an organization
Page 73
73
Note... A site can belong to only one organization.
If you wish to assign to Org1 a site that is currently assigned to Org2, you must rst remove the site from Org2 (refer to Editing an Organization), and then assign it to Org1.
5. Click Submit.
Editing an Organization
An account owner can edit the name, description, and assigned sites of an existing organization.
To edit an organization:
1. Click Account in the sidebar.
2. In the right pane, select the Organizations tab.
3. In the list of organizations, click the pencil icon adjacent to the organization you wish to edit.
Figure 54: Selecting to edit an organization
The Update Organization window appears (very similar to Figure 52).
4. In the Update Organization window, change the organization’s name, description, or assigned sites.
5. Click Submit.
Page 74
74 75
MANAGING USERS
Users are managed by assigning them to an organization or account,
and assigning them roles. A user’s role denes his permitted actions (see
Understanding User Roles).
Viewing the List of Users
You can view all the users in your organization (if you are an Organization owner), or in your account (if you are an account owner).
To view all users:
1. Click Account in the sidebar.
2. In the right pane, select the Users tab.
Figure 55: Users window
The Users table shows, for each user in your organization (or account):
• The user’s name
• The user’s login name
• The user’s organization, and his Organizational Role
• The user’s mobile phone number
• The user’s Account Role (if any)
• You can click in the top right to select to display also the user’s Email address.
Page 75
75
Adding a User
A user with an Account Owner role can add users at either the account or organization level, while a user with an Organization Owner role can add
users to his organization only.
Note... The logged-in user can change most of his own user details, such as email, mobile phone, and password, as described in Setting Your Own User Details.
To add a user at the account or organization level:
1. Click Account in the sidebar.
2. In the right pane, select the Users tab.
3. Click + Add User.
Figure 56: Selecting to Add User – at the Account level
The Add New User window appears.
Figure 57: Add New User window – Account User
Page 76
76 77
Figure 58: Add New User window – Organization User
4. In the Add New User window:
a. Enter the user’s actual rst name and last name in the Name elds.
b. Enter a user name in the User Name eld. Note that this is the
username which this user must enter when logging in.
c. Optionally enter a description.
d. Enter the user’s email address and optionally a mobile phone
number. Threshold alerts will be sent to this address/mobile number (refer to Dening a Threshold’s Alert Recipients).
e. Optionally select a Time Zone.
f. In the Role section, specify whether the user will be an
Organization User or Account User:
• If you are creating an Account User, select a role for the user.
• If you are creating an Organization User, you can give the user roles in multiple organizations. To do so, select an organization and a role, and click Add. Repeat these actions for every organization in which you wish to assign the user a role.
5. Click Submit. The user is added to the users table, as shown below.
Figure 59: User successfully added to account
Note...
In order to access the Sper Scientic user interface, a user also needs
a password. The user password is created after a user is successfully
dened, as described in Editing, Disabling or Deleting a User.
Page 77
77
Editing, Disabling or Deleting a User
An account owner can edit/disable/delete users at either the account or organization level, while an organization owner can edit/disable/delete users of his organization only.
To edit, disable or delete a user:
1. Click Account in the sidebar.
2. In the right pane, select the Users tab.
3. Hover over the line of the user you wish to modify. Several icons appear to the left of the user’s Name.
Figure 60: Options for modifying a user
4. Select the icon corresponding to the action you wish to take:
Edit user settings. Click this icon and edit the settings in the Edit User Properties window that appears.
Indicates the user was not assigned a password. Click this
icon to dene a user password. The password length must be
at least six characters, and it must contain both letters and numbers.
Indicates the user has a valid password. Click this icon to change the existing password. Note that the logged-in user can change his own password, as described in Changing your own password.
Indicates the user password has expired. Click this icon to
dene a new password.
Disable the user. A disabled user does not receive threshold alerts and cannot access the UI, but is not deleted from the database.
Delete the user from the database.
Page 78
78 79
Adding Existing Users to Organization(s)
An account owner can give an organization user, permissions in more than one organization. For example, you may wish to grant the Organization Owner of Org1 permission to view the sites and streams
(=Operator permissions) in Org2 and Org3. In this case you would give
this user an Organization Owner role in Org1, an Organization Operator role in Org2, and an Organization Operator role in Org3.
Note that a similar mechanism exists for giving users certain permissions to sites, called Sharing. The di󰀨erences between Sharing sites and adding users to an organization, are:
• Sharing gives permissions to specic sites, not to all an
organization’s sites.
• Sharing bestows Analyst (viewing and reporting) permissions only, while a user who is added to an organization can be given any role.
To add an existing user to an organization:
1. Click Account in the sidebar.
2. In the right pane, select the Organizations tab.
3. Click + Add User in the Users column of the organization to which you want to add a user.
Figure 61: Selecting to add a user to an organization
The Add User to Organization window appears
Page 79
79
Figure 62: Assigning a role to a user
4. In the Select User drop-down list, specify which user to add to the organization.
5. In the Select Role drop-down list, specify the user’s role in this organization.
Note... If the role assigned here is not identical to the role assigned to the user upon user creation, the system grants him permissions to the organization’s assets that correspond to the higher of the two roles.
Page 80
80 81
MANAGING USER GROUPS
Alert Groups
The main purpose of a user group is to dene alert groups – that is, dene which users will receive which threshold alerts.
The full process includes the following actions:
1. On the one hand, create a user, create a user group, and assign users to the group. Refer to Adding a User, Adding a User Group and Assigning a User to a Group.
2. On the other hand, set data stream thresholds and dene which
groups will receive alerts when the thresholds are exceeded. Refer to Conguring Data Stream Thresholds and Dening a Threshold’s Alert Recipients.
Site-sharing
A user group can also serve as a mechanism for sharing sites with any user. For a full description and instructions, refer to Sharing Sites with Any User.
Note... Only a user with an “Owner” role can manage user groups. An Account Owner can manage user groups in any organization, while an Organization Owner can manage the user groups in his organization.
Page 81
81
Adding a User Group
To create a user group:
1. Click Account in the sidebar.
2. In the right pane, select the User Groups tab.
3. Click + Add Group.
Figure 63: Selecting to add a user group
The Add New Group window appears.
Page 82
82 83
Figure 64: Add New Group window
4. In the Add New Group window:
a. Enter a group name.
b. Optionally enter a description.
c. In the Account Organization eld, specify which owners can
manage this group.
• Select No organization if you want this group to remain at the account level. In this case, only the account owner can manage the group.
• Select a specic organization if you want to associate this group with a specic organization. In this case, both the account owner and the specic organization’s owner can
manage the group.
Page 83
83
Note... If the group was created at the organization level, the group is automatically associated with that organization, and there is no option to
select a di󰀨erent organization.
5. Optionally, share sites which you can manage, with all users of this group, using the Assign Group Shared Site Permissions option. Refer to Sharing Sites with Any User.
6. Click Submit. The group is added to the groups table, as shown below.
Figure 65: Group successfully added
7. You can now assign users as group members. Refer to Assigning a
User to a Group.
Assigning a User to a Group
To assign a user to a group:
1. In the Account > User Groups tab, click Add User adjacent to the name of the group you created.
Figure 66: Selecting to add a user to a group
2. Select a user from the drop-down list. The list of users you can add includes only those users you can manage, so an organization owner can only select users from his organization. The list includes also the owner performing the Add User operation, thus an owner can add himself to the group he created.
Page 84
84 85
Note... A user can be a member of more than one group.
Removing a User from a Group
To remove a user from a group:
1. In the Account > User Groups tab, click the x to the right of the user name.
Figure 67: Selecting to remove a user from a group
2. Conrm the removal.
Editing a Group
1. In the Account > User Groups tab, click to the right of the group name.
Figure 68: Selecting to edit a group
2. In the Edit Group Properties window that appears, edit the group’s properties, as described in Adding a User Group.
Page 85
85
SHARING SITES AND ACCOUNTS
The Sper Scientic user interface provides several options for sharing
sites and accounts, with users who are not associated with those sites or accounts.
Sharing Sites with Any User
You can share any site that you can manage, even with users who are not members of the organization to which the site belongs. This option is available through the User Group mechanism. The sites you specify for sharing will be available in the Visualization and Reports windows, to all the members of the group.
To share organization(s)’ site(s):
1. Create a User Group, or edit an existing group, as follows:
a. Click Account in the sidebar.
b. In the right pane, select the User Groups tab.
c. Click + Add Group to dene a new group, or click to the right
of an existing group name. The Add New Group window or Edit Group Properties window appears.
Page 86
86 87
Figure 69: Edit Group Properties window
2. In the group denition window:
a. In the Assign Group Shared Sites Permissions section, select
from the drop-down list all the account’s sites you want to share with the members of the group.
b. You can click Select All if you wish to select all of the account’s
sites, or click Clear All to delete all the sites you selected.
c. Click Add Group or Update Group.
3. Assign to the group those users with whom you wish to share the
sites (refer to Assigning a User to a Group).
Page 87
87
Sharing an Account with any Sper Scientic User
An account owner can share the account with any Sper Scientic user, as well as dene that user’s role in the account.
Note... If you share an account with a user, that user cannot then share the account with others, even if you granted him Account Owner permissions.
To share an account with any Sper Scientic user:
1. Click Account in the sidebar.
2. Click the share icon
at the top of the right pane.
Figure 70: Share an Account
3. In the Account Sharing window that appears, click + Share.
Figure 71: Account Sharing window
A Share Account window appears.
Page 88
88 89
Figure 72: Share Account window
4. In the Share Account window:
a. Specify the user, by entering the user’s Ayyeka User Email.
b. Specify an account role for that user.
Page 89
89
SETTING PERSONAL PREFERENCES
The logged-in user can change most of his own user details, such as email, mobile phone, and password, as well as customize some user interface display settings.
Setting Your Own User Details
The logged-in user can change his own user details at any time. The Account > Users window will automatically be updated with the new settings.
To set your own user details:
1. At the bottom of the side bar, click the arrow to the right of your
login name.
2. Select Prole.
Figure 73: Selecting the Prole option
The Prole Details window appears.
Figure 74: Prole Details window
3. Click Edit Prole to edit your user details. The Edit Prole Details window appears.
Page 90
90 91
Figure 75: Edit Prole Details window
4. In the Edit Prole Details window you can:
a. Edit your actual rst name and last name in the Name elds.
Note that you cannot change your own login name.
b. Edit your Email address and/or your Mobile phone number.
Threshold alerts are sent to this address/mobile number (refer to Dening a Threshold’s Alert Recipients).
c. Specify a Time Zone.
5. Click Submit.
Changing your own password
The logged-in user can change his own password at any time.
To change your own password:
1. At the bottom of the side bar, click the arrow to the right of your
login name.
2. Select Prole.
Figure 76: Selecting the Prole option
3. In the Prole Details window that appears (Figure 74), click Edit Password.
Page 91
91
4. In the Update Password window that appears, enter the Old
Password (=current password), and enter and conrm the New Password.
Figure 77: Update Password window
5. Click Submit.
Customizing your User Interface Display
The logged-in user can customize his user interface display at any time. In addition, an Organization Owner and Account Owner can customize
the user interface display of the users they manage, unless a specic
user customizes his user interface display himself.
To customize your user interface display:
1. At the bottom of the side bar, click the arrow to the right of your
login name.
2. Select Preferences.
Figure 78: Selecting the Preferences option
The Preferences window appears.
Page 92
92 93
Figure 79: Preferences window
3. In the Site Marker Cluster Radius slider, specify the size of clusters of site markers in the Visualization map. Lower values dictate smaller clusters of site markers. You must refresh the
window for the change to take e󰀨ect.
4. In Sidebar, specify the default appearance of the sidebar when the UI is launched: Maximized or Minimized.
5. In the Date and Time Format elds, specify the format of all date
and time elds in the UI. Note that you can edit the format directly
in the window.
6. In Apply Default Settings to, specify to which users these default Preferences apply:
• User – The dened Preferences apply to yourself (the logged in user).
• Organization – The dened Preferences apply to each of the users of the organization(s) you can manage, unless a user set his own preferences.
• Account – The dened Preferences apply to each of the users of the
account(s) you can manage, unless a user’s organization owner set the organization’s preferences, or the user set his own preferences.
Therefore, the Preferences that the logged-in user sets, always override any other Preferences settings.
Page 93
93
MAINTENANCE
Raphael™ Battery Replacement
The Battery Status data stream displays a device’s current battery level, enabling you to prepare for battery replacement.
Replacement batteries can be ordered from Sper Scientic, part no. 870101.
Battery Replacement Instructions
1. Beware of static discharge, making sure to work in a clean environment and ensuring that your hands and the Raphael™ device are completely dry.
Place the Raphael™ device face down on a dry, stable surface with the connectors pointing downward.
2.
Partially unscrew the six (6) screws located on the back of the Raphael™
enclosure, until you can lift o󰀨 the
back panel with the screws still
a󰀩xed to their screw holes.
3.
Remove the Raphael’s™ back panel
and place it at-side down adjacent to
the Raphael™ box.
4.
On the interface board, move the ON/ OFF switch to the OFF position.
5.
Carefully disconnect the male end of the battery connector cable from the female connector on the interface board. Using an indelible pen, mark the battery as “Used” and dispose of it properly.
Page 94
94 95
6. Mark the new battery with the current date. Place the battery in the Raphael™ enclosure and carefully connect the male end of the battery connector cable to the female connector on the interface board.
Verify that the yellow, red and blue LED lights on the interface board blink
briey. This conrms that the battery
has been successfully connected.
7.
On the interface board, move the ON/OFF switch to the ON position. The Raphael™ device turns on and performs a 10-minute calibration process, after which it starts operating in normal mode.
8.
Replace the Raphael™ back panel, ensuring that the battery cable is neatly arranged and not pinched within the Raphael™ enclosure.
9.
Tighten the six (6) back panel screws until the Raphael™ is closed and sealed. Do not over-tighten as this will strip the screw threads.
The Raphael™ device is now ready to resume monitoring and transmission.
10.
In the Management user interface, select Devices in the sidebar, and select the device in the Sites Tree pane.
In the bottom part of the device information box, click the arrow in the drop-down Commands list, and select Reset Battery Status.
Page 95
95
TROUBLESHOOTING
Raphael™ device does not turn on
Problem: Magnetic activator does not turn the Raphael™ on
Recommended Actions:
1. Partially unscrew the six (6) screws located on the back of the Raphael™ enclosure (see Battery Replacement Instructions, step
2), until you can lift o󰀨 the back panel with the screws still a󰀩xed
to their screw holes.
2. Remove the Raphael’s™ back panel and place it at-side down
adjacent to the Raphael™ box.
3. On the interface board, move the ON/OFF switch to the ON position (see Battery Replacement Instructions, step 4). The Raphael™ device turns on and performs a 10-minute calibration process, after which it starts operating in normal mode
4. Replace the Raphael™ back panel, ensuring that the battery cable is neatly arranged and not pinched within the Raphael™ enclosure.
5. Tighten the six (6) back panel screws until the Raphael™ is closed and sealed. Do not over-tighten as this will strip the screw threads.
Technical Support – Contact Information
Address: Sper Scientic LTD.
8281 E. Evans Rd, Ste. 103 Scottsdale, Arizona 85260
Phone: (480) 948- 4448
Email: raphaelsupport@sperscientic.com
Internet: www.sperscientic.com | www.sperdirect.com
Page 96
96 97
FAQ
Is the Raphael™ activator unique per device?
The Raphael™ Activator is a magnet, and is identical for all Raphael™ devices, in all Raphael™ kits.
Why are updated GPS coordinates not appearing in the UI?
When the device reports new GPS coordinates to the server, it takes the server several minutes to complete the processing. Usually however, the
issue is the time it takes for the GPS coordinates to be detected in the eld.
Keep in mind that:
• The internal GPS antenna is located at the top of the device,
opposite the connectors panel. That side of the Raphael™ device needs a clear view of a patch of sky for about 5-10 minutes in order to pick up a GPS signal.
• Trees, buildings, roofs, etc. interfere with the GPS signal.
What is the recommended range for the device cellular signal?
The recommended range is -89 dBm and above. More specically:
Signal value in dBm Resultant signal quality
< = -100 very weak
between -99 and -90 weak
between -89 and -80 fair
between -79 and -65 good
> -64 excellent
Page 97
97
How can I change the destination server address?
If you must change the address of the server to which Raphael™ devices transmit their data, perform the following:
1. Click Device(s) in the sidebar,.
2. In the Sites Tree pane, select the device.
3. In the right pane, select the Conguration tab.
4. Click Advanced Device Conguration.
5. In the conguration tree, expand the GSM node.
6. Select the server_addr node.
7. To the right of the conguration tree, select the drop-down arrow
adjacent to the current value and Select Set Setting.
Figure 80: Changing the destination server address
8. In the Send New Value window (see Figure 26) that appears, enter the new server IP address or DNS name in the New Value eld, and click Submit.
Page 98
98 99
Why are device conguration changes not taking e󰀨ect?
Most of the settings available through Conguration > Advanced Device Conguration require a reboot in order to take e󰀨ect.
To reboot a device:
1. Click Devices in the sidebar, and select the device in the Sites Tree pane.
2. In the bottom part of the device information box, click the arrow in the drop-down Commands list, and select Reboot. Both the
conguration changes and the reboot will take e󰀨ect after the
device contacts the server.
Figure 81: Selecting to reboot a device
Page 99
99
SPECIFICATIONS
Raphael™ Specications
Data and Software
Data Architecture Sper Scientic private cloud and/or on-
premises server
Cyber Security AES-256 encryption
Sensor ngerprinting
One-Time Password (OTP)
Software Integration SOAP-API, REST-API
SCADA Integration OPC-UA, OPC-DA, OPC-HDA, DNP3, CSV
Sper Scientic User Interface
Web-based, Tablet, Mobile
Data Export Options CSV
Device Memory Up to 32 GB
Data Communication Bidirectional
Alarm Notication SMS & Email
Alarm Threshold Up to 8 per data stream
System Health Check Included
Power
Primary Power Supply
Field-replaceable internal military grade lithium battery, 3.9V DC 3A
Battery Capacity 32Ah
Voltage Input 4.5 V – 28 V
Operational Run Time 3,500+ transmissions per battery pack,
4+ years*
Battery Status
Notications
Included
External Power Solar and permanent power compatibility,
Automatic power source switching
* Assumes operation of one pressure sensor sampling once every
15 minutes and transmission once every 4 hours.
Page 100
100 101
Sensor Integration
Sensor Ports 3 ports: supports up to 10 sensors using distri-
bution cables
Sensor Position External hard-wired
Serial Interfaces RS485, SDI-12, RS232
Serial Protocols Modbus RTU, ASCII, Custom
Serial Channels Up to 15
Analog Channels Up to 4 (current loop, voltage)
Discrete Channels Up to 2
Sensor Power Supply Output
12 V, 350 mA
Connectivity
Communication Network
Multi-network carrier: 2G, 3G, LTE (4G), CDMA, LPWAN, Satellite, and Bluetooth low-energy
SIM Card Global SIM card and data plan included
Cellular Roaming Global SIM card supports over 110 countries
Conguration & Upgrades
Remotely over-the-air, USB PC connection
Data Transmission
Prole
Periodic, Data Dependent
Antenna Internal or external
Built-in GPS Included
Mechanical Enclosure*
Dimensions (W x H x D)
13.2 cm x 16.5 cm x 7.3 cm (5.2 in x 6.5 in x 2.9 in)
Weight 0.7 kg (1.5 lbs)
Enclosure Material Molded Polycarbonate
Waterproong Rating IP 68 / NEMA 6P
Hazardous Location Class I Div 1, ATEX certications (pending)
Operating Temperature Range
-20°C to +60°C (-4°F to +140°F)
Storage Temperature Range
-40°C to +80°C (-40°F to +176°F)
* Complies with: Radiated emission standards (ETSI EN 301 489-1/ -17
Class B and CFR 47 FCC Part 15 Subpart B Class B), Immunity per ETSI EN 301 .
Loading...
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use