diff --git a/content/en/docs/workstation/wks-installation.md b/content/en/docs/workstation/wks-installation.md index 4bd84a58f8b..d74af765223 100644 --- a/content/en/docs/workstation/wks-installation.md +++ b/content/en/docs/workstation/wks-installation.md @@ -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**. {{< figure src="/attachments/workstation/wks-install2.png" class="no-border" >}} @@ -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. @@ -281,6 +281,18 @@ For production environments, it is recommended to disable *Developer Mode* to pr #### Device Settings +##### Configuration in Management UI + +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. + ##### 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. @@ -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 + +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 @@ -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. \ No newline at end of file diff --git a/content/en/docs/workstation/wks-message-syntax.md b/content/en/docs/workstation/wks-message-syntax.md index 8cfe5f42e00..e13d30f255c 100644 --- a/content/en/docs/workstation/wks-message-syntax.md +++ b/content/en/docs/workstation/wks-message-syntax.md @@ -86,3 +86,15 @@ Send instruction in hexadecimal as a string, for example, *FFCA000000* to read t * `1#` - Card disconnected * `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=`. + +### Response + +The output of the print command, for example, `hello` in a *TESTHELLO.prn* file. \ No newline at end of file diff --git a/content/en/docs/workstation/wks-monitoring.md b/content/en/docs/workstation/wks-monitoring.md new file mode 100644 index 00000000000..6b33f5ae9fe --- /dev/null +++ b/content/en/docs/workstation/wks-monitoring.md @@ -0,0 +1,27 @@ +--- +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. + +## Accessing the Usage Reports + +You can access the Usage Reports by performing the following steps: + +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. \ No newline at end of file diff --git a/content/en/docs/workstation/wks-troubleshooting.md b/content/en/docs/workstation/wks-troubleshooting.md index 372aba5b7cd..ce61ee30007 100644 --- a/content/en/docs/workstation/wks-troubleshooting.md +++ b/content/en/docs/workstation/wks-troubleshooting.md @@ -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: @@ -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!* diff --git a/static/attachments/workstation/wks-install2.png b/static/attachments/workstation/wks-install2.png index 96c9b73d60b..78cecaa869f 100644 Binary files a/static/attachments/workstation/wks-install2.png and b/static/attachments/workstation/wks-install2.png differ diff --git a/static/attachments/workstation/wks-usage1.png b/static/attachments/workstation/wks-usage1.png new file mode 100644 index 00000000000..cdb3d3b3469 Binary files /dev/null and b/static/attachments/workstation/wks-usage1.png differ diff --git a/static/attachments/workstation/wks-usage2.png b/static/attachments/workstation/wks-usage2.png new file mode 100644 index 00000000000..aa6da0ea6b7 Binary files /dev/null and b/static/attachments/workstation/wks-usage2.png differ