-
Notifications
You must be signed in to change notification settings - Fork 772
Registering workstation clients #10646
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: development
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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 | ||
|
|
||
| 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**. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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*. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. For Windows: https://marketplace.mendix.com/link/component/247448 |
||
| 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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` | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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:
|
||
| 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
There was a problem hiding this comment.
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.