Workspace navigation and Setup pages

Everything inside one workspace lives under /workspace/$workspaceId/…. The cloud app and a local workspace show the same pages at the same paths. Workspace settings are described in Workspace list and settings, and what each role can do in Workspace roles.

Navigation

The sidebar lists the workspace’s enabled dashboards. Below them:

• Alarms, in a workspace that raises alarms, for every member, with the number of alarms waiting for acknowledgement. See Alarms page.
• Setup…, for editors, admins, and the owner, a menu of the Setup sections.
• In the cloud app, owners of the billing account that pays for the workspace see its balance, with the spend of the last 24 hours and 7 days, and a link to the account. Collapsed, the sidebar shows a wallet icon with the same figures in its tooltip, and a red dot below zero.

Inside a Setup section the sidebar shows Back to workspace, the Setup label, and one row per section, with the open one highlighted. Every Setup page header has a Setup label above its title. On phones, the menu button in the header opens the same list.

Viewers and operators have no way into Setup or Activity history: opening such a URL takes them back to the dashboards. Someone who is not a member of the workspace gets a page that says so.

Workspace home

/workspace/$workspaceId opens the first enabled dashboard. With no enabled dashboard it shows No dashboards available. Editors, admins, and the owner also get:

• in the cloud app, Set up your workspace with AI, which opens the assistant, then Manual setup, which opens the Setup menu, and below them the command to develop the workspace locally;
• in a local workspace, Manual setup.

Entity IDs

Edit dialogs for a parameter, endpoint, dashboard, or report, and the branch rename dialog, show the object’s UUID under the title, with a copy button. Use it in API calls and dashboard configuration. Create dialogs and lists show no IDs. The workspace UUID is in the URL and under the heading of Workspace settings.

Timestamps in the app are YYYY-MM-DD HH:mm:ss in your browser’s timezone.

Dashboards

/workspace/$workspaceId/d/$dashboardId shows one dashboard to every member.

• A disabled dashboard is missing from the sidebar, but its URL still opens it.
• Editors, admins, and the owner get Dashboard actions (…) in the page header, with Edit settings and Duplicate.
• A dashboard built with an older version of the tools shows Dashboard needs a rebuild; rebuild it with hmi build and push it again.
• The cloud app runs the published build. A local workspace runs the dashboard’s source; until hmi pull downloads the source, it shows Dashboard sources not downloaded and runs the published build.

History reports

/workspace/$workspaceId/reports/$presetId opens a history report for every member, including View only. Editors, admins, and the owner open its settings from the page: Edit on a saved report, Save on a temporary one. The page is described in Report page.

Setup

Setup is for editors, admins, and the owner.

Section	Path	Reference
Dashboards	…/setup/dashboards	Setup: Dashboards
Endpoints	…/setup/endpoints	Setup: Endpoints, Endpoints
Parameters	…/setup/parameters	Setup: Parameters
Reports	…/setup/reports	Setup: Reports
Automations	…/setup/automations	Setup: Automations
Activity history	…/audit	Activity history
Files	…/setup/files	Setup: Files
Stored data	…/setup/storage	Setup: Stored data

Paths start with /workspace/$workspaceId. Creating or editing an item opens a dialog over its list, with its own path, such as …/setup/parameters/$parameterId; the list keeps its scroll position and filter underneath. The endpoint status page and an automation are full pages.

Setup: Dashboards

The list creates, duplicates, edits, deletes, enables, disables, and reorders dashboards. The name opens the dashboard; drag the handle to reorder.

• Create dashboard (…/new) takes a name and an optional template. The template’s description shows under the field.
• Create from report (…/new-from-report) makes a dashboard that shows a saved report. The name and description come from the report and can be changed. Later edits of the report appear on the dashboard.
• Duplicate creates a copy named “ (copy)” with the same equipment and parameter bindings, then opens it.
• Edit settings (…/$dashboardId) changes the name, description, icon, and JSON configuration. The configuration must be a JSON object that matches the dashboard’s configuration schema.

The steps are in Create and publish a dashboard.

Setup: Endpoints

The list shows each endpoint’s connection, name, and address, with an enabled switch. Create endpoint opens a dialog for the kind, the name, and the connection details; an MC252 PIN endpoint then asks for a press of the R button on the device, or the 8-digit code from its screen. The name opens the endpoint’s status page, with the tabs Connection, Programs, Recorded readings, and Device UI as the endpoint has them.

The list, fields, and status page are described in Endpoints. The Programs tab is described in Write MC252 programs and Deploy programs to an MC252.

Setup: Parameters

The tree holds branches and parameters. Its toolbar has:

• a filter by name, mnemonic, or tag, and expand or collapse all;
• Details, which shows each parameter’s description, source, tags, Last reading, and Next reading;
• the add menu: Root branch, Parameter, and From template…, which stamps a parameter template for an endpoint and unit ID under a new root branch;
• Quick report on up to 20 selected parameters, which opens a temporary history report;
• delete, which counts the parameters and branches and names the reports that use them;
• Delete readings… for the selection, for admins and the owner. See Setup: Stored data.

Branch names need not be unique, and a workspace can have several root branches. Deleting a branch deletes its sub-branches and their parameters.

A parameter’s dialog has the sections General (name, mnemonic, units, description, tags, branch, icon, Parameter is enabled, and the background reading period), Source (Constant, Calculated, or Modbus TCP), and Value (the value type and its options). The fields and their limits are in Parameter sources and Parameter value types. The formula field shows what is wrong with a formula, and where, as you type.

Live values in the tree

Read reads the selected parameters once; Live keeps reading them. Each value updates as its result arrives, and shows a pending state while a read is in progress. Turning Live off, hiding the browser tab, or leaving the page cancels pending reads.

• When the tree loads, each value shows the last reading, dimmed. A new reading replaces it. So does a definite error from the device or the setup, such as a Modbus exception, a decode error, or a disabled parameter. A timeout, a lost connection, or a full request queue keeps the last reading and shows the error next to it. See The last reading stays on screen.
• To write, select Read with Live off, then select the value. Enter writes it; Escape cancels. A writable parameter that shows Decode error offers Write value with an empty editor, so a new constant can get its first value. Writing is possible only when the source allows it.
• After a write, the old value shows as stale until the tree reads the parameter again.

The display mode, kept for the browser session, is one of:

Mode	Shows	Writes
Formatted	The formatted value with units, or the label of an integer or boolean value	Free text, or a choice of the configured labels
Number	The number; 1 or 0 for a boolean	Free text
Hex	The raw bytes as 0x…, without units	Hex digits, which replace the raw bytes

Choosing a parameter

Every field that takes one parameter, in Setup forms, alarm rules, graphics bindings, and dashboard setup, shows the chosen parameter’s name and mnemonic, its branch path, and its value with units. The value is read once, when the field shows or the parameter is chosen.

Selecting the field opens a search over the enabled parameters, as a popover or, on a phone, a sheet. With an empty search it shows the tree, opened at the chosen parameter; Shift+click opens or closes a whole branch. Typing lists the parameters whose name in any language, mnemonic, branch path, or address contains every word typed, best matches first. The arrow keys move through the list and open and close branches, and Enter picks.

Fields that take several parameters, such as Add parameters in reports, have checkboxes instead; a branch checkbox or Select all matches checks many at once. Add parameters also lists disabled parameters, marked Disabled, so reports can show their recorded history.

Setup: Reports

The list holds the workspace’s saved reports. Create report and a report’s edit action open the report settings in a large dialog; the title opens the report. Temporary reports from Quick report are not listed. A view type the app does not recognize stays unchanged as a read-only card. Every setting is in Report settings, and the steps in Create a report.

Setup: Automations

The Automations tab lists automations with their error and warning counts, owning dashboard, last run, and an enabled switch. New automation and the name open the automation’s page, with the tabs Editor and Run history. The editor suggests names and values as you type, shows information when you point at a name, and lists each problem with its fixes and Ask the assistant. The Alarm rules tab lists alarm rules; New alarm rule and a row open the rule in a dialog. From a starter, on both tabs, fills in a new automation or alarm rule from a starter.

The documents are described in Automations and alarm rules, and the steps in Write and debug automations.

Setup: Files

The workspace’s uploaded files and folders, most recently changed first. The name downloads a file, or a folder as a ZIP.

• Upload adds a file of up to 50 MiB. A name that exists already gets -1, -2, and so on before its extension. A ZIP file unpacks into a folder named after it.
• Process file on a PDF or Excel file extracts its contents into a folder named <file>-ingested, for the assistant to read: the page text and images of a PDF, and the sheets and images of a workbook. The button shows progress while it runs and comes back once that folder is deleted.
• Documents attached to an assistant message are added here too.

Setup: Stored data

Stored data (…/setup/storage) shows what the workspace stores and pays for. Editors see it; admins and the owner change retention and delete data. The steps are in Manage stored data.

The page has the cards totals, Readings retention, readings per parameter, Activity history, Alarm log, and files.

Category	Counted in	What counts
Readings	records	One stored reading of one parameter. The table lists each parameter’s records, its oldest and newest reading, and the retention that applies
Readings of deleted parameters	records	Listed under the parameter’s last name, until deleted or removed by the default retention
Activity history	records	Events and the changes they record
Alarm log	events	One per alarm raised, acknowledged, cleared, shelved, unshelved, or removed
Files	bytes	Dashboard sources and builds, templates, uploads, other files, and older versions kept for checkpoints. A file at several paths counts once

The totals are what billing measured for the last hour. The breakdown by parameter and file area is measured when the page opens, at most once an hour, and after each deletion, so it can differ slightly from the totals.

Retention:

• Readings: a default of Keep everything or a number of days, for every parameter no rule covers and for readings of deleted parameters. Rules keep chosen parameters and branches for their own number of days, or for ever. A branch rule covers its sub-branches and parameters, including ones added later. A parameter or branch can be in one rule only, and the most specific rule wins.
• Activity history and Alarm log: at least 30 days, or keep everything.
• Retention runs every hour. It deletes readings older than the start of the UTC day N days ago. Before you save a change, the dialog shows how many records it deletes.
• Shortening the activity history keeps what is needed to revert to the remaining checkpoints. Shortening the alarm log leaves active alarms as they are.

Deleting:

• Delete readings… on the readings card covers all parameters; the trash button on a row covers one; Delete readings… in the Parameters toolbar covers the selection. The ranges are Older than a date, In a period, and All readings.
• Delete old history… and Delete old log… take a date at least 30 days ago.
• Every dialog counts the records it deletes first. Deletion runs in the background; you get a notification when it ends.
• Readings of the last five minutes are always kept. Deleted readings cannot be recovered, not even by reverting to a checkpoint. Reports recalculate from the remaining readings.

Every deletion and retention change is recorded in activity history.

Edits made at the same time

Setup dialogs remember the version of the item they opened. If someone else changes it before you save, in the app, through the assistant, or with hmi push, saving stops with “Someone changed this item in the meantime” and saves nothing. Keep my changes saves your version over theirs on the next save; Load latest version reopens the dialog with the saved version. Enable switches, deletes, and branch renames stop with the same message and refresh the list.

Local workspace

After hmi pull, the local app serves the same /workspace/$workspaceId/… pages for the pulled workspace. See Pull a workspace.

	Cloud app	Local workspace
Signed in with	Your sign-in	The workspace API key of the pull
Workspaces	Every workspace you belong to	The pulled workspace only
Account and workspace settings	Yes	No; use the cloud app
Assistant	Yes	No
Dashboards	The published build	The local source, or the published build when it is not pulled
Branding	The pushed files	The files on disk, including changes not yet pushed

Related docs

• Manage workspaces
• Workspace list and settings
• Workspace roles
• Configure endpoints