Introduction to the AquaControl Web Application

Introduction

The AquaControl Web Application is the primary user interface for the Aquana Water IoT Platform.  It provides the ability to manage, configure, and control devices, setup operating rules, view and manage device alerts and notifications, and oversee user administration.  This article is meant to provide a high level introduction to the structure and function of AquaControl Web.  

General Navigation

Navigation from the initial dashboard can be done by using 4 features:  Top Navigation bar, Search bar, and Location Selector. If you are invited to more than one platform account, you can use the Platform Account Selector to toggle between accounts.

Each platform account is designed using a hierarchy of Locations, 2 levels are possible underneath the top level.  Each Location level contains an identical Dashboard that displays all of the information for that Location as well as any Locations underneath.  The "top-level" of the account is not intended for Device activation, it is intended to provide a top level summary of all Locations found in the account.  In typical Utility applications, there will be one level of Locations under the top level that consists of service addresses, but could also include "zones" with service addresses underneath.  For Real Estate applications, there are often Building Numbers or Floors, with Apartment Locations underneath.  

If you are invited into more than one Platform Account, the button displaying the Platform Account name at the very top of the interface can be clicked to select other Platform Accounts.

The top navigation bar consists of:  Dashboard, Devices, Maps, Reports, and Settings. 

Your user profile is accessible by clicking on your username in the upper right of the screen.

Using the top Search bar, you can enter keywords or numbers such as Location name, Device name, Serial Number to find Locations and Devices within the platform.  The search results will display the top five results from each category.  If there are more results, remember to click "view more" next to the category heading. 

The Location Selector icon in the upper left corner of the top navigation bar allows you to select specific Locations within the Platform Account.  Use the search filter within the Location Selector to filter for keywords and numbers if you have a lot of Locations.  

Dashboard

Upon logging in, you will see the top level “Dashboard”, which has an overall summary of the Locations and Devices in your Platform Account.  

The Summary section shows a summary of Devices and Alerts in that Location and underneath.  At each level, the Location Dashboard allows you to click and view in the Devices screen or on the Map.  Either all devices in that location, or ones with specific conditions like all open valves, all devices with pending commands, or all devices with certain alert conditions. 

The Alerts Timeline is a visual representation of Alerts over time. Click on the dots to view the device details.  You can also choose what alerts you want to view as well as the time range displayed.

If you are using water meters you will see a water graph next. The graph defaults to the last 24 hours, showing usage that matches the "meter read interval" configured for your devices.  As you zoom out in time, the plot points change to hourly or daily depending on the zoom level.

At the top level Dashboard, next comes the Activity logs.  This is the last section on the Dashboard.  This is where you can view historical device activity that includes Alerts, Commands, Check-ins and Meter Readings (if you are using water meters). 

The Commands log will display all commands created by User, along with 3 timestamps. The top timestamp is when the command is scheduled, the middle is when the command will be sent to the device based on it's next expected check-in, and the bottom is when the device completed and acknowledged completion of the command.  For Cloud commands over the wide area network (LoRaWAN or LTE-M), these times will all be different.  For local bluetooth commands, all of the times will be the same because you are connected directly to the device controlling it in real time.  

Just above the Activity log, as you navigate below the top level Location to Locations underneath that contain active Devices, you will see a section called "Devices in this Location" with "Device Cards" that represent the physical devices found in that specific Location.

Clicking on a Device Card will bring you to the Device Details screen for that Device.  If you are viewing a Smart Valve, you can control the valve by clicking the "Valve Control" button in the upper left of the screen.  The information panel provides details about the devices configuration and history.  Clicking on the gear icon will allow you to update settings if you have permission to do so.  Each Device Details screen has similar Activity feeds to the Dashboard, but only for the device you selected.

This is a Dashboard for a Platform Account that uses no water meters will not contain meter related graphs or summaries:

This is a Dashboard for a Platform Account that uses water meters will contain meter related graphs and summaries:

Devices 

Clicking on “Devices” from the top navigation bar brings you to a list of devices and their locations within the platform account.  Device status is shown, with additional columns available by clicking the top right icon. You can sort the list by clicking on the column you wish to sort by.  The list can also be exported as XLSX, PDF, or CSV. 

Clicking on a Location name will bring you to that Location's Dashboard.  This dashboard is where all device management functions are located.  Clicking on a serial number will bring you to the Device Details screen for that Device.

Devices can be managed individually through the Device Details screen, or in batches by clicking on the "Batch Control" button at the top right of the Devices screen.  

Batch Control

When you first click the Batch Control button, you will be taken to a screen that displays a history of batch commands.  These operate similarly to the Activity > Commands screen.  It displays each device configured in the batch along with the command status and timestamps for that device. 

Clicking "Create Batch Command" takes you to the batch configuration screen. 

1. Command to be sent:  Here is where you would choose the command you want to send to all devices that you choose to add to the batch list.  This is also where you would choose to send a  Check-In Boost to the devices.  This feature is primarily used for LTE-M cellular devices on a 8 or 12 hour check-in interval in order to reduce latency for the reconnect or OPEN command execution after a non payment disconnect has occurred.  The Boost would be sent to the devices along with a Closed command.  Then the device will accelerate it's check-in interval for a certain duration of time, and then return to it's regular check-in interval after that duration.  Check-In Boost setting are configured by your Aquana Support Team during account onboarding.  

2. When to send it:  you can choose to either send the command at the next expected check-in time for the device, or schedule it for a future time.  

3. Select target locations and devices: this is where you create your batch list by selecting the locations and devices for the command.  

Or retarget a resent batch:  This option allows you to choose from a previous batch, please check all steps to make sure the command, timing, and target locations are correct before submitting the batch.

4. Confirm selected devices and current position: this section displays a summary of the devices you selected in step 3, and shows you the current valve position of the device as well.  Deselect any devices that you do not want included in the batch.

Create Command: once you click this button, the commands will be queued for all devices, waiting the target time.  Any batch can be cancelled within the Batch Control history screen.

Map

The AquaControl platform supports the process of geolocating devices within your Platform Account. This is an optional configuration activity.  If your devices have been geolocated, selecting "Map" brings up the Map of Devices screen which displays a satellite image with device locations superimposed on it.  The color of the dot indicates whether the valve is OPEN (green dot), CLOSED (red dot), or REDUCED (yellow dot).  If the dot has a red circle around it, this indicates an active alert condition.  Clicking on a dot will bring up a mini Dashboard for those devices.  From here you can select a device and go to the Device Details screen to further manage the device functions and access specific data about the device.

Reports

Selecting "Reports" brings up a list of pre-configured reports that will show multiple aspects of device status and activity.

Settings

"Settings" brings you to the core function of AquaControl Web application where Platform Account setup, device setup and configuration, alert parameters, and user administration are all accomplished.  These will be explained as follows:

• Rules & Notifications

  • At this time, most rules will alert and resolve on their own.  For alerts that have not resolved, there is currently no way to dismiss or suppress the alert condition until it resolves.  
  • Only the Aquana Support Team can edit, enable, and disable rules.  Please submit a support ticket if you wish to change any Rule settings.
  • All Administrator Users in the Account can manage notification settings.  By clicking on the gear icon next to the rule, Administrators can manage the Notification List by choosing which User should receive an email or SMS for a given Rule.
  • All Administrator Users in the Account can manage Rule target location settings.  By clicking on the gear icon next to the rule, Administrators can manage the "Locations where Rule is Enabled" by choosing which Locations the Rule should apply to. 
    • NOTE: By default, a Rule is applied to all Locations underneath the top-level account Location.
  • During account onboarding the Aquana Support Team will review the rules & alerts we typically suggest.  The rules enabled depend upon the devices you are using and their application.  This is a list of available Rules:
    • Completed Commands:  Every time a device completes a command, this rule will log the event in the Activity > Alerts log, and send notifications if configured to do so.
    • Missed Check-ins:  This rule will trigger an alert if a devices missed its regularly scheduled check-in time.  Next time the device checks-in, it will trigger a "resolved" alert indicating that the alert is no longer active.
    • Missed Command Response:  When a command is sent to the device, the device should process that command and send an response back to AquaControl that it has been completed.  There are certain conditions where either a command is not received by the device, or the response is unable to reach AquaControl.  In each of these cases, the device will display a Missed Command Response alert.  The next time the device checks in, if it did receive and process the command, the alert should resolve.  If it did not receive the command at all, it will not resolve and the command should be resent manually by the User. 
    • Constant Flow (Leak): 
      • This Rule does not manage the thresholds of the algorithm running on the device, but it does manage the Notifications sent should this alert be communicated by the device.    
      • DEVICE CONFIGURATION NOTE:  the device algorithm thresholds are managed within the Meter Device Details settings.  The primary threshold for Constant Flow is "Duration".  How long should a constant flow condition be present before triggering an alert.  Many water meter companies use 24hours, assuming that someone will stop using water within a 24hour period.  Our algorithm is configurable in order to reduce the amount of time required.  Our algorithm is also able to check this condition in immediately, outside of it's regular check-in cadence, and/or close the valve automatically.  
    • High Flow (Burst): 
      • This Rule does not manage the thresholds of the algorithm running on the device, but it does manage the Notifications sent should this alert be communicated by the device.    
      • DEVICE CONFIGURATION NOTE:  the device algorithm thresholds are managed within the Meter Device Details settings.  The primary thresholds for High Flow are "Amount of Flow" and "Duration of Flow".  For example, if 120 gallons of water are used in a 30 minute timeframe, an alert will be triggered.  Our algorithm is also able to check this condition in immediately, outside of it's regular check-in cadence, and/or close the valve automatically.
    • Smart Valve Reboot Alert:  Every time a device restarts for any reason in the field, the device will automatically check-in and report that it has been rebooted.  
    • Battery Level:  When a device reaches a certain battery level threshold, an alert will be triggered. 
    • Ambient Temperature:  When a device detects ambient temperate below a certain threshold, an alert will be triggered.
    • Periodic Sediment Turn:  In order to ensure that a valve is operational for its lifetime, we automatically perform a Sediment Turn, which is a 180º turn from Open to Open or Reduced to Reduced in order to remove any mineral buildup that may have occurred.  We do not perform sediment turns when the valve is in a Closed position in case there are fixtures open downstream of the valve.  Our default is to perform this turn every 3 months.  We can target a time of day for it to occur as well, by default this is 2am.  If your water is heavy with minerals, we can accelerate this interval.  If you would prefer for the turn to happen during the day, we can change the target time.  All of this can be done during account onboarding or by submitting a support ticket.
    • Water Sensors:  If you are using standalone water sensors we have provided, when the alert is received we can perform 2 actions: Send notifications and/or send a Close command to the valve(s) within the same Location as the water sensor.
•  Users
  • Only Administrator Users can add, edit, or remove Users.
  • The Users landing page shows all Users currently invited into the account, along with their Security Group permission level.
  • Permission levels include:
    • Owner - the owner is the top-level Administrator of an account, only other owners can add, edit or remove Owners. We don't typically use this Group due to this requirement.
    • Administrator - the administrator can do everything in the account.
    • Billing Operator - can control devices and read reports
    • Installer - can manage, configure and control devices and locations
    • Reader - these users have Read Only permission and are unable to send commands or make any configuration changes.
• Location Editor: 
  • Only Administrators and Installers can manage Locations
  • ACTIVATION NOTE: New Locations can be created during the Device Activation process using the Aquana Mobile app for the device being activated.  This screen is useful if you'd like to set up Locations prior to installation, so your installer can activate devices within existing Locations.
  • This screen allows Users with permission to add, edit, or remove Locations.
  • Add new Locations to "parent" locations by clicking on the plus icon next to the parent Location.   Name the Location and include an "External ID" if desired, such as a billing ID.  Additionally, if you'd like to create multiple locations at once, using a standard naming convention with an incrementing suffix number, you can edit the "Locations to add" number. 
  • Clicking the pencil icon next to the Location name allows you to edit the name of the Location, add an External ID, or delete the Location.  You cannot delete Locations that contain Devices.  Please reach out to the Aquana Product Support Team if you'd like to delete or move a Device.  
• New Device Activation Settings
  • Only Administrators can manage New Device Activation Settings
  • This screen allows you to populate the device settings that will be used when Devices are activated using Aquana Mobile.  Please reach out to the Aquana Product Support Team for guidance before modifying your defaults.  These can have a significant effect on the Device's battery life and performance.
• Account Settings
  • Only Administrators can manage Account Settings
  • This screen captures general account information as well as how the platform account displays time based on timezone, water consumption unit of measure, and temperature unit of measure.  Example: Central Timezone, US. Gallons, Fahrenheit.  
  • If you are billing for water, your billing cycle start date and custom billing ID can be configured here.
  • Check-In Boost default settings are governed here so that your Users are not able to edit them in Valve Control or Batch Control.  This setting is critical in terms of its impact on battery life.  The Aquana Product Support Team should discuss this with you during onboarding to establish the appropriate settings that will not invalidate your battery warranty.  Please reach out to the Support Team if you wish to change these settings so we can provide guidance.