User Manual

1What CloudWorks Online is

CloudWorks Online is a browser front-end for a CloudWorks server. It talks directly to the server's Integration API over HTTPS, so everything you see — device status, datalogs, alarms, users — is read live from your own CloudWorks database. Nothing is stored anywhere else.

To use it you need three things from whoever runs your CloudWorks server: the server host name, the HTTPS port, and an API key. New users usually receive these in their welcome email as a connection link (see section 2), together with a user code and password.

The console works in any modern desktop or mobile browser. A light and a dark theme are built in — switch between them with the sun/moon button on the top bar.

2Connecting to your server

Using a connection link

If your welcome or password email contains a connection link, just open it. The link fills in the server host, port and API key silently and takes you straight to the sign-in screen with the message "Connection configured — sign in to continue." You never need to see or type the key.

Entering the details by hand

1. Click the gear button on the top bar to open Connection settings.
2. Fill in Server host, HTTPS port and API key.
3. Click Test to check the connection, then Save.

The settings are kept in your browser, so you only enter them once per device.

3Signing in

Enter your user code and password and press Sign in. Zone, site and device users also enter the access code they were given, which scopes what they can see.

A brand-new system

If no administrator has been captured in the database yet, the sign-in screen shows a message below the button: "No administrator has been captured yet — just press Sign in to continue." Pressing Sign in with the fields left blank signs you in as Default Admin with full rights. Once you create a real Administrator account, normal credentials are required.

Forgot password

Click Forgot password? under the Sign in button and enter your email address. If the address belongs to exactly one user, a new password is generated and emailed to it.

Changing your own password

While signed in, click the key button on the top bar, enter your current password and the new one twice, and save. Every user can do this for their own account.

4Finding your way around

The top bar shows the server you are connected to, the refresh, theme, settings, change-password and sign-out buttons, and your name and role. The sidebar is the main navigation:

• Dashboard — the whole estate at a glance.
• Comms analyser — the communications register and link-quality graphs (section 7).
• Users — user management; shown to Administrators and Supervisors.
• Zones — a collapsible tree of every zone and its sites, with device counts. Zones start collapsed; click the arrow beside a zone to show its sites, or click the zone name to open it. A red dot marks a zone or site with an active alarm.

Device status is shown the same way everywhere: Online for a logger currently connected, Sleep for a battery logger between wakeups, and Alarm when the device has raised an alarm.

5Zones, sites and devices

The estate is organised as zones (for example a region or customer) containing sites (a physical location, with its own time zone) containing devices (the loggers). All device timestamps are shown in the site's local time.

Building the estate

• Add a zone — the + button next to "Zones" in the sidebar. On a brand-new database the dashboard also offers a Create a zone button.
• Add a site — open a zone and click + Add site. Pick the site's time zone from the standard Windows time-zone list; the server uses it for time correction.
• Add a device — open a site and add the device by its code (the serial number). Its details populate when it first connects.

Editing and deleting are on the same pages. Deleting a site or zone also deletes everything in it, including datalog history — the confirmation dialog states exactly what will be removed and asks you to type the code to confirm.

The map

Devices with coordinates can be shown on an OpenStreetMap view. Markers are coloured by status; clicking one opens a detail bubble with the device code, hardware, application, comms and alarm status, last seen, datalog and wakeup periods, GSM signal and power mode, plus a link to the device page.

6Device pages

Click any device to open its page. At the top are the key readings for its application — level, flow, consumption, moisture, whatever the application provides — followed by charts and the raw data table.

• Time range — chips for 24 hours, 48 hours, 7 days and 30 days set the window for every chart and the table.
• Charts — ordered with consumption first, then flow, pressure and other instantaneous readings, with loop readings last.
• Data table — the newest records in the range, expandable at the bottom of the page.
• Alarms — an active alarm shows as a banner with the alarm message; managers get a Clear alarm button, and the page refreshes as soon as it is cleared.

Fuel sensors (application 044) additionally show a fuel tank graphic beside the readings: the fill height follows the measured level percentage, with the current volume and level next to it.

The Manage menu

For Administrators and Supervisors, the Manage ▾ button on a device page opens the device operations:

• Configure logger… — the remote configuration screen (section 10).
• Move to another site… and Replace hardware… — re-home a device or swap a failed unit onto a new device code while keeping its site, configuration and history.
• Flag configuration reload / Cancel configuration reload — ask the server to re-read the logger's stored settings into the database at its next contact.
• Send remote command… (online loggers) or Queue script command… (sleeping loggers) — issue a raw logger command.
• Delete datalog range… and Delete device… — destructive operations, each with a typed confirmation.

7Comms analyser

Comms analyser lists every device with its current comms state, last-seen time and link details. Click a row to open the communications analyser for that device: roughly the last 24 hours in 10-minute periods, shown as a full-width Packets graph, a full-width Dropped packets graph below it, and Average latency and Average signal side by side beneath those. Use it to judge link quality and spot when a device last spoke.

8Users and roles

The Users page (Administrators and Supervisors) lists all accounts and is where users are created, edited and removed. Every user needs a unique email address — it is where password resets are sent.

A user's password can be reset from their edit dialog (a new password is emailed to them), and every user can change their own password from the top bar (section 3).

9Tank tables

Tank applications convert a measured level into a volume through a tank table — a list of level/volume pairs. On a tank device the Tank calibration panel shows how many entries the device has and opens the editor.

The tank table editor

• Generate from a shape — pick the tank shape (rectangular, cylindrical, spherical and capsule variants, each shown as a drawing), enter its dimensions and generate a full table in 1 mm steps.
• Manual capture — enter measured level/volume points by hand; captured points are marked and kept when the rest of the table is interpolated between them.
• CSV import / export — exchange the table with a spreadsheet.
• Filling profile — a chart of volume against level so you can sanity-check the table before saving.

Saving writes the complete table to the device record, replacing what was there.

Calibrate from dip

On fuel sensors (application 044) the panel also has Calibrate from dip…: dip the tank, enter the measured level in metres from the tank bottom, and the correction is queued and applied at the device's next contact.

10Remote logger configuration

Open it from a device page via Manage ▾ · Configure logger…. The screen adapts to the logger model — loop inputs, pulse inputs, generator supplies, communications, power and application settings appear only where the hardware has them. All thirteen CloudWorks logger models are supported.

Online and sleeping loggers

• An Online logger is configured directly: the screen interrogates it when it opens, shows its current settings, and each change is sent as soon as you finish editing the field. The command console at the bottom shows every command and reply.
• A Sleep logger is configured through the script queue: changes are queued on the server and execute when the logger next wakes. A Clear queued scripts button empties the queue if you change your mind before the wakeup.

How values are checked

Text fields stop at the logger's storage limit for that setting, and numeric fields are checked against the logger's valid range — an out-of-range entry is put back to a safe value and nothing is sent. The limits are listed in Appendix A.

AConfiguration limits

Text settings, maximum length in characters:

Numeric settings, valid ranges: