Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/en/docs/releasenotes/workstation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
18 changes: 3 additions & 15 deletions content/en/docs/workstation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" >}}

Expand All @@ -86,6 +74,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
17 changes: 17 additions & 0 deletions content/en/docs/workstation/client/_index.md
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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.
Expand Down
108 changes: 108 additions & 0 deletions content/en/docs/workstation/client/wks-client-installation.md
Original file line number Diff line number Diff line change
@@ -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.
29 changes: 29 additions & 0 deletions content/en/docs/workstation/client/wks-client-proxy-settings.md
Original file line number Diff line number Diff line change
@@ -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"
```
6 changes: 5 additions & 1 deletion content/en/docs/workstation/management/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 16 additions & 0 deletions content/en/docs/workstation/management/wks-management-devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading
Loading