You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/workstation/wks-batch-registration.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,6 +13,10 @@ The registration process is a necessary first step when enabling this crucial fu
13
13
14
14
Mendix Workstation supports both individual registration of local Workstation clients, and bulk rollouts for large production environments.
15
15
16
+
{{% alert color="info" %}}
17
+
After a Workstation Client is registered, any changes that you make in Workstation Management (such as adding new devices, or setting the **Detect Card Readers** toggle to **Off**) will be immediately synchronized with the Client. To change this behavior, see [Client's Auto-Refresh](/mendix-workstation/installation/#auto-refresh).
18
+
{{% /alert %}}
19
+
16
20
## Registering a Single Workstation Client
17
21
18
22
If you are developing or testing Workstation configurations, you can register a single Workstation Client for your local computer by performing the following steps:
Any changes that you make in Workstation Management (such as adding new devices, or setting the **Detect Card Readers** toggle to **Off**) will be immediately synchronized with the Workstation Client. To change this behavior, see [Client's Auto-Refresh](#auto-refresh).
100
+
99
101
### Configuring and Testing Virtual Devices
100
102
101
103
After registering your computer, test your connectivity by creating a pair of virtual devices: a TCP/IP server that will emulate a device, and a TCP/IP client that will connect to the emulated device.
102
104
103
105
#### Creating a TCP/IP Server
104
106
105
107
1. Go to [Mendix Workstation Management](https://workstation.home.mendix.com/).
106
-
2. In the **Station** page, click **Add Device**.
108
+
2. In the **Station Details** page, click **Add Device**.
107
109
3. Select **TCP/IP Server** as the **Device Type**, and then click **Next**.
108
110
4. In the **Device Name** field, enter **Test Server**
109
111
5. In the **Device Class** field, select or create a class (for example, *Virtual*), and then click **Next**.
@@ -119,7 +121,7 @@ The emulated device, a local TCP/IP server listening on port 1705, is added to t
119
121
#### Creating a TCP/IP Client
120
122
121
123
1. Go to [Mendix Workstation Management](https://workstation.home.mendix.com/).
122
-
2. In the **Station** page, click **Add Device**.
124
+
2. In the **Station Details** page, click **Add Device**.
123
125
3. Select **TCP/IP Client** as the **Device Type**, and then click **Next**.
124
126
4. In the **Device Name** field, enter **Test Client**, and then click **Next**.
125
127
5. In the **Device Class** field, select or create a class (for example, *Virtual*), and then click **Next**.
@@ -153,7 +155,7 @@ Different device types have different requirements for the message syntax. For m
153
155
154
156
### Quitting the Workstation Client
155
157
156
-
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 if [Developer Mode](#developer-mode) is enabled. Alternatively, the Workstation Client process can always be stopped via Windows Task Manager.
158
+
The Workstation Client runs automatically at system startup. 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 if [Developer Mode](#developer-mode) is enabled. Alternatively, the Workstation Client process can always be stopped via Windows Task Manager.
157
159
158
160
## Advanced Configurations
159
161
@@ -167,6 +169,8 @@ Navigate to the **Settings** page in a workspace to configure settings that are
167
169
168
170
#### Log Settings
169
171
172
+
Log settings are available in Workstation Management at **Settings > Log Settings**.
173
+
170
174
The Workstation Client always stores logs to the file system it is installed on (c.f. [Troubleshooting - Workstation Client](/mendix-workstation/troubleshooting/#workstation-client)). No logs are send to the Workstation Management. However, you can configure the log level and retention policy of all the Workstation Clients that are registered to stations in the workspace.
171
175
172
176
##### Log Level
@@ -186,9 +190,21 @@ Verbosity and thus log file size increases with each log level. To constrain thi
186
190
187
191
Modify these settings to the needs of your logging policy, especially if you require to keep debug level logs in production for retrospective troubleshooting.
188
192
193
+
#### Client's Auto-Refresh {#auto-refresh}
194
+
195
+
Auto-refresh settings are available in Workstation Management at **Settings > Client's Auto-Refresh**.
196
+
197
+
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.
198
+
199
+
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.
200
+
201
+
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.
202
+
189
203
#### Local Device Testing
190
204
191
-
By default, the Workstation Management is pre-configured as an allowed app to connect to the Workstation Client on the **Test your Station** page in a workspace. To disable this, navigate to the tab "Local Device Testing" on the **Settings** page and toggle it off.
205
+
Local device testing settings are available in Workstation Management at **Settings > Local Device Testing**.
206
+
207
+
By default, the Workstation Management is pre-configured as an allowed app to connect to the Workstation Client on the **Test your Station** page in a workspace. To disable this setting, toggle it off.
192
208
193
209
### Workspace Team and Collaboration {#collaboration}
0 commit comments