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
40 changes: 34 additions & 6 deletions content/en/docs/workstation/wks-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ A *station* represents a workstation on the shop floor. It can connect to one or

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

3. Enter a name for your new workspace, and then click **Create Workspace**.
3. Enter a name for your new workspace, specify the environment type (**Test**, **Acceptance** or **Production**), and then click **Create Workspace**.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Test type workspaces have developer mode for stations turned on by default

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Changing the type from test to anything else won't change the developer mode setting. (Won't deactivate it.) And vice versa.


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

Expand Down Expand Up @@ -196,7 +196,7 @@ Auto-refresh settings are available in Workstation Management at **Settings > Cl

By default, the Workstation Client operates in auto-refresh mode. That is, any changes made to the configuration in Workstation Management are immediately reflected in the Client.

To change this behavior, set the **Auto-Refresh Mode** toggle to **Off**. You can then force the configuration to refresh by clicking **Refresh on Computer** in Workstation Management, or by clicking **Refresh** in the Workstation Client.
To change this behavior, set the **Auto-Refresh Mode** toggle to **Off**. You can then force the configuration to refresh by clicking **Sync Clients** in Station Overview, or by clicking **Refresh** in the Workstation Client.

The **Check Interval** setting is only available when the auto-refresh mode is enabled. It specifies how often a Workstation Client that is disconnected due to a web socket failure should automatically refresh its configuration by polling Workstation Management. By default, this happens every 60 minutes.

Expand Down Expand Up @@ -281,6 +281,18 @@ For production environments, it is recommended to disable *Developer Mode* to pr

#### Device Settings

##### Configuration in Management UI

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Explain each field separately - for Maia.


To add a printer device, perform the following steps:

1. Navigate to the **Devices** section on the **Station Detail** page.
2. Click **Add Device** and select the device type.
3. Enter a meaningful name for the device, for example, *Shopfloor Printer*.
4. Optional: Select or create a class to help you manage your devices, for example, *Building A Printers*.
5. Specify the information required to connect to the device.

The required information depends on the type of the device. For some devices, like printers, you must only specify the device name. For others, like Serial Port devices, you can use a variety of identifiers such as serial numbers, manufacturer names, and others.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"For others, like Serial Port devices, you can use a variety of identifiers such as serial numbers, manufacturer names, and others." Add a dedicated section for serial devices. Printers cannot be added that way.
Just document here that the "printer name" must be filled with the exact name as in the OS printer settings


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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

as discussed, pls. update this section "Auto detecting card readers is enabled by default. This setting can be configured on a Station page by toggling Detect Card Readers."

  • is disabled by default
  • Go to station detail page --> 3-dot menu --> edit station --> set checkbox and save
    And all other places where this "toggl" is mentioned

Same for debugger mode toggl

Expand All @@ -289,9 +301,19 @@ Auto detecting card readers is enabled by default. This setting can be configure

Refer to [Message Syntax - Card Readers](/mendix-workstation/device-syntax/#card-readers) for a more in-depth explaination how to communicate with card readers.

### Serial Port Devices

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Static vs dynamic port assignment, different methods depending on use case. Cf demo. Static using com ports, dynamic - pnp id or manufacturer.


Serial Port devices allow you to connect to a device with a serial port.

##### Bluetooth Devices

Add Bluetooth LE (BLE) devices that use the ATT protocol by entering the exact device name as displayed in your OS' device manager

Refer to [Message Syntax - Bluetooth](/mendix-workstation/device-syntax/#bluetooth) for a more in-depth explaination how to communicate with bluetooth devices.

##### File Device

This section explains the configuration of a file device. Refer to [Message Syntax - File Device](/mendix-workstation/device-syntax/#file-device) for a more in-depth explaination how to communicate with file devices.
File devices allow you to read and write from a file. Refer to [Message Syntax - File Device](/mendix-workstation/device-syntax/#file-device) for a more in-depth explaination how to communicate with file devices.

###### Allowed Folder Configuration

Expand All @@ -316,8 +338,14 @@ Windows and Unix-style paths can be used independently of the operating system t

The administrator can choose to allow either one or a combination of the following permissions: subscribe to change events, read files, and write files.

##### Bluetooth Devices
##### TCP/IP Client

Simply add Bluetooth LE (BLE) devices that use the ATT protocol by entering the exact device name as displayed in your OS' device manager
TCP/IP clients allow you to connect to remote devices over the network.

Refer to [Message Syntax - Bluetooth](/mendix-workstation/device-syntax/#bluetooth) for a more in-depth explaination how to communicate with bluetooth devices.
##### TCP/IP Server

TCP/IP clients allow you to host connections over the network.

##### Printers

You can integrate your Workstations with printer devices.
12 changes: 12 additions & 0 deletions content/en/docs/workstation/wks-message-syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,15 @@ Send instruction in hexadecimal as a string, for example, *FFCA000000* to read t
* `1#` - Card disconnected

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Merged in #11455

* `2# Response` - Response from device as raw hexadecimal.
* `3# Error` - Error message from device.

## Printers

This device type requires the following message and response:

### Message

A print command, for example, `P#TESTHELLO#RAW#aGVsbG8=`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

TWS-919 contains further explanations of the message format that should be added here:

Message format:

  • P#PrintJobDocName#Format#DataPayloadInBase64 : Submit a print job.
  • S : Get printer status and queued jobs.
  • C#JobId : Cancel print job.
    Response format:
  • P#DocName#JobId : Print job accepted by OS print interface.
  • S#State#StateReason1,...#NumJobs#JobId1:JobName1:JobState1,... : Printer state and job list summary.
  • E#ErrorMessage : Error.

Example: P#TESTHELLO#RAW#aGVsbG8=

Breaking down the print command

  • P (command prefix): tells the Workstation Client that the incoming instruction is a Print command
  • separator

  • TESTHELLOFILE (filename): name assigned to the print job. The client uses this to create the temporary file (e.g., TESTHELLOFILE.prn) before sending it to the printer spooler
  • separator

  • RAW (The Format Type): Tells the Workstation Client that the data following it is Raw Printer Commands (such as ZPL for Zebra printers, EPL, or PCL) rather than a standard document like a PDF or a Word file. By printing in "RAW," bypasses the standard printer drivers' formatting. It sends the exact code the printer needs to generate labels, barcodes, or specific layouts.
  • aGVsbG8= (The Payload): Data string encoded to Base64. Base64 decoded, it translates to the text: 'hello'. If you are testing this and the printer isn't reacting, double-check that the string you are encoding in Base64 matches the specific language your printer speaks (e.g., a Zebra printer won't know what to do with plain text "hello" unless it's wrapped in ZPL commands like ^XA^FO50,50^A0N,50,50^FDhello^FS^XZ).


### Response

The output of the print command, for example, `hello` in a *TESTHELLO.prn* file.
27 changes: 27 additions & 0 deletions content/en/docs/workstation/wks-monitoring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Changes merged in this PR: #11454

title: "Monitoring Mendix Workstation"
linktitle: "Monitoring"
url: /mendix-workstation/monitoring/
description: "Describes how to access and use the Usage Report page of Mendix Workstation."
weight: 35
---

## Introduction

Mendix Workstation provides detailed usage reports that show how stations are being used across your different workspaces and company. This helps you understand and optimize your Workstation deployment.

Workstation Clients automatically report their daily active usage to the server, tracking which stations were used and on which days. This data powers the usage reports, giving you valuable insights without extra effort.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Note: currently, the report is indeed tracking "active stations". Will change to "active Workstation Clients" as next release i.e. 4.0 GA.


## Accessing the Usage Reports

You can access the Usage Reports by performing the following steps:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Add:
3. To view a report of all workspaces that are owned by your company, you must have the Mendix admin role assigned in ControlCenter. TO view the report, go to Workstation Management and click the Company Usage Report tab.

Screenshot can be created from test environment.

1. To view the reports for all workspaces that you own or administer, go to Workstation Management, and click **My Usage Report**.

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

2. To view the reports for a specific workspace, open the workspace in Workstation Management, and then click **Usage**.

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

The Usage Reports display information about the usage trends for each station both daily and over time.
6 changes: 6 additions & 0 deletions content/en/docs/workstation/wks-troubleshooting.md

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

#11452 combines the changes from this PR and #10643

Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ Contact Mendix Support to transfer workspace ownership.

## Workstation Client

### Logs

By default, the Client retains logs of up to 10 MB for the past seven days locally on your computer. Access logs by clicking the **Logs** button on the Client UI, then optionally selecting the level of logs you want to see. Opening the Client's console through the browser developer tools (**Ctrl + Shift + I**) can also provide additional information about encountered errors in the UI of the Client.

Log files are also available by day in the Client's app data folder. On Windows, press **Win + R** and enter:
Expand All @@ -42,6 +44,10 @@ On Linux, the *Mendix Workstation/logs* folder is located at either `$XDG_CONFIG
* Start the Workstation Client. Click the three-dot icon in the top tight, then click **Logs**. Debug level logs are only available in *Developer Mode*
* Start the Workstation Client from PowerShell: `start "C:\Program Files\Mendix Workstation\Mendix Workstation.exe" -ArgumentList "--log-level=debug" -wait`.

### Diagnostics

When [Developer Mode](/mendix-workstation/installation/#developer-mode) is enabled, the Client also shows a **Diagnostics** page. This page displays information about the available devices, credentials, station configuration, system info, and log levels, which you can use to help you troubleshoot any issues.

### Registration Token Could Not Be Parsed

The Client shows an error like the following: *Registration token could not be parsed. Please enter another token!*
Expand Down
Binary file modified static/attachments/workstation/wks-install2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/attachments/workstation/wks-usage1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/attachments/workstation/wks-usage2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading