Aquantify

Help updated for Aquantify v3.2.0.254

Dashboard widgets

Add widgets from Dashboard > Configure. Open a widget’s Settings to select its source and presentation. Arrange and resize the widgets, then save the dashboard.

Choose a widget

Open the configuration guide for your widget:

WidgetPurpose and setup
ComplianceShows compliance information grouped by the configured parameter custom attribute. Select the attribute and a meaningful title.
Date rangeProvides a date selector for other widgets. Set its label and context field; the default field is dateRange.
Latest resultShows a recent measurement for the configured parameter and location context. Check its date and unit alongside the value.
Results chartPlots results from a saved source filter. Choose that filter, the number of results to take and the colour.
ChartDisplays a saved chart with a chosen period. Use saved chart management to prepare its pinned series first.
Results importedSummarises result-import activity for the configured scope.
MapDisplays locations and query-derived information on a map. Configure the location and result-query settings for the intended data.
TableDisplays the output of a SELECT query. Set a title, polling interval and any bindings to dashboard selectors.
Custom attributeProvides selections based on an entity’s custom attribute. Choose the entity type, attribute, label and context field.
HeadingAdds text to identify sections and explain the dashboard’s purpose.

Link a date selector to a table

For example, a monitoring dashboard can show a date selector above a results table. Give the Date range widget the context field dateRange. In the table, bind the query’s parameters to the selector:

fromDate=dateRange.min
toDate=dateRange.max

The SQL parameters are @fromDate and @toDate. Use a query prepared for the required Aquantify dataset and its date-boundary rules. The parameter name on the left must match the SQL; the context path on the right must match the selector.

Table widget settings identifying SELECT query, parameter bindings and Save
A table connects query parameters to dashboard context through one binding per line.

Configure a date selector

  1. Add Date range and open the widget’s Settings.
  2. Set the visible Label and its Field name, for example dateRange.
  3. Save the widget settings, then save the dashboard through Configure.
Date range widget settings with Label, Field name and final Save
Field name identifies the selector’s dashboard context; Label is the text people see.

The date selector initially uses This month when no saved range is available. Changing the range updates its context value. A receiving Table or Map widget must bind its SQL parameters to that value, such as dateRange.min and dateRange.max.

Configure Latest result

  1. Add Latest result, point at the widget to reveal its toolbar, and open Settings.
  2. Enter a Title, then choose Parameter and Sample point.
  3. Choose an Organisation to restrict the result source, or None to leave it unrestricted by organisation.
  4. Select a compatible UOM where offered. Changing Parameter clears the previous unit choice, so review it again.
  5. Save the settings and the dashboard. Check the displayed value, unit, date and organisation.
Latest result settings identifying parameter, location, organisation, compatible unit and final Save
Each Latest result widget represents the fixed measurement and location configured here.

For example, use a title such as “Inlet chlorine”, choose the chlorine parameter and inlet sample point, and select its compatible unit. A latest reading may be older than today: read its date before interpreting it. Use Refresh to request it again.

Configure Compliance

  1. Add Compliance and open its Settings.
  2. Enter Title and choose the Parameter custom attribute used to group measurements.
  3. Set Take days to a positive number, such as 30 for the example period.
  4. Save the settings and the dashboard, then review the displayed groups and percentages.
Compliance settings showing title, parameter custom attribute, Take days and final Save
The grouping attribute and Take days define the view; the date-selector widget does not replace these choices.

Populate the chosen attribute on the relevant parameters first. If expected groups are absent, review those attribute values and the results available in the selected number of days. Use Refresh where offered. An empty widget does not establish full compliance.

Configure a custom-attribute selector

  1. Add Custom attribute and open Settings.
  2. Select Entity, then its Attribute.
  3. Enter a visible Label and a distinct Context parameter name, for example siteClasses.
  4. Save the settings and the dashboard. Configure receiving queries to use that context name.
Custom attribute selector settings with entity, attribute, label, context parameter name and final Save
Choose the attribute on the appropriate entity; its context name connects the selector to query widgets.

A lookup attribute offers its defined choices and stores the selected lookup IDs. A non-lookup attribute accepts comma-separated values. Both supply a list of values. The receiving query must be written to handle that list and its empty-selection case.

classes=siteClasses

This binding connects SQL parameter @classes to the selector named siteClasses. A query expecting lookup names will not receive those names when the selector supplies IDs. Use different context names for selectors that should act independently.

Configure Map

FieldWhat to enter
TitleA name explaining the map’s purpose.
Mapbox tokenThe map token supplied for this deployment.
Dark style / Light styleThe style used for each application theme. Review both even when configuring in light mode.
Polling interval (seconds)A value greater than 10; the initial value is 60.
Cluster max zoomThe highest zoom where points are clustered. Above it, points appear individually.
Cluster radiusThe grouping distance in screen pixels. Increasing it merges points farther apart.
SQL (SELECT only)A query returning latitude, longitude, value and optionally label.
Parameter bindingsOne SqlParameterName=contextField binding per line, as with Table.
Map settings identifying token and styles, polling and clustering, SELECT query, parameter bindings and final Save
The coordinate columns locate the query rows; bindings connect their scope to dashboard selectors.

Have the reporting administrator prepare the query for the intended dataset. For a date-aware map, use the same fromDate=dateRange.min and toDate=dateRange.max bindings as the table example, with matching SQL parameters. Review coordinate columns, values and labels before saving settings and the dashboard.

Other widget settings

WidgetConfiguration steps
TableSet Title, Polling interval (greater than 10 seconds), SELECT query and Parameter bindings. Save the widget and dashboard. The date-binding example above shows the connection.
Results chartPrepare a saved Tasks filter, choose it under Source filter, enter a positive Take results count and choose Colour. Recent searches are not listed as saved sources.
ChartChoose a saved Chart, Title and Period. Use Manage saved charts to prepare the pinned series.
Results importedSet Title, Polling interval (greater than 10 seconds) and a positive Take last (hours), then tick at least one organisation. This widget’s window is its own hours setting.
HeadingEnter Text or paste formatted text from Word into the editor. Save the widget and dashboard; use headings to explain the surrounding data.

Within a widget editor, Cancel discards its changes and Remove removes the widget after confirmation. Save the dashboard through Configure > Save to retain widget settings, additions, removals and layout changes.

Check the displayed data

  1. Choose a period or attribute value and check which widgets are configured to follow it.
  2. Review parameter, sample point, organisation and unit where shown.
  3. Use Refresh where available, or allow the configured polling interval to elapse.
  4. If a widget is empty, check its saved source, selector bindings, date range and access permissions.

A blank table or map can mean that its query returned no matching records. It does not prove that no results exist elsewhere. For a comparison, open the relevant browser with the same scope.

Browse or search all help topics →