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
86 changes: 37 additions & 49 deletions content/en/docs/workstation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Mendix Workstation"
url: /mendix-workstation/
description: "Presents documentation on configuring and using Mendix Workstation."
weight: 46
weight: 42
no_list: false
description_list: true
cascade:
Expand All @@ -11,31 +11,20 @@ cascade:

## Introduction

Mendix Workstation is designed to help you build smarter, faster, and more operator-friendly applications for shop floor 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.
Mendix Workstation helps you build applications for shop floor operators. It enables Mendix applications to directly interact with peripheral devices on a local workstation, without relying on intermediate servers or heavy network traffic.

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

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

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.
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 equipment in a controlled and secure manner.

## Licensing Mendix Workstation

Mendix Workstation is [Limited Availability](/releasenotes/release-status/#limited-availability) for production use. Support is provided according to your Mendix SLA if you purchased a Workstation license. If you want to take Mendix Workstation into production, contact your CSM to see what arrangements are possible. Without a license you can use Mendix Workstation for development, but workspaces are individual and cannot be shared.

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)

## Features of Mendix Workstation
## Capabilities Overview

Mendix Workstation has the following features:

* Direct local device access - Mendix Workstation allows Mendix client applications to send and receive messages directly from the PC's local hardware.
* 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.
* Interactions with the local PC, such as sending and receiving on-event messages, are handled with Mendix nanoflows.
* Enables Mendix applications to communicate with local devices without routing through a central server, network overload, or any additional intermediate systems.
* Uses Mendix nanoflows to handle interactions with the local PC, such as sending and receiving on-event messages.
* Supports multiple interfaces:

* PCSC (smart card Reader) - APDU protocol
Expand All @@ -46,58 +35,57 @@ Mendix Workstation has the following features:

* Can emulate and simulate interfaces.

## Benefits of Using Mendix Workstation

* Improve operator user experience and efficiency.
* Renovate home-grown application and get control of legacy systems.
* Keep core systems clean.
* Create apps adapted to the operator's job, instead of forcing the operator to adapt their job to the software.
* Compose new forms of user experience tailored to manufacturing processes, equipment and environment.
* Expand to adjacent users and domains of your core systems and cross boundaries between silos.

## Use Cases
### Use Cases

Mendix Workstation can be used to create apps that handle use cases such as the following:
You can use Mendix Workstation to create apps that handle use cases such as the following:

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

## Components of Mendix Workstation
### Benefits

Mendix Workstation consists of the following components:
Using Mendix Workstation offers the following benefits for your organization:

* [Workstation Management](https://workstation.home.mendix.com/) - Allows centralized configuration.
* [Workstation Client](https://marketplace.mendix.com/link/component/247448) - Allows real-time communication with local hardware.
* [Workstation Connector](https://marketplace.mendix.com/link/component/247460) - Allows app integration.
* It improves operator user experience and efficiency by enabling Mendix applications to directly interact with devices on a local workstation.
* It allows for the renovation of home-grown applications and gaining control over legacy systems by providing a modern platform for Mendix applications to connect directly to existing devices.
* It helps keep core systems clean by allowing Mendix applications to communicate with devices without routing through any additional intermediate systems.
* It enables the creation of apps adapted to the operator's job with the exact devices they use, instead of forcing the operator to adapt their job to generic software limitations.
* It gives you the means to compose new forms of user experience tailored to manufacturing processes, equipment and environment, so that your applications can seamlessly integrate with new physical tools and processes on the shop floor.
* It facilitates expansion to adjacent users and domains and helps cross boundaries between silos by enabling deployment across multiple environments and sites.

Together, these components enable Mendix applications to securely and efficiently integrate with local devices, bridging the gap between digital workflows and physical operations.
## Key Components

### Architecture Diagram
Mendix Workstation consists of the following components:

{{< figure src="/attachments/workstation/WorkstationDiagram.png" class="no-border" >}}
* [Workstation Management](/mendix-workstation/management/) - Allows centralized configuration.
* Workstation Client - Allows real-time communication with local hardware.

### Workstation Management (Mendix Service)
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.

Used by central IT and application support teams. Workstation Management is a Mendix Platform application which provides a centralized interface to configure and monitor all workstations and devices across the organization. Whether managing a few stations or hundreds across multiple global sites, administrators can register computers, assign devices, group them into workspaces, and remotely troubleshoot connection issues.
* Workstation Connector - Allows app integration.

This makes it easier to manage a large, diverse fleet of devices without the need for manual setup or on-site support.
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.

### Workstation Client (Native Application)
The connector handles the following tasks:

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.
* 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 Connector (Mendix Module)
{{< figure src="/attachments/workstation/WorkstationDiagram.png" class="no-border" >}}

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.
## Licensing Mendix Workstation

The connector handles the following tasks:
Mendix Workstation is [Limited Availability](/releasenotes/release-status/#limited-availability) for production use. Support is provided according to your Mendix SLA if you purchased a Workstation license. If you want to take Mendix Workstation into production, contact your CSM to see what arrangements are possible. Without a license you can use Mendix Workstation for development, but workspaces are individual and cannot be shared.

* 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
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)

## Read More
25 changes: 25 additions & 0 deletions content/en/docs/workstation/management/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "Mendix Workstation Management"
linktitle: "Workstation Management"
url: /mendix-workstation/management/
description: "Provides an overview of Mendix Workstation Management."
no_list: false
description_list: true
weight: 30
---

## Introduction

[Workstation Management](https://workstation.home.mendix.com/) is a tool for overseeing and optimizing Mendix Workstation deployments across your organization. Tailored for central IT and application support teams, this Mendix Platform service offers a centralized interface to streamline the configuration, monitoring, and troubleshooting of all Workstation Clients and their connected devices.

This document provides an overview of every facet of Workstation Management, so that you can discover how to perform initial setup, manage user access and roles, configure various device types with precise control, and implement robust monitoring and logging strategies. By mastering these functionalities, you can ensure seamless operation, enhance efficiency, and provide reliable support for your Mendix Workstation ecosystem, regardless of its scale or geographical distribution.

## Basic Concepts

For more information about the terms used in this document, such as *station* or *device*, refer to the [Mendix Workstation glossary](/mendix-workstation/glossary/).

## Users

Workstation Management is used by central IT and application support teams.

## Read More
113 changes: 113 additions & 0 deletions content/en/docs/workstation/management/wks-management-admin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
---
title: "Managing Stations"
linktitle: "Stations"
url: /mendix-workstation/management-stations/
description: "Describes the administration of stations in Mendix Workstation Management."
weight: 50
---

## Introduction

The **Stations** page displays a comprehensive overview of all your configured stations. This page provides quick insights into the status of each station and offers various actions for creation, management, and bulk operations.

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

## Station Status Indicators

The overview page displays the current status of each station, helping you quickly identify any issues or pending actions:

* **No computer registered** - The station has been created in Workstation Management, but no physical computer running the Workstation Client has been linked to it yet.
* **Computer registered** - A Workstation Client on a physical computer is successfully registered and actively linked to this station.
* **Client's config is out of sync** - The configuration defined in Workstation Management for this station has changed, but the Workstation Client on the registered computer has not yet received or applied these updates. This can happen if auto-refresh is disabled or if there's a temporary connectivity issue.
* **Unknown computer** - The Workstation Client on the registered computer is reporting an unrecognized identifier, or there's an issue with its registration.
Error while registering: An error occurred during the attempt to register a Workstation Client to this station. Further investigation (for example, checking client logs) may be required.

## Creating a New Station

To create a new station, choose one of the following options, depending on your deployment scenario.

### Creating a Station from Scratch

To create a station from scratch, perform the following steps:

1. Click **Create Station**.
2. Provide a unique **Station Name**.

The name is a mandatory identifier for your station.

3. Optional: Add a station group to organize your stations (for example, by location, department, or function).
4. Optional: Specify an **Auto-Accepted Computer Name**.

If provided, during a bulk registration process, any Workstation Client reporting this computer name are automatically mapped and registered to this specific station, streamlining large-scale deployments.

### Creating a Station from Clipboard

If you have previously copied the configuration of an existing station (for example, from another workspace or for duplication purposes), you can use the **Create Station from Clipboard** option to paste and create a new station based on that data.

### Create Station from File

This option allows you to import a station's configuration from a previously exported file. This is particularly useful for migrating or replicating single station configurations.

## Exporting and Importing Stations

Workstation Management provides robust features for managing stations in bulk, facilitating migration, backup, and replication tasks.

* **Export Stations** - Export all stations in the current workspace, or select specific stations from the overview list to export only those you need.
* **Import Stations** - When importing stations from a file, you have fine-grained control over how duplicates are handled:

* **Ignore** - If a station with the same identifier already exists, the imported station will be skipped.
* **Duplicate** - A new station will be created, even if one with the same identifier already exists, resulting in a duplicate entry.
* **Replace** - The existing station with the matching identifier will be completely overwritten by the imported station's data.
* **Merge** - The imported station's data will be intelligently merged with the existing station's configuration, updating fields where there are differences.

The import process allows you to specify what information to include:

* **Include Apps** - Specify whether to include the associated Mendix applications configured for the imported stations.
* **Include Devices** - Specify whether to include the device configurations linked to the imported stations.

## Bulk Registration Tokens

For large-scale deployments, administrators can generate bulk registration tokens to simplify the process of linking multiple Workstation Clients to stations without manual intervention for each client.

### Generating a Token

Specify a valid time period for the token, after which it will automatically expire.
Upon generation, the system provides the registration command for the terminal, which can be used to register Workstation Clients.

### Managing Tokens

You can revoke an active bulk registration token at any time, immediately invalidating it and preventing further registrations using that token.

## Station Detail Page

Once a station is created, clicking on the arrow in the **Stations Overview** page will take you to the **Station Detail** page. This page is your central hub for viewing and configuring all specific settings and associated devices for that individual station.

From here, you can perform the following tasks:

* Change the station name.
* Manually refresh configuration to the client, forcing the Workstation Client on the registered computer to immediately pull the latest settings from Workstation Management.
* Configure advanced settings like **Detect Card Readers** and **Station Developer Mode**.
* Manage and configure all devices associated with this station.

## Advanced Station Settings

### Detect Card Readers

Card readers are handled uniquely within Workstation Management. They are not configured as separate devices in the Devices overview of a Station page. Instead, the Workstation Client automatically detects connected card readers.

Auto detecting card readers is enabled by default. You can toggle the **Detect Card Readers** setting on the **Station Detail Page** to **Off** if you do not want the Workstation Client to automatically detect smart card readers for this specific station.

### Developer Mode {#developer-mode}

Developer mode can be configured on the **Station** page by toggling **Enable Developer Mode**.

When Developer Mode is enabled, users of the Workstation Client have access to:

* Quit the program from the start menu.
* Unlink the Workstation Client, allowing it to be registered to another station.
* Debug level live logs displayed in the Logs pane of the Workstation Client, even if the workspace's log level is set to a different level.
* Developer tools (accessible by pressing *Ctrl + Shift + I*).

{{% alert color="info" %}}
For production environments, it is strongly recommended to disable Developer Mode. This prevents Workstation operators from accidentally quitting or unlinking the Workstation Client and restricts access to debugging tools that are not needed in a live operational setting.
{{% /alert %}}
Loading
Loading