Skip to content

Commit 12eff30

Browse files
committed
docs
1 parent c1285a1 commit 12eff30

2 files changed

Lines changed: 45 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Changelog
22

3+
## [3.4.11] - 2026-06-06
4+
- Add System Status: **Folder & Role - Camera User Status** view item - a tile with two live lists, **Camera Folders** (online / total cameras per device-tree folder) and **Roles** (logged-in / total users per role). In setup mode the tile shows a centered **Open configuration...** button that opens a split window with the settings on the left and a live preview of the tile on the right.
5+
- Improve System Status: The view item is fully configurable - show all folders and roles or pick them individually, a **Show** mode (all / cameras only / roles only), recording-server prefix toggle, sort (alphabetical or most-offline-first), and styling (text size, count color, offline highlight, row spacing). A **Render mode** switches between **List** (rows) and **Dashboard** (rectangular cards) with a configurable card minimum width.
6+
37
## [3.4.10] - 2026-06-05
48
- Fix System Status: Camera recording traversal
59
- Improve System Status: Allow camera grouping by folders

docs/plugins/smart-client/system-status.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "System Status Plugin for Milestone XProtect"
3-
description: "System Status plugin for Milestone XProtect Smart Client - a toolbar button that opens a System Health window with three tables: recording servers and their storage, every enabled camera with live stream statistics (FPS, bitrate, resolution, codec), used storage and recording span, and the currently connected users."
3+
description: "System Status plugin for Milestone XProtect Smart Client - a toolbar button that opens a System Health window with three tables: recording servers and their storage, every enabled camera with live stream statistics (FPS, bitrate, resolution, codec), used storage and recording span, and the currently connected users. Also ships a Folder & Role view item showing online cameras per device-tree folder and logged-in users per role, as a list or as dashboard cards."
44
---
55

66
<div class="show-title" markdown>
@@ -9,6 +9,8 @@ description: "System Status plugin for Milestone XProtect Smart Client - a toolb
99

1010
Adds a **System Status** button to the Smart Client toolbar. Hovering the button shows a live summary such as `3/19 Cameras 4 Users`. Clicking it opens the **System Health** window, a resizable overview with three tables: recording servers and their storage, cameras with live stream statistics, and connected users.
1111

12+
The plugin also ships a **Folder & Role - Camera User Status** view item you can drop into any view, showing online cameras per folder and logged-in users per role. See [Folder & Role view item](#folder--role-view-item).
13+
1214
## Quick Start
1315

1416
1. Install the plugin and open Smart Client.
@@ -84,6 +86,44 @@ Background services such as the Event Server and the Log Server are filtered out
8486

8587
The **Auto 2s** button toggles live updates. While it is on, the camera stream figures (FPS, bitrate, resolution, online state, used storage) refresh every two seconds. The update is merged in place, so your selection, scroll position, and sort order are preserved and the recording-range cells are not re-queried on every tick. Storage figures and recorder state refresh on a slower cycle and on a manual **Refresh** (or **F5**). Turn auto off to hold the current view. All querying stops the moment the window is closed.
8688

89+
## Folder & Role view item
90+
91+
Alongside the toolbar button, the plugin ships a **Folder & Role - Camera User Status** view item you can drop into any Smart Client view. It shows two live lists:
92+
93+
- **Camera Folders** - one row per Management Client device-group folder, with the number of online cameras out of the total, for example `5 / 8 Devices`.
94+
- **Roles** - one row per role, with how many of its assigned users are currently logged in, for example `1 / 4 Users`.
95+
96+
The online and logged-in number is coloured so a glance tells you coverage, and the counts update live from the same background layer that feeds the toolbar.
97+
98+
### Setting it up
99+
100+
In setup mode the tile shows a centered **Open configuration...** button. It opens a configuration window with the settings on the left and a live preview of the tile on the right, so every change is visible before you apply it.
101+
102+
| Setting | What it does |
103+
|---|---|
104+
| Selection | Show every folder and role, or tick **Show only the folders / roles I pick** to choose them individually from two lists. |
105+
| Recording-server prefix | Keep or drop the leading `server /` segment from folder names. Same-named groups across recorders merge into one row when the prefix is off. |
106+
| Render mode | **List** shows stacked rows; **Dashboard** shows rectangular cards that wrap to fill the tile. |
107+
| Show | All sections, **Cameras only**, or **Roles only**. |
108+
| Folders section on top | Choose which of the two sections comes first when both are shown. |
109+
| Sort rows | Alphabetical, or most-offline-first for monitoring at a glance. |
110+
| Row spacing | Comfortable or compact, in list mode. |
111+
| Card min width | Minimum card width in dashboard mode. Cards grow past it to fit long folder names, so set a larger value for uniform cards. |
112+
| Text size | Size of the row and card text. |
113+
| Count colour | Colour of the online and logged-in number. |
114+
| Offline highlight | Optionally colour the count when some members are offline, with its own colour. |
115+
116+
### How the counts are worked out
117+
118+
| Question | Source |
119+
|---|---|
120+
| Which folders exist and which cameras they hold | The Management Client device-group tree (user-defined folders). |
121+
| Which cameras are online | The current device state reported by the Event Server. |
122+
| Which roles exist and their users | The configuration role and user lists. |
123+
| Which users are logged in | The MIP environments currently connected to the Event Server, matched to role members. |
124+
125+
Role membership is matched to logins by user name, since the connected-client list does not expose a SID. Active Directory users are matched on account and display name.
126+
87127
## How it works
88128

89129
Two layers feed the window.

0 commit comments

Comments
 (0)