Merge pull request mendix#11001 from mendix/kk-wks-connector36

katarzyna-koltun-mx · web-flow · commit 1c4dfc80dec9 · 2026-04-23T09:18:32.000+02:00
Wks connector updates
diff --git a/content/en/docs/releasenotes/workstation/_index.md b/content/en/docs/releasenotes/workstation/_index.md
@@ -10,6 +10,71 @@ cascade:
 
 These release notes cover changes made to the [Mendix Workstation](/mendix-workstation/).
 
+## 3.6.0
+
+### Release date: April 23, 2026
+
+### Workstation Management
+
+#### 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.
+* 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.
+
+#### 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.
+
+{{% 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.
+
+### 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.
+
+### 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: 
+
+    *  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.
+    * Manage events in a nanoflow with the new `SubscribeToObjectChanges` and `WaitForObjectChanges` nanoflow actions.
+    * Benefit from easier configuration of common use cases with the new `ConnectDevice`, `SendDeviceMessage` and `WaitForDeviceMessage` nanoflow actions.
+
+For more information, see [Nanoflows](/mendix-workstation/build-app/#javascript-actions) and [Widgets](/mendix-workstation/build-app/#widgets).
+
+#### Improvement
+
+* The **Model Peripheral** entity is now a specialization of the **Device** entity and no longer requires association.
+* Calling `GetStation` is no longer required to initiate the Workstation Connector. It is only required to read the station configuration.
+
+#### 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.
+
+#### Deprecations
+
+* We have deprecated the following actions:
+
+    * `SendMessage` - Deprecated in favor of `SendDeviceMessage` and `WaitForDeviceMessage`
+    * `SubscribeToMessages` - Deprecated in favor of `GetCreateDevice`
+    * `SubscribeToErrors` - Deprecated in favor of `GetCreateDevice`
+
+    The deprecated actions are longer exposed as nanoflows and have been moved to the `_USE_ME/Deprecated` folder.
+
 ## 3.5.0
 
 ### Release date: March 12, 2026
diff --git a/content/en/docs/workstation/wks-build-app.md b/content/en/docs/workstation/wks-build-app.md
@@ -65,67 +65,114 @@ To change a user's role or remove them from the workspace, click the three-dot i
 
 ## Getting Started with Custom Logic for Device Interaction
 
-Now that you are ready to start using Mendix Workstation, you can implement your own custom logic for interacting with devices. The following nanoflows and Java actions are essential for establishing connections, sending or receiving messages, and managing device interactions:
-
-* **GetStation** - Retrieves the computer information connected to the Client.
-* **SendMessage** - Sends data or commands to the connected device. For more information about the supported message syntax, see [Message Syntax for File, Smart Card, and Bluetooth Devices](/mendix-workstation/device-syntax/).
-* **SubscribeToMessages** - Subscribes to device messages and triggers a nanoflow when messages are received.
-* **SubscribeToErrors** - Subscribes to device connection errors and triggers a nanoflow when errors occur.
-* **Unsubscribe** - End the subscription to device messages or errors.
-* **UnsubscribeByContext** - End all subscriptions related to a context object.
-* **UnsubscribeByDevice** - End all subscriptions related to a specific device.
-* **DisconnectDevice** - Unsubscribe and completely disconnect from a specific device.
-
-These nanoflows and actions serve as the core building blocks for integrating devices into your Mendix applications and tailoring the functionality to your specific requirements.
+Now that you are ready to start using Mendix Workstation, you can implement your own custom logic for interacting with devices. The following nanoflows and actions serve as the core building blocks for integrating devices into your Mendix applications and tailoring the functionality to your specific requirements.
 
 ### Understanding the Domain Model
 
 The domain model contains the following entities:
 
-* **Station** - Includes the station name, computer name, the workspace name and the client version (non-persistent entities).
-* **Device** - A list of devices associated with the station; includes device names and properties required to achieve a connection (non-persistent entities).
+* **Station** - A non-persistent entity representing the Workstation Client configuration.
+* **Device** - A non-persistent entity representing a connectable peripheral device. Includes the name, class and state (Available, Connected, or Error). Specialize this to maintain your device specific state.
 * **AppKeyPair** - A persistent entity to store the app's key pair. The public key needs to be entered in the corresponding app in the Workstation Management. 
 
-### Using the Nanoflows and Actions
+### Using the Nanoflows and Actions {#javascript-actions}
 
 The following section provides more information about using the nanoflows and Java actions in your Mendix application.
 
+#### SendDeviceMessage
+
+Call `SendDeviceMessage` to send a message to a device. For more information about the supported message syntax, see [Message Syntax for File, Smart Card, and Bluetooth Devices](/mendix-workstation/device-syntax/). This action has the following parameters:
+
+* `device` 
+* `message`
+
+#### WaitForDeviceMessage 
+
+Call `WaitForDeviceMessage` to wait for a message from the connected device for the duration of the specified timeout period. This action has the following parameters:
+
+* `device` 
+* `timeout`
+
+#### WaitForObjectChange
+
+Call `WaitForObjectChange` to wait for changes in the attributes of the specified object for the duration of the specified timeout period. This action has the following parameters:
+
+* `objectToObserve`
+* `attributes`
+* `timeout`
+
+#### GetCreateDevice
+
+Call this nanoflow to create and configure a device, and define the actions that should happen on connection, disconnection, or messages from the device. This action has the following parameters:
+
+* `name`
+* `class` 
+* `initialize`
+* `createDevice` 
+* `entity`
+* `onConnect`
+* `onMessage` 
+* `onDisconnect`
+
+#### ConnectDevice
+
+Call this action to connect to a specific device.
+
+#### DisconnectDevice
+
+Call this action to disconnect from a specific device.
+
+#### Initialize
+
+This action sets up communication with the Workstation Client. It should be automatically called through the `initialize` parameter of `GetStation` or `GetCreateDevice`.
+
 #### GetStation
 
-Call `GetStation` to retrieve configuration of the current Client computer by using the Workstation Client. `GetStation` can be used multiple times, but it queries the Workstation Client only the first time. The following calls return the current object loaded in the session. If connection with Workstation Client does not work, `GetStation` returns an empty object.
+Call `GetStation` to retrieve the current Workstation Client configuration and devices. This action creates and returns a station object with a linked device object per peripheral.
 
-#### SendMessage
+To interact with a specific device, it is better to use `GetCreateDevice` instead. `GetCreateDevice` has a more convenient API, allows specialization, and does not create station and device objects which may not be needed.
 
-Call `SendMessage` to send a message to a device. `SendMessage` includes the option to wait for the response of the device in the current nanoflow.
+#### SubscribeToObjectChanges
 
-#### SubscribeToMessages
+Call `SubscribeToObjectChanges` to trigger a nanoflow when the specified object changes.  This action has the following parameters:
 
-Call `SubscribeToMessages` to trigger a nanoflow when a message is received from a device. `SubscribeToMessages` provides an option to specify a context object that will be passed to the callback nanoflow whenever a message is received.
+* `objectToObserve`
+* `attributes`
+* `callback`
+* `applicationContext`
 
-The callback nanoflow must have the following parameters: 
+#### SubscribeToDeviceMessages
 
-* `Device` (object) 
-* `Message` (String)
-* `Context object` (same as the name used when subscribing)
+Call `SubscribeToDeviceMessages` to trigger a nanoflow when a message is received from a device. This action has the following parameters: 
 
-#### SubscribeToErrors
+* `device`
+* `callback`
+* `applicationContext`
 
-Call `SubscribeToErrors` to trigger a nanoflow on device connection error.
+#### SubscribeToDeviceErrors
 
-The callback nanoflow must have the following parameters: 
+Call `SubscribeToDeviceErrors` to trigger a nanoflow on device connection error. This action has the following parameters: 
 
-* `Device` (object) 
-* `ErrorMessage` (String)
-* `ErrorCode` (Integer)
-* `Context object` (same as the name used when subscribing)
+* `device`
+* `callback`
+* `applicationContext`
 
 #### Unsubscribe
 
 Call `Unsubscribe` to end a subscription.
 
-#### UnsubscribeByContext
+#### Private Nanoflows
+
+`CreateStation`, `CommitStation`, `CreateDevice`, and `CommitDevice` are private nanoflows, required be compatible with [strict mode](/refguide/strict-mode/).
+
+### Widgets {#widgets}
+
+The following widgets allow you to specify when to execute an action:
 
-Call `UnsubscribeByContext` to end all subscriptions related to a context object.
+* **On Load/Unload** - Execute the action when the widget is first rendered, or when it is removed (unloaded).
+* **On Change** - Execute the action when the specified attribute changes.
+* **On Equal** - Execute the action when an attribute is equal to the specified expression.
+* **On True** - Execute the action when the specified expression is true.
 
 ## Error Logs
 
diff --git a/content/en/docs/workstation/wks-message-syntax.md b/content/en/docs/workstation/wks-message-syntax.md
@@ -64,7 +64,7 @@ The section below shows a sample test that you can run to verify the configurati
     * **Allow writing files** - **Yes**
     * Use the default values for everything else 
 4. Register the Station to your computer (assuming the Workstation Client is installed there).
-5. In your Workspace, navigate to **Test Your Station** and click on the configured file device.
+5. In your Workspace, navigate to **Test Your Station** and click **Test** by the configured file device.
 6. Enter `3#test.txt#Hello from Mendix` in the **Send Message** field, and then press **Send Message**.
 
     The test should show a response like `S#3#C:\MyTestFolder\test.txt` to indicate that the text file *test.txt* was successfully written to *MyTestFolder*. 
