From 228c1d64f69535ebf19a4858f64c919310dc0eee Mon Sep 17 00:00:00 2001 From: katarzyna_koltun Date: Fri, 23 Jan 2026 13:47:59 +0100 Subject: [PATCH 1/3] Draft Workstation updates --- content/en/docs/workstation/wks-client.md | 138 ++++++++++++++++++ content/en/docs/workstation/wks-connector.md | 138 ++++++++++++++++++ .../en/docs/workstation/wks-installation.md | 4 - content/en/docs/workstation/wks-management.md | 17 +++ 4 files changed, 293 insertions(+), 4 deletions(-) create mode 100644 content/en/docs/workstation/wks-client.md create mode 100644 content/en/docs/workstation/wks-connector.md create mode 100644 content/en/docs/workstation/wks-management.md diff --git a/content/en/docs/workstation/wks-client.md b/content/en/docs/workstation/wks-client.md new file mode 100644 index 00000000000..d793a6038d1 --- /dev/null +++ b/content/en/docs/workstation/wks-client.md @@ -0,0 +1,138 @@ +--- +title: "Mendix Workstation Management" +linktitle: "Workstation Management" +url: /mendix-workstation/management/ +description: "Describes how to set up and administer Mendix Workstation Management." +weight: 30 +--- + +## Introduction + +After you have [installed the Workstation Client](/mendix-workstation/installation/), you must either build a Mendix application that will send data or commands to your devices, or extend an existing app accordingly. In order to do that, you must download, install, and configure the [Mendix Workstation Connector](https://marketplace.mendix.com/link/component/247460) from the Mendix Marketplace. + +### How the Connection Works + +The Workstation Connector must authenticate itself to the Workstation Client so that the Client trusts the app using the Connector and establishes a connection. To achieve this, a key pair has to be generated by the Workstation Connector. The public key must be configured in the corresponding app in the Workstation Management. Workstation Client configuration must be up-to-date so that the public key can be verified. + +The Workstation Connector establishes connection with the Device through the Workstation Client when it is needed. The connection is closed when it is not required anymore. + +When a client browser or tab instance tries to connect to a device, previously connected browser or tab instances are disconnected from the device. + +The Workstation Connector connects with Workstation Client using a local WebSocket on port 8094. Communication with each configured device uses another WebSocket on port 8095 for the first device, 8096 for the second, and so on, so that the range of ports used is port *8094* to *8094+n*, where *n* is the number of devices you have. Make sure that the Runtime or Admin port of your local development server in Studio Pro (**App Settings** > **Configurations** > **Server**) is not configured on a port greater or equal to 8094. + +## Prerequisites + +* Mendix Workstation 3.0.0 +* Mendix Studio Pro 9.24.11 or newer + +## Installing and Configuring the Workstation Connector + +To install and configure the Workstation Connector, perform the following steps: + +1. Open an existing app to extend with Workstation functionality in Mendix Studio Pro, or create a new app. +2. Import the [Mendix Workstation Connector](https://marketplace.mendix.com/link/component/247460) from the Mendix Marketplace. +3. Configure the station in Workstation Management by performing the following steps: + + 1. Navigate to the **Workspaces** page in [Workstation Management](https://workstation.home.mendix.com/). + 2. Click **Create Workspace**, or select an existing workspace from the overview. + 3. Click **Create Station**. + 4. Enter a name for the station and optionally select or create a group to categorize it, such as *Assembly*. + 5. Add devices in the **Devices** section. + 6. Click **Register Computer** to register your computer. + 7. Click **Download** to navigate to the Workstation Client listing in the Marketplace, download the Client installer for Windows, install it, and launch it. + 8. Copy the registration token and paste it into the [Workstation Client](/mendix-workstation/installation/) registration field. + +4. Configure your app as an allowed app by performing the following steps: + + 1. In your app go to [App Security](/refguide/app-security/#user-roles) and assign the module role **StationConnector.Administrator** to the Administrator user role. + 2. In your app add the page **StationConnector_Security** to your navigation or link to it from an **Open page** button. Alternatively, place the snippet **SNIPPET_StationAdminPage** on a page available to the Adminstrator user role. + 3. Run the app. + 4. Log in as an Administrator, navigate to the page you added in step 2 and copy the shown public key. + 5. Go back to the [Workstation Management](https://workstation.home.mendix.com/) and navigate to the workspace you created in step 3.2. + 6. Go to the **Apps** page in your workspace and click **Create App**. + 7. Enter your app's URL (for example, `http://localhost:8080`, which is the default when running an app locally) and paste the copied public key into the **Public Key** field. + 8. Perform one of the following actions: + * To enable the app for all stations, select **Enable in all stations** + * To enable it for a specific station, go to **Stations** and navigate to your station. You will find the created app under the **Apps** section. Here you can enable the application just for this station by pressing the toggle. + 9. Refresh the Workstation Client. + 10. Optional: To recreate the key pair, additionally assign the module role **StationConnector.SecurityAdministrator** to your Administrator role. This adds a **Regenerate KeyPair** button to the **StationConnector_Security** page. Use caution when using this button in a production scenario to avoid the need to reconfigure the app in the Management, and refresh all Workstation Clients. + +## Managing Apps + +The app that you created in the previous section is available on the **Apps** page that you can access through the left navigation menu. To enable or disable the app for all your stations or groups of stations, click the icon in the right column of the app list, and then click **Manage App**. + +## Managing Users + +You can invite other Workstation Management users to your workspace to share configurations and collaborate. This feature requires a Workstation license. + +To invite a user, click **Team** in the left navigation menu, then click **Invite Team Member**. Enter the user's email address and select a role. For more information about the available roles, see [Workspace Team and Collaboration](/mendix-workstation/installation/#collaboration). + +To change a user's role or remove them from the workspace, click the three-dot icon in the right column of the user list. This action requires the Owner or Workspace Admin role. + +## 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. + +### 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). +* **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 + +The following section provides more information about using the nanoflows and Java actions in your Mendix application. + +#### 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. + +#### SendMessage + +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. + +#### SubscribeToMessages + +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. + +The callback nanoflow must have the following parameters: + +* `Device` (object) +* `Message` (String) +* `Context object` (same as the name used when subscribing) + +#### SubscribeToErrors + +Call `SubscribeToErrors` to trigger a nanoflow on device connection error. + +The callback nanoflow must have the following parameters: + +* `Device` (object) +* `ErrorMessage` (String) +* `ErrorCode` (Integer) +* `Context object` (same as the name used when subscribing) + +#### Unsubscribe + +Call `Unsubscribe` to end a subscription. + +#### UnsubscribeByContext + +Call `UnsubscribeByContext` to end all subscriptions related to a context object. + +## Error Logs + +Logs for the Workstation Management, Client, and Connector are available in case of issues. For more information about accessing the logs, see [Troubleshooting Mendix Workstation](/mendix-workstation/troubleshooting/). diff --git a/content/en/docs/workstation/wks-connector.md b/content/en/docs/workstation/wks-connector.md new file mode 100644 index 00000000000..d793a6038d1 --- /dev/null +++ b/content/en/docs/workstation/wks-connector.md @@ -0,0 +1,138 @@ +--- +title: "Mendix Workstation Management" +linktitle: "Workstation Management" +url: /mendix-workstation/management/ +description: "Describes how to set up and administer Mendix Workstation Management." +weight: 30 +--- + +## Introduction + +After you have [installed the Workstation Client](/mendix-workstation/installation/), you must either build a Mendix application that will send data or commands to your devices, or extend an existing app accordingly. In order to do that, you must download, install, and configure the [Mendix Workstation Connector](https://marketplace.mendix.com/link/component/247460) from the Mendix Marketplace. + +### How the Connection Works + +The Workstation Connector must authenticate itself to the Workstation Client so that the Client trusts the app using the Connector and establishes a connection. To achieve this, a key pair has to be generated by the Workstation Connector. The public key must be configured in the corresponding app in the Workstation Management. Workstation Client configuration must be up-to-date so that the public key can be verified. + +The Workstation Connector establishes connection with the Device through the Workstation Client when it is needed. The connection is closed when it is not required anymore. + +When a client browser or tab instance tries to connect to a device, previously connected browser or tab instances are disconnected from the device. + +The Workstation Connector connects with Workstation Client using a local WebSocket on port 8094. Communication with each configured device uses another WebSocket on port 8095 for the first device, 8096 for the second, and so on, so that the range of ports used is port *8094* to *8094+n*, where *n* is the number of devices you have. Make sure that the Runtime or Admin port of your local development server in Studio Pro (**App Settings** > **Configurations** > **Server**) is not configured on a port greater or equal to 8094. + +## Prerequisites + +* Mendix Workstation 3.0.0 +* Mendix Studio Pro 9.24.11 or newer + +## Installing and Configuring the Workstation Connector + +To install and configure the Workstation Connector, perform the following steps: + +1. Open an existing app to extend with Workstation functionality in Mendix Studio Pro, or create a new app. +2. Import the [Mendix Workstation Connector](https://marketplace.mendix.com/link/component/247460) from the Mendix Marketplace. +3. Configure the station in Workstation Management by performing the following steps: + + 1. Navigate to the **Workspaces** page in [Workstation Management](https://workstation.home.mendix.com/). + 2. Click **Create Workspace**, or select an existing workspace from the overview. + 3. Click **Create Station**. + 4. Enter a name for the station and optionally select or create a group to categorize it, such as *Assembly*. + 5. Add devices in the **Devices** section. + 6. Click **Register Computer** to register your computer. + 7. Click **Download** to navigate to the Workstation Client listing in the Marketplace, download the Client installer for Windows, install it, and launch it. + 8. Copy the registration token and paste it into the [Workstation Client](/mendix-workstation/installation/) registration field. + +4. Configure your app as an allowed app by performing the following steps: + + 1. In your app go to [App Security](/refguide/app-security/#user-roles) and assign the module role **StationConnector.Administrator** to the Administrator user role. + 2. In your app add the page **StationConnector_Security** to your navigation or link to it from an **Open page** button. Alternatively, place the snippet **SNIPPET_StationAdminPage** on a page available to the Adminstrator user role. + 3. Run the app. + 4. Log in as an Administrator, navigate to the page you added in step 2 and copy the shown public key. + 5. Go back to the [Workstation Management](https://workstation.home.mendix.com/) and navigate to the workspace you created in step 3.2. + 6. Go to the **Apps** page in your workspace and click **Create App**. + 7. Enter your app's URL (for example, `http://localhost:8080`, which is the default when running an app locally) and paste the copied public key into the **Public Key** field. + 8. Perform one of the following actions: + * To enable the app for all stations, select **Enable in all stations** + * To enable it for a specific station, go to **Stations** and navigate to your station. You will find the created app under the **Apps** section. Here you can enable the application just for this station by pressing the toggle. + 9. Refresh the Workstation Client. + 10. Optional: To recreate the key pair, additionally assign the module role **StationConnector.SecurityAdministrator** to your Administrator role. This adds a **Regenerate KeyPair** button to the **StationConnector_Security** page. Use caution when using this button in a production scenario to avoid the need to reconfigure the app in the Management, and refresh all Workstation Clients. + +## Managing Apps + +The app that you created in the previous section is available on the **Apps** page that you can access through the left navigation menu. To enable or disable the app for all your stations or groups of stations, click the icon in the right column of the app list, and then click **Manage App**. + +## Managing Users + +You can invite other Workstation Management users to your workspace to share configurations and collaborate. This feature requires a Workstation license. + +To invite a user, click **Team** in the left navigation menu, then click **Invite Team Member**. Enter the user's email address and select a role. For more information about the available roles, see [Workspace Team and Collaboration](/mendix-workstation/installation/#collaboration). + +To change a user's role or remove them from the workspace, click the three-dot icon in the right column of the user list. This action requires the Owner or Workspace Admin role. + +## 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. + +### 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). +* **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 + +The following section provides more information about using the nanoflows and Java actions in your Mendix application. + +#### 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. + +#### SendMessage + +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. + +#### SubscribeToMessages + +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. + +The callback nanoflow must have the following parameters: + +* `Device` (object) +* `Message` (String) +* `Context object` (same as the name used when subscribing) + +#### SubscribeToErrors + +Call `SubscribeToErrors` to trigger a nanoflow on device connection error. + +The callback nanoflow must have the following parameters: + +* `Device` (object) +* `ErrorMessage` (String) +* `ErrorCode` (Integer) +* `Context object` (same as the name used when subscribing) + +#### Unsubscribe + +Call `Unsubscribe` to end a subscription. + +#### UnsubscribeByContext + +Call `UnsubscribeByContext` to end all subscriptions related to a context object. + +## Error Logs + +Logs for the Workstation Management, Client, and Connector are available in case of issues. For more information about accessing the logs, see [Troubleshooting Mendix Workstation](/mendix-workstation/troubleshooting/). diff --git a/content/en/docs/workstation/wks-installation.md b/content/en/docs/workstation/wks-installation.md index c40c99d7dfa..0dc5091e443 100644 --- a/content/en/docs/workstation/wks-installation.md +++ b/content/en/docs/workstation/wks-installation.md @@ -8,10 +8,6 @@ weight: 20 ## Introduction -This document outlines the installation and basic configuration of Mendix Workstation. It provides a quick-start guide for initial setup, followed by detailed instructions on advanced configurations for workspaces and stations. - -## Quick Start Guide - This guide helps you configure and test a minimum working version of Mendix Workstation. By following these steps, you will complete the following: * Create a basic configuration within Workstation Management. diff --git a/content/en/docs/workstation/wks-management.md b/content/en/docs/workstation/wks-management.md new file mode 100644 index 00000000000..64ac78c5aa1 --- /dev/null +++ b/content/en/docs/workstation/wks-management.md @@ -0,0 +1,17 @@ +--- +title: "Mendix Workstation Management" +linktitle: "Workstation Management" +url: /mendix-workstation/management/ +description: "Describes how to set up and administer Mendix Workstation Management." +weight: 30 +--- + +## Introduction + +Workstation Management is a Mendix Platform service which provides a centralized interface to configure and monitor all workstations and devices across the organization. Whether managing a few stations or hundreds across multiple global sites, administrators can register computers, assign devices, group them into workspaces, and remotely troubleshoot connection issues. + +This makes it easier to manage a large, diverse fleet of devices without the need for manual setup or on-site support. + +### Users + +Workstation Management issed by central IT and application support teams. \ No newline at end of file From d17225d62a5faebcf364c2f5e41e7df0f2b2441e Mon Sep 17 00:00:00 2001 From: katarzyna_koltun Date: Mon, 23 Feb 2026 10:40:42 +0100 Subject: [PATCH 2/3] glossary --- content/en/docs/workstation/wks-glossary.md | 149 ++++++++++++++++++++ 1 file changed, 149 insertions(+) create mode 100644 content/en/docs/workstation/wks-glossary.md diff --git a/content/en/docs/workstation/wks-glossary.md b/content/en/docs/workstation/wks-glossary.md new file mode 100644 index 00000000000..43e8a852d83 --- /dev/null +++ b/content/en/docs/workstation/wks-glossary.md @@ -0,0 +1,149 @@ +--- +title: "Mendix Workstation Glossary" +linktitle: "Glossary" +url: /mendix-workstation/glossary/ +description: "Defines terminology associated with with Mendix Workstation." +weight: 50 +--- + +## Introduction + +If you encounter any issues with your Workstation Management, Connector, or Client, use the following troubleshooting tips to help you solve them. + +## Workstation Management + +### Station Status of Unlinked Workstation Client Is Still "Computer Registered" + +This issue might occur if your Workstation Client could not establish a connection to the Workstation Management, for example, because the computer was not connected to a network. + +#### Solution + +Manually unregister the station in Workstation Management. + +### Workspace Owner Account Deactivated + +The Workspace's owner account has been deactivated, and the owner did not transfer the ownership to another Workspace member. + +Contact Mendix Support to transfer workspace ownership. + +## Workstation Client + +By default, the Client retains logs of up to 10 MB for the past seven days locally on your computer. Access logs by clicking the **Logs** button on the Client UI, then optionally selecting the level of logs you want to see. Opening the Client's console through the browser developer tools (**Ctrl + Shift + I**) can also provide additional information about encountered errors in the UI of the Client. + +Log files are also available by day in the Client's app data folder. On Windows, press **Win + R** and enter: + +* If you installed the Client using the installer for all users: `%ProgramData%\Mendix Workstation\logs` +* If you are using the portable version: `%AppData%\Mendix Workstation\logs` + +On Linux, the *Mendix Workstation/logs* folder is located at either `$XDG_CONFIG_HOME` or `~/.config`. + +**Live logs** are available in two ways: + +* 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`. + +### Registration Token Could Not Be Parsed + +The Client shows an error like the following: *Registration token could not be parsed. Please enter another token!* + +#### Cause + +You entered a registration token with an invalid format. + +#### Solution + +Ensure you copied and pasted the token exactly as displayed in Workstation Management without any additional characters. Create a new registration token if the issue persists. + +### Registration Token Denied by Workstation Management + +The Client shows an error like the following: *Registration token denied by Workstation Management. Please use another token*. + +#### Cause + +The registration token is no longer valid. This can occur if: + +* The token expired after one hour +* The token was recreated in Workstation Management (using the **Refresh** button or reopening the registration window) +* The token has already been used by another Workstation Client + +#### Solution + +If the station status in Workstation Management is still *No computer registered*, regenerate the token and try again. Otherwise, verify the correct computer and Client are registered to that station and unregister if not. + +### HTTPError: Request failed with status code 503 Service Temporarily Unavailable + +The Client shows an error like the following: *Station could not be synchronized with Management. Error invoking remote method 'refresh-station-config': HTTPError: Request failed with status code 503 Service Temporarily Unavailable: GET.* + +#### Cause + +Workstation Management is temporarily offline, most likely due to maintenance. + +#### Solution + +Check out the [Mendix Status Page](https://status.mendix.com/) to see if there is a scheduled maintenance for the Workstation Management. If there is no maintenance message and the issue persists after a few minutes, report an incident via the status page. + +### TimeoutError: Request timed out + +The Client shows an error like the following: *Station could not be synchronized with Management. Error invoking remote method 'refresh-station-config': TimeoutError: Request timed out: GET [yourStationURL]* + +#### Cause + +The Client request to Workstation Management is not forwarded to the Workstation Management server and times out. This issue may occur if your network traffic is routed through a proxy server, as is common in protected corporate IT environments, and the proxy server is offline. + +#### Solution + +Verify whether your computer's network traffic is routed through a proxy server and configure your proxy settings accordingly. See [Network Configuration](/mendix-workstation/prerequisites/#network-configuration). + +### Workstation Management URL cannot be resolved + +The Client shows an error like the following: *Station could not be synchronized with Management. Error invoking remote method 'refresh-station-config': Error: Workstation Management URL cannot be resolved. This might be an DNS issue or the host is offline.* + +#### Cause + +The Client cannot resolve the URL to Workstation Management. This can have several causes, most commonly when the machine running the Workstation Client has no internet connection. + +#### Solution + +First, verify you have a working internet connection. Then verify you can access [Workstation Management](https://workstation.home.mendix.com/) from your browser. If your browser cannot resolve that address, there may be an issue with your DNS server or configuration. On Windows, verify your DNS settings for your Ethernet or wireless LAN adapter using the command prompt and entering `ipconfig`. The command `nslookup www.mendix.com` provides further information about the IP address your DNS server resolved for the Mendix domain. + +## Workstation Connector + +Connector logs are available in Studio Pro's console during local development or in the environment logs of your running environment. Since the Connector performs most operations client-side in nanoflows, you can also inspect local logs in the browser console. + +### Workstation Client Did Not Respond Within 3 Seconds. Connection Failed. + +If the **StationConnector.GetStation** nanoflow fails to connect to the Workstation Client, this error appears in the browser console and in Studio Pro's Console on the **Client_Nanoflow** log node. + +#### Cause + +The connection between the Client and Connector cannot be established. This occurs either because the Workstation Client cannot be found on the local computer, or because the current application is not allowed to establish a connection. + +#### Solution + +* Verify the Workstation Client is running and registered on the same computer as the browser attempting to connect via the StationConnector. +* Verify the Client is registered in the correct workspace by comparing the workspace name and ID displayed in the Client UI with the workspace in Workstation Management. +* Verify the application attempting to connect is properly configured as an allowed app in the workspace and on the station. To do so, check that your application (such as `http://localhost:8080`) is added in the **Apps** section of your workspace. If the app is added, verify the public key of the configured workspace app matches the public key displayed in your app using the Connector. If not, update the public key value of the workspace app with the latest value displayed in the app. Next, verify the app is also enabled as an allowed app in the station configuration by navigating to the respective station detail page in that workspace. Always click the **Refresh** button in the Workstation Client after applying any changes in Workstation Management. + +### The Client Requested a Session for a Time That Is Ahead of the Server + +This is a warning log for the Mendix runtime on the **StationConnector - GetWebsocketSession** log node. + +#### Cause + +For security reasons, the Connector only allows establishing a session when the computer running the Workstation Client has a time within 24 hours of the Mendix runtime server hosting the app. + +#### Solution + +Set the time on the computer running the Workstation Client to within 24 hours of the Mendix runtime server. If this is not possible, you can customize this behavior in the **StationConnector.GetWebsocketsSession** microflow, but you must maintain this customization when updating the module to a newer version. + +### Context Entity Is Not Updated After Sending a Message + +The context entity on your page is not updated after sending a message. Specifically, modifying a context entity shortly after sending a message for the first time does not always work. + +#### Cause + +Sending a message for the first time sets the **Connected** state to **true** and triggers a commit on the device. This refreshes the device and all data sources nested within a device data source. Some of these data sources may create a new blank entity instead of displaying the updated entity. + +#### Solution + +Ensure all data sources nested within a device data source follow a Singleton (also known as GetCreate) pattern, where an entity is created if it does not exist or retrieved if it does. From c0995097890a51748645d1a1481c7b9f57eb12ac Mon Sep 17 00:00:00 2001 From: katarzyna_koltun Date: Mon, 23 Feb 2026 10:48:02 +0100 Subject: [PATCH 3/3] draft --- content/en/docs/workstation/wks-glossary.md | 141 ++------------------ 1 file changed, 9 insertions(+), 132 deletions(-) diff --git a/content/en/docs/workstation/wks-glossary.md b/content/en/docs/workstation/wks-glossary.md index 43e8a852d83..6d09afe39d9 100644 --- a/content/en/docs/workstation/wks-glossary.md +++ b/content/en/docs/workstation/wks-glossary.md @@ -2,148 +2,25 @@ title: "Mendix Workstation Glossary" linktitle: "Glossary" url: /mendix-workstation/glossary/ -description: "Defines terminology associated with with Mendix Workstation." +description: "Presents and explains several concepts related to Mendix Workstation." weight: 50 --- ## Introduction -If you encounter any issues with your Workstation Management, Connector, or Client, use the following troubleshooting tips to help you solve them. -## Workstation Management +## Concepts -### Station Status of Unlinked Workstation Client Is Still "Computer Registered" +### Workstation -This issue might occur if your Workstation Client could not establish a connection to the Workstation Management, for example, because the computer was not connected to a network. +### Station -#### Solution +### Workspace -Manually unregister the station in Workstation Management. +### Device -### Workspace Owner Account Deactivated +### Client -The Workspace's owner account has been deactivated, and the owner did not transfer the ownership to another Workspace member. +### Computer -Contact Mendix Support to transfer workspace ownership. - -## Workstation Client - -By default, the Client retains logs of up to 10 MB for the past seven days locally on your computer. Access logs by clicking the **Logs** button on the Client UI, then optionally selecting the level of logs you want to see. Opening the Client's console through the browser developer tools (**Ctrl + Shift + I**) can also provide additional information about encountered errors in the UI of the Client. - -Log files are also available by day in the Client's app data folder. On Windows, press **Win + R** and enter: - -* If you installed the Client using the installer for all users: `%ProgramData%\Mendix Workstation\logs` -* If you are using the portable version: `%AppData%\Mendix Workstation\logs` - -On Linux, the *Mendix Workstation/logs* folder is located at either `$XDG_CONFIG_HOME` or `~/.config`. - -**Live logs** are available in two ways: - -* 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`. - -### Registration Token Could Not Be Parsed - -The Client shows an error like the following: *Registration token could not be parsed. Please enter another token!* - -#### Cause - -You entered a registration token with an invalid format. - -#### Solution - -Ensure you copied and pasted the token exactly as displayed in Workstation Management without any additional characters. Create a new registration token if the issue persists. - -### Registration Token Denied by Workstation Management - -The Client shows an error like the following: *Registration token denied by Workstation Management. Please use another token*. - -#### Cause - -The registration token is no longer valid. This can occur if: - -* The token expired after one hour -* The token was recreated in Workstation Management (using the **Refresh** button or reopening the registration window) -* The token has already been used by another Workstation Client - -#### Solution - -If the station status in Workstation Management is still *No computer registered*, regenerate the token and try again. Otherwise, verify the correct computer and Client are registered to that station and unregister if not. - -### HTTPError: Request failed with status code 503 Service Temporarily Unavailable - -The Client shows an error like the following: *Station could not be synchronized with Management. Error invoking remote method 'refresh-station-config': HTTPError: Request failed with status code 503 Service Temporarily Unavailable: GET.* - -#### Cause - -Workstation Management is temporarily offline, most likely due to maintenance. - -#### Solution - -Check out the [Mendix Status Page](https://status.mendix.com/) to see if there is a scheduled maintenance for the Workstation Management. If there is no maintenance message and the issue persists after a few minutes, report an incident via the status page. - -### TimeoutError: Request timed out - -The Client shows an error like the following: *Station could not be synchronized with Management. Error invoking remote method 'refresh-station-config': TimeoutError: Request timed out: GET [yourStationURL]* - -#### Cause - -The Client request to Workstation Management is not forwarded to the Workstation Management server and times out. This issue may occur if your network traffic is routed through a proxy server, as is common in protected corporate IT environments, and the proxy server is offline. - -#### Solution - -Verify whether your computer's network traffic is routed through a proxy server and configure your proxy settings accordingly. See [Network Configuration](/mendix-workstation/prerequisites/#network-configuration). - -### Workstation Management URL cannot be resolved - -The Client shows an error like the following: *Station could not be synchronized with Management. Error invoking remote method 'refresh-station-config': Error: Workstation Management URL cannot be resolved. This might be an DNS issue or the host is offline.* - -#### Cause - -The Client cannot resolve the URL to Workstation Management. This can have several causes, most commonly when the machine running the Workstation Client has no internet connection. - -#### Solution - -First, verify you have a working internet connection. Then verify you can access [Workstation Management](https://workstation.home.mendix.com/) from your browser. If your browser cannot resolve that address, there may be an issue with your DNS server or configuration. On Windows, verify your DNS settings for your Ethernet or wireless LAN adapter using the command prompt and entering `ipconfig`. The command `nslookup www.mendix.com` provides further information about the IP address your DNS server resolved for the Mendix domain. - -## Workstation Connector - -Connector logs are available in Studio Pro's console during local development or in the environment logs of your running environment. Since the Connector performs most operations client-side in nanoflows, you can also inspect local logs in the browser console. - -### Workstation Client Did Not Respond Within 3 Seconds. Connection Failed. - -If the **StationConnector.GetStation** nanoflow fails to connect to the Workstation Client, this error appears in the browser console and in Studio Pro's Console on the **Client_Nanoflow** log node. - -#### Cause - -The connection between the Client and Connector cannot be established. This occurs either because the Workstation Client cannot be found on the local computer, or because the current application is not allowed to establish a connection. - -#### Solution - -* Verify the Workstation Client is running and registered on the same computer as the browser attempting to connect via the StationConnector. -* Verify the Client is registered in the correct workspace by comparing the workspace name and ID displayed in the Client UI with the workspace in Workstation Management. -* Verify the application attempting to connect is properly configured as an allowed app in the workspace and on the station. To do so, check that your application (such as `http://localhost:8080`) is added in the **Apps** section of your workspace. If the app is added, verify the public key of the configured workspace app matches the public key displayed in your app using the Connector. If not, update the public key value of the workspace app with the latest value displayed in the app. Next, verify the app is also enabled as an allowed app in the station configuration by navigating to the respective station detail page in that workspace. Always click the **Refresh** button in the Workstation Client after applying any changes in Workstation Management. - -### The Client Requested a Session for a Time That Is Ahead of the Server - -This is a warning log for the Mendix runtime on the **StationConnector - GetWebsocketSession** log node. - -#### Cause - -For security reasons, the Connector only allows establishing a session when the computer running the Workstation Client has a time within 24 hours of the Mendix runtime server hosting the app. - -#### Solution - -Set the time on the computer running the Workstation Client to within 24 hours of the Mendix runtime server. If this is not possible, you can customize this behavior in the **StationConnector.GetWebsocketsSession** microflow, but you must maintain this customization when updating the module to a newer version. - -### Context Entity Is Not Updated After Sending a Message - -The context entity on your page is not updated after sending a message. Specifically, modifying a context entity shortly after sending a message for the first time does not always work. - -#### Cause - -Sending a message for the first time sets the **Connected** state to **true** and triggers a commit on the device. This refreshes the device and all data sources nested within a device data source. Some of these data sources may create a new blank entity instead of displaying the updated entity. - -#### Solution - -Ensure all data sources nested within a device data source follow a Singleton (also known as GetCreate) pattern, where an entity is created if it does not exist or retrieved if it does. +### Registration token