Skip to content

Commit 58d465c

Browse files
Merge pull request #10113 from mendix/kk-workstation-names
Cleared up naming for Workstation
2 parents 52dbef3 + cd19426 commit 58d465c

8 files changed

Lines changed: 45 additions & 45 deletions

File tree

content/en/docs/releasenotes/workstation/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "Mendix Workstation Release Notes"
3-
linktitle: Mendix Workstation
2+
title: "Mendix Workstation Client Release Notes"
3+
linktitle: Mendix Workstation Client
44
url: /releasenotes/workstation/
5-
description: "Release notes for updates to the Mendix Workstation"
5+
description: "Release notes for updates to the Mendix Workstation Client"
66
weight: 40
77
cascade:
88
- numberless_headings: true

content/en/docs/workstation/_index.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
---
2-
title: "Mendix Workstation"
2+
title: "Mendix Workstation Client"
33
url: /mendix-workstation/
4-
description: "Presents documentation on configuring and using the Mendix Workstation."
4+
description: "Presents documentation on configuring and using the Mendix Workstation Client."
55
weight: 42
66
no_list: false
77
description_list: true
88
cascade:
99
- content_type: "Mendix Workstation"
1010
---
1111
{{% alert color="info" %}}
12-
Mendix Workstation is available only for members of the Mendix Workstation Client Pre-Release Program. Support is available only to members of the program. To become a program member, contact Mendix Sales.
12+
Mendix Workstation Client is available only for members of the Mendix Workstation Client Pre-Release Program. Support is available only to members of the program. To become a program member, contact Mendix Sales.
1313
{{% /alert %}}
1414

1515
## Introduction
1616

17-
Mendix Workstation is designed to help you build smarter, faster, and more operator-friendly applications for shopfloor operators. It enables Mendix cloud applications to directly interact with peripheral devices on a local workstation, without relying on intermediate servers or heavy network traffic.
17+
Mendix Workstation Client is designed to help you build smarter, faster, and more operator-friendly applications for shopfloor operators. It enables Mendix cloud applications to directly interact with peripheral devices on a local workstation, without relying on intermediate servers or heavy network traffic.
1818

1919
By connecting applications directly to the PC's local resources, Workstation allows for near real-time communication with devices like printers, barcode scanners, smartcard readers, and industrial scales, all from within a Mendix app. This setup ensures low-latency performance and reduces infrastructure complexity.
2020

2121
Workstation is especially valuable in manufacturing and industrial environments where precision, speed, and reliability are key to operator efficiency.
2222

2323
In addition to connectivity features, Workstation supports enterprise-grade deployment of projects across multiple environments and sites. It enables distributed teams to collaborate effectively and centrally manage connections to a wide range of heterogeneous equipment assets in a controlled and secure manner.
2424

25-
## Features of Mendix Workstation
25+
## Features of Mendix Workstation Client
2626

27-
Mendix Workstation has the following features:
27+
Mendix Workstation Client has the following features:
2828

29-
* Direct local device access - Mendix Workstation allows Mendix client applications to send and receive messages directly from the PC's local hardware.
29+
* Direct local device access - Mendix Workstation Client allows Mendix client applications to send and receive messages directly from the PC's local hardware.
3030
* No server detour - Communication happens between the client app and local devices — without routing through a central server, network overload, or any additional intermediate systems.
3131
* Interactions with the local PC, such as sending and receiving on-event messages, are handled with Mendix nanoflows.
3232
* Supports multiple interfaces:
@@ -39,7 +39,7 @@ Mendix Workstation has the following features:
3939

4040
* Can emulate and simulate interfaces.
4141

42-
## Benefits of Using Mendix Workstation
42+
## Benefits of Using Mendix Workstation Client
4343

4444
* Improve operator user experience and efficiency.
4545
* Renovate home-grown application and get control of legacy systems.
@@ -50,17 +50,17 @@ Mendix Workstation has the following features:
5050

5151
## Use Cases
5252

53-
Mendix Workstation can be used to create apps that handle use cases such as the following:
53+
Mendix Workstation Client can be used to create apps that handle use cases such as the following:
5454

5555
* Printing labels on an industrial thermal label printer (for example, a Zebra printer)
5656
* Badge operators with an NFC smartcard reader and PC/SC specification
5757
* Scanning and parsing barcodes (for example, GS1 specifications)
5858
* Weighing materials with an industrial scale (for example, a Mettler Toledo SICS-compatible scale)
5959
* Connected smart tools (for example, screwdrivers with torque control)
6060

61-
## Components of Mendix Workstation
61+
## Components of Mendix Workstation Client
6262

63-
Mendix Workstation consists of the following components:
63+
Mendix Workstation Client consists of the following components:
6464

6565
* [Workstation Management](https://workstation.home.mendix.com/) - Allows centralized configuration.
6666
* [Workstation Client](https://marketplace.mendix.com/link/component/241063) - Allows real-time communication with local hardware.

content/en/docs/workstation/wks-build-app.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "Building an App for Mendix Workstation"
2+
title: "Building an App for Mendix Workstation Client"
33
linktitle: "Building an App"
44
url: /mendix-workstation/build-app/
5-
description: "Describes how to install the Workstation Connector and build an app to work with Mendix Workstation."
5+
description: "Describes how to install the Workstation Connector and build an app to work with Mendix Workstation Client."
66
weight: 30
77
---
88

@@ -73,7 +73,7 @@ To change a user's role, or remove them from the workspace, click the three dot
7373

7474
## Getting Started with Custom Logic for Device Interaction
7575

76-
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:
76+
Now that you are ready to start using Mendix Workstation Client, 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:
7777

7878
* **GetStation** - Retrieves the computer information connected to the Client.
7979
* **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/message-syntax/).
@@ -162,4 +162,4 @@ The administrator can choose to allow either one or a combination of the followi
162162

163163
## Error Logs
164164

165-
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/).
165+
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 Client](/mendix-workstation/troubleshooting/).

content/en/docs/workstation/wks-installation.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
2-
title: "Installing and Configuring Mendix Workstation"
2+
title: "Installing and Configuring Mendix Workstation Client"
33
linktitle: "Installation and Configuration"
44
url: /mendix-workstation/installation/
5-
description: "Documents the installation process for Mendix Workstation."
5+
description: "Documents the installation process for Mendix Workstation Client."
66
weight: 20
77
---
88

99
## Introduction
1010

11-
This document provides a quick start guide for installing Mendix Workstation, and then configuring its basic settings. Mendix Workstation is available for the following operating systems:
11+
This document provides a quick start guide for installing Mendix Workstation Client, and then configuring its basic settings. Mendix Workstation Client is available for the following operating systems:
1212

1313
* [Microsoft Windows (global installer)](https://marketplace.mendix.com/link/component/241063)
1414
* [Microsoft Windows (portable)](https://marketplace.mendix.com/link/component/242552)
1515
* [Linux ARM 64](https://marketplace.mendix.com/link/component/245627)
1616

17-
To configure Mendix Workstation, perform the following steps:
17+
To configure Mendix Workstation Client, perform the following steps:
1818

1919
### Creating a Workspace and Station
2020

@@ -43,28 +43,28 @@ A *station* represents a workstation on the shopfloor. It can connect to one or
4343

4444
## Downloading and Running the Workstation Client
4545

46-
The Mendix Workstation Client is a connector between the devices and your local PC. You can download and enable the client by performing the following steps:
46+
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:
4747

4848
1. Open a station and click **Register Computer**.
4949

5050
{{< figure src="/attachments/workstation/wks-install5.png" class="no-border" >}}
5151

52-
2. In the **Computer Registration** dialog, click **Download**. The [Mendix Workstation Client](https://marketplace.mendix.com/link/component/241063) page on the Mendix Marketplace opens for the Windows installer. 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/242552) and [Linux](https://marketplace.mendix.com/link/component/245627) version by using the search, or navigate to them through the above links.
52+
2. In the **Computer Registration** dialog, click **Download**. The [Workstation Client](https://marketplace.mendix.com/link/component/241063) page on the Mendix Marketplace opens for the Windows installer. 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/242552) and [Linux](https://marketplace.mendix.com/link/component/245627) version by using the search, or navigate to them through the above links.
5353

5454
{{< figure src="/attachments/workstation/wks-install6.png" class="no-border" >}}
5555

5656
3. Perform one of the following actions:
5757

5858
* For Windows:
5959

60-
* 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 Access Control, click **Yes** to allow Mendix 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.
61-
* If you do not have administrator rights for your computer, download the [Mendix Workstation Client Portable](https://marketplace.mendix.com/link/component/242552) instead. As a best practice, put the portable client in a new folder in your Documents folders, and then click the .exe file to run the client.
60+
* 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 Access 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.
61+
* If you do not have administrator rights for your computer, download the [Workstation Client Portable](https://marketplace.mendix.com/link/component/242552) instead. As a best practice, put the portable client in a new folder in your Documents folders, and then click the .exe file to run the client.
6262

6363
* For Linux - Download and install the [Linux](https://marketplace.mendix.com/link/component/245627) version of the client.
6464

6565
## Registering your Computer
6666

67-
With the Mendix Workstation Client running on your computer, you must now register your computer in the Workstation Management.
67+
With the Workstation Client running on your computer, you must now register your computer in the Workstation Management.
6868

6969
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.
7070
2. Click the menu in the overview and select **Register computer**.

content/en/docs/workstation/wks-message-syntax.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ weight: 40
88

99
## Introduction
1010

11-
To communicate with your devices, you must ensure that the messages you send have the correct syntax. This syntax varies depending on the type of device. The following sections show the required syntax for file system, smart card, and Bluetooth devices.
11+
To enable Mendix Workstation Client to communicate with your devices, you must ensure that the messages you send have the correct syntax. This syntax varies depending on the type of device. The following sections show the required syntax for file system, smart card, and Bluetooth devices.
1212

1313
## Bluetooth
1414

content/en/docs/workstation/wks-prerequisites.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: "Getting Started with Mendix Workstation"
2+
title: "Getting Started with Mendix Workstation Client"
33
linktitle: "Getting Started"
44
url: /mendix-workstation/prerequisites/
5-
description: "Documents the requirements for the Mendix Workstation."
5+
description: "Documents the requirements for the Mendix Workstation Client."
66
weight: 10
77
---
88

99
## Introduction
1010

11-
This document presents the system requirements for Mendix Workstation.
11+
This document presents the system requirements for Mendix Workstation Client.
1212

1313
## System Requirements
1414

@@ -23,15 +23,15 @@ This document presents the system requirements for Mendix Workstation.
2323

2424
## Network Configuration
2525

26-
Before implementing Mendix Workstation, perform the following steps:
26+
Before implementing Mendix Workstation Client, perform the following steps:
2727

2828
1. Ensure that the Workstation user can access the Mendix Cloud.
2929
2. Open the required ports for communication (for example, TCP 443 for HTTPS).
30-
3. Add the Mendix Workstation client to the Allow list for any firewall or antivirus software, if applicable.
30+
3. Add the Workstation Client to the Allow list for any firewall or antivirus software, if applicable.
3131

3232
## Device Connectivity
3333

34-
Before connecting devices with Mendix Workstation perform the following steps:
34+
Before connecting devices with Mendix Workstation Client perform the following steps:
3535

3636
* Make sure the devices are correctly set up and connected to your computer.
3737
* Verify that the device driver is installed and up to date.
@@ -45,19 +45,19 @@ Before connecting devices with Mendix Workstation perform the following steps:
4545
* For Serial Port connection - Open the device and test device basic commands.
4646
* 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.
4747

48-
## Best Practices for Working with Mendix Workstation
48+
## Best Practices for Working with Mendix Workstation Client
4949

50-
As you begin your work with Mendix Workstation, keep in mind the following best practices to help you.
50+
As you begin your work with Mendix Workstation Client, keep in mind the following best practices to help you.
5151

5252
### Security Recommendations
5353

54-
For more information, see [Security Best Practices for Mendix Workstation](/mendix-workstation/security/).
54+
For more information, see [Security Best Practices for Mendix Workstation Client](/mendix-workstation/security/).
5555

5656
### Performance Optimization
5757

5858
* Ensure workstations meet the recommended hardware specifications.
5959
* Minimize background processes to improve performance.
60-
* When building app logic reusing the Connectors nanoflows, minimize the amount of microflow calls and [other actions](https://docs.mendix.com/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.
60+
* When building app logic reusing the Connectors nanoflows, minimize the amount of microflow calls and [other actions](https://docs.mendix.com/refguide/nanoflows/#logic-where-no-connection-is-needed) that require a server connection. One key benefit of Mendix Workstation Client is client-sided data processing. Every call to the Mendix runtime adds an performance overhead.
6161

6262
### Maintenance Guidelines
6363

content/en/docs/workstation/wks-security.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "Security Best Practices for Mendix Workstation"
2+
title: "Security Best Practices for Mendix Workstation Client"
33
linktitle: "Security Best Practices"
44
url: /mendix-workstation/security/
5-
description: "Provides information about best-practice security configuration for the Mendix Workstation."
5+
description: "Provides information about best-practice security configuration for the Mendix Workstation Client."
66
weight: 15
77
---
88

content/en/docs/workstation/wks-troubleshooting.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: "Troubleshooting Mendix Workstation"
2+
title: "Troubleshooting Mendix Workstation Client"
33
linktitle: "Troubleshooting"
44
url: /mendix-workstation/troubleshooting/
5-
description: "Describes how to solve potential issues with Mendix Workstation."
5+
description: "Describes how to solve potential issues with Mendix Workstation Client."
66
weight: 40
77
---
88

99
## Introduction
1010

11-
If you encounter any issues with your Mendix Workstation Management, Connector, or Client, use the following troubleshooting tips to help you solve them.
11+
If you encounter any issues with your Workstation Management, Connector, or Client, use the following troubleshooting tips to help you solve them.
1212

1313
## Workstation Management
1414

@@ -34,7 +34,7 @@ The Client retains logs for the last eight days. You can access the logs by clic
3434

3535
You can also find log files by day in the Client's app data folder. To do so on Windows, press **Win + R**. If you installed the Client using the installer for all users, enter `%ProgramData%\Mendix Workstation\logs`. If you are using the portable version, enter `%AppData%\Mendix Workstation\logs`. On Linux the Mendix *Workstation/logs* folder is either located at `$XDG_CONFIG_HOME` or `~/.config`.
3636

37-
Alternatively, you can start the Mendix Workstation Client from Powershell to view logs: `start "C:\Program Files\Mendix Workstation\Mendix Workstation.exe" -ArgumentList "--log-level=debug" -wait`.
37+
Alternatively, you can start the Workstation Client from Powershell to view logs: `start "C:\Program Files\Mendix Workstation\Mendix Workstation.exe" -ArgumentList "--log-level=debug" -wait`.
3838

3939
### Registration Token Could Not Be Parsed
4040

@@ -86,7 +86,7 @@ The connection between the Client and the Connector cannot be established either
8686

8787
#### Solution
8888

89-
* Verify that the Mendix Workstation Client is running and registered on the same computer as the browser that is trying to establish a connection via the StationConnector.
89+
* Verify that the Workstation Client is running and registered on the same computer as the browser that is trying to establish a connection via the StationConnector.
9090
* Verify that the Client is registered in the correct Workspace by comparing the Workspace name and ID displayed in the Client UI with the Workspace in the Management.
9191
* Verify that the application that is attempting a connection is properly configured as an allowed app in the Workspace and on the Station. To do so check that your application, for example, running on `http://localhost:8080`, is added in the **Apps** section of your Workspace. If the app is added, check that the public key of the configured workspace app is up to date with the public key displayed in your app that is using the connector. If not, update the public key value of the workspace app with the latest value displayed in the app. Next, check that the app is also enabled as an allowed app in the Station configuration by going to the respective Station detail page in that workspace. Always press the **Refresh** button in the Workstation Client after applying any changes in the Management.
9292

0 commit comments

Comments
 (0)