Skip to content

Commit ba6c6d2

Browse files
Merge pull request #11514 from mendix/kk-wks-configuring-client
Kk wks configuring client
2 parents 09f905e + 8530566 commit ba6c6d2

6 files changed

Lines changed: 64 additions & 6 deletions

File tree

content/en/docs/workstation/client/wks-client-autostart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,6 @@ For more information, refer to the documentation of your operating system, such
2121

2222
## Stopping the Workstation Client Manually {#stop-client}
2323

24-
The **Close** button closes the Client window but does not terminate the application; it continues to run in the background. To completely quit the Client, right-click its icon in the Windows systray and select **Quit**. This action is only available in [Developer Mode](/mendix-workstation/management-stations/#developer-mode).
24+
The **Close** button closes the Client window but does not terminate the application. It continues to run in the background. To completely quit the Client, right-click its icon in the Windows systray and select **Quit**. This action is only available in [Developer Mode](/mendix-workstation/management-stations/#developer-mode).
2525

2626
Alternatively, you can stop the Workstation Client process by using Windows Task Manager.

content/en/docs/workstation/client/wks-client-installation.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,9 @@ If you have administrator rights for your Windows computer, install the Workstat
6060

6161
For a silent installation, you can also run the installer as an administrator with the `/S` argument, that is, `MendixWorkstationX.Y.Z.exe /S`.
6262

63-
The default installation folder is *C:\Program Files\Mendix Workstation*. The app data folder can be found at *C:\ProgramData\Mendix Workstation*. The client runs automatically after the installation is completed.
63+
The default installation folder is *C:\Program Files\Mendix Workstation*. The app data folder can be found at *C:\ProgramData\Mendix Workstation*. The client runs automatically after the installation is completed.
64+
65+
4. After the installation finishes, start the Workstation Client.
6466

6567
### Windows Portable
6668

@@ -69,6 +71,7 @@ If you do not have administrator rights for your Windows computer, create a port
6971
1. Download the [portable Microsoft Windows version of the installer](https://marketplace.mendix.com/link/component/247456).
7072
2. As a best practice, create a new folder for the Client (for example, in your *Documents* folder).
7173
3. Extract the Client to the target folder, and then click the *.exe* file to run the Client.
74+
4. After the installation finishes, start the Workstation Client.
7275

7376
### Linux
7477

@@ -101,4 +104,19 @@ To install the Workstation Client on a Linux machine, perform the following step
101104
sudo capsh --user=$(whoami) --iab="^cap_net_raw" -- -c "'/opt/Mendix Workstation/Mendix Workstation'"
102105
```
103106
104-
The Workstation Client runs automatically at system startup. To modify this behavior, see [Autostart Configuration for the Workstation Client](/mendix-workstation/network-configuration/).
107+
6. After the installation finishes, start the Workstation Client.
108+
109+
### MacOS
110+
111+
To configure the Workstation Client on a macOS machine, perform the following steps:
112+
113+
1. Download the [macOS version of the installer](https://marketplace.mendix.com/link/component/253905).
114+
2. Double-click the installer to start the installation process.
115+
116+
The macOS version of the Workstation Client is not yet notarized by Apple, so you will see a warning during the installation. For information about resolving the issue, see [Open a Mac app from an unknown developer](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unknown-developer-mh40616/mac) in the macOS documentation.
117+
118+
3. After the installation finishes, start the Workstation Client.
119+
120+
## Stopping the Workstation Client
121+
122+
The Workstation Client sets up the required auto-start settings during the first start. Afterward, it runs automatically on system startup. To change this behavior, see [Autostart Configuration for the Workstation Client](/mendix-workstation/autostart-configuration/)
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: "Using the Workstation Client"
3+
url: /mendix-workstation/use-client/
4+
description: "Describes how to use the Mendix Workstation Client."
5+
weight: 30
6+
---
7+
8+
## Introduction
9+
10+
This reference guide provides information about the menus and functionalities of the Workstation Client.
11+
12+
## Overview
13+
14+
The Workstation Client is an application installed on computers which you want to register as stations in Mendix Workstation.
15+
16+
{{< figure src="/attachments/workstation/wks-client-use1.png" class="no-border" >}}
17+
18+
## Basic Information
19+
20+
The top section of the Workstation Client shows the following information:
21+
22+
* The name and ID of the workspace where the Client is registered
23+
* The ID of the computer where the Client is installed
24+
* The ID of the station created for this computer in Workstation Management
25+
* The date and time of the last update of this Workstation Client's configuration (for example, the list of devices associated with the Client)
26+
* The currently installed version of the Client
27+
28+
## Devices
29+
30+
The **Devices** section shows a list of all devices currently associated with the station through this Workstation Client. For each device, the section shows the availability, connection status, and any errors captured for this device. You can also expand each device to see more information about its connection parameters (for example, the host or port of a TCP/IP server).
31+
32+
## Additional Actions
33+
34+
Click the **three dots** menu in the top right corner of the Workstation Client to perform any of the following actions:
35+
36+
* **Refresh** - 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. If you [disabled the Client's auto-refresh in Workstation Management](/mendix-workstation/management-settings/#auto-refresh), you can use the **Refresh** option to manually refresh the Client's configuration.
37+
* **Deregister** - When [Developer Mode](/mendix-workstation/management-stations/#developer-mode) is enabled, you can select this option to deregister the Client from Workstation Management.
38+
* **Management** - Selecting this option opens the **Workstation Management** portal in your browser.
39+
* **Logs** - This option shows the Workstation Client logs, which you can use to help you troubleshoot any issues. For more information, see [Troubleshooting the Workstation Client](/mendix-workstation/troubleshooting-workstation-client/).
40+
* **Diagnostics** - When [Developer Mode](/mendix-workstation/management-stations/#developer-mode) is enabled, you can select this option to view information about the available devices, credentials, station configuration, system info, and log levels, which you can use to help you troubleshoot any issues. For more information, see [Troubleshooting the Workstation Client](/mendix-workstation/troubleshooting-workstation-client/).

content/en/docs/workstation/management/wks-management-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Auto-refresh settings are available in Workstation Management at **Settings > Cl
4343

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

46-
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.
46+
To change this behavior, change the **Auto-Refresh Mode** setting 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.
4747

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

content/en/docs/workstation/troubleshooting/wks-troubleshooting-client.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This document provides troubleshooting instructions for some potential issues re
1212

1313
### Logs
1414

15-
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.
15+
By default, the Client retains logs of up to 10 MB for the past seven days locally on your computer. To access the logs, open the Client and select the **Logs** option from the **three dots** menu in the top right corner, then optionally select the level of logs you want to see.
1616

1717
Log files are also available by day in the Client's app data folder. On Windows, press **Win + R** and enter:
1818

@@ -92,4 +92,4 @@ The Client cannot resolve the URL to Workstation Management. This can have sever
9292

9393
### Solution
9494

95-
First, verify you have a working internet connection. Then verify you can access [Workstation Management](https://workstation.home.mendix.com/) from your browser. If your browser cannot resolve that address, there may be an issue with your DNS server or configuration. On Windows, verify your DNS settings for your Ethernet or wireless LAN adapter using the command prompt and entering `ipconfig`. The command `nslookup www.mendix.com` provides further information about the IP address your DNS server resolved for the Mendix domain.
95+
First, verify you have a working internet connection. Then verify you can access [Workstation Management](https://workstation.home.mendix.com/) from your browser. If your browser cannot resolve that address, there may be an issue with your DNS server or configuration. On Windows, verify your DNS settings for your Ethernet or wireless LAN adapter using the command prompt and entering `ipconfig`. The command `nslookup www.mendix.com` provides further information about the IP address your DNS server resolved for the Mendix domain.
134 KB
Loading

0 commit comments

Comments
 (0)