Workspace archives

A workspace archive is one SQLite file. hmi download and hmi download-readings write it, and hmi upload reads it into a pulled workspace. The steps are in Download and upload readings archives, and the flags in the CLI reference.

What an archive holds

A full download holds the workspace’s setup and data:

• the workspace name, time zone, and location;
• the parameter tree: branches and parameters with their sources, value types, and reading periods;
• endpoints, including the PIN codes of PIN endpoints and the public keys of WireGuard endpoints;
• dashboards and their source files, and the other files of the workspace;
• reports and their comments;
• MC252 edge programs, automations, and alarm rules;
• the values of constant parameters, unless you add --no-const-values;
• stored readings, unless you add --no-readings.

hmi download-readings holds only the chosen parameters and branches with their readings, and the endpoints they use unless you add --no-endpoints.

Keep archives private: they can contain the PIN codes of your devices and your plant’s readings.

What an archive leaves out

• Workspace members, invitations, roles, and API keys.
• Billing accounts, charges, and limits.
• Activity history, alarm history, and assistant chats.
• Device access secrets: WireGuard private keys stay on the device, and device access tokens stay on the server.
• Unsaved temporary reports.

An archive does not name the workspace it is uploaded to: hmi upload writes into the workspace of the checkout it runs in, and never creates a workspace.

Versions

The archive version is stored in the SQLite file itself (PRAGMA user_version). The current version is 6. hmi upload accepts versions 1 to 6, so archives written by older hmi releases can still be uploaded. An older archive simply lacks what was added later: the workspace name (version 2 and later), its time zone and location (version 4 and later), edge programs (version 5 and later), and automations and alarm rules (version 6).