Aqualus Water permission areas reference

Aqualus Water permission areas reference

Aqualus Water permission areas reference

This page is the detailed companion to Manage Roles. It explains what each of the 13 permission areas in Aqualus Water actually controls, what the access levels mean, and which functions each area covers.

The role groups feature in 10.1.13.13 changed how permissions are assigned to a user (a single named role group instead of setting each area individually). The underlying permission areas, the access levels, and the functions they govern are unchanged. Use this page when you need to know what a permission area does, or when you are deciding what level to set for a custom role.

Permission levels

Each permission area uses a numeric access scale, starting at 0 (no access) and running up to a maximum of 4. Not every area uses every level. The per-area sections below show which levels apply for each function. Each level grants a set of accesses, shown in the role permission matrix using the icons below.

Icon

Access

Meaning

Icon

Access

Meaning

No Access

The user cannot see or use the function.

🅡

Read-Only (View)

The user can open and view the function but cannot change anything.

🅲

Create Only

The user can create new records but cannot edit or delete existing records.

🅼

Create & Modify

The user can create new records and edit existing records. Cannot delete.

🆆

Create, Modify & Delete

Full write access, including deletion.

🅘

Import

The user can import data into this function (for example, from a CSV file).

🅔

Export

The user can export data from this function.

Level 0 is always No Access. Level 1 is the lowest functional level. The combination of icons in each cell of the matrix shows exactly what that level grants for that specific function.

There are two general rules to set before any of the area-specific levels make sense:

  1. generalUserLevel must be set to 1 for any user who needs to use the portal. Without this, no other permissions take effect.

  2. To grant system administration privileges, set publicSystemConfiguration as described under that area's section below.

Permission areas at a glance

Area

Plain-English summary

Where it lives in the application

Area

Plain-English summary

Where it lives in the application

adviceUserLevel

Management of water meter and AMR advices, including manual advices, advices created through file uploads, and management of exceptions and errors in file uploads.

AMR Management → AMR Configuration

dataManagement

Management of data within Aqualus, specifically raw pulseCount files and other related files, exception management, and quarantine management.

AMR Management → AMR Data Management

dmaUser

Reporting and management of District Metered Areas (DMAs).

Network Management → District Metered Areas (DMAs)

personalInformation

Global permission area. Controls whether a user can see customer personal information (owner names, phone numbers, email and postal addresses) anywhere in the application. Without it, the user sees an Access Denied screen on data containing PII.

Applies across the whole application

mobileUser

The ability to use a mobile device that has the Aqualus management application installed (Field Engineers with tablets need this). Also required for Billing staff to access the Meter Read File Export.

Global. Permissions managed on the server, cascade to devices on sync

notificationLevel

Viewing and creating user notifications of different types (individual, batch) including file notes.

System Configuration → Notifications, and the Property Dashboard

pmnUser

Reporting and management of Private Metered Networks (PMNs).

Network Management → Private Metered Networks (PMNs)

generalUserLevel

Global on/off switch for portal access. Must be set to 1 for the user to log in.

Global

publicUserManagement (Customer Portal)

Management of public user accounts in the Aqualus Customer Portal.

Public User Management

publicUserRegistrations (Customer Portal)

Management of public user registrations (the association of user accounts to an assessment).

Public User Registrations

publicUserShadow (Customer Portal)

The ability for a staff user to shadow a public user's account for troubleshooting. The staff user assumes the public user's identity, including any TENANT, AGENT and PMN roles assigned to that public user.

Public System (Customer Portal)

publicSystemConfiguration (Customer Portal)

Modification of user-configurable elements that appear on the Customer Portal public website (water tips, banners, welcome page content, panel content). Also gates system administration privileges in the staff portal.

Public System (Customer Portal)

systemAdministrator

High-level management of Aqualus, including user management, system list configuration, and system customisation.

System Configuration, User Management

Detail by permission area

The following sections list every function covered by each permission area, the underlying script that serves the function (useful when raising a support case), and a one-line note on what the access levels grant. For the granular icon-by-icon detail of every level, refer to the source matrices attached to this page.

adviceUserLevel

Domain: AMR Management → AMR Configuration

Function

Script

Function

Script

Meter and AMR Advice Processing

ManageAMRs/frmManualMeterMAC.aspx

Upload Meter and AMR Advice Spreadsheet (Deprecated)

ManageAMRs/frmUploadAdvice.aspx

Meter Advice Search

ManageAMRs/frmAdviceSearch.aspx

Export AMR MACs to CSV File for Taggle

ManageAMRs/frmExportAMRMACs.aspx

SkillTech Replacement or Taggle CSV File Upload (Deprecated)

ManageAMRs/frmUploadTaggleOrReplacement.aspx

Meter and AMR File Processing

ManageAMRs/frmMeterAMRProcessing.aspx

Meter and AMR File Processing - Unprocessed Exceptions

ManageAMRs/frmMeterAMRExceptions.aspx

Levels 0–3 are in active use. Level 1 grants View on most functions. Level 2 adds Create where applicable. Level 3 adds Modify (and Delete on a few). Levels 2 and 3 are highlighted in the source matrix as the typical settings for an Advice Officer.

Constraint on flagging a meter for investigation: a meter cannot be flagged for investigation unless it has an AMR attached. The flag option is hidden in the UI for any meter without an AMR. This applies to Meter and AMR Advice Processing regardless of the user's adviceUserLevel value.

dataManagement

Domain: AMR Management → AMR Data Management

Function

Script

Function

Script

Upload AMR Pulse Readings

ManageAMRs/frmUploadPulseReadings.aspx

Readings Exception Management (Individual Processing)

ManageAMRs/frmExceptionManagement.aspx

Readings Exception Management (Batch Processing)

ManageAMRs/frmExceptionManagement.aspx

AMR Quarantine Processing (Individual Processing)

ManageAMRs/frmQuarantineManagement.aspx

AMR Quarantine Processing (Batch Processing)

ManageAMRs/frmQuarantineManagement.aspx

Levels 0–2 cover the practical cases. Level 1 grants View. Level 2 adds Create / Modify (and Import on Upload AMR Pulse Readings).

dmaUser

Domain: Network Management → District Metered Areas (DMAs)

Function

Script

Function

Script

Manage DMAs

ManageNetwork/frmManageDMAs.aspx

DMA Dashboard

ManageNetwork/frmDMADashboard.aspx

Assign Meters to Network

ManageNetwork/frmBulkMeterAssignment.aspx

Assign Assessments to Network

ManageNetwork/frmBulkAssessmentAssignment.aspx

Manage Automatic Assessment Rules

ManageNetwork/frmManageAutoAssessmentRules.aspx

Run Rules Now

ManageNetwork/frmDMADashboard.aspx

DMA Consumption Report

ManageNetwork/frmDMAConsumptionReport.aspx

Manage Network Meters and Supplies

ManageNetwork/frmManageNetworkMetersSupplies.aspx

DMA Summary Report

ManageNetwork/frmDMASummaryReport.aspx

Levels 0–3 in use. Reports gain Export at higher levels.

personalInformation

Global. Applies across the whole application.

Function

Script

Function

Script

All Reports

NA

All Report Data Extracts

NA

All Dashboards

NA

All Customer Notifications

NA

Level 0 = no PII visible (Access Denied screen on any data containing customer personal information). Level 1 = PII visible. Level 2 and above are reserved.

mobileUser

Global. Server-side configuration that cascades to mobile devices on sync.

Function

Script

Function

Script

Can use the Aqualus Mobile Application

NA

Mobile Device Management

Maintenance/frmDeviceManagement.aspx

Mobile Batch Management

Maintenance/frmUploadBatch.aspx

Levels 0–3 in use. Level 2 and 3 are the typical Field Engineer settings.

Also required for Billing staff. Access to the Meter Read File Export is gated by mobileUser, so any user who needs to generate or download Meter Read File Exports must have this permission set even if they never use the mobile application. This is the most common reason a Billing Officer is unable to produce a Meter Read File and is worth checking first when a user reports the export is missing or greyed out.

notificationLevel

Domains: System Configuration, Property Dashboard

Function

Script

Function

Script

Bulk Customer Notification Upload

Maintenance/frmUploadNotifications.aspx

Notification Report

Maintenance/frmNotificationReport.aspx

Record Notification (Notes Only)

Maintenance/frmRecordNotification.aspx

Record Notification (All Types)

Maintenance/frmRecordNotification.aspx

Levels 2 and 3 are the typical operational settings (Create / Modify, with Import / Export on the report).

pmnUser

Domain: Network Management → Private Metered Networks (PMNs)

Function

Script

Function

Script

Manage Private Metered Networks

ManageNetwork/frmManagePMNs.aspx

PMN Dashboard

ManageNetwork/frmNetworkDashboard.aspx

Manage Supply Meter Associations

ManageNetwork/frmManageMeterAssociations.aspx

Manage Private Meter Associations

ManageNetwork/frmManageMeterAssociations.aspx

Detailed Private Meter Report

ManageNetwork/frmDetailedPMN.aspx

PMN Consumption Report

ManageNetwork/frmConsumptionReport.aspx

Levels 0–2 in active use. Reports gain Export at level 2.

generalUserLevel

Global. The on/off switch.

Set to 1 for any user who needs portal access. Without this, no other permissions take effect. There is no permission matrix for this area; it is binary.

systemAdministrator

Domains: System Configuration, User Management

Function

Script

Function

Script

Manage System Constants

Maintenance/frmManageConstants.aspx

Manage System Lists

Maintenance/frmManageLists.aspx

Manage System Appearance

(newer function, no separate script reference)

Change Your Password

Maintenance/frmChangePassword.aspx

Manage Users and Roles

Maintenance/frmManageUsers.aspx

Change Your Password is available from level 0 onwards (everyone can change their own password). All other functions require level 1 or above.

Aqualus Customer Portal access

The four areas below cover the Customer Portal. Permissions in this section apply to staff users who manage the public-facing portal, not to the public users themselves.

publicUserManagement (Customer Portal)

Domain: Public User Management

Function

Script

Function

Script

Management of User Accounts

NA

Public User Password Reset

NA

Public user activity report (Audit Trail)

NA

Levels 0–3 in use.

publicUserRegistrations (Customer Portal)

Domain: Public User Registrations

Function

Script

Function

Script

Moderating of User Registration Requests

NA

Management of User Registrations

NA

User Registration Associations (Dashboard Panel)

NA

Levels 0–3 in use.

publicUserShadow (Customer Portal)

Domain: Public System

Function

Script

Function

Script

Public User Home Dashboard

NA

Manage Registrations (Self)

NA

Property Summary - Dashboard

NA

Property Profile

NA

Alerts and Reports

NA

PMNs

NA

When a staff user shadows a public user, the staff user's effective permissions are the public user's, including any TENANT, AGENT and PMN roles attached to that public user.

publicSystemConfiguration (Customer Portal)

Domain: Public System

Function

Script

Function

Script

Manage Welcome Page Content

NA

Manage Banners

NA

Manage Banner Layout

NA

Manage Water Tips

NA

Manage Service Outages

NA

Manage Panel Titles

NA

Manage Panel Content

NA

Levels 0–2 in use.

Related pages