From 9dfd7cbaeae8f8764620758dfd2366fe456fa72a Mon Sep 17 00:00:00 2001 From: katarzyna_koltun Date: Thu, 2 Jul 2026 19:57:05 +0200 Subject: [PATCH 1/4] updates to the structure and order of the Workstation docs --- content/en/docs/workstation/client/_index.md | 17 ++ .../{ => client}/wks-batch-registration.md | 40 +-- .../client/wks-client-installation.md | 108 ++++++++ .../client/wks-client-proxy-settings.md | 29 +++ .../en/docs/workstation/management/_index.md | 6 +- .../{ => management}/wks-import.md | 2 +- .../management/wks-management-devices.md | 16 ++ .../management/wks-management-team.md | 18 +- .../workstation/management/wks-management.md | 8 +- .../{ => management}/wks-monitoring.md | 2 +- .../{wks-build-app.md => wks-connector.md} | 14 +- .../en/docs/workstation/wks-prerequisites.md | 230 ------------------ ...{wks-installation.md => wks-quickstart.md} | 93 ++++--- 13 files changed, 286 insertions(+), 297 deletions(-) create mode 100644 content/en/docs/workstation/client/_index.md rename content/en/docs/workstation/{ => client}/wks-batch-registration.md (60%) create mode 100644 content/en/docs/workstation/client/wks-client-installation.md create mode 100644 content/en/docs/workstation/client/wks-client-proxy-settings.md rename content/en/docs/workstation/{ => management}/wks-import.md (99%) rename content/en/docs/workstation/{ => management}/wks-monitoring.md (99%) rename content/en/docs/workstation/{wks-build-app.md => wks-connector.md} (94%) delete mode 100644 content/en/docs/workstation/wks-prerequisites.md rename content/en/docs/workstation/{wks-installation.md => wks-quickstart.md} (53%) diff --git a/content/en/docs/workstation/client/_index.md b/content/en/docs/workstation/client/_index.md new file mode 100644 index 00000000000..9f1b84a1539 --- /dev/null +++ b/content/en/docs/workstation/client/_index.md @@ -0,0 +1,17 @@ +--- +title: "Mendix Workstation Client" +linktitle: "Workstation Client" +url: /mendix-workstation/client/ +description: "Describes how to set up and administer the Mendix Workstation Client." +weight: 31 +--- + +## Introduction + +Installed on each local workstation, the [Workstation Client](https://marketplace.mendix.com/link/component/247448) establishes a secure and reliable connection between a workstation and the hardware, peripherals, or local data sources attached to that workstation. It handles the traffic between connected devices and the client application using the configurations provided by the Workstation Management and the functionality of the Workstation Connector. + +### Users + +Workstation Client is used by central IT, support teams, operators, and supervisors. + +## Read More diff --git a/content/en/docs/workstation/wks-batch-registration.md b/content/en/docs/workstation/client/wks-batch-registration.md similarity index 60% rename from content/en/docs/workstation/wks-batch-registration.md rename to content/en/docs/workstation/client/wks-batch-registration.md index 4ec3c04f8cc..f4ce230028d 100644 --- a/content/en/docs/workstation/wks-batch-registration.md +++ b/content/en/docs/workstation/client/wks-batch-registration.md @@ -1,38 +1,44 @@ --- title: "Registering Workstation Clients" url: /mendix-workstation/register/ -description: "Describes how to register and pre-configurer multiple Workstation Clients." -weight: 30 +description: "Describes how to register and pre-configure multiple Workstation Clients." +weight: 35 --- ## Introduction -Installed on each local workstation, the Mendix Workstation Client acts as a bridge between the Mendix app and local hardware. The goal of the Workstation Client is to establish a secure and reliable connection between the Mendix Application Client and the hardware, peripherals, or local data sources attached to that workstation. This connection is facilitated by the Workstation Connector and the Workstation Client. - -The registration process is a necessary first step when enabling this crucial functionality. It onboards your local Workstation Client installation into your Mendix Workstation Management environment. This onboarding allows for centralized management, configuration deployment, and monitoring of your clients, ensuring they are properly set up to bridge your Mendix applications with the physical world. +After [installing the Workstation Client](/mendix-workstation/install-client/), you must register it in Workstation Management. Registering the client onboards your local Workstation Client installation into your Mendix Workstation Management environment. This onboarding allows for centralized management, configuration deployment, and monitoring of your clients, ensuring that they are properly set up to bridge your Mendix applications with the physical world. Mendix Workstation supports both individual registration of local Workstation clients, and bulk rollouts for large production environments. {{% alert color="info" %}} -After a Workstation Client is registered, any changes that you make in Workstation Management (such as adding new devices, or setting the **Detect Card Readers** toggle to **Off**) will be immediately synchronized with the Client. To change this behavior, see [Client's Auto-Refresh](/mendix-workstation/management-settings/#auto-refresh). +After a Workstation Client is registered, any changes that you make in Workstation Management (such as adding new devices, or disabling the **Detect Card Readers** option) will be immediately synchronized with the Client. To change this behavior, see [Client's Auto-Refresh](/mendix-workstation/management-settings/#auto-refresh). {{% /alert %}} ## Registering a Single Workstation Client If you are developing or testing Workstation configurations, you can register a single Workstation Client for your local computer 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**, or select an existing station for which no computer is yet registered. -4. In the top right corner of the banner, click **Register Computer** to register your computer. -5. Click **Download** to navigate to the Workstation Client listing in the Marketplace, download the Client installer for Windows, install it, and launch it. You can find the listing at the following links: +1. Open the [Workspaces](https://workstation.home.mendix.com/) page. +2. Click the workspace where you want to register the Clients. +3. On the **Stations** page, edit or create a station representing the computer where you installed the Workstation Client. +4. Click the **Register Computer** button in the top right corner of the screen. +5. Click **Copy** to copy the registration token to your clipboard. + + {{< figure src="/attachments/workstation/wks-install7.png" class="no-border" >}} + +4. Open the Workstation Client and paste the copied registration token into the **Enter your registration token** field. +5. Click **Register computer**. + + {{< figure src="/attachments/workstation/wks-install8.png" class="no-border" >}} + +6. In Workstation Management, in the **Computer Registration** dialog, click **Done**. + + {{< figure src="/attachments/workstation/wks-install9.png" class="no-border" >}} - * [Windows](https://marketplace.mendix.com/link/component/247448) - * [Windows (portable version)](https://marketplace.mendix.com/link/component/247456) - * [Linux ARM64](https://marketplace.mendix.com/link/component/247459) - * [MacOS](https://marketplace.mendix.com/link/component/253905) +The **Stations** page now shows your station's status as **Computer Registered**. -6. Copy the registration token and paste it into the [Workstation Client](/mendix-workstation/installation/) registration field. + {{< figure src="/attachments/workstation/wks-install10.png" class="no-border" >}} ## Bulk-Registering Workstation Clients @@ -45,7 +51,7 @@ This feature is only available to licensed Mendix Workstation users. For more in To bulk-register Workstation Clients, perform the following steps: 1. Open the [Workspaces](https://workstation.home.mendix.com/) page. -2. Click the workspace where you want to register the clients. +2. Click the workspace where you want to register the Clients. 3. On the **Stations** page, click the three-dot menu in the top right corner of the screen, and then click **Bulk Register**. The **Create Bulk Registration Token** dialog opens. You can use it to activate a time-limited token which can then be entered into the registration field of multiple Workstation Clients. diff --git a/content/en/docs/workstation/client/wks-client-installation.md b/content/en/docs/workstation/client/wks-client-installation.md new file mode 100644 index 00000000000..3cdcc72fd5a --- /dev/null +++ b/content/en/docs/workstation/client/wks-client-installation.md @@ -0,0 +1,108 @@ +--- +title: "Installing the Workstation Client" +url: /mendix-workstation/install-client/ +description: "Describes how to download and install the Workstation Client." +weight: 30 +aliases: + - /mendix-workstation/prerequisites/ +--- + +## Introduction + +After [creating one or more workspaces](/mendix-workstation/management-config/) for your organization, you can proceed by installing the Workstation Client on the computers which you want to register as stations in Workstation Management. + +## Prerequisites + +Before you install the Workstation Client, ensure that you fulfill the following prerequisites. + +### System Requirements + +* 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 + +### Access Requirements + +You must have a Mendix account with [owner or admin](/mendix-workstation/management-team/) access to Mendix Workstation Management. + +## Downloading the Client + +You can download the Client from the Mendix Marketplace at the following links: + +* [Workstation Client](https://marketplace.mendix.com/link/component/247448) - For Microsoft Windows. Creates a global installation of the Workstation Client. Must be installed as a Windows user with administrator rights. +* [Workstation Client Portable](https://marketplace.mendix.com/link/component/247456) - For Microsoft Windows. Creates a portable installation of the Workstation Client. Does not require Windows administrator rights. +* [Workstation Client Linux ARM 64](https://marketplace.mendix.com/link/component/247459) - For Linux ARM 64. +* [Workstation Client macOS](https://marketplace.mendix.com/link/component/253905) - For macOS. Only Apple Silicon is supported. + +Alternatively, you can download the [global Microsoft Windows](https://marketplace.mendix.com/link/component/247448) version of the Client directly from Workstation Management by performing the following steps: + +1. Open the [station that you created](/mendix-workstation/management-config/) and click **Register Computer**. + + {{< figure src="/attachments/workstation/wks-install5.png" class="no-border" >}} + +2. In the **Computer Registration** dialog, click **Download**. + +This opens the Mendix Marketplace page for the [global Microsoft Windows version of the installer](https://marketplace.mendix.com/link/component/247448). If you want to install the [portable](https://marketplace.mendix.com/link/component/247456), [Linux](https://marketplace.mendix.com/link/component/247459) or [macOS](https://marketplace.mendix.com/link/component/253905) version, use the Marketplace search, or navigate to them through the above links. + +{{< figure src="/attachments/workstation/wks-install6.png" class="no-border" >}} + +## Installing the Workstation Client + +Refer to the following topics for information about installing the Workstation Client. + +### Windows (Global) + +If you have administrator rights for your Windows computer, install the Workstation Client by performing the following steps: + +1. Download the [global Microsoft Windows version of the installer](https://marketplace.mendix.com/link/component/247448). +2. Run the Workstation Client installer. +3. If you get a prompt from Windows User Account Control, click **Yes** to allow Workstation Client to be installed. + + For a silent installation, you can also run the installer as an administrator with the `/S` argument, that is, `MendixWorkstationX.Y.Z.exe /S`. + +The default installation folder is *C:\Program Files\Mendix Workstation*. The app data folder can be found at *C:\ProgramData\Mendix Workstation*. The client runs automatically after the installation is completed. + +### Windows Portable + +If you do not have administrator rights for your Windows computer, create a portable instance of the Workstation Client by performing the following steps: + +1. Download the [portable Microsoft Windows version of the installer](https://marketplace.mendix.com/link/component/247456). +2. As a best practice, create a new folder for the Client (for example, in your *Documents* folder). +3. Extract the Client to the target folder, and then click the *.exe* file to run the Client. + +### Linux + +To install the Workstation Client on a Linux machine, perform the following steps: + +1. Download the [Linux version of the installer](https://marketplace.mendix.com/link/component/247459). +2. Install the Client by running the following command, where `X.X.X.X` is the version and build number of the downloaded *.deb* package: + + ```text + sudo apt install ./MendixWorkstation_X.X.X.X_arm64.deb + ``` + +3. Install the card reader dependencies by running the following command: + + ```text + sudo apt install pcscd libcap2-bin + ``` + +4. Enable card reader dependencies by running the following command: + + ```text + sudo systemctl enable pcscd --now + ``` + +5. To start the application, go to the **Applications menu** > **Accessories > Mendix Workstation**. + + Bluetooth support requires starting the application with the `CAP_NET_RAW` privilege (for raw network packet access): + + ```text + sudo capsh --user=$(whoami) --iab="^cap_net_raw" -- -c "'/opt/Mendix Workstation/Mendix Workstation'" + ``` + +The Workstation Client runs automatically at system startup. To modify this behavior, see [Stopping the Workstation Client](#stop-client). + +### Stopping the Workstation Client {#stop-client} + +The **Close** button closes the Client window but does not terminate the application; it continues to run in the background. To completely quit the Client, right-click its icon in the Windows systray and select **Quit**. This action is only available if [Developer Mode](/mendix-workstation/management-stations/#developer-mode) is enabled. Alternatively, the Workstation Client process can always be stopped via Windows Task Manager. \ No newline at end of file diff --git a/content/en/docs/workstation/client/wks-client-proxy-settings.md b/content/en/docs/workstation/client/wks-client-proxy-settings.md new file mode 100644 index 00000000000..2251c6ec8e5 --- /dev/null +++ b/content/en/docs/workstation/client/wks-client-proxy-settings.md @@ -0,0 +1,29 @@ +--- +title: "Network Configuration for the Workstation Client" +linktitle: "Network Configuration" +url: /mendix-workstation/network-configuration/ +description: "Describes how to configure custom proxy settings for the Workstation Client." +weight: 30 +--- + +## Introduction + +To ensure that the Workstation Client works correctly, review the following information about the network configuration, custom certificates, and proxy settings. + +## Network Configuration + +To configure the network settings for the Workstation Client, perform the following steps: + +1. Ensure that the Workstation user can access the Mendix Cloud. +2. Open the required ports for communication (for example, TCP 443 for HTTPS). +3. Add the Workstation Client to the Allow list for any firewall or antivirus software, if applicable. + +## Custom Certificates and Proxy Settings + +The Workstation Client uses the operating system's certificates and proxy environment variables to establish a connection with Workstation Management. In most controlled corporate environments, these settings are preconfigured on employee computers by IT departments. + +To use a custom proxy configuration, you must start the Workstation Client from the command line and set the environment variables as described [here](https://github.com/nodejs/undici/blob/main/docs/docs/api/EnvHttpProxyAgent.md#class-envhttpproxyagent). For example, from the Windows Command Prompt, run the following command: + +``` +set HTTPS_PROXY=[PROXY_IP_ADDRESS] && "C:\Program Files\Mendix Workstation\Mendix Workstation.exe" +``` \ No newline at end of file diff --git a/content/en/docs/workstation/management/_index.md b/content/en/docs/workstation/management/_index.md index de55a939ae1..7f5767c746e 100644 --- a/content/en/docs/workstation/management/_index.md +++ b/content/en/docs/workstation/management/_index.md @@ -5,7 +5,7 @@ url: /mendix-workstation/management/ description: "Provides an overview of Mendix Workstation Management." no_list: false description_list: true -weight: 30 +weight: 11 --- ## Introduction @@ -22,4 +22,8 @@ For more information about the terms used in this document, such as *station* or Workstation Management is used by central IT and application support teams. +## Accessing Workstation Management + +Workstation Management is an online portal available at [https://workstation.home.mendix.com/](https://workstation.home.mendix.com/). + ## Read More diff --git a/content/en/docs/workstation/wks-import.md b/content/en/docs/workstation/management/wks-import.md similarity index 99% rename from content/en/docs/workstation/wks-import.md rename to content/en/docs/workstation/management/wks-import.md index 395349ab386..1e86308db79 100644 --- a/content/en/docs/workstation/wks-import.md +++ b/content/en/docs/workstation/management/wks-import.md @@ -3,7 +3,7 @@ title: "Managing and Sharing Workspace and Station Data" linktitle: "Managing and Sharing Data" url: /mendix-workstation/import-export/ description: "Describes how to import and export workspace and station data across workspaces and environments." -weight: 30 +weight: 100 --- ## Introduction diff --git a/content/en/docs/workstation/management/wks-management-devices.md b/content/en/docs/workstation/management/wks-management-devices.md index 678c9ce630d..e4762c3c21e 100644 --- a/content/en/docs/workstation/management/wks-management-devices.md +++ b/content/en/docs/workstation/management/wks-management-devices.md @@ -10,6 +10,22 @@ weight: 60 This section details how to configure various device types for the current station. For each device type, you will find instructions on how to set it up in the Management UI, along with the specific message syntax required for Mendix applications to communicate with it through the Workstation Client. +## Device Connectivity + +Before connecting devices with Mendix Workstation, perform the following steps: + +1. Make sure the devices are correctly set up and connected to your computer. +2. Verify that all device drivers are installed and updated. +3. Obtain the connection parameters used by the devices: + + * For Serial Port connection - baud rate, data bits, parity and stop bits, flow control. + * For TCP/IP connection - IP address and port. + +4. Obtain the manual and technical documentation for your devices, including chapters describing the communication protocol and how to configure it. +5. Test the connection and protocol on your operating system using the tool recommended in the device technical documentation or using common tool such as PuTTY. + * For Serial Port connection - Open the device and test device basic commands. + * For TCP/IP connection - Ping the device to make sure that it is reachable on the network and not blocked by a firewall, and then test the basic device commands. + ## 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. diff --git a/content/en/docs/workstation/management/wks-management-team.md b/content/en/docs/workstation/management/wks-management-team.md index 1cbd3c0c87f..911a484d36d 100644 --- a/content/en/docs/workstation/management/wks-management-team.md +++ b/content/en/docs/workstation/management/wks-management-team.md @@ -12,10 +12,26 @@ weight: 90 Collaborating with other users in a workspace requires a Workstation license. {{% /alert %}} -On the **Team** page, you can invite and manage members of a workspace. Only users who have signed into Workstation Management can be invited by email. +On the **Team** page, you can invite other Workstation Management users to your workspace to share configurations and collaborate. Only users who have signed into Workstation Management can be invited by email. {{< figure src="/attachments/workstation/wks-team1.png" class="no-border" >}} +## Inviting Users + +To invite a user, perform the following steps: + +1. In Workstation Management, in the left navigation menu, click **Team** to open the **Team** page. +2. Click **Invite Team Member**. +3. Enter the user's email address and select a role. + +For more information about the available roles, see [User Roles](#user-roles). + +## Managing Users + +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. + +## User Roles {#user-roles} + You can assign the following roles to your users: * Owner - The owner has full rights to manage the workspace. They can perform the following tasks: diff --git a/content/en/docs/workstation/management/wks-management.md b/content/en/docs/workstation/management/wks-management.md index 714331c7366..8a854da6e3b 100644 --- a/content/en/docs/workstation/management/wks-management.md +++ b/content/en/docs/workstation/management/wks-management.md @@ -27,6 +27,10 @@ To start using Mendix Workstation, you must first create a workspace and a stati {{< figure src="/attachments/workstation/wks-install4.png" class="no-border" >}} -6. Optional: If you do not want Workstation Management to detect smart card readers, in **Station** view, set the **Detect Card Readers** toggle to **Off**. +6. Optional: If you do not want Workstation Management to detect smart card readers, perform the following steps: - {{< figure src="/attachments/workstation/wks-install16.png" class="no-border" >}} \ No newline at end of file + 1. In **Station** view, click the **three dots** icon. + 2. Click **Edit Station**. + 3. Clear the **Detect Card Readers** check box. + +After you create a workspace and station, you can proceed with installing the Workstation Clients on the computers which you want to connect to your devices. For more information, see [Mendix Workstation Client](/mendix-workstation/client/). \ No newline at end of file diff --git a/content/en/docs/workstation/wks-monitoring.md b/content/en/docs/workstation/management/wks-monitoring.md similarity index 99% rename from content/en/docs/workstation/wks-monitoring.md rename to content/en/docs/workstation/management/wks-monitoring.md index b0e0e851e1e..86ab2f3737d 100644 --- a/content/en/docs/workstation/wks-monitoring.md +++ b/content/en/docs/workstation/management/wks-monitoring.md @@ -3,7 +3,7 @@ title: "Monitoring Mendix Workstation" linktitle: "Monitoring" url: /mendix-workstation/monitoring/ description: "Describes how to access and use the Usage Report page of Mendix Workstation." -weight: 35 +weight: 110 --- ## Introduction diff --git a/content/en/docs/workstation/wks-build-app.md b/content/en/docs/workstation/wks-connector.md similarity index 94% rename from content/en/docs/workstation/wks-build-app.md rename to content/en/docs/workstation/wks-connector.md index b6f8a84cdfa..8ab336b2827 100644 --- a/content/en/docs/workstation/wks-build-app.md +++ b/content/en/docs/workstation/wks-connector.md @@ -1,14 +1,16 @@ --- -title: "Building an App for Mendix Workstation" -linktitle: "Building an App" -url: /mendix-workstation/build-app/ +title: "Mendix Workstation Connector" +linktitle: "Workstation Connector" +url: /mendix-workstation/connector/ description: "Describes how to install the Workstation Connector and build an app to work with Mendix Workstation." -weight: 30 +aliases: + - /mendix-workstation/build-app/ +weight: 12 --- ## 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. +After you have [installed the Workstation Client](/mendix-workstation/install-client/), 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 @@ -22,7 +24,7 @@ The Workstation Connector connects with Workstation Client using a local WebSock ## Prerequisites -* Mendix Workstation 3.0.0 +* Mendix Workstation 3.0.0 or newer * Mendix Studio Pro 9.24.11 or newer ## Installing and Configuring the Workstation Connector diff --git a/content/en/docs/workstation/wks-prerequisites.md b/content/en/docs/workstation/wks-prerequisites.md deleted file mode 100644 index c52b4045e48..00000000000 --- a/content/en/docs/workstation/wks-prerequisites.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -title: "Getting Started with Mendix Workstation" -linktitle: "Getting Started" -url: /mendix-workstation/prerequisites/ -description: "Documents the requirements for Mendix Workstation, as well as a step-by-step walkthrough through a simple installation and configuration process." -weight: 10 ---- - -## Introduction - -Use this guide to help you get started with Mendix Workstation. Review the system, access, and network prerequisites, and then follow a step-by-step walkthrough to help you set up and test the connection. - -## Prerequisites - -Before you get started with Mendix Workstation, ensure that you fulfill the following prerequisites. - -### System Requirements - -* Operating System - Windows 10 or Windows 11 (64-bit); Linux ARM64 -* Memory - Minimum 4 GB RAM (8 GB recommended for optimal performance) -* Disk Space - 400 MB of free disk space for installation - -### Access Requirements - -* A Mendix account -* Access to Mendix Workstation Management for configuration - -### Network Configuration - -Before implementing Mendix Workstation, perform the following steps: - -1. Ensure that the Workstation user can access the Mendix Cloud. -2. Open the required ports for communication (for example, TCP 443 for HTTPS). -3. Add the Workstation Client to the Allow list for any firewall or antivirus software, if applicable. - -### Custom Certificates and Proxy Settings - -The Workstation Client uses the operating system's certificates and proxy environment variables to establish a connection with Workstation Management. In most controlled corporate environments, these settings are preconfigured on employee computers by IT departments. - -To use a custom proxy configuration, you must start the Workstation Client from the command line and set the environment variables as described [here](https://github.com/nodejs/undici/blob/main/docs/docs/api/EnvHttpProxyAgent.md#class-envhttpproxyagent). For example, from the Windows Command Prompt, run the following command: - -``` -set HTTPS_PROXY=[PROXY_IP_ADDRESS] && "C:\Program Files\Mendix Workstation\Mendix Workstation.exe" -``` - -## Device Connectivity - -Before connecting devices with Mendix Workstation perform the following steps: - -* Make sure the devices are correctly set up and connected to your computer. -* Verify that the device driver is installed and up to date. -* Take a note of the connection parameters used by the devices: - - * For Serial Port connection - baud rate, data bits, parity and stop bits, flow control. - * For TCP/IP connection - IP address and port. - -* Obtain the manual and technical documentation for your devices, including chapters describing the communication protocol and how to configure it. -* Test the connection and protocol on your operating system using the tool recommended in the device technical documentation or using common tool such as PuTTY. - * For Serial Port connection - Open the device and test device basic commands. - * For TCP/IP connection - Ping the device to make sure that it is reachable on the network and not blocked by a firewall, and then test the basic device commands. - -## Workstation Client Download Links - -Mendix Workstation can be downloaded from the Mendix Marketplace: - -* [Microsoft Windows (global installer)](https://marketplace.mendix.com/link/component/247448) -* [Microsoft Windows (portable)](https://marketplace.mendix.com/link/component/247456) -* [Linux ARM 64](https://marketplace.mendix.com/link/component/247459) - -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. -* Set up a pair of virtual TCP/IP Client and Server devices for testing. -* Install the Workstation Client on your computer. -* Verify the connection between your virtual devices directly from Workstation Management. - -### Creating a Workspace and Station - -A *station* represents a workstation on the shop floor. It can connect to one or more apps or devices. A *workspace* is a grouping of one or more stations. For example, a workspace may group together all the stations which belong to the same factory or factory line. - -1. Go to [Mendix Workstation Management](https://workstation.home.mendix.com/) and sign in with your Mendix account. -2. In **Workspace Overview**, click **Create Workspace**. - - {{< figure src="/attachments/workstation/wks-install1.png" class="no-border" >}} - -3. Enter a name for your new workspace, and then click **Create Workspace**. - - {{< figure src="/attachments/workstation/wks-install2.png" class="no-border" >}} - -4. After the workspace is created, in the **Stations** page, click **Create a New Station**. - - {{< figure src="/attachments/workstation/wks-install3.png" class="no-border" >}} - -5. Enter a name for the station, and then click **Create Station**. - - {{< figure src="/attachments/workstation/wks-install4.png" class="no-border" >}} - -6. Optional: If you do not want Workstation Management to detect smart card readers, in **Station** view, set the **Detect Card Readers** toggle to **Off**. - - {{< figure src="/attachments/workstation/wks-install16.png" class="no-border" >}} - -### Downloading and Running the Workstation Client - -The Workstation Client is a connector between the devices and your local PC. You can download and enable the client by performing the following steps: - -1. Open the station that you created, and click **Register Computer**. - - {{< figure src="/attachments/workstation/wks-install5.png" class="no-border" >}} - -2. In the **Computer Registration** dialog, click **Download**. - - This will open the Mendix Marketplace page for the [Workstation Client Windows Installer](https://marketplace.mendix.com/link/component/247448). Alternatively, you can find the component on the Mendix Marketplace by searching for "Workstation Client". You can also find the [portable](https://marketplace.mendix.com/link/component/247456) and [Linux](https://marketplace.mendix.com/link/component/247459) version by using the search, or navigate to them through the above links. - - {{< figure src="/attachments/workstation/wks-install6.png" class="no-border" >}} - -3. Perform one of the following actions: - - * For Windows: - - * If you have administrator rights for your computer, click **Download** and run the Workstation Client installer in the form of an NSIS installer package. If you get a prompt from Windows User Account Control, click **Yes** to allow Workstation Client to be installed; for a silent installation, you can also run the installer as an administrator with the `/S` argument, that is, `MendixWorkstationX.Y.Z.exe /S`. The default installation folder is *C:\Program Files\Mendix Workstation*. The app data folder can be found at *C:\ProgramData\Mendix Workstation*. The client runs automatically after the installation is completed. - * If you do not have administrator rights for your computer, download the [Workstation Client Portable](https://marketplace.mendix.com/link/component/247456) instead. As a best practice, put the portable client in a new folder (for example, in your Documents folder), and then click the .exe file to run the client. - - * For Linux: - * Download the [Linux](https://marketplace.mendix.com/link/component/247459) version of the Client - * Run the following command to install: `sudo apt install ./MendixWorkstation_X.X.X.X_arm64.deb` (replace *X.X.X.X* with the actual version and build number of the downloaded .deb package) - * Install card reader dependencies: `sudo apt install pcscd libcap2-bin` - * Enable card reader dependencies: `sudo systemctl enable pcscd --now` - * Start the application from the applications menu > **Accessories > Mendix Workstation** - * Bluetooth support requires starting the application with `CAP_NET_RAW` privilege (for raw network packet access): `sudo capsh --user=$(whoami) --iab="^cap_net_raw" -- -c "'/opt/Mendix Workstation/Mendix Workstation'"` - -### Registering your Computer - -With the Workstation Client running on your computer, you must now register your computer in the Workstation Management. - -1. Go to [Mendix Workstation Management](https://workstation.home.mendix.com/) and navigate to the **Station Overview** in the workspace which contains the station that you want to register to your computer. -2. Click the menu associated with your station in the overview, and then select **Register computer**. -3. Click **Copy** to copy the registration token to your clipboard. - - {{< figure src="/attachments/workstation/wks-install7.png" class="no-border" >}} - -4. Open the Workstation Client and paste the copied registration token into the **Enter your registration token** field. -5. Click **Register computer**. - - {{< figure src="/attachments/workstation/wks-install8.png" class="no-border" >}} - -6. In Workstation Management, in the **Computer Registration** dialog, click **Done**. - - {{< figure src="/attachments/workstation/wks-install9.png" class="no-border" >}} - -The **Stations** page now shows your station's status as **Computer Registered**. - - {{< figure src="/attachments/workstation/wks-install10.png" class="no-border" >}} - -### Configuring and Testing Virtual Devices - -After registering your computer, test your connectivity by creating a pair of virtual devices: a TCP/IP server that will emulate a device, and a TCP/IP client that will connect to the emulated device. - -#### Creating a TCP/IP Server - -1. Go to [Mendix Workstation Management](https://workstation.home.mendix.com/). -2. In the **Station** page, click **Add Device**. -3. Select **TCP/IP Server** as the **Device Type**, and then click **Next**. -4. In the **Device Name** field, enter **Test Server** -5. In the **Device Class** field, select or create a class (for example, *Virtual*), and then click **Next**. -6. In the **Port** field, leave the default value of **1705**, and click **Next**. -7. In the **Messages** dialog, leave all values as default, and click **Add Device**. - - {{< figure src="/attachments/workstation/wks-install12.png" class="no-border" >}} - -The emulated device, a local TCP/IP server listening on port 1705, is added to the **Devices** list in the **Station** page. - - {{< figure src="/attachments/workstation/wks-install13.png" class="no-border" >}} - -#### Creating a TCP/IP Client - -1. Go to [Mendix Workstation Management](https://workstation.home.mendix.com/). -2. In the **Station** page, click **Add Device**. -3. Select **TCP/IP Client** as the **Device Type**, and then click **Next**. -4. In the **Device Name** field, enter **Test Client**, and then click **Next**. -5. In the **Device Class** field, select or create a class (for example, *Virtual*), and then click **Next**. -6. In the **Host** and **Port** fields, leave the default value of **localhost** and **1705**, and click **Next**. - - {{< figure src="/attachments/workstation/wks-install14.png" class="no-border" >}} - -7. In the **Messages** dialog, leave all values as default, and click **Add Device**. - -The device, which will be used to connect to the TCP/IP server running in Workstation Client, is added to the **Devices** list in the **Station** page. - -#### Testing the Devices - -After configuring the server and client pair, test their connectivity by performing the following steps: - -1. In the left navigation menu of the current workspace, click **Settings**, and ensure that the **Enable Local Device Testing** toggle is set to **On**. -2. In the left navigation menu, click **Test Your Station**. - - The page refreshes and displays a list of all your devices. This includes detected smart card readers available on your computer if you did not disable detecting card readers as described [in step 6](/mendix-workstation/installation/#creating-a-workspace-and-station). - -3. In your web browser, duplicate the tab where you have opened the **Test Your Station** page. -4. Arrange the two opened tabs so that you can view the two **Test Your Station** pages side by side. -5. In the left tab, click on the client device (**Test Client**). -6. In the right tab, click on the server device (**Test Server**). -7. In the left tab, on the **Test Client** device, enter a test message, and then click **Send Message**. In the other tab, on the **Test Server**, the sent message appears in the **Last message received** field. -8. In the same way, send a message from the **Test Server** to the **Test Client** device. - -{{% alert color="info" %}} -Different device types have different requirements for the message syntax. For more information, see [Configuring Devices](/mendix-workstation/management-devices/). -{{% /alert %}} - -### Quitting the Workstation Client - -The **Close** button closes the Client window but does not terminate the application; it continues to run in the background. To completely quit the Client, right-click its icon in the Windows systray and select **Quit**. This action is only available if [Developer Mode](/mendix-workstation/management-stations/#developer-mode) is enabled. Alternatively, the Workstation Client process can always be stopped via Windows Task Manager. - -## Best Practices for Working with Mendix Workstation - -As you begin your work with Mendix Workstation, keep in mind the following best practices to help you. - -### Security Recommendations - -For more information, see [Security Best Practices for Mendix Workstation](/mendix-workstation/security/). - -### Performance Optimization - -* Ensure stations meet the recommended hardware specifications. -* Minimize background processes to improve performance. -* When building app logic reusing the Connectors nanoflows, minimize the amount of microflow calls and [other actions](/refguide/nanoflows/#logic-where-no-connection-is-needed) that require a server connection. One key benefit of Mendix Workstation is client-sided data processing. Every call to the Mendix runtime adds an performance overhead. - -### Maintenance Guidelines - -* Periodically review and update workstation and device configurations. -* Monitor workstation health and resolve any connectivity issues promptly. diff --git a/content/en/docs/workstation/wks-installation.md b/content/en/docs/workstation/wks-quickstart.md similarity index 53% rename from content/en/docs/workstation/wks-installation.md rename to content/en/docs/workstation/wks-quickstart.md index 2e3d5da4447..c79b31efa92 100644 --- a/content/en/docs/workstation/wks-installation.md +++ b/content/en/docs/workstation/wks-quickstart.md @@ -1,13 +1,17 @@ --- -title: "Installing and Configuring Mendix Workstation" -linktitle: "Installation and Configuration" -url: /mendix-workstation/installation/ -description: "Quick start and advanced guide for installing and configuring Mendix Workstation, including setting up workspaces, stations, and devices for initial testing from the Workstation Management." -weight: 20 +title: "Getting Started with Mendix Workstation" +linktitle: "Getting Started" +url: /mendix-workstation/quickstart/ +description: "Provides a step-by-step walkthrough through a simple installation and configuration process for Mendix Workstation." +aliases: + - /mendix-workstation/installation/ +weight: 10 --- ## Introduction +Use this guide to help you get started with Mendix Workstation. Review the system, access, and network prerequisites, and then follow a step-by-step walkthrough to help you set up and test the connection. + 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. @@ -15,18 +19,16 @@ This guide helps you configure and test a minimum working version of Mendix Work * Install the Workstation Client on your computer. * Verify the connection between your virtual devices directly from Workstation Management. -### Creating a Workspace and Station +## Creating a Workspace and Station {#create-workspace} -To create a workspace and a station, perform the following steps: +A *station* represents a workstation on the shop floor. It can connect to one or more apps or devices. A *workspace* is a grouping of one or more stations. For example, a workspace may group together all the stations which belong to the same factory or factory line. 1. Go to [Mendix Workstation Management](https://workstation.home.mendix.com/) and sign in with your Mendix account. 2. In **Workspace Overview**, click **Create Workspace**. {{< figure src="/attachments/workstation/wks-install1.png" class="no-border" >}} -3. Enter a name for your new workspace, specify the environment type (**Test**, **Acceptance** or **Production**), and then click **Create Workspace**. - - Workspaces created with the Test environment type have [Developer Mode](/mendix-workstation/management-stations/#developer-mode) for their stations enabled by default. Changing the environment type after creation does not disable or enable Developer Mode. +3. Enter a name for your new workspace, and then click **Create Workspace**. {{< figure src="/attachments/workstation/wks-install2.png" class="no-border" >}} @@ -38,46 +40,48 @@ To create a workspace and a station, perform the following steps: {{< figure src="/attachments/workstation/wks-install4.png" class="no-border" >}} -6. Optional: If you do not want Workstation Management to detect smart card readers, in **Station** view, set the **Detect Card Readers** toggle to **Off**. +6. Optional: If you do not 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. - {{< figure src="/attachments/workstation/wks-install16.png" class="no-border" >}} +## Installing the Workstation Client -### Downloading and Running the Workstation Client +The Workstation Client is a connector between between a Mendix app and various devices. You must install it on a computer, and then register it in Workstation Management. -The Workstation Client is a connector between the devices and your local PC. You can download and enable the client by performing the following steps: +{{% alert color="info" %}} +The following instructions assume that your operating system is Windows, and that you have Windows administrator rights that allow you to perform a global installation. If you do not have administrator rights, or if you want to install the Client on a Linux machine, see [Installing the Workstation Client](/mendix-workstation/install-client/) for instructions. +{{% /alert %}} -1. Open the station that you created, and click **Register Computer**. +1. Open the [station that you created](#create-workspace) and click **Register Computer**. {{< figure src="/attachments/workstation/wks-install5.png" class="no-border" >}} 2. In the **Computer Registration** dialog, click **Download**. - This will open the Mendix Marketplace page for the [Workstation Client Windows Installer](https://marketplace.mendix.com/link/component/247448). Alternatively, you can find the component on the Mendix Marketplace by searching for "Workstation Client". You can also find the [portable](https://marketplace.mendix.com/link/component/247456) and [Linux](https://marketplace.mendix.com/link/component/247459) version by using the search, or navigate to them through the above links. - {{< figure src="/attachments/workstation/wks-install6.png" class="no-border" >}} -3. Perform one of the following actions: - - * For Windows: +3. Run the Workstation Client installer. +4. If you get a prompt from Windows User Account Control, click **Yes** to allow Workstation Client to be installed. - * If you have administrator rights for your computer, click **Download** and run the Workstation Client installer in the form of an NSIS installer package. If you get a prompt from Windows User Account Control, click **Yes** to allow Workstation Client to be installed; for a silent installation, you can also run the installer as an administrator with the `/S` argument, that is, `MendixWorkstationX.Y.Z.exe /S`. The default installation folder is *C:\Program Files\Mendix Workstation*. The app data folder can be found at *C:\ProgramData\Mendix Workstation*. The client runs automatically after the installation is completed. - * If you do not have administrator rights for your computer, download the [Workstation Client Portable](https://marketplace.mendix.com/link/component/247456) instead. As a best practice, put the portable client in a new folder (for example, in your Documents folder), and then click the .exe file to run the client. + For a silent installation, you can also run the installer as an administrator with the `/S` argument, that is, `MendixWorkstationX.Y.Z.exe /S`. - * For Linux: - * Download the [Linux](https://marketplace.mendix.com/link/component/247459) version of the Client - * Run the following command to install: `sudo apt install ./MendixWorkstation_X.X.X.X_arm64.deb` (replace *X.X.X.X* with the actual version and build number of the downloaded .deb package) - * Install card reader dependencies: `sudo apt install pcscd libcap2-bin` - * Enable card reader dependencies: `sudo systemctl enable pcscd --now` - * Start the application from the applications menu > **Accessories > Mendix Workstation** - * Bluetooth support requires starting the application with `CAP_NET_RAW` privilege (for raw network packet access): `sudo capsh --user=$(whoami) --iab="^cap_net_raw" -- -c "'/opt/Mendix Workstation/Mendix Workstation'"` +The default installation folder is *C:\Program Files\Mendix Workstation*. The app data folder can be found at *C:\ProgramData\Mendix Workstation*. The client runs automatically after the installation is completed. ### Registering your Computer With the Workstation Client running on your computer, you must now register your computer in the Workstation Management. -1. Go to [Mendix Workstation Management](https://workstation.home.mendix.com/) and navigate to the **Station Overview** in the workspace which contains the station that you want to register to your computer. -2. Click the menu associated with your station in the overview, and then select **Register computer**. -3. Click **Copy** to copy the registration token to your clipboard. +{{% alert color="info" %}} +The following instructions assume that you are registering a single computer for testing purposes. If you want to register multiple Workstation clients and their host computers in a single rollout, see [Registering Workstation Clients](/mendix-workstation/register/) for instructions. +{{% /alert %}} + +1. Open the [Workspaces](https://workstation.home.mendix.com/) page. +2. Click the workspace where you want to register the Clients. +3. On the **Stations** page, edit or create a station representing the computer where you installed the Workstation Client. +4. Click the **Register Computer** button in the top right corner of the screen. +5. Click **Copy** to copy the registration token to your clipboard. {{< figure src="/attachments/workstation/wks-install7.png" class="no-border" >}} @@ -94,8 +98,6 @@ The **Stations** page now shows your station's status as **Computer Registered** {{< figure src="/attachments/workstation/wks-install10.png" class="no-border" >}} -Any changes that you make in Workstation Management (such as adding new devices, or setting the **Detect Card Readers** toggle to **Off**) will be immediately synchronized with the Workstation Client. To change this behavior, see [Client's Auto-Refresh](/mendix-workstation/management-settings/#auto-refresh). - ### Configuring and Testing Virtual Devices After registering your computer, test your connectivity by creating a pair of virtual devices: a TCP/IP server that will emulate a device, and a TCP/IP client that will connect to the emulated device. @@ -103,7 +105,7 @@ After registering your computer, test your connectivity by creating a pair of vi #### Creating a TCP/IP Server 1. Go to [Mendix Workstation Management](https://workstation.home.mendix.com/). -2. In the **Station Details** page, click **Add Device**. +2. In the **Station** page, click **Add Device**. 3. Select **TCP/IP Server** as the **Device Type**, and then click **Next**. 4. In the **Device Name** field, enter **Test Server** 5. In the **Device Class** field, select or create a class (for example, *Virtual*), and then click **Next**. @@ -119,7 +121,7 @@ The emulated device, a local TCP/IP server listening on port 1705, is added to t #### Creating a TCP/IP Client 1. Go to [Mendix Workstation Management](https://workstation.home.mendix.com/). -2. In the **Station Details** page, click **Add Device**. +2. In the **Station** page, click **Add Device**. 3. Select **TCP/IP Client** as the **Device Type**, and then click **Next**. 4. In the **Device Name** field, enter **Test Client**, and then click **Next**. 5. In the **Device Class** field, select or create a class (for example, *Virtual*), and then click **Next**. @@ -151,6 +153,21 @@ After configuring the server and client pair, test their connectivity by perform Different device types have different requirements for the message syntax. For more information, see [Configuring Devices](/mendix-workstation/management-devices/). {{% /alert %}} -### Quitting the Workstation Client +## Best Practices for Working with Mendix Workstation + +As you begin your work with Mendix Workstation, keep in mind the following best practices to help you. + +### Security Recommendations + +For more information, see [Security Best Practices for Mendix Workstation](/mendix-workstation/security/). + +### Performance Optimization + +* Ensure stations meet the recommended hardware specifications. +* Minimize background processes to improve performance. +* When building app logic reusing the Connectors nanoflows, minimize the amount of microflow calls and [other actions](/refguide/nanoflows/#logic-where-no-connection-is-needed) that require a server connection. One key benefit of Mendix Workstation is client-sided data processing. Every call to the Mendix runtime adds an performance overhead. + +### Maintenance Guidelines -The Workstation Client runs automatically at system startup. The **Close** button closes the Client window but does not terminate the application; it continues to run in the background. To completely quit the Client, right-click its icon in the Windows systray and select **Quit**. This action is only available if [Developer Mode](/mendix-workstation/management-stations/#developer-mode) is enabled. Alternatively, the Workstation Client process can always be stopped via Windows Task Manager. \ No newline at end of file +* Periodically review and update workstation and device configurations. +* Monitor workstation health and resolve any connectivity issues promptly. From ba6cc784f8fdc061d6d1584bdd20130cdcb178e7 Mon Sep 17 00:00:00 2001 From: katarzyna_koltun Date: Fri, 3 Jul 2026 09:13:22 +0200 Subject: [PATCH 2/4] link fixes --- content/en/docs/releasenotes/workstation/_index.md | 2 +- content/en/docs/workstation/_index.md | 2 +- .../workstation/troubleshooting/wks-troubleshooting-client.md | 2 +- content/en/docs/workstation/wks-quickstart.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/en/docs/releasenotes/workstation/_index.md b/content/en/docs/releasenotes/workstation/_index.md index a59236e6062..c660c0a9ce1 100644 --- a/content/en/docs/releasenotes/workstation/_index.md +++ b/content/en/docs/releasenotes/workstation/_index.md @@ -133,7 +133,7 @@ If more than one station is found for a given computer name during bulk registra * 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). +For more information, see [Nanoflows](/mendix-workstation/connector/#javascript-actions) and [Widgets](/mendix-workstation/connector/#widgets). #### Improvements diff --git a/content/en/docs/workstation/_index.md b/content/en/docs/workstation/_index.md index 79128d2b933..3c2553603d5 100644 --- a/content/en/docs/workstation/_index.md +++ b/content/en/docs/workstation/_index.md @@ -86,6 +86,6 @@ The following functionalities are only available with a license: * [Bulk import of stations](/mendix-workstation/import-export/) * [Bulk registration of Workstation Clients](/mendix-workstation/register/) -* [Inviting users](/mendix-workstation/build-app/#invite-users) +* [Inviting users](/mendix-workstation/connector/#invite-users) ## Read More diff --git a/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md b/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md index c477cccc29f..7f13f4f2872 100644 --- a/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md +++ b/content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md @@ -80,7 +80,7 @@ The Client request to Workstation Management is not forwarded to the Workstation ### 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). +Verify whether your computer's network traffic is routed through a proxy server and configure your proxy settings accordingly. See [Network Configuration](/mendix-workstation/network-configuration/). ## Workstation Management URL cannot be resolved diff --git a/content/en/docs/workstation/wks-quickstart.md b/content/en/docs/workstation/wks-quickstart.md index c79b31efa92..3e2d4bbab7b 100644 --- a/content/en/docs/workstation/wks-quickstart.md +++ b/content/en/docs/workstation/wks-quickstart.md @@ -140,7 +140,7 @@ After configuring the server and client pair, test their connectivity by perform 1. In the left navigation menu of the current workspace, click **Settings**, and ensure that the **Enable Local Device Testing** toggle is set to **On**. 2. In the left navigation menu, click **Test Your Station**. - The page refreshes and displays a list of all your devices. This includes detected smart card readers available on your computer if you did not disable detecting card readers as described [in step 6](/mendix-workstation/installation/#creating-a-workspace-and-station). + The page refreshes and displays a list of all your devices. This includes detected smart card readers available on your computer if you did not [disable detecting card readers](#creating-a-workspace-and-station). 3. In your web browser, duplicate the tab where you have opened the **Test Your Station** page. 4. Arrange the two opened tabs so that you can view the two **Test Your Station** pages side by side. From f2a93309d57e798d5d10d7c43a145aebedf906b4 Mon Sep 17 00:00:00 2001 From: katarzyna_koltun Date: Fri, 3 Jul 2026 09:51:36 +0200 Subject: [PATCH 3/4] Fix link error --- content/en/docs/workstation/wks-quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/workstation/wks-quickstart.md b/content/en/docs/workstation/wks-quickstart.md index 3e2d4bbab7b..a6091df42f7 100644 --- a/content/en/docs/workstation/wks-quickstart.md +++ b/content/en/docs/workstation/wks-quickstart.md @@ -140,7 +140,7 @@ After configuring the server and client pair, test their connectivity by perform 1. In the left navigation menu of the current workspace, click **Settings**, and ensure that the **Enable Local Device Testing** toggle is set to **On**. 2. In the left navigation menu, click **Test Your Station**. - The page refreshes and displays a list of all your devices. This includes detected smart card readers available on your computer if you did not [disable detecting card readers](#creating-a-workspace-and-station). + The page refreshes and displays a list of all your devices. This includes detected smart card readers available on your computer if you did not [disable detecting card readers](#create-workspace). 3. In your web browser, duplicate the tab where you have opened the **Test Your Station** page. 4. Arrange the two opened tabs so that you can view the two **Test Your Station** pages side by side. From 5cd34cf943a9536c145c1f39ba35074ee2e86e06 Mon Sep 17 00:00:00 2001 From: katarzyna_koltun Date: Fri, 3 Jul 2026 10:02:32 +0200 Subject: [PATCH 4/4] minor updates to intro --- content/en/docs/workstation/_index.md | 16 ++-------------- content/en/docs/workstation/wks-connector.md | 13 +++++++++++++ 2 files changed, 15 insertions(+), 14 deletions(-) diff --git a/content/en/docs/workstation/_index.md b/content/en/docs/workstation/_index.md index 3c2553603d5..e5c0a2ab44a 100644 --- a/content/en/docs/workstation/_index.md +++ b/content/en/docs/workstation/_index.md @@ -61,20 +61,8 @@ Using Mendix Workstation offers the following benefits for your organization: Mendix Workstation consists of the following components: * [Workstation Management](/mendix-workstation/management/) - Allows centralized configuration. -* Workstation Client - Allows real-time communication with local hardware. - - Used by central IT, support teams, operators, and supervisors. Installed on each local workstation, the Workstation Client acts as a bridge between the Mendix client app and local hardware. It handles the traffic between connected devices and the client application using the configurations provided by the Workstation Management. - -* Workstation Connector - Allows app integration. - - Used by Mendix developers. The App Connector is a plug-and-play Mendix module that allows developers to connect their apps to local devices using nanoflows. It establishes a connection with the Workstation Client, which acts as the intermediary between the Mendix app and the local devices. Once this connection is established, the module facilitates seamless data exchange by routing messages and events back and forth between the app and the devices. - - The connector handles the following tasks: - - * Retrieving local station configuration (name and device list) - * Connecting and disconnecting devices - * Exchanging messages with devices - * Subscribing for triggering app logic on event when receiving messages from a device +* [Workstation Client](/mendix-workstation/client/) - Allows real-time communication with local hardware. +* [Workstation Connector](/mendix-workstation/connector/) - Allows app integration. {{< figure src="/attachments/workstation/WorkstationDiagram.png" class="no-border" >}} diff --git a/content/en/docs/workstation/wks-connector.md b/content/en/docs/workstation/wks-connector.md index 8ab336b2827..6b52d57efd0 100644 --- a/content/en/docs/workstation/wks-connector.md +++ b/content/en/docs/workstation/wks-connector.md @@ -12,6 +12,19 @@ weight: 12 After you have [installed the Workstation Client](/mendix-workstation/install-client/), 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. +The Workstation Connector is a Mendix module that allows developers to connect their apps to local devices using nanoflows. It establishes a connection with the Workstation Client, which acts as the intermediary between the Mendix app and the local devices. Once this connection is established, the module facilitates seamless data exchange by routing messages and events back and forth between the app and the devices. + +The connector handles the following tasks: + +* Retrieving local station configuration (name and device list) +* Connecting and disconnecting devices +* Exchanging messages with devices +* Subscribing for triggering app logic on event when receiving messages from a device + +### Users + +Workstation Client is used by central IT, support teams, operators, and supervisors. + ### 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.