From efa215c08a61198d3b0f878d1477d23f1319d9a5 Mon Sep 17 00:00:00 2001 From: Nikolas Leimer Date: Thu, 24 Sep 2026 18:03:42 +0200 Subject: [PATCH 01/12] Workstation Management: document the Test Your Station refresh fix Refreshing the Test Your Station page no longer bypasses the check that the station belongs to the current workspace. Adds the 4.3.0 release-notes section with that bug fix under Workstation Management. --- content/en/docs/releasenotes/workstation/_index.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/content/en/docs/releasenotes/workstation/_index.md b/content/en/docs/releasenotes/workstation/_index.md index 1d4d979f05d..1a4f013dd78 100644 --- a/content/en/docs/releasenotes/workstation/_index.md +++ b/content/en/docs/releasenotes/workstation/_index.md @@ -10,6 +10,16 @@ cascade: These release notes cover changes made to the [Mendix Workstation](/mendix-workstation/). +## 4.3.0 + +### Release date: October 8, 2026 + +### Workstation Management + +#### Bug Fixes + +* We have fixed an issue where refreshing the **Test Your Station** page bypassed the check that the station belongs to the current workspace. + ## 4.2.1 ### Release date: September 16, 2026 From 26303a77553b2b12de5e0ab0df3544c0d72693bb Mon Sep 17 00:00:00 2001 From: Nikolas Leimer Date: Thu, 24 Sep 2026 18:06:18 +0200 Subject: [PATCH 02/12] Workstation Management: document the developer mode entitlement requirement Turning off developer mode now requires Workstation licenses. Documents the rule in the Developer Mode section of Managing Stations, qualifies the existing production recommendation, and adds the 4.3.0 Improvements bullet. --- content/en/docs/releasenotes/workstation/_index.md | 4 ++++ .../en/docs/workstation/management/wks-management-admin.md | 4 +++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/content/en/docs/releasenotes/workstation/_index.md b/content/en/docs/releasenotes/workstation/_index.md index 1a4f013dd78..3c74db82323 100644 --- a/content/en/docs/releasenotes/workstation/_index.md +++ b/content/en/docs/releasenotes/workstation/_index.md @@ -16,6 +16,10 @@ These release notes cover changes made to the [Mendix Workstation](/mendix-works ### Workstation Management +#### Improvements + +* Developer mode - Turning off developer mode now requires Workstation licenses. In a workspace without an entitlement, developer mode stays enabled. For more information, see [Managing Stations: Developer Mode](/mendix-workstation/management-stations/#developer-mode). + #### Bug Fixes * We have fixed an issue where refreshing the **Test Your Station** page bypassed the check that the station belongs to the current workspace. diff --git a/content/en/docs/workstation/management/wks-management-admin.md b/content/en/docs/workstation/management/wks-management-admin.md index 22782a9a7af..e999b9dd864 100644 --- a/content/en/docs/workstation/management/wks-management-admin.md +++ b/content/en/docs/workstation/management/wks-management-admin.md @@ -128,6 +128,8 @@ Developer mode can be configured on the **Station** page by selecting **Enable D Environments created with the Test environment type have developer mode enabled by default for easier testing. Changing the environment type after creation does not enable or disable developer mode. For more information about creating environments, see [Configuring Workspaces](/mendix-workstation/management-workspaces/). +Disabling developer mode requires Workstation licenses. In a workspace without an entitlement, developer mode is enabled by default, and saving a station with **Enable Developer Mode** cleared is refused with the message "You currently are not entitled to disable developer mode. Please contact your administrator to obtain the necessary Workstation licenses." Stations that already have developer mode disabled keep that setting, and a workspace that loses its entitlement does not have developer mode re-enabled on its existing stations. + When developer mode is enabled, users of the Workstation Client can perform the following actions: * Quit the program from the Start menu. @@ -135,5 +137,5 @@ When developer mode is enabled, users of the Workstation Client can perform the * Debug level live logs displayed in the Logs pane of the Workstation Client, even if the workspace's log level is set to a different level. {{% alert color="info" %}} -For production environments, it is strongly recommended to disable Developer Mode. This prevents Workstation operators from accidentally quitting or deregistering the Workstation Client, and restricts access to debugging tools that are not needed in a live operational setting. +For production environments, it is strongly recommended to disable Developer Mode, which requires an entitled workspace. This prevents Workstation operators from accidentally quitting or deregistering the Workstation Client, and restricts access to debugging tools that are not needed in a live operational setting. {{% /alert %}} From 2c164f31469b0d466167b8329f387d231db785db Mon Sep 17 00:00:00 2001 From: Nikolas Leimer Date: Fri, 25 Sep 2026 08:48:47 +0200 Subject: [PATCH 03/12] Workstation Management: document camera device configuration Camera is a new device connection type in Workstation Management. Adds a Camera section to Configuring Devices with the configuration steps and connection parameters, and the 4.3.0 New Features bullet. --- .../docs/releasenotes/workstation/_index.md | 4 +++ .../management/wks-management-devices.md | 27 +++++++++++++++++++ 2 files changed, 31 insertions(+) diff --git a/content/en/docs/releasenotes/workstation/_index.md b/content/en/docs/releasenotes/workstation/_index.md index 3c74db82323..1e889fcfde8 100644 --- a/content/en/docs/releasenotes/workstation/_index.md +++ b/content/en/docs/releasenotes/workstation/_index.md @@ -16,6 +16,10 @@ These release notes cover changes made to the [Mendix Workstation](/mendix-works ### Workstation Management +#### New Features + +* Camera devices - We have added a new *camera* connection type to configure a USB camera or webcam attached to the computer that runs the Workstation Client. You can set the camera to use and the requested width, height, and frame rate of its video feed, and enable barcode and motion detection. For more information, see [Configuring Devices: Camera](/mendix-workstation/management-devices/#camera). + #### Improvements * Developer mode - Turning off developer mode now requires Workstation licenses. In a workspace without an entitlement, developer mode stays enabled. For more information, see [Managing Stations: Developer Mode](/mendix-workstation/management-stations/#developer-mode). diff --git a/content/en/docs/workstation/management/wks-management-devices.md b/content/en/docs/workstation/management/wks-management-devices.md index 32522f75686..7e5dbd22b41 100644 --- a/content/en/docs/workstation/management/wks-management-devices.md +++ b/content/en/docs/workstation/management/wks-management-devices.md @@ -154,6 +154,33 @@ To add a Bluetooth device, perform the following steps: For the message syntax used to communicate with this device, see [Bluetooth](/mendix-workstation/device-syntax/#bluetooth). +## Camera {#camera} + +A camera device describes a camera attached to the computer that runs the Workstation Client: which camera to use, the video feed properties to request from it, and which detection features to enable. Currently only USB cameras and webcams are supported. + +### Configuring Cameras + +To add a camera device, perform the following steps: + +1. In Workstation Management, navigate to the **Devices** section on the **Station Detail** page. +2. Click **Add Device**, select **Camera**, and then click **Next**. +3. In the **Device Name** field, enter an identifying name for the device. +4. Optional: Select or create a class to help you manage your devices. +5. Click **Next**. +6. Configure the following connection parameters: + + | Parameter | Description | + | --- | --- | + | **Camera Type** | Required; the type of camera connection. Only **USB/Webcam** is currently supported. Support for RTSP, UDP, and HTTP (MJPEG) camera streams is planned. | + | **Camera Name** | Optional; the name of the camera to use. Leave the field empty to use the default camera. | + | **Width** | Optional; the requested width of the camera feed. If the camera does not support the requested value, the closest supported value is used. The value must be greater than `0`, or empty. | + | **Height** | Optional; the requested height of the camera feed. If the camera does not support the requested value, the closest supported value is used. The value must be greater than `0`, or empty. | + | **Frame Rate** | Optional; the requested frame rate of the camera feed. If the camera does not support the requested value, the closest supported value is used. The value must be greater than `0`, or empty. | + | **Enable Barcode Detection** | Optional; when enabled, the video feed is processed and an event is sent when a barcode is detected in the frame. The default value is **No**. | + | **Enable Motion Detection** | Optional; when enabled, the video feed is processed and an event is sent when motion is detected in the frame. The default value is **No**. | + +7. Click **Add Device**. + ## Keyboard Wedge {#keyboard-wedge} You can configure Workstation to connect with devices that emulate a keyboard by sending data as key strokes, such as barcode scanners, RFID readers, or measurement devices. Because these devices present themselves to the operating system as a standard keyboard, keyboard events are captured wherever the current focus is, for example in the web app or in an input field. The operator does not have to place the cursor in a specific input field first. From 45af4ed198f969c939e7b3702b2869145e9ec654 Mon Sep 17 00:00:00 2001 From: Nikolas Leimer Date: Fri, 25 Sep 2026 09:05:33 +0200 Subject: [PATCH 04/12] Workstation Management: document retrieving Workstation Client diagnostics Workstation Management can now retrieve the diagnostics of the Workstation Client for a station. Adds a Client Diagnostics section to Managing Stations, cross-links it from Troubleshooting the Workstation Client, and adds the 4.3.0 New Features bullets for Workstation Management and Workstation Client. --- .../en/docs/releasenotes/workstation/_index.md | 7 +++++++ .../management/wks-management-admin.md | 15 +++++++++++++++ .../troubleshooting/wks-troubleshooting-client.md | 4 +++- 3 files changed, 25 insertions(+), 1 deletion(-) diff --git a/content/en/docs/releasenotes/workstation/_index.md b/content/en/docs/releasenotes/workstation/_index.md index 1e889fcfde8..b1e2b6bc23c 100644 --- a/content/en/docs/releasenotes/workstation/_index.md +++ b/content/en/docs/releasenotes/workstation/_index.md @@ -19,6 +19,7 @@ These release notes cover changes made to the [Mendix Workstation](/mendix-works #### New Features * Camera devices - We have added a new *camera* connection type to configure a USB camera or webcam attached to the computer that runs the Workstation Client. You can set the camera to use and the requested width, height, and frame rate of its video feed, and enable barcode and motion detection. For more information, see [Configuring Devices: Camera](/mendix-workstation/management-devices/#camera). +* Client diagnostics - We have added a **Diagnostics** button to the **Station Detail** page that retrieves the diagnostics of the Workstation Client on the registered computer, so you can see which peripherals it detects, what system it runs on, and how many log entries it has recorded per level, without access to that computer. For more information, see [Managing Stations: Client Diagnostics](/mendix-workstation/management-stations/#client-diagnostics). #### Improvements @@ -28,6 +29,12 @@ These release notes cover changes made to the [Mendix Workstation](/mendix-works * We have fixed an issue where refreshing the **Test Your Station** page bypassed the check that the station belongs to the current workspace. +### Workstation Client + +#### New Features + +* Client diagnostics - The Workstation Client now answers diagnostics requests from Workstation Management, so a station's diagnostics can be inspected from Workstation Management. The local file system paths that the client's own **Diagnostics** page shows are left out of the response. + ## 4.2.1 ### Release date: September 16, 2026 diff --git a/content/en/docs/workstation/management/wks-management-admin.md b/content/en/docs/workstation/management/wks-management-admin.md index e999b9dd864..7abf59ceb95 100644 --- a/content/en/docs/workstation/management/wks-management-admin.md +++ b/content/en/docs/workstation/management/wks-management-admin.md @@ -113,6 +113,21 @@ From here, you can perform the following tasks: * Manually refresh configuration to the client, forcing the Workstation Client on the registered computer to immediately pull the latest settings from Workstation Management. * Configure advanced settings like **Detect Card Readers** and **Station Developer Mode**. * Manage and configure all devices associated with this station. +* Retrieve diagnostics from the Workstation Client on the registered computer. + +### Client Diagnostics {#client-diagnostics} + +The Workstation Client scans the computer it runs on for connected peripherals and reports on its own state. You can retrieve that information from Workstation Management, which lets you check what a station actually has attached without asking the operator to read it off the computer. + +To retrieve the diagnostics of a station, click **Diagnostics** on the **Station Detail** page. The diagnostics are displayed as JSON in a side panel, next to the name of the registered computer, and cover the following: + +* The serial ports, Bluetooth devices, card readers, printers, and cameras that the Workstation Client detects, with the metadata it has for each of them. +* System information about the computer and the Workstation Client, such as the operating system, the client type, the client version, and how long it has been running. +* A count of the log entries the Workstation Client has recorded per log level. + +The **Diagnostics** button is only shown when a computer is registered to the station and its Workstation Client is connected, in the same way as the **Refresh on Computer** button. The data is pulled from the Workstation Client at the moment you click the button and is discarded again when you close the panel, so it always reflects the current state of the computer rather than a stored snapshot. If the request does not succeed, Workstation Management reports that the diagnostics for that computer could not be retrieved. + +The diagnostics that Workstation Management retrieves are a subset of the **Diagnostics** page in the Workstation Client itself, and omit the local file system paths that the client's own page shows. For the client-side page, see [Troubleshooting the Workstation Client: Diagnostics](/mendix-workstation/troubleshooting-workstation-client/#diagnostics). ## Advanced Station Settings diff --git a/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md b/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md index 780a7a34dcc..7f1265ee307 100644 --- a/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md +++ b/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md @@ -26,10 +26,12 @@ On Linux, the *Mendix Workstation/logs* folder is located at either `$XDG_CONFIG * Start the Workstation Client. Click the three-dot icon in the top tight, then click **Logs**. Debug level logs are only available in *Developer Mode* * Start the Workstation Client from PowerShell: `start "C:\Program Files\Mendix Workstation\Mendix Workstation.exe" -ArgumentList "--log-level=debug" -wait`. -### Diagnostics +### Diagnostics {#diagnostics} When [Developer Mode](/mendix-workstation/management-stations/#developer-mode) is enabled, the Client also shows a **Diagnostics** page. This page displays information about the available devices, credentials, station configuration, system info, and log levels, which you can use to help you troubleshoot any issues. +You can also retrieve a subset of this information from Workstation Management, without access to the computer and regardless of whether Developer Mode is enabled. For more information, see [Managing Stations: Client Diagnostics](/mendix-workstation/management-stations/#client-diagnostics). + ## Registration Token Could Not Be Parsed The Client shows an error like the following: *Registration token could not be parsed. Please enter another token!* From ef72a22a548c378dd7a8680efed746c69055d778 Mon Sep 17 00:00:00 2001 From: Nikolas Leimer Date: Fri, 25 Sep 2026 09:52:16 +0200 Subject: [PATCH 05/12] Workstation Management: apply docs style guide to the 4.3.0 documentation Applies the docs style guide and the repository's Vale and markdownlint rules to the 4.3.0 documentation on this branch. No changes to structure, meaning or technical claims. --- content/en/docs/releasenotes/workstation/_index.md | 4 ++-- .../workstation/management/wks-management-admin.md | 12 ++++++------ .../workstation/management/wks-management-devices.md | 4 ++-- .../troubleshooting/wks-troubleshooting-client.md | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/content/en/docs/releasenotes/workstation/_index.md b/content/en/docs/releasenotes/workstation/_index.md index b1e2b6bc23c..983366a8d1b 100644 --- a/content/en/docs/releasenotes/workstation/_index.md +++ b/content/en/docs/releasenotes/workstation/_index.md @@ -19,7 +19,7 @@ These release notes cover changes made to the [Mendix Workstation](/mendix-works #### New Features * Camera devices - We have added a new *camera* connection type to configure a USB camera or webcam attached to the computer that runs the Workstation Client. You can set the camera to use and the requested width, height, and frame rate of its video feed, and enable barcode and motion detection. For more information, see [Configuring Devices: Camera](/mendix-workstation/management-devices/#camera). -* Client diagnostics - We have added a **Diagnostics** button to the **Station Detail** page that retrieves the diagnostics of the Workstation Client on the registered computer, so you can see which peripherals it detects, what system it runs on, and how many log entries it has recorded per level, without access to that computer. For more information, see [Managing Stations: Client Diagnostics](/mendix-workstation/management-stations/#client-diagnostics). +* Client diagnostics - We have added a **Diagnostics** button to the **Station Detail** page that retrieves the diagnostics of the Workstation Client on the registered computer. You can see which peripherals it detects, what system it runs on, and how many log entries it has recorded per level, without access to that computer. For more information, see [Managing Stations: Client Diagnostics](/mendix-workstation/management-stations/#client-diagnostics). #### Improvements @@ -33,7 +33,7 @@ These release notes cover changes made to the [Mendix Workstation](/mendix-works #### New Features -* Client diagnostics - The Workstation Client now answers diagnostics requests from Workstation Management, so a station's diagnostics can be inspected from Workstation Management. The local file system paths that the client's own **Diagnostics** page shows are left out of the response. +* Client diagnostics - The Workstation Client now answers diagnostics requests from Workstation Management, so a station's diagnostics can be inspected without access to the computer. The local file system paths that the client's own **Diagnostics** page shows are left out of the response. ## 4.2.1 diff --git a/content/en/docs/workstation/management/wks-management-admin.md b/content/en/docs/workstation/management/wks-management-admin.md index 7abf59ceb95..03226e1fc36 100644 --- a/content/en/docs/workstation/management/wks-management-admin.md +++ b/content/en/docs/workstation/management/wks-management-admin.md @@ -117,17 +117,17 @@ From here, you can perform the following tasks: ### Client Diagnostics {#client-diagnostics} -The Workstation Client scans the computer it runs on for connected peripherals and reports on its own state. You can retrieve that information from Workstation Management, which lets you check what a station actually has attached without asking the operator to read it off the computer. +The Workstation Client scans the computer it runs on for connected peripherals and reports on its own state. You can retrieve that information from Workstation Management, which lets you check what a station has attached without asking the operator to read it off the computer. -To retrieve the diagnostics of a station, click **Diagnostics** on the **Station Detail** page. The diagnostics are displayed as JSON in a side panel, next to the name of the registered computer, and cover the following: +To retrieve the diagnostics of a station, click **Diagnostics** on the **Station Detail** page. The diagnostics appear as JSON in a side panel next to the name of the registered computer, and cover the following: * The serial ports, Bluetooth devices, card readers, printers, and cameras that the Workstation Client detects, with the metadata it has for each of them. * System information about the computer and the Workstation Client, such as the operating system, the client type, the client version, and how long it has been running. * A count of the log entries the Workstation Client has recorded per log level. -The **Diagnostics** button is only shown when a computer is registered to the station and its Workstation Client is connected, in the same way as the **Refresh on Computer** button. The data is pulled from the Workstation Client at the moment you click the button and is discarded again when you close the panel, so it always reflects the current state of the computer rather than a stored snapshot. If the request does not succeed, Workstation Management reports that the diagnostics for that computer could not be retrieved. +The **Diagnostics** button appears only when a computer is registered to the station and its Workstation Client is connected. This is the same condition as for the **Refresh on Computer** button. The diagnostics are pulled from the Workstation Client when you click the button, and discarded again when you close the panel. They therefore always reflect the current state of the computer rather than a stored snapshot. If the request fails, Workstation Management reports that it cannot retrieve the diagnostics for that computer. -The diagnostics that Workstation Management retrieves are a subset of the **Diagnostics** page in the Workstation Client itself, and omit the local file system paths that the client's own page shows. For the client-side page, see [Troubleshooting the Workstation Client: Diagnostics](/mendix-workstation/troubleshooting-workstation-client/#diagnostics). +Workstation Management retrieves a subset of the information on the **Diagnostics** page of the Workstation Client itself. The local file system paths that the client's own page shows are left out. For the client-side page, see the [Diagnostics](/mendix-workstation/troubleshooting-workstation-client/#diagnostics) section in *Troubleshooting the Workstation Client*. ## Advanced Station Settings @@ -143,7 +143,7 @@ Developer mode can be configured on the **Station** page by selecting **Enable D Environments created with the Test environment type have developer mode enabled by default for easier testing. Changing the environment type after creation does not enable or disable developer mode. For more information about creating environments, see [Configuring Workspaces](/mendix-workstation/management-workspaces/). -Disabling developer mode requires Workstation licenses. In a workspace without an entitlement, developer mode is enabled by default, and saving a station with **Enable Developer Mode** cleared is refused with the message "You currently are not entitled to disable developer mode. Please contact your administrator to obtain the necessary Workstation licenses." Stations that already have developer mode disabled keep that setting, and a workspace that loses its entitlement does not have developer mode re-enabled on its existing stations. +Disabling developer mode requires Workstation licenses. In a workspace without an entitlement, developer mode is enabled by default. Saving a station with **Enable Developer Mode** cleared is then refused with the message *You currently are not entitled to disable developer mode. Please contact your administrator to obtain the necessary Workstation licenses.* Stations that already have developer mode disabled keep that setting. Losing the entitlement does not re-enable developer mode on existing stations. When developer mode is enabled, users of the Workstation Client can perform the following actions: @@ -152,5 +152,5 @@ When developer mode is enabled, users of the Workstation Client can perform the * Debug level live logs displayed in the Logs pane of the Workstation Client, even if the workspace's log level is set to a different level. {{% alert color="info" %}} -For production environments, it is strongly recommended to disable Developer Mode, which requires an entitled workspace. This prevents Workstation operators from accidentally quitting or deregistering the Workstation Client, and restricts access to debugging tools that are not needed in a live operational setting. +For production environments, it is strongly recommended to disable Developer Mode, which requires Workstation licenses. This prevents Workstation operators from accidentally quitting or deregistering the Workstation Client, and restricts access to debugging tools that are not needed in a live operational setting. {{% /alert %}} diff --git a/content/en/docs/workstation/management/wks-management-devices.md b/content/en/docs/workstation/management/wks-management-devices.md index 7e5dbd22b41..59a78c5805d 100644 --- a/content/en/docs/workstation/management/wks-management-devices.md +++ b/content/en/docs/workstation/management/wks-management-devices.md @@ -156,7 +156,7 @@ For the message syntax used to communicate with this device, see [Bluetooth](/me ## Camera {#camera} -A camera device describes a camera attached to the computer that runs the Workstation Client: which camera to use, the video feed properties to request from it, and which detection features to enable. Currently only USB cameras and webcams are supported. +A camera device describes a camera attached to the computer that runs the Workstation Client. It defines which camera to use, the video feed properties to request from it, and which detection features to enable. Only USB cameras and webcams are currently supported. ### Configuring Cameras @@ -171,7 +171,7 @@ To add a camera device, perform the following steps: | Parameter | Description | | --- | --- | - | **Camera Type** | Required; the type of camera connection. Only **USB/Webcam** is currently supported. Support for RTSP, UDP, and HTTP (MJPEG) camera streams is planned. | + | **Camera Type** | Required; the type of camera connection. Only **USB/Webcam** is currently supported. Support for camera streams over Real Time Streaming Protocol (RTSP), User Datagram Protocol (UDP), and HTTP with Motion JPEG (MJPEG) is planned. | | **Camera Name** | Optional; the name of the camera to use. Leave the field empty to use the default camera. | | **Width** | Optional; the requested width of the camera feed. If the camera does not support the requested value, the closest supported value is used. The value must be greater than `0`, or empty. | | **Height** | Optional; the requested height of the camera feed. If the camera does not support the requested value, the closest supported value is used. The value must be greater than `0`, or empty. | diff --git a/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md b/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md index 7f1265ee307..8ff2728454d 100644 --- a/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md +++ b/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md @@ -30,7 +30,7 @@ On Linux, the *Mendix Workstation/logs* folder is located at either `$XDG_CONFIG When [Developer Mode](/mendix-workstation/management-stations/#developer-mode) is enabled, the Client also shows a **Diagnostics** page. This page displays information about the available devices, credentials, station configuration, system info, and log levels, which you can use to help you troubleshoot any issues. -You can also retrieve a subset of this information from Workstation Management, without access to the computer and regardless of whether Developer Mode is enabled. For more information, see [Managing Stations: Client Diagnostics](/mendix-workstation/management-stations/#client-diagnostics). +You can also retrieve a subset of this information from Workstation Management, without access to the computer and regardless of whether Developer Mode is enabled. For more information, see the [Client Diagnostics](/mendix-workstation/management-stations/#client-diagnostics) section in *Managing Stations*. ## Registration Token Could Not Be Parsed From d595f42287fea22acd245f04f1568c679b44020c Mon Sep 17 00:00:00 2001 From: Nikolas Leimer Date: Fri, 2 Oct 2026 13:46:24 +0200 Subject: [PATCH 06/12] correcting card readers default statement --- .../management/wks-management-admin.md | 22 ++++++++++++------- content/en/docs/workstation/wks-quickstart.md | 4 ++-- 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/content/en/docs/workstation/management/wks-management-admin.md b/content/en/docs/workstation/management/wks-management-admin.md index 03226e1fc36..0caea86f0a8 100644 --- a/content/en/docs/workstation/management/wks-management-admin.md +++ b/content/en/docs/workstation/management/wks-management-admin.md @@ -135,22 +135,28 @@ Workstation Management retrieves a subset of the information on the **Diagnostic Card readers are handled uniquely within Workstation Management. They are not configured as separate devices in the Devices overview of a Station page. Instead, the Workstation Client automatically detects connected card readers. -Auto detecting card readers is enabled by default. You can toggle the **Detect Card Readers** setting on the **Station Detail Page** to **Off** if you do not want the Workstation Client to automatically detect smart card readers for this specific station. +Auto detecting card readers is disabled by default. To enable this feature, perform the following steps: + 1. In **Station** view, click the **three dots** icon. + 2. Click **Edit Station**. + 3. Clear the **Detect Card Readers** check box. ### Developer Mode {#developer-mode} -Developer mode can be configured on the **Station** page by selecting **Enable Developer Mode**. - -Environments created with the Test environment type have developer mode enabled by default for easier testing. Changing the environment type after creation does not enable or disable developer mode. For more information about creating environments, see [Configuring Workspaces](/mendix-workstation/management-workspaces/). - -Disabling developer mode requires Workstation licenses. In a workspace without an entitlement, developer mode is enabled by default. Saving a station with **Enable Developer Mode** cleared is then refused with the message *You currently are not entitled to disable developer mode. Please contact your administrator to obtain the necessary Workstation licenses.* Stations that already have developer mode disabled keep that setting. Losing the entitlement does not re-enable developer mode on existing stations. - When developer mode is enabled, users of the Workstation Client can perform the following actions: * Quit the program from the Start menu. * Deregister the Workstation Client, allowing it to be registered to another station. -* Debug level live logs displayed in the Logs pane of the Workstation Client, even if the workspace's log level is set to a different level. +* Access debug level live logs displayed in the Logs pane of the Workstation Client, even if the workspace's log level is set to a different level. + +Environments created with the Test environment type have developer mode enabled by default for easier testing. Changing the environment type after creation does not enable or disable developer mode. For more information about creating environments, see [Configuring Workspaces](/mendix-workstation/management-workspaces/). + +Disabling developer mode requires Workstation licenses. In a workspace without an entitlement, developer mode is enabled by default. Losing the entitlement does not re-enable developer mode on existing stations. {{% alert color="info" %}} For production environments, it is strongly recommended to disable Developer Mode, which requires Workstation licenses. This prevents Workstation operators from accidentally quitting or deregistering the Workstation Client, and restricts access to debugging tools that are not needed in a live operational setting. {{% /alert %}} + +To configure developer mode, perform the following steps: + 1. In **Station** view, click the **three dots** icon. + 2. Click **Edit Station**. + 3. Check or clear the **Developer Mode** check box. diff --git a/content/en/docs/workstation/wks-quickstart.md b/content/en/docs/workstation/wks-quickstart.md index 56ce0aa72e2..6812b99a853 100644 --- a/content/en/docs/workstation/wks-quickstart.md +++ b/content/en/docs/workstation/wks-quickstart.md @@ -49,11 +49,11 @@ A *station* represents a workstation on the shop floor. It can connect to one or Workstation Management opens the new station. -6. Optional: If you do not want Workstation Management to detect smart card readers, perform the following steps: +6. Optional: If you want Workstation Management to detect smart card readers, perform the following steps: 1. In **Station** view, click the **three dots** icon. 2. Click **Edit Station**. - 3. Clear the **Detect Card Readers** check box. + 3. Tick the **Detect Card Readers** check box. ## Installing the Workstation Client From 2359b06d7546341e23db74fd26194a145223d575 Mon Sep 17 00:00:00 2001 From: Nikolas Leimer Date: Fri, 2 Oct 2026 14:47:29 +0200 Subject: [PATCH 07/12] Workstation Management: document configured card reader devices Card readers can now be configured as devices of a station, identified by the name of the card reader. Rewrites the Card Readers section of Configuring Devices, updates Detect Card Readers in Managing Stations, and adds the 4.3.0 New Features bullet. --- .../docs/releasenotes/workstation/_index.md | 1 + .../management/wks-management-admin.md | 9 ++++--- .../management/wks-management-devices.md | 26 ++++++++++++++++--- 3 files changed, 29 insertions(+), 7 deletions(-) diff --git a/content/en/docs/releasenotes/workstation/_index.md b/content/en/docs/releasenotes/workstation/_index.md index 983366a8d1b..7121eb39aba 100644 --- a/content/en/docs/releasenotes/workstation/_index.md +++ b/content/en/docs/releasenotes/workstation/_index.md @@ -20,6 +20,7 @@ These release notes cover changes made to the [Mendix Workstation](/mendix-works * Camera devices - We have added a new *camera* connection type to configure a USB camera or webcam attached to the computer that runs the Workstation Client. You can set the camera to use and the requested width, height, and frame rate of its video feed, and enable barcode and motion detection. For more information, see [Configuring Devices: Camera](/mendix-workstation/management-devices/#camera). * Client diagnostics - We have added a **Diagnostics** button to the **Station Detail** page that retrieves the diagnostics of the Workstation Client on the registered computer. You can see which peripherals it detects, what system it runs on, and how many log entries it has recorded per level, without access to that computer. For more information, see [Managing Stations: Client Diagnostics](/mendix-workstation/management-stations/#client-diagnostics). +* Card reader devices - We have added a new *card reader* connection type to define the card readers that a station uses by their name, in addition to detecting them automatically. Configured card readers are part of the station configuration, so they are kept when you copy a station. For more information, see [Configuring Devices: Card Readers](/mendix-workstation/management-devices/#card-readers). #### Improvements diff --git a/content/en/docs/workstation/management/wks-management-admin.md b/content/en/docs/workstation/management/wks-management-admin.md index 0caea86f0a8..16448f7ec42 100644 --- a/content/en/docs/workstation/management/wks-management-admin.md +++ b/content/en/docs/workstation/management/wks-management-admin.md @@ -133,12 +133,13 @@ Workstation Management retrieves a subset of the information on the **Diagnostic ### Detect Card Readers -Card readers are handled uniquely within Workstation Management. They are not configured as separate devices in the Devices overview of a Station page. Instead, the Workstation Client automatically detects connected card readers. +The Workstation Client can automatically detect the card readers attached to the computer and add them to its device list. Alternatively, you can configure card readers as devices of the station. For more information, see [Configuring Devices: Card Readers](/mendix-workstation/management-devices/#card-readers). Auto detecting card readers is disabled by default. To enable this feature, perform the following steps: - 1. In **Station** view, click the **three dots** icon. - 2. Click **Edit Station**. - 3. Clear the **Detect Card Readers** check box. + +1. In **Station** view, click the **three dots** icon. +2. Click **Edit Station**. +3. Select the **Detect Card Readers** check box. ### Developer Mode {#developer-mode} diff --git a/content/en/docs/workstation/management/wks-management-devices.md b/content/en/docs/workstation/management/wks-management-devices.md index 59a78c5805d..bb895cacbbc 100644 --- a/content/en/docs/workstation/management/wks-management-devices.md +++ b/content/en/docs/workstation/management/wks-management-devices.md @@ -48,11 +48,31 @@ From this page you can perform the following actions: Renaming or deleting a class that is used to lookup a device in a Workstation app breaks the logic of every app that relies on it, so check the **Devices** count and active **Apps** before you change a class. {{% /alert %}} -## Card Readers +## Card Readers {#card-readers} -Card reader devices cannot be configured as separate devices in the **Devices** overview of a **Station** page. Instead, they are automatically detected by the Workstation Client and added to the device list of the Client. +A card reader device describes a smart card reader that is attached to the computer that runs the Workstation Client and connects using the PC/SC protocol. You can add card readers to a station in the following ways: -Auto-detecting card readers is disabled by default. You can enable this setting on a **Station** page by selecting **Detect Card Readers**. +* Configure each card reader as a device in the **Devices** section of the **Station Detail** page. The Workstation Client uses only the card readers whose names match the configured names. Configured card readers are part of the station configuration, so they are kept when you copy a station. +* Let the Workstation Client detect the attached card readers automatically. Auto-detecting card readers is disabled by default. For more information, see [Managing Stations: Detect Card Readers](/mendix-workstation/management-stations/#detect-card-readers). + +### Configuring Card Readers + +To add a card reader device, perform the following steps: + +1. In Workstation Management, navigate to the **Devices** section on the **Station Detail** page. +2. Click **Add Device**, select **Card Reader**, and then click **Next**. +3. In the **Device Name** field, enter an identifying name for the device. +4. Optional: Select or create a class to help you manage your devices. +5. Click **Next**. +6. In the **Card Reader Name** field, enter the name of the card reader as it is defined by the operating system. This field is required. + + {{% alert color="info" %}} + To find the name of the card reader, check the diagnostics of the Workstation Client, which list each attached card reader with its `name` under `cardReaders`. In Workstation Management, click **Diagnostics** on the **Station Detail** page, as described in [Managing Stations: Client Diagnostics](/mendix-workstation/management-stations/#client-diagnostics). Alternatively, open the **Diagnostics** page of the Client itself, which is available when developer mode is enabled, as described in [Troubleshooting the Workstation Client: Diagnostics](/mendix-workstation/troubleshooting-workstation-client/#diagnostics). Both ways require a registered station: the Workstation Client must run on a computer with the card reader attached, and be registered to a station. + {{% /alert %}} + +7. Click **Add Device**. + +When the Workstation Client receives the station configuration, it connects to the card reader with the configured name. If no card reader with that name is attached, the device stays unavailable until the card reader is attached. If **Detect Card Readers** is also enabled, the Workstation Client displays only the configured device for a configured card reader, and does not add that card reader a second time as a detected device. This also applies when the **Device Name** of the configured device is the name of the card reader. Card readers that are not configured are still detected and displayed. For the message syntax used to communicate with this device, see [Card Readers](/mendix-workstation/device-syntax/#card-readers). From 4e2921143edad888d8a8fdc534a43d23f46abb80 Mon Sep 17 00:00:00 2001 From: Nikolas Leimer Date: Fri, 2 Oct 2026 14:47:29 +0200 Subject: [PATCH 08/12] Workstation Management: document the local user email case fix Adds the 4.3.0 Bug Fixes bullet for local users whose email address contains uppercase letters. --- content/en/docs/releasenotes/workstation/_index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/en/docs/releasenotes/workstation/_index.md b/content/en/docs/releasenotes/workstation/_index.md index 7121eb39aba..38d9e0e6c7a 100644 --- a/content/en/docs/releasenotes/workstation/_index.md +++ b/content/en/docs/releasenotes/workstation/_index.md @@ -29,6 +29,7 @@ These release notes cover changes made to the [Mendix Workstation](/mendix-works #### Bug Fixes * We have fixed an issue where refreshing the **Test Your Station** page bypassed the check that the station belongs to the current workspace. +* We have fixed an issue where a local user whose email address contained uppercase letters could not be found when adding them to a workspace. ### Workstation Client From 750a4a87f304ecd204f57d1197f0a6f62315c9db Mon Sep 17 00:00:00 2001 From: Nikolas Leimer Date: Fri, 2 Oct 2026 17:17:28 +0200 Subject: [PATCH 09/12] Workstation Client: document API key encryption at rest The Workstation Client now encrypts its API key with the secret store of the operating system. Adds the 4.3.0 Improvements bullet, a Secret Store system requirement, a keyring note for Linux bulk registration, and troubleshooting sections for an unavailable secret store and for registering the Client again. --- .../docs/releasenotes/workstation/_index.md | 6 +++ .../client/wks-batch-registration.md | 4 ++ .../client/wks-client-installation.md | 3 +- .../wks-troubleshooting-client.md | 46 +++++++++++++++++++ 4 files changed, 58 insertions(+), 1 deletion(-) diff --git a/content/en/docs/releasenotes/workstation/_index.md b/content/en/docs/releasenotes/workstation/_index.md index 38d9e0e6c7a..fb398e04d9a 100644 --- a/content/en/docs/releasenotes/workstation/_index.md +++ b/content/en/docs/releasenotes/workstation/_index.md @@ -37,6 +37,12 @@ These release notes cover changes made to the [Mendix Workstation](/mendix-works * Client diagnostics - The Workstation Client now answers diagnostics requests from Workstation Management, so a station's diagnostics can be inspected without access to the computer. The local file system paths that the client's own **Diagnostics** page shows are left out of the response. +#### Improvements + +* Credential storage - The Workstation Client now encrypts its API key at rest with the secret store of the operating system, which protects the key from being copied off the computer. An API key that is stored in plain text is encrypted automatically the first time the Client reads it after the upgrade, so no action is needed. This has the following implications: + * Potentially breaking change - The Workstation Client now requires a secret store of the operating system. The secret store exists by default on Windows and macOS, and on most Linux distributions that are commonly used in production environments. Ensure that your Linux distribution meets this requirement, as the Client does not start otherwise. For more information, see [Troubleshooting the Workstation Client: Safe Storage Is Unavailable](/mendix-workstation/troubleshooting-workstation-client/#safe-storage-unavailable). + * In some scenarios, such as copying the configuration folder to another computer or downgrading the Client, the Workstation Client must be registered again. For more information, see [Troubleshooting the Workstation Client: Client Must Be Registered Again](/mendix-workstation/troubleshooting-workstation-client/#client-registered-again). + ## 4.2.1 ### Release date: September 16, 2026 diff --git a/content/en/docs/workstation/client/wks-batch-registration.md b/content/en/docs/workstation/client/wks-batch-registration.md index 35fef37deca..8c388bcb95a 100644 --- a/content/en/docs/workstation/client/wks-batch-registration.md +++ b/content/en/docs/workstation/client/wks-batch-registration.md @@ -64,6 +64,10 @@ To bulk-register Workstation Clients, perform the following steps: On Linux machines, you can use the following script: `mendix-workstation --registration-token {bulk registration token}`. + {{% alert color="info" %}} + The Client requires an unlocked keyring to encrypt its API key. If you run the script from an SSH session, the keyring may not be running or may be locked, and the Client does not start. In that case, unlock the keyring in the SSH session before you run the script. For more information, see [Troubleshooting the Workstation Client: Safe Storage Is Unavailable](/mendix-workstation/troubleshooting-workstation-client/#safe-storage-unavailable). + {{% /alert %}} + For more information about the options that the Workstation Client accepts on the command line, see [Command-Line Options](/mendix-workstation/use-client/#command-line-options). After the command runs or the token is entered manually, the Workstation Clients display the status **Waiting for station assignment**. This indicates that the clients are registered, but not yet associated with a specific station. diff --git a/content/en/docs/workstation/client/wks-client-installation.md b/content/en/docs/workstation/client/wks-client-installation.md index e51f8113baf..2e14102085b 100644 --- a/content/en/docs/workstation/client/wks-client-installation.md +++ b/content/en/docs/workstation/client/wks-client-installation.md @@ -19,7 +19,8 @@ Before you install the Workstation Client, ensure that you fulfill the following * Operating System - Windows 10 or Windows 11 (64-bit); Linux ARM64; macOS (Apple Silicon) * Memory - Minimum 4 GB RAM (8 GB recommended for optimal performance) -* Disk Space - 400 MB of free disk space for installation +* Disk Space - 450 MB of free disk space for installation +* Secret Store - A secret store of the operating system, which the Client uses to encrypt its API key. It exists by default on Windows and macOS. On Linux, ensure that a keyring is installed and unlocked; otherwise, the Client does not start. For more information, see [Troubleshooting the Workstation Client: Safe Storage Is Unavailable](/mendix-workstation/troubleshooting-workstation-client/#safe-storage-unavailable). ### Access Requirements diff --git a/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md b/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md index 8ff2728454d..55bcd234c11 100644 --- a/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md +++ b/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md @@ -32,6 +32,52 @@ When [Developer Mode](/mendix-workstation/management-stations/#developer-mode) i You can also retrieve a subset of this information from Workstation Management, without access to the computer and regardless of whether Developer Mode is enabled. For more information, see the [Client Diagnostics](/mendix-workstation/management-stations/#client-diagnostics) section in *Managing Stations*. +## Safe Storage Is Unavailable {#safe-storage-unavailable} + +The Client does not start and shows the following error: *Safe storage is unavailable. Install or unlock the system keyring and retry.* On Linux, the computer may also show a prompt to unlock the keyring. + +### Cause + +The Client encrypts its API key with the secret store of the operating system, and cannot start without it. On Linux, the secret store is the keyring of the desktop environment, which is usually unlocked with the password that the user enters at login. The Client cannot start in the following cases: + +* The keyring is not installed. +* The keyring is locked. +* The Client is started from an SSH session - No desktop login takes place, so the keyring may not be running or may be locked. +* The computer logs in automatically, for example a shop floor computer in kiosk mode - No password is entered at login, so the keyring stays locked and the operating system prompts for its password. On an unattended computer, nobody enters it, and the Client does not start. +* The desktop environment provides no supported keyring - This can be the case with minimal kiosk sessions. + +### Solution + +Install or unlock the keyring of the operating system, and then start the Client again. Depending on the cause, use one of the following approaches: + +* SSH session - Before you start the Client, start the keyring service in the SSH session and unlock it with the password of the user. Alternatively, log in to the desktop session of the user on the computer, which unlocks the keyring, and then start the Client. +* Automatic login - Configure the login of the computer so that it unlocks the keyring. +* No supported keyring - Install a keyring that is supported by your desktop environment. + +For the exact steps, see the documentation of your Linux distribution, desktop environment, or keyring. + +{{% alert color="warning" %}} +Do not work around this issue by setting a blank password for the keyring. The Client then starts and encrypts its API key, but depending on the keyring, its contents may no longer be protected. This could lead to a situation where the credentials of the Client are not protected from being copied off the computer. +{{% /alert %}} + +## Client Must Be Registered Again {#client-registered-again} + +After a change to the computer, the Client shows the registration screen although it was registered before. + +### Cause + +The API key of the Client can only be decrypted with the secret store that encrypted it. If the secret store changes, the Client cannot read its credentials. This happens in the following scenarios: + +* The configuration folder is copied between computers or into an image, for example for a shared installation. +* A computer is replaced and its configuration folder is restored from a backup. +* An administrator resets the password of the user, for installations per user. +* The keyring changes on Linux. +* The Client is downgraded from version 4.3 to a lower version. + +### Solution + +Register the Client again. For more information, see [Registering Workstation Clients](/mendix-workstation/register/). + ## Registration Token Could Not Be Parsed The Client shows an error like the following: *Registration token could not be parsed. Please enter another token!* From 1e526b9240e5952b593309ee8c8da14f4db4cbbe Mon Sep 17 00:00:00 2001 From: Nikolas Leimer Date: Fri, 2 Oct 2026 18:15:12 +0200 Subject: [PATCH 10/12] Workstation Client: document camera devices and device testing Documents camera support in the Workstation Client, including barcode and motion detection, the camera message syntax and the supported barcode types. Adds a Testing Devices section to Using the Workstation Client, including the camera test buttons, clarifies the Camera Name parameter in Configuring Devices, and adds the 4.3.0 release notes. --- .../docs/releasenotes/workstation/_index.md | 2 ++ .../workstation/client/wks-client-usage.md | 30 ++++++++++++++++ .../connector/wks-connector-device-syntax.md | 35 +++++++++++++++++++ .../management/wks-management-devices.md | 2 +- 4 files changed, 68 insertions(+), 1 deletion(-) diff --git a/content/en/docs/releasenotes/workstation/_index.md b/content/en/docs/releasenotes/workstation/_index.md index fb398e04d9a..fbc87fa65af 100644 --- a/content/en/docs/releasenotes/workstation/_index.md +++ b/content/en/docs/releasenotes/workstation/_index.md @@ -36,6 +36,8 @@ These release notes cover changes made to the [Mendix Workstation](/mendix-works #### New Features * Client diagnostics - The Workstation Client now answers diagnostics requests from Workstation Management, so a station's diagnostics can be inspected without access to the computer. The local file system paths that the client's own **Diagnostics** page shows are left out of the response. +* Camera devices - We have added support for USB cameras and webcams, including barcode and motion detection. For more information, see [Device Message Syntax: Camera](/mendix-workstation/device-syntax/#camera). +* Device testing - We have added a test view to the Workstation Client to test devices directly on the computer, like the **Test Your Station** page in Workstation Management. For more information, see [Using the Workstation Client: Testing Devices](/mendix-workstation/use-client/#testing-devices). #### Improvements diff --git a/content/en/docs/workstation/client/wks-client-usage.md b/content/en/docs/workstation/client/wks-client-usage.md index 314ed9c2b32..46372476304 100644 --- a/content/en/docs/workstation/client/wks-client-usage.md +++ b/content/en/docs/workstation/client/wks-client-usage.md @@ -32,6 +32,7 @@ The **Devices** section shows a list of all devices currently associated with th * Availability - When a device shows as **Available**, it is likely connectable. The specifics depend on the device type: * Bluetooth - Bluetooth devices are scanned continuously. They are considered available if seen, and unavailable if not seen for 30 seconds. + * Camera - The Client checks the cameras attached to the computer. The device is available if the name of an attached camera contains the configured **Camera Name**, ignoring case. If no **Camera Name** is configured, the first camera that the Client finds is used. * Printer - The Client polls the system printer list. The scan only checks that the device exists, not its status, configuration, or connectivity. * Serial device - The Client polls the system port list. The scan only checks that the device exists, not its connectivity. * TCP/IP client - The Client only checks that the host is defined and the port is valid. It cannot verify remote connectivity without actually connecting. @@ -41,6 +42,35 @@ The **Devices** section shows a list of all devices currently associated with th You can also expand each device to see more information about its connection parameters (for example, the host or port of a TCP/IP server). +### Testing Devices {#testing-devices} + +When [Developer Mode](/mendix-workstation/management-stations/#developer-mode) is enabled, you can test a device directly in the Workstation Client, without a Mendix app. This works like the **Test Your Station** page in Workstation Management. To test a device, click the **test** icon (flask) next to the device in the **Devices** section. + +The test view shows the following: + +* The device type and device class. +* The availability, connection, and error status of the device. +* A log of the messages that are sent to the device (`<-`) and received from it (`->`), and of connection changes. + +To communicate with the device, perform the following actions: + +* Click **Connect** or **Disconnect** to open or close the connection to the device. +* Enter a message in the message field, and then click **Send** or press Enter. If the device is not connected yet, the Client connects first. If you send an empty message, the last message is sent again. + +For the message syntax of each device type, see [Device Message Syntax](/mendix-workstation/device-syntax/). + +#### Testing Cameras {#testing-cameras} + +For camera devices, the test view also shows the following preconfigured test buttons, so you do not need to enter the commands manually: + +* **Start camera** / **Stop camera** - Show or hide a live preview of the camera feed. +* **Scan barcode** - Scan the current frame for barcodes once. Only works when **Enable Barcode Detection** is enabled for the camera in Workstation Management. +* **Start barcode detection** / **Stop barcode detection** - Continuously report the barcodes that enter and leave the frame. Only works when **Enable Barcode Detection** is enabled for the camera in Workstation Management. +* **Start motion detection** / **Stop motion detection** - Report when motion starts and stops in the frame. Only works when **Enable Motion Detection** is enabled for the camera in Workstation Management. +* **Help** - Show the available camera commands. + +If a detection capability is not enabled, its buttons are disabled. To enable barcode or motion detection, edit the camera device in Workstation Management. For more information, see [Configuring Devices: Camera](/mendix-workstation/management-devices/#camera). + ## Additional Actions Click the **three dots** menu in the top right corner of the Workstation Client to perform any of the following actions: diff --git a/content/en/docs/workstation/connector/wks-connector-device-syntax.md b/content/en/docs/workstation/connector/wks-connector-device-syntax.md index 67e3670f5a7..4aff92eeb30 100644 --- a/content/en/docs/workstation/connector/wks-connector-device-syntax.md +++ b/content/en/docs/workstation/connector/wks-connector-device-syntax.md @@ -58,6 +58,41 @@ Once subscribed, every notification from the device arrives as a response in the Instead of building these messages by hand, you can call the `BLE_Subscribe`, `BLE_Unsubscribe`, `BLE_Read`, and `BLE_Write` nanoflows from [Workstation Commons](/mendix-workstation/commons/#bluetooth), which take `ServiceUUID` and `CharacteristicUUID` as plain parameters. +## Camera {#camera} + +This device type requires the following messages and responses. Barcode commands are available only when **Enable Barcode Detection** is configured for the device, and motion commands only when **Enable Motion Detection** is configured. Send `H` to the camera to list all commands, and `B#H` to list the supported barcode types. + +### Message + +* `B#S` - Scan the next available frame for all barcode types. +* `B#S#Type1,Type2,...` - Scan the next available frame for the specified barcode types. +* `B#C#S` - Start continuous scanning for all barcode types. +* `B#C#S#Type1,Type2,...` - Add the specified barcode types to continuous scanning. +* `B#C#T` - Stop continuous scanning for all barcode types. +* `B#C#T#Type1,Type2,...` - Remove the specified barcode types from continuous scanning. +* `M#S` - Start motion detection. +* `M#T` - Stop motion detection. +* `H` - Show all camera commands. `B#H`, `M#H`, and `W#H` show the barcode, motion, and live preview commands. + +### Response + +* `B#S#Count#Type1:TextBase64,...` - The barcodes found in the scanned frame. Each barcode consists of its type and its content encoded in Base64. +* `B#C#S#Count#Type1:TextBase64,...` - During continuous scanning, the barcodes that entered the frame. +* `B#C#T#Count#Type1:TextBase64,...` - During continuous scanning, the barcodes that left the frame. A barcode is reported as left when it has not been detected for one second. +* `M#S#Score` - Motion started. `Score` is the share of changed pixels in the frame, between `0` and `1`. +* `M#T#Score` - Motion stopped. + +Motion is reported only when it starts or stops for at least about 250 milliseconds, not for every frame. + +### Barcode Types + +Use the following values for `Type1,Type2,...` in the barcode commands. Values that start with `All` select a group of barcode types. + +* Groups - `All`, `AllReadable`, `AllCreatable`, `AllLinear`, `AllMatrix`, `AllGS1`, `AllRetail`, `AllIndustrial` +* Linear barcodes - `Codabar`, `Code39`, `Code39Std`, `Code39Ext`, `Code32`, `PZN`, `Code93`, `Code128`, `ITF`, `ITF14`, `DataBar`, `DataBarOmni`, `DataBarStk`, `DataBarStkOmni`, `DataBarLtd`, `DataBarExp`, `DataBarExpStk`, `EANUPC`, `EAN13`, `EAN8`, `ISBN`, `UPCA`, `UPCE`, `Telepen`, `TelepenAlpha`, `TelepenNumeric`, `DXFilmEdge` +* Matrix barcodes - `PDF417`, `CompactPDF417`, `MicroPDF417`, `Aztec`, `AztecCode`, `AztecRune`, `QRCode`, `QRCodeModel1`, `QRCodeModel2`, `MicroQRCode`, `RMQRCode`, `DataMatrix`, `MaxiCode` +* Other - `OtherBarcode` + ## Keyboard Wedge {#keyboard-wedge} Keyboard wedge devices are input-only, so Mendix applications do not send messages to them. When the Workstation Client recognizes a complete message, it forwards the payload to the Workstation Connector with the prefix and suffix removed. diff --git a/content/en/docs/workstation/management/wks-management-devices.md b/content/en/docs/workstation/management/wks-management-devices.md index bb895cacbbc..77ec9749350 100644 --- a/content/en/docs/workstation/management/wks-management-devices.md +++ b/content/en/docs/workstation/management/wks-management-devices.md @@ -192,7 +192,7 @@ To add a camera device, perform the following steps: | Parameter | Description | | --- | --- | | **Camera Type** | Required; the type of camera connection. Only **USB/Webcam** is currently supported. Support for camera streams over Real Time Streaming Protocol (RTSP), User Datagram Protocol (UDP), and HTTP with Motion JPEG (MJPEG) is planned. | - | **Camera Name** | Optional; the name of the camera to use. Leave the field empty to use the default camera. | + | **Camera Name** | Optional; the name of the camera to use. The Workstation Client uses the first camera whose name contains this value, ignoring case. Leave the field empty to use the first camera that the Client finds. | | **Width** | Optional; the requested width of the camera feed. If the camera does not support the requested value, the closest supported value is used. The value must be greater than `0`, or empty. | | **Height** | Optional; the requested height of the camera feed. If the camera does not support the requested value, the closest supported value is used. The value must be greater than `0`, or empty. | | **Frame Rate** | Optional; the requested frame rate of the camera feed. If the camera does not support the requested value, the closest supported value is used. The value must be greater than `0`, or empty. | From 5796a9375e7a32e978de2c8a6c0bfc4b2ed066a4 Mon Sep 17 00:00:00 2001 From: mendix-nleimer <93211773+mendix-nleimer@users.noreply.github.com> Date: Fri, 25 Sep 2026 11:04:43 +0200 Subject: [PATCH 11/12] Update release notes for Test your Station fix - more accurate description of what was fixed on Test your Station - consistently simple past --- .../docs/releasenotes/workstation/_index.md | 204 +++++++++--------- 1 file changed, 102 insertions(+), 102 deletions(-) diff --git a/content/en/docs/releasenotes/workstation/_index.md b/content/en/docs/releasenotes/workstation/_index.md index fbc87fa65af..b64c413d016 100644 --- a/content/en/docs/releasenotes/workstation/_index.md +++ b/content/en/docs/releasenotes/workstation/_index.md @@ -18,9 +18,9 @@ These release notes cover changes made to the [Mendix Workstation](/mendix-works #### New Features -* Camera devices - We have added a new *camera* connection type to configure a USB camera or webcam attached to the computer that runs the Workstation Client. You can set the camera to use and the requested width, height, and frame rate of its video feed, and enable barcode and motion detection. For more information, see [Configuring Devices: Camera](/mendix-workstation/management-devices/#camera). -* Client diagnostics - We have added a **Diagnostics** button to the **Station Detail** page that retrieves the diagnostics of the Workstation Client on the registered computer. You can see which peripherals it detects, what system it runs on, and how many log entries it has recorded per level, without access to that computer. For more information, see [Managing Stations: Client Diagnostics](/mendix-workstation/management-stations/#client-diagnostics). -* Card reader devices - We have added a new *card reader* connection type to define the card readers that a station uses by their name, in addition to detecting them automatically. Configured card readers are part of the station configuration, so they are kept when you copy a station. For more information, see [Configuring Devices: Card Readers](/mendix-workstation/management-devices/#card-readers). +* Camera devices - We added a new *camera* connection type to configure a USB camera or webcam attached to the computer that runs the Workstation Client. You can set the camera to use and the requested width, height, and frame rate of its video feed, and enable barcode and motion detection. For more information, see [Configuring Devices: Camera](/mendix-workstation/management-devices/#camera). +* Client diagnostics - We added a **Diagnostics** button to the **Station Detail** page that retrieves the diagnostics of the Workstation Client on the registered computer. You can see which peripherals it detects, what system it runs on, and how many log entries it has recorded per level, without access to that computer. For more information, see [Managing Stations: Client Diagnostics](/mendix-workstation/management-stations/#client-diagnostics). +* Card reader devices - We added a new *card reader* connection type to define the card readers that a station uses by their name, in addition to detecting them automatically. Configured card readers are part of the station configuration, so they are kept when you copy a station. For more information, see [Configuring Devices: Card Readers](/mendix-workstation/management-devices/#card-readers). #### Improvements @@ -28,16 +28,16 @@ These release notes cover changes made to the [Mendix Workstation](/mendix-works #### Bug Fixes -* We have fixed an issue where refreshing the **Test Your Station** page bypassed the check that the station belongs to the current workspace. -* We have fixed an issue where a local user whose email address contained uppercase letters could not be found when adding them to a workspace. +* We fixed an issue where refreshing the **Test Your Station** page did not reflect the latest state of the workspace settings and station configuration on the Workstation Client. +* We fixed an issue where a local user whose email address contained uppercase letters could not be found when adding them to a workspace. ### Workstation Client #### New Features * Client diagnostics - The Workstation Client now answers diagnostics requests from Workstation Management, so a station's diagnostics can be inspected without access to the computer. The local file system paths that the client's own **Diagnostics** page shows are left out of the response. -* Camera devices - We have added support for USB cameras and webcams, including barcode and motion detection. For more information, see [Device Message Syntax: Camera](/mendix-workstation/device-syntax/#camera). -* Device testing - We have added a test view to the Workstation Client to test devices directly on the computer, like the **Test Your Station** page in Workstation Management. For more information, see [Using the Workstation Client: Testing Devices](/mendix-workstation/use-client/#testing-devices). +* Camera devices - We added support for USB cameras and webcams, including barcode and motion detection. For more information, see [Device Message Syntax: Camera](/mendix-workstation/device-syntax/#camera). +* Device testing - We added a test view to the Workstation Client to test devices directly on the computer, like the **Test Your Station** page in Workstation Management. For more information, see [Using the Workstation Client: Testing Devices](/mendix-workstation/use-client/#testing-devices). #### Improvements @@ -53,17 +53,17 @@ These release notes cover changes made to the [Mendix Workstation](/mendix-works #### New Features -* Keyboard wedge devices - We have added keyboard wedge support for Linux. +* Keyboard wedge devices - We added keyboard wedge support for Linux. #### Bug Fixes -* We have fixed an issue with the mapping of the keyboard layouts that resulted in incorrect interpretation of keyboard inputs. +* We fixed an issue with the mapping of the keyboard layouts that resulted in incorrect interpretation of keyboard inputs. ### Workstation Commons #### Bug Fixes -* We have included a missing dependency on the sticky scroll widget. +* We included a missing dependency on the sticky scroll widget. ## 4.2.0 @@ -73,26 +73,26 @@ These release notes cover changes made to the [Mendix Workstation](/mendix-works #### New Features -* Keyboard wedge devices - We have added a new *keyboard wedge* connection type to connect with devices sending data as keyboard strokes. This connection enables basic integration with input devices like barcode scanners, RFID readers, or measurement devices. For more information, see [Configuring Devices: Keyboard Wedge](/mendix-workstation/management-devices/#keyboard-wedge). +* Keyboard wedge devices - We added a new *keyboard wedge* connection type to connect with devices sending data as keyboard strokes. This connection enables basic integration with input devices like barcode scanners, RFID readers, or measurement devices. For more information, see [Configuring Devices: Keyboard Wedge](/mendix-workstation/management-devices/#keyboard-wedge). #### Improvements -* Station creation - We have added the option to create a new station by copying an existing station. For more information, see [Managing Stations: Creating a New Station](/mendix-workstation/management-stations/#create-station). +* Station creation - We added the option to create a new station by copying an existing station. For more information, see [Managing Stations: Creating a New Station](/mendix-workstation/management-stations/#create-station). * Station details - The station details now display if there is a live connection to a Workstation Client on a registered computer. -* Adding devices - We have improved the UX of the **Add Device** wizard when selecting a connection type. +* Adding devices - We improved the UX of the **Add Device** wizard when selecting a connection type. * Registering computers - When clipboard permissions are disabled in the browser, the registration key is instead fully displayed in a text area. -* Private management - We have made the following improvement to Private Workstation Management: +* Private management - We made the following improvement to Private Workstation Management: - * We have made it easier to see if a specific SSO configuration was created at runtime or deploy time. A warning appears when editing a deploy-time configuration at runtime. - * To provide more flexibility when switching SSO protocols, we have made it possible to edit SSO users and their principal attributes. - * We have fixed some UI issues in the navigation and the SAML metadata popup window. - * We have added the missing default attribute mapping for Display Name in the SAML configuration. - * We have upgraded Private Workstation Management to Mendix 11.12.4. + * We made it easier to see if a specific SSO configuration was created at runtime or deploy time. A warning appears when editing a deploy-time configuration at runtime. + * To provide more flexibility when switching SSO protocols, We made it possible to edit SSO users and their principal attributes. + * We fixed some UI issues in the navigation and the SAML metadata popup window. + * We added the missing default attribute mapping for Display Name in the SAML configuration. + * We upgraded Private Workstation Management to Mendix 11.12.4. #### Bug Fixes -* We have fixed an issue where the **Workspace Settings** page would freeze after closing the **Log Level**, **Retention Policy**, and **Client Update Check Interval** dialogs. -* We have fixed *uncontrolled input* warnings that would appear in the console. +* We fixed an issue where the **Workspace Settings** page would freeze after closing the **Log Level**, **Retention Policy**, and **Client Update Check Interval** dialogs. +* We fixed *uncontrolled input* warnings that would appear in the console. ### Workstation Client @@ -102,13 +102,13 @@ These release notes cover changes made to the [Mendix Workstation](/mendix-works #### Improvements -* Registering computers - We have improved computer registration to prevent accidental double submissions. We have also added a **Registering...** indicator while the request is in progress. +* Registering computers - We improved computer registration to prevent accidental double submissions. We also added a **Registering...** indicator while the request is in progress. ### Workstation Connector #### Improvements -* UX improvements - We have added new toolbox icons for all exposed Javascript actions that dark-mode compatible and aligned with the icons in Studio Pro. +* UX improvements - We added new toolbox icons for all exposed Javascript actions that dark-mode compatible and aligned with the icons in Studio Pro. ### Marketplace @@ -138,7 +138,7 @@ These release notes cover changes made to the [Mendix Workstation](/mendix-works #### New Features * Improved client reporting - The client now sends detailed installation information (**Client Type**) to the Management system, providing better visibility into your deployment. -* Consistent device states - We have refactored how devices are managed to ensure they consistently report their status as available, connected, or in an error state. +* Consistent device states - We refactored how devices are managed to ensure they consistently report their status as available, connected, or in an error state. #### Improvements @@ -168,19 +168,19 @@ We are thrilled to announce the General Availability (GA) release of our Worksta #### New Features * Default printer usage - You can now create a printer device without specifying a name. The Workstation Client will then automatically connect to the default printer as defined by the operating system, simplifying printer setup. -* PDF Printing Support (Windows) - We have added support for PDF printing on Windows Workstation Clients, expanding your printing capabilities. +* PDF Printing Support (Windows) - We added support for PDF printing on Windows Workstation Clients, expanding your printing capabilities. * Enhanced usage report filters - The usage report now includes a workspace environment type filter (Test, Acceptance, or Production). This allows for more granular analysis of Workstation usage across different stages of your deployment. -* More accurate usage metrics - We have refined the usage report by switching unique client counting from Station ID to Client ID and added an environment-type filter. This provides more precise and insightful usage data. +* More accurate usage metrics - We refined the usage report by switching unique client counting from Station ID to Client ID and added an environment-type filter. This provides more precise and insightful usage data. * Downloadable company usage report - You can now download the company usage report, making it easier to analyze and share your Workstation usage data offline. -* Device class and station group management - We have introduced full Create, Read, Update, and Delete (CRUD) capabilities for device classes and station groups. Newly created station groups and device classes are automatically selected during station creation, editing, or acceptance, streamlining your workflow. +* Device class and station group management - We introduced full Create, Read, Update, and Delete (CRUD) capabilities for device classes and station groups. Newly created station groups and device classes are automatically selected during station creation, editing, or acceptance, streamlining your workflow. #### Improvements -* Dependency security and updates - We have fixed some vulnerabilities in dependencies, and updated the modules to enhance security and performance. +* Dependency security and updates - We fixed some vulnerabilities in dependencies, and updated the modules to enhance security and performance. #### Bug Fixes -* We have fixed a bug that occurred with trailing whitespace in the URLs of imported applications within JSON files, ensuring smoother app imports. +* We fixed a bug that occurred with trailing whitespace in the URLs of imported applications within JSON files, ensuring smoother app imports. ### Private Workstation Management @@ -200,7 +200,7 @@ We are thrilled to announce the General Availability (GA) release of our Worksta #### Bug Fixes -* We have fixed some issues with non-UTF-8 delimiter or suffix encoding in serial, TCP-IP client, and TCP-IP server devices, ensuring reliable data transmission. +* We fixed some issues with non-UTF-8 delimiter or suffix encoding in serial, TCP-IP client, and TCP-IP server devices, ensuring reliable data transmission. ### Workstation Connector @@ -263,11 +263,11 @@ We are thrilled to announce the General Availability (GA) release of our Worksta #### Improvements -* Configurable auto-refresh behavior – We have provided options for how auto-refresh works, including default settings for workspaces and how clients respond in both automatic and manual modes. This allows for flexible management of your workstation configurations. +* Configurable auto-refresh behavior – We provided options for how auto-refresh works, including default settings for workspaces and how clients respond in both automatic and manual modes. This allows for flexible management of your workstation configurations. #### Fixes -* UI inconsistencies – We have fixed several visual inconsistencies in the Management UI, particularly improving the display and user experience when using dark mode. This makes the interface cleaner and more consistent for everyone. +* UI inconsistencies – We fixed several visual inconsistencies in the Management UI, particularly improving the display and user experience when using dark mode. This makes the interface cleaner and more consistent for everyone. ### Workstation Client @@ -288,7 +288,7 @@ We are thrilled to announce the General Availability (GA) release of our Worksta #### Fixes -* We have fixed an issue where, due to security hardening, it was not possible to refresh the configuration of a Workstation Client which was originally registered with an earlier version of Workstation Management. +* We fixed an issue where, due to security hardening, it was not possible to refresh the configuration of a Workstation Client which was originally registered with an earlier version of Workstation Management. ## 3.6.0 @@ -298,34 +298,34 @@ We are thrilled to announce the General Availability (GA) release of our Worksta #### New Features -* We have enhanced the **Test Your Station** page with more granular functions to test, validate and troubleshoot communication with devices. This includes more connection states, a **Connect** and **Disconnect** button, and communication logs. You can also switch between devices to test multiple devices. +* We enhanced the **Test Your Station** page with more granular functions to test, validate and troubleshoot communication with devices. This includes more connection states, a **Connect** and **Disconnect** button, and communication logs. You can also switch between devices to test multiple devices. * Single computer registration keys are now valid for one hour. The keys are displayed and visible to all authorized users. * The maximum time window for bulk registration keys is limited to three months. -* We have improved the **Station management** user interface for a more intuitive use experience. +* We improved the **Station management** user interface for a more intuitive use experience. #### Fixes -* To support advanced use cases when preparing station configurations on multiple computers, we have fixed an issue which prevented stations from being edited when multiple stations shared the same computer name. Computer names for stations within the same workspace are no longer required to be unique. +* To support advanced use cases when preparing station configurations on multiple computers, We fixed an issue which prevented stations from being edited when multiple stations shared the same computer name. Computer names for stations within the same workspace are no longer required to be unique. {{% alert color="info" %}} If more than one station is found for a given computer name during bulk registration, the system now automatically creates an *Unassigned computer* instead of attempting an automatic assignment. This ensures that you can manually select the correct station configuration, preventing unintended assignments. {{% /alert %}} -* We have fixed an issue where the login dialogue was opened after a session time-out. +* We fixed an issue where the login dialogue was opened after a session time-out. ### Workstation Client #### Fixes -* We have addressed some minor issues within the Bluetooth functionality, including improved handling of Bluetooth protocol errors to prevent unexpected behavior. -* We have fixed a crash that could occur during window movement if the client configuration was not writable, improving the application stability. -* We have updated the underlying dependencies for the Smart Card reader functionality, enhancing stability and compatibility. +* We addressed some minor issues within the Bluetooth functionality, including improved handling of Bluetooth protocol errors to prevent unexpected behavior. +* We fixed a crash that could occur during window movement if the client configuration was not writable, improving the application stability. +* We updated the underlying dependencies for the Smart Card reader functionality, enhancing stability and compatibility. ### Workstation Connector #### New Features -* We have added a number of other new nanoflows, JavaScript actions, and widgets to simplify the creation of custom, reusable peripheral modules for your organization: +* We added a number of other new nanoflows, JavaScript actions, and widgets to simplify the creation of custom, reusable peripheral modules for your organization: * Manage peripheral object creation and initialize peripheral objects using the new `GetCreateDevice` action. You can configure callbacks on connection, on message, and on disconnection. * Trigger application level logic on device events with new widgets. Handling peripheral events no longer requires changing peripheral modules. @@ -341,13 +341,13 @@ For more information, see [Nanoflows](/mendix-workstation/develop-app/#javascrip #### Fixes -* We have removed the `Station_User` association. Object garbage collection is now handled internally, leading to more robust object management. -* We have fixed an issue related to the timing of initial connections. -* We have fixed an issue where devices were sometimes discovered with a delay. +* We removed the `Station_User` association. Object garbage collection is now handled internally, leading to more robust object management. +* We fixed an issue related to the timing of initial connections. +* We fixed an issue where devices were sometimes discovered with a delay. #### Deprecations -* We have deprecated the following actions: +* We deprecated the following actions: * `SendMessage` – Deprecated in favor of `SendDeviceMessage` and `WaitForDeviceMessage` * `SubscribeToMessages` – Deprecated in favor of `GetCreateDevice` @@ -365,19 +365,19 @@ For more information, see [Nanoflows](/mendix-workstation/develop-app/#javascrip * Updated access controls for Computer Admin role – The Computer Admin role now has updated access permissions, allowing them only to read and view existing bulk registration tokens and their associated details. -* Improved UI for bulk registration token management – We have updated the user interface for managing bulk registration tokens, enhancing the overall user experience and making it more intuitive to work with. +* Improved UI for bulk registration token management – We updated the user interface for managing bulk registration tokens, enhancing the overall user experience and making it more intuitive to work with. #### Fixes -* Unassigned computers excluded from station export – We have fixed an issue where unassigned computers were incorrectly included in station exports. Now, unassigned computers are no longer exportable as stations and will not appear in the list of stations available for download, ensuring cleaner and more accurate exports. +* Unassigned computers excluded from station export – We fixed an issue where unassigned computers were incorrectly included in station exports. Now, unassigned computers are no longer exportable as stations and will not appear in the list of stations available for download, ensuring cleaner and more accurate exports. -* Duplicate station naming in single import – The single import behavior has been updated to accept duplicate names by automatically adding a numeric suffix when a station with the same name is imported, ensuring unique identification and smoother workflow. We have addressed an issue where empty stations were unintentionally created. +* Duplicate station naming in single import – The single import behavior has been updated to accept duplicate names by automatically adding a numeric suffix when a station with the same name is imported, ensuring unique identification and smoother workflow. We addressed an issue where empty stations were unintentionally created. ### Workstation Client #### Fixes -* Robust remote deregistration error handling – We have fixed an issue where an uncaught error pop-up could occasionally appear if Workstation Management crashed immediately after a remote deregistration of a station. This ensures a more stable and resilient client experience. +* Robust remote deregistration error handling – We fixed an issue where an uncaught error pop-up could occasionally appear if Workstation Management crashed immediately after a remote deregistration of a station. This ensures a more stable and resilient client experience. ## 3.4.0 @@ -387,14 +387,14 @@ For more information, see [Nanoflows](/mendix-workstation/develop-app/#javascrip #### New Features -* Enhanced bulk registration process – We have improved the bulk registration experience to make managing multiple workstations even more efficient and intuitive. +* Enhanced bulk registration process – We improved the bulk registration experience to make managing multiple workstations even more efficient and intuitive. * New unassigned stations list – If a newly registered station cannot be automatically matched with a preconfigured station, it now appears in the new **Unassigned Stations** list. Before you can edit these unassigned stations, you must first either accept or manually assign them, giving you better control over station assignments. - * Code snippet copier – To simplify the registration process from the terminal, we have added a convenient code snippet copier, making the process quicker and less prone to errors. + * Code snippet copier – To simplify the registration process from the terminal, We added a convenient code snippet copier, making the process quicker and less prone to errors. * Reopenable registration token – You can now reopen and copy the registration token if you need to access it again after initial generation. * Token expiration banner – A clear banner now displays if your registration token has expired, helping you stay informed and avoid registration issues. -* Advanced station import options – We have enhanced the station import process by providing more robust options for handling duplicate stations. When importing, you can now specify how you want to manage existing named stations. The following options are available: +* Advanced station import options – We enhanced the station import process by providing more robust options for handling duplicate stations. When importing, you can now specify how you want to manage existing named stations. The following options are available: * **Ignore** – Existing stations will not be updated or imported. * **Duplicate** – A new station will be created with a suffix number. @@ -403,8 +403,8 @@ For more information, see [Nanoflows](/mendix-workstation/develop-app/#javascrip #### Fixes -* **Add Device Configuration** dialog stability – We have fixed a bug that was causing the **Add Device Configuration** dialog to close unexpectedly, ensuring a smoother configuration experience. -* Improved import summary UI – We have reworked the import summary UI for better usability and user experience, providing clearer and more intuitive feedback on your import operations. +* **Add Device Configuration** dialog stability – We fixed a bug that was causing the **Add Device Configuration** dialog to close unexpectedly, ensuring a smoother configuration experience. +* Improved import summary UI – We reworked the import summary UI for better usability and user experience, providing clearer and more intuitive feedback on your import operations. #### Known Bugs and Limitations @@ -420,10 +420,10 @@ For more information, see [Nanoflows](/mendix-workstation/develop-app/#javascrip #### Fixes -* Uninstallation cleanup – We have resolved an issue where the *Mendix Workstation* folder was not being completely removed during uninstallation. This fix ensures a cleaner uninstallation process. -* Error handling for bulk registration – We have fixed an error that occurred when attempting to bulk re-register an unassigned station from PowerShell, leading to a more robust registration experience. -* Special character display in license agreements – We have fixed an issue that caused special characters to display incorrectly within the license agreement. All text is now rendered accurately. -* Flexible BLE characteristic matching – We have resolved an issue where BLE characteristics and services were case-sensitive and did not accept standard UUID formats. Now, BLE characteristics can be specified in uppercase and can contain dashes, providing greater flexibility and compatibility. For example, `EF680301-9B35-4933-9B10-52FFA9740042` will now be correctly recognized. +* Uninstallation cleanup – We resolved an issue where the *Mendix Workstation* folder was not being completely removed during uninstallation. This fix ensures a cleaner uninstallation process. +* Error handling for bulk registration – We fixed an error that occurred when attempting to bulk re-register an unassigned station from PowerShell, leading to a more robust registration experience. +* Special character display in license agreements – We fixed an issue that caused special characters to display incorrectly within the license agreement. All text is now rendered accurately. +* Flexible BLE characteristic matching – We resolved an issue where BLE characteristics and services were case-sensitive and did not accept standard UUID formats. Now, BLE characteristics can be specified in uppercase and can contain dashes, providing greater flexibility and compatibility. For example, `EF680301-9B35-4933-9B10-52FFA9740042` will now be correctly recognized. ## 3.3.0 @@ -433,25 +433,25 @@ For more information, see [Nanoflows](/mendix-workstation/develop-app/#javascrip #### New Features -* Automatic suffixing for duplicate workstations – To make managing your workstations even smoother, we have implemented automatic suffixing for imported workstations that have duplicate names. This helps prevent naming conflicts and keeps your environment tidy. -* Feedback module replaced by the new Forum Space – We have removed the Feedback function in the Workstation Management. Don't worry, your voice is still incredibly important to us! Please share your questions, ideas, and feedback in the new dedicated [Mendix Forum Space for Mendix Workstation](https://community.mendix.com/link/spaces/mendix-workstation-client). This change will help us centralize discussions and provide better support. +* Automatic suffixing for duplicate workstations – To make managing your workstations even smoother, We implemented automatic suffixing for imported workstations that have duplicate names. This helps prevent naming conflicts and keeps your environment tidy. +* Feedback module replaced by the new Forum Space – We removed the Feedback function in the Workstation Management. Don't worry, your voice is still incredibly important to us! Please share your questions, ideas, and feedback in the new dedicated [Mendix Forum Space for Mendix Workstation](https://community.mendix.com/link/spaces/mendix-workstation-client). This change will help us centralize discussions and provide better support. * Special characters in workspace names – You can now use special characters in your workspace names, giving you more flexibility and personalization. -* Unique auto-accepted computer names – We have added a uniqueness validation to the **Auto-Accepted Computer Name** field used for bulk registration. This ensures that each computer name is distinct, preventing potential conflicts during the registration process. +* Unique auto-accepted computer names – We added a uniqueness validation to the **Auto-Accepted Computer Name** field used for bulk registration. This ensures that each computer name is distinct, preventing potential conflicts during the registration process. #### Fixes -* Enhanced export and import experience – We have revised the UI for the import and export process for a better user experience. +* Enhanced export and import experience – We revised the UI for the import and export process for a better user experience. * The **Select individual stations** dropdown has been reworked for better usability. * The **Import summary** now provides clearer insights into your import operations. -* Runtime error prevention – We have addressed and fixed several issues that were causing runtime errors, leading to a more stable experience. -* Duplicate application prevention during import – We have resolved a bug that caused applications to be duplicated when importing stations. Now, when importing stations that reference an application, the system checks for existing applications with the same identifying properties (like URL and Public Key). If an application already exists, it is reused, preventing unnecessary duplicates and ensuring a cleaner application registry. -* Input validation for station creation – We have fixed an issue in the station creation process where clicking **Continue** with an empty input field could lead to an error. The process is now more robust. +* Runtime error prevention – We addressed and fixed several issues that were causing runtime errors, leading to a more stable experience. +* Duplicate application prevention during import – We resolved a bug that caused applications to be duplicated when importing stations. Now, when importing stations that reference an application, the system checks for existing applications with the same identifying properties (like URL and Public Key). If an application already exists, it is reused, preventing unnecessary duplicates and ensuring a cleaner application registry. +* Input validation for station creation – We fixed an issue in the station creation process where clicking **Continue** with an empty input field could lead to an error. The process is now more robust. ### Workstation Client #### Fixes -* File name emission for the file connector – We have resolved an issue where the file connector was not returning the changed file name when subscribing to file changes. Now, when you subscribe to a file path, the file connector correctly emits the specific file names on file change events, providing more precise information. +* File name emission for the file connector – We resolved an issue where the file connector was not returning the changed file name when subscribing to file changes. Now, when you subscribe to a file path, the file connector correctly emits the specific file names on file change events, providing more precise information. ## 3.2.0 @@ -475,9 +475,9 @@ On the **Station** page, have added a new **Refresh Client** action. You can use #### Fixes -* Dark mode display – We have resolved some display issues which could occur when using Workstation Management in dark mode. -* Workspace sorting – We have corrected an issue affecting the sorting behavior of workspaces. -* Application configuration duplication – We have fixed a problem that could lead to users inadvertently creating duplicate application configurations by adding a space before or after the key or URL. +* Dark mode display – We resolved some display issues which could occur when using Workstation Management in dark mode. +* Workspace sorting – We corrected an issue affecting the sorting behavior of workspaces. +* Application configuration duplication – We fixed a problem that could lead to users inadvertently creating duplicate application configurations by adding a space before or after the key or URL. #### Known Bugs and Limitations @@ -504,14 +504,14 @@ The Workstation Client automatically resets on the next refresh when its associa #### Fixes and Other Changes -* Linux ARM64 executable name – For improved consistency, we have removed the spaces from the executable name of the Workstation Client (Linux ARM64 version). -* Bluetooth LE device discovery – We have addressed an issue where the discovery process for Bluetooth LE devices did not correctly recognize the full device name, which previously led to failed connection attempts. The Workstation Client now accurately matches Bluetooth BT advertisement names. +* Linux ARM64 executable name – For improved consistency, We removed the spaces from the executable name of the Workstation Client (Linux ARM64 version). +* Bluetooth LE device discovery – We addressed an issue where the discovery process for Bluetooth LE devices did not correctly recognize the full device name, which previously led to failed connection attempts. The Workstation Client now accurately matches Bluetooth BT advertisement names. ### Workstation Connector #### Fixes -* Refresh of the updated device list – We have fixed an issue where updates to the device list were not immediately sent to the web application after a configuration update, requiring a manual refresh. The list is now updated immediately. +* Refresh of the updated device list – We fixed an issue where updates to the device list were not immediately sent to the web application after a configuration update, requiring a manual refresh. The list is now updated immediately. ## 3.1.0 @@ -527,7 +527,7 @@ You can now copy the station configuration to the clipboard, or download it to a #### Fixes -* We have fixed an issue in Workstation Management where the side panel for device editing would not open or required a second click to open, particularly noticeable on slow networks. +* We fixed an issue in Workstation Management where the side panel for device editing would not open or required a second click to open, particularly noticeable on slow networks. #### Known Bugs and Limitations @@ -537,7 +537,7 @@ You can now copy the station configuration to the clipboard, or download it to a #### Improvements -* We have made system logs more readable and concise, simplifying the process of monitoring activity and troubleshooting any potential issues. +* We made system logs more readable and concise, simplifying the process of monitoring activity and troubleshooting any potential issues. #### Fixes @@ -627,20 +627,20 @@ The Sample App is available in the Mendix Marketplace. #### Workstation Management -* We have added the Mendix Portal Global Navigation Menu top bar and menu. -* We have made other usability improvements. +* We added the Mendix Portal Global Navigation Menu top bar and menu. +* We made other usability improvements. #### Workstation Client -* We have added a button to paste the registration token. +* We added a button to paste the registration token. #### Workstation Connector -* We have added the SecurityAdministrator security role. Only users with this role can regenerate the `KeyPair` in the **Station connector Security** of an app. +* We added the SecurityAdministrator security role. Only users with this role can regenerate the `KeyPair` in the **Station connector Security** of an app. ### Fixes -* We have fixed an issue in the Workstation Client where, when the client app closed and re-opened a connection, data buffered from the previous session was sent to the new session. The data buffer now is cleared when the connection is closed. +* We fixed an issue in the Workstation Client where, when the client app closed and re-opened a connection, data buffered from the previous session was sent to the new session. The data buffer now is cleared when the connection is closed. ## 2.4.0 @@ -711,12 +711,12 @@ The third pre-release of Mendix Workstation is available under the conditions of #### Workstation Client -* We have fixed an issue where connecting, sending a message, and disconnecting quickly on a serial port would result in a *Port not open* error. +* We fixed an issue where connecting, sending a message, and disconnecting quickly on a serial port would result in a *Port not open* error. #### Workstation Connector -* We have fixed the security model so that private key of the app is only available to admin users. -* We have fixed an issue where a Device object was deleted when user was using the cancel button of a page on which Device was a parameter. +* We fixed the security model so that private key of the app is only available to admin users. +* We fixed an issue where a Device object was deleted when user was using the cancel button of a page on which Device was a parameter. * Detected card reader devices are set to the class `CardReader`. * Windows Hello for Business is no longer detected as a card reader. @@ -751,7 +751,7 @@ The second pre-release of Mendix Workstation is available under the conditions o #### Workstation Client * The Workstation Client is now digitally signed. -* We have provided a portable version of the Workstation Client for users without administrator rights. +* We provided a portable version of the Workstation Client for users without administrator rights. #### Workstation Connector @@ -762,12 +762,12 @@ The second pre-release of Mendix Workstation is available under the conditions o * Connector actions are exposed in the nanoflow toolbox under the Workstation category. * You can now send and wait for response in a synchronous nanoflow. * Device data can directly be managed in an App nanoflow using a subscription pattern. -* We have added support for concurrent connections to devices. When a client browser or tab instance tries to connect to a device, the previously connected instance is disconnected from the device. +* We added support for concurrent connections to devices. When a client browser or tab instance tries to connect to a device, the previously connected instance is disconnected from the device. * The Workstation Management URL constant is not required anymore in your app. #### Starter App -* We have created a Starter App showing how to use the connector, exchange messages with devices, and measure the exchange performance. +* We created a Starter App showing how to use the connector, exchange messages with devices, and measure the exchange performance. #### Marketplace @@ -777,10 +777,10 @@ The second pre-release of Mendix Workstation is available under the conditions o #### Workstation Management -* We have improved the usability of the **Test your Station** page. +* We improved the usability of the **Test your Station** page. * **Test your Station** now includes a button to refresh the Workstation Client configuration in the Client. -* We have added validation to prevent the station name from including special characters. -* We have changed the navigation to a dynamic sidebar menu. +* We added validation to prevent the station name from including special characters. +* We changed the navigation to a dynamic sidebar menu. * The parsing of incoming messages can be configured without split and without delimiter. #### Workstation Client @@ -797,15 +797,15 @@ The second pre-release of Mendix Workstation is available under the conditions o #### Security -* We have simplified and improved app security by replacing the access key replaced with a private key used for communication with the Workstation Client signature through asymmetric security key pairs. +* We simplified and improved app security by replacing the access key replaced with a private key used for communication with the Workstation Client signature through asymmetric security key pairs. ### Fixes #### Workstation Client -* We have fixed a bug where the device connection was not available anymore after connection errors. The Client now always tries to reconnect. -* We have fixed a bug where smart card readers were not detected when no other devices were configured. -* We have fixed a bug where computer registration was not possible if client time was not synchronized with server time. +* We fixed a bug where the device connection was not available anymore after connection errors. The Client now always tries to reconnect. +* We fixed a bug where smart card readers were not detected when no other devices were configured. +* We fixed a bug where computer registration was not possible if client time was not synchronized with server time. #### Breaking Changes @@ -888,9 +888,9 @@ The first pre-release of Mendix Workstation is available under the conditions of #### Workstation Management -* We have simplified the user journey of configuring devices and apps with prefilled values, validations, and tooltips. +* We simplified the user journey of configuring devices and apps with prefilled values, validations, and tooltips. * Mendix Platform Design is now available. -* We have enabled connections with device connected to a client serial port (RS232). +* We enabled connections with device connected to a client serial port (RS232). * Comprehensive and error proof configuration of Serial Port connection properties is now available. * Comprehensive and error proof configuration of Serial Port message parsing is now available. * Messages coming from a serial port device can be parsed by time and size. @@ -900,18 +900,18 @@ The first pre-release of Mendix Workstation is available under the conditions of * Connection with TCP/IP servers running on a client to emulate devices is now available. * Comprehensive and error proof configuration of TCP/IP Server device properties (emulated device) is now available. * Connection with smart card readers is now available. -* We have removed the old version of the PCSC Smart Card interface. Only the NFC version is used. +* We removed the old version of the PCSC Smart Card interface. Only the NFC version is used. #### Workstation Agent -* We have simplified the user interface. +* We simplified the user interface. * Computer registration with registration token has replaced the embedded onboarding page. -* We have added a new installer for the agent. +* We added a new installer for the agent. * You can install the Workstation Agent for all users in `C:\Program Files`. * The Workstation Agent data files are saved in `C:\ProgramData` to make it available for all users. * There is now a proper clean-up of Workstation Agent data files when uninstalling the agent. -* We have added support for quiet installation and uninstallation calls by Windows command-line shell (NSIS specification). -* We have added support for multiple user sessions running the Workstation Agent on a single computer. +* We added support for quiet installation and uninstallation calls by Windows command-line shell (NSIS specification). +* We added support for multiple user sessions running the Workstation Agent on a single computer. * Workstation Agent data files on client computers are deleted when the Workstation Agent is reset. #### Workstation Connector @@ -922,13 +922,13 @@ The first pre-release of Mendix Workstation is available under the conditions of ### Fixes -* We have fixed an issue where no message was received from serial port devices when no termination char has been configured. -* We have fixed issues that occurred when exchanging binary data with a serial port. +* We fixed an issue where no message was received from serial port devices when no termination char has been configured. +* We fixed issues that occurred when exchanging binary data with a serial port. ### Deprecations * The **Connect**, **Disconnect** and **Send Message** buttons are removed from the client and replaced by **Local Device Testing** in Workstation Management. -* We have removed the option to launch the Workstation Agent on login and start in systray. The option will be restored in a future release. +* We removed the option to launch the Workstation Agent on login and start in systray. The option will be restored in a future release. * Support for Output Suffix Wait will be removed in future releases. ### Breaking Changes From c79e4eabb9530f2d9f40d755732c85a9e737b283 Mon Sep 17 00:00:00 2001 From: Nikolas Leimer Date: Fri, 2 Oct 2026 18:25:11 +0200 Subject: [PATCH 12/12] Workstation 4.3.0 release notes: shorten feature bullets Reduces the 4.3.0 release-notes bullets to what was added or changed and links to the reference pages for usage details. --- content/en/docs/releasenotes/workstation/_index.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/content/en/docs/releasenotes/workstation/_index.md b/content/en/docs/releasenotes/workstation/_index.md index b64c413d016..44929757c9d 100644 --- a/content/en/docs/releasenotes/workstation/_index.md +++ b/content/en/docs/releasenotes/workstation/_index.md @@ -18,13 +18,13 @@ These release notes cover changes made to the [Mendix Workstation](/mendix-works #### New Features -* Camera devices - We added a new *camera* connection type to configure a USB camera or webcam attached to the computer that runs the Workstation Client. You can set the camera to use and the requested width, height, and frame rate of its video feed, and enable barcode and motion detection. For more information, see [Configuring Devices: Camera](/mendix-workstation/management-devices/#camera). -* Client diagnostics - We added a **Diagnostics** button to the **Station Detail** page that retrieves the diagnostics of the Workstation Client on the registered computer. You can see which peripherals it detects, what system it runs on, and how many log entries it has recorded per level, without access to that computer. For more information, see [Managing Stations: Client Diagnostics](/mendix-workstation/management-stations/#client-diagnostics). -* Card reader devices - We added a new *card reader* connection type to define the card readers that a station uses by their name, in addition to detecting them automatically. Configured card readers are part of the station configuration, so they are kept when you copy a station. For more information, see [Configuring Devices: Card Readers](/mendix-workstation/management-devices/#card-readers). +* Camera devices - We added a new *camera* connection type to configure USB cameras and webcams. For more information, see [Configuring Devices: Camera](/mendix-workstation/management-devices/#camera). +* Client diagnostics - We added the option to retrieve the diagnostics of the Workstation Client of a station, without access to its computer. For more information, see [Managing Stations: Client Diagnostics](/mendix-workstation/management-stations/#client-diagnostics). +* Card reader devices - We added a new *card reader* connection type to configure card readers by their name, in addition to detecting them automatically. For more information, see [Configuring Devices: Card Readers](/mendix-workstation/management-devices/#card-readers). #### Improvements -* Developer mode - Turning off developer mode now requires Workstation licenses. In a workspace without an entitlement, developer mode stays enabled. For more information, see [Managing Stations: Developer Mode](/mendix-workstation/management-stations/#developer-mode). +* Developer mode - Turning off developer mode now requires Workstation licenses. For more information, see [Managing Stations: Developer Mode](/mendix-workstation/management-stations/#developer-mode). #### Bug Fixes @@ -35,14 +35,14 @@ These release notes cover changes made to the [Mendix Workstation](/mendix-works #### New Features -* Client diagnostics - The Workstation Client now answers diagnostics requests from Workstation Management, so a station's diagnostics can be inspected without access to the computer. The local file system paths that the client's own **Diagnostics** page shows are left out of the response. +* Client diagnostics - The Workstation Client now provides its diagnostics to Workstation Management. For more information, see [Managing Stations: Client Diagnostics](/mendix-workstation/management-stations/#client-diagnostics). * Camera devices - We added support for USB cameras and webcams, including barcode and motion detection. For more information, see [Device Message Syntax: Camera](/mendix-workstation/device-syntax/#camera). * Device testing - We added a test view to the Workstation Client to test devices directly on the computer, like the **Test Your Station** page in Workstation Management. For more information, see [Using the Workstation Client: Testing Devices](/mendix-workstation/use-client/#testing-devices). #### Improvements -* Credential storage - The Workstation Client now encrypts its API key at rest with the secret store of the operating system, which protects the key from being copied off the computer. An API key that is stored in plain text is encrypted automatically the first time the Client reads it after the upgrade, so no action is needed. This has the following implications: - * Potentially breaking change - The Workstation Client now requires a secret store of the operating system. The secret store exists by default on Windows and macOS, and on most Linux distributions that are commonly used in production environments. Ensure that your Linux distribution meets this requirement, as the Client does not start otherwise. For more information, see [Troubleshooting the Workstation Client: Safe Storage Is Unavailable](/mendix-workstation/troubleshooting-workstation-client/#safe-storage-unavailable). +* Credential storage - The Workstation Client now encrypts its API key at rest with the secret store of the operating system. Existing API keys are encrypted automatically after the upgrade. This has the following implications: + * Potentially breaking change - The Workstation Client now requires a secret store of the operating system and does not start without it. On Linux, ensure that a keyring is available. For more information, see [Troubleshooting the Workstation Client: Safe Storage Is Unavailable](/mendix-workstation/troubleshooting-workstation-client/#safe-storage-unavailable). * In some scenarios, such as copying the configuration folder to another computer or downgrading the Client, the Workstation Client must be registered again. For more information, see [Troubleshooting the Workstation Client: Client Must Be Registered Again](/mendix-workstation/troubleshooting-workstation-client/#client-registered-again). ## 4.2.1