Skip to content
Open
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
61 changes: 61 additions & 0 deletions content/en/docs/workstation/wks-batch-registration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: "Registering Workstation Clients"
url: /mendix-workstation/register/
description: "Describes how to register and pre-configurer multiple Workstation Clients."
weight: 30
---

## Introduction
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add here a little bit more context:

The ultimate goal of the Mendix Workstation Client is to establish a secure and reliable connection between the Mendix Application Client and the specific hardware, peripherals, or local data sources attached to that same workstation. This vital connection is facilitated via the Workstation Connector and the Workstation Client.

To enable this crucial functionality, the registration process is a critical first step: 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.


Installed on each local workstation, the Workstation Client acts as a bridge between the Mendix app and local hardware. The Workstation Client is installed on a computer in order to establish a connection with the Workstation Connector, and through it, your Mendix app.

Mendix Workstation supports both individual registration of local Workstation clients, and bulk rollouts for large production environments.

## 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**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To remain consistent, I would also add here: ...,or select an existing station from the list for which no computer is yet registered.

4. Enter a name for the station and optionally select or create a group to categorize it, such as *Assembly*.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think point 4 and 5 we can skip here. specifically number 5 is not needed to register a computer,

5. Add devices in the **Devices** section.
6. Click **Register Computer** to register your computer.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add some orientation help? For example: Click “Register Computer,” located at the top right of the banner, to start registering a computer.

7. Click **Download** to navigate to the Workstation Client listing in the Marketplace, download the Client installer for Windows, install it, and launch it.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Click Download to navigate to the Workstation Client listing in the Marketplace. Download and install the Client installer for Windows, then launch the application.
We should also add here the links to the different Versions of the Client, or if we have the links already somewhere else at least mention the available options.

For Windows: https://marketplace.mendix.com/link/component/247448
For Windows (portable version): https://marketplace.mendix.com/link/component/247456
For Linux ARM64: https://marketplace.mendix.com/link/component/247459
For maxOS: https://marketplace.mendix.com/link/component/253905

8. Copy the registration token and paste it into the [Workstation Client](/mendix-workstation/installation/) registration field.

## Bulk-Registering Workstation Clients

In a production environment, you can register multiple Workstation clients and their host computers in a single rollout. This enables large-scale deployments on production floors (for example, factory shop floors) where dozens to hundreds of machines require setup.

{{% alert color="info" %}}
This feature is only available to licensed Mendix Workstation users. For more information about obtaining a Workstation license, see [Mendix Workstation](/mendix-workstation/).
{{% /alert %}}

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.
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.

4. Specify the timeframe during which the token is valid.
5. Copy the token to a clipboard and save it in a secure location. For security reasons, the token is only displayed once.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part is outdated. We have revised it, and as long as the token is active, it can be viewed and copied by the appropriate roles.

6. Click **Activate Token**. The **Stations** page displays the timeframe during which the bulk registration is scheduled.
7. Use an automated script to distribute the token to client computers during the allowed timeframe. For example, on Windows machines, you can use the following script: `Start-Process -FilePath {path where the Workstation Client is installed} -ArgumentList "--registration-token {bulk registration token}" -Wait`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would describe it as an option: You can also...

It would be good to add the command for Linux here as well. Alawi will provide us with the commands tomorrow after testing.


After the command runs, the Workstation Clients display the status **Waiting for station assignment**. This indicates that the clients are registered, but not yet associated with a specific station. On the **Stations** page in Workstation Management, you can now see placeholder stations also named **Waiting for station assignment**. These stations correspond to computers which were registered during bulk import.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After the command runs or the token is entered manually, the Workstation Clients will initially display the status "Computer not matched to available station." This status indicates that while the clients are successfully registered, they haven't yet been associated with a specific station.

To view these newly registered clients, refresh the Stations page in Workstation Management. You'll find them listed under a separate section as "unassigned computers."

Alternatively, you can pre-configure the computer name for a station in advance. This is done by entering the computer's name in the "Auto-Accepted Computer Name" field when creating a new station or editing an existing one. If the computer name is pre-configured, the client will automatically switch to an Active status with the correct configuration upon registration, and the station status in Workstation Management will update to "Computer Registered" after refresh.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok I see the automatically assigning is documented on the bottom.


8. On the **Stations** page, click **View** by a placeholder **Waiting for station assignment** station.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Point 8 and 9 is also outdated:

In the case of an “unassigned computer,” you have three options:

  1. Accept Computer: Creates an empty station.
  2. Assign Computer: Allows us to assign an existing configured station.
  3. Reject Computer: Rejects the computer and disconnects/deregisters it.

9. Review the configuration and click **Assign to station** to reassign the computer to an existing station, or **Accept** to create a new station.

### Automatically Assigning Computers to Stations

Instead of reassigning computers to stations manually after the bulk import, you can configure stations to automatically accept computers with a specific name.

1. On the **Stations** page, click the three-dot menu by the station where you want to automatically register a computer.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can also be configured during creation.

2. Click **Edit Station**.
3. In the **Auto-Accepted Computer Name** field, enter a computer name.

Computers with this name are automatically assigned to the station during the bulk import.
12 changes: 1 addition & 11 deletions content/en/docs/workstation/wks-build-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,7 @@ To install and configure the Workstation Connector, perform the following steps:

1. Open an existing app to extend with Workstation functionality in Mendix Studio Pro, or create a new app.
2. Import the [Mendix Workstation Connector](https://marketplace.mendix.com/link/component/247460) from the Mendix Marketplace.
3. Configure the station in Workstation Management by performing the following steps:

1. Navigate to the **Workspaces** page in [Workstation Management](https://workstation.home.mendix.com/).
2. Click **Create Workspace**, or select an existing workspace from the overview.
3. Click **Create Station**.
4. Enter a name for the station and optionally select or create a group to categorize it, such as *Assembly*.
5. Add devices in the **Devices** section.
6. Click **Register Computer** to register your computer.
7. Click **Download** to navigate to the Workstation Client listing in the Marketplace, download the Client installer for Windows, install it, and launch it.
8. Copy the registration token and paste it into the [Workstation Client](/mendix-workstation/installation/) registration field.

3. Register one or more Workstation Clients. For more information, see [Registering Workstation Clients](/mendix-workstation/register/).
4. Configure your app as an allowed app by performing the following steps:

1. In your app go to [App Security](/refguide/app-security/#user-roles) and assign the module role **StationConnector.Administrator** to the Administrator user role.
Expand Down