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
2 changes: 2 additions & 0 deletions content/en/docs/workstation/client/wks-batch-registration.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ To bulk-register Workstation Clients, perform the following steps:

On Linux machines, you can use the following script: `mendix-workstation --registration-token {bulk registration token}`.

For more information about the options that the Workstation Client accepts on the command line, see [Command-Line Options](/mendix-workstation/use-client/#command-line-options).

After the command runs or the token is entered manually, the Workstation Clients display the status **Waiting for station assignment**. This indicates that the clients are registered, but not yet associated with a specific station.

To view these newly registered clients, refresh the Stations page in Workstation Management. You will find them listed under a separate section as **unassigned computers**.
Expand Down
57 changes: 57 additions & 0 deletions content/en/docs/workstation/client/wks-client-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,60 @@ Click the **three dots** menu in the top right corner of the Workstation Client
* **Management** - Selecting this option opens the **Workstation Management** portal in your browser.
* **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/).
* **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/).

## Command-Line Options {#command-line-options}

You can start the Workstation Client from a terminal or a rollout script to register it, inspect it, or change where it stores its data. This is how the Client is registered during a bulk rollout. For more information, see [Registering Workstation Clients](/mendix-workstation/register/).

How you invoke the Client depends on the operating system:

* On Windows, call the executable by the path where the Workstation Client is installed, for example `& {path where the Workstation Client is installed} --version`.
* On Linux, call `mendix-workstation --version`.

The following options are available:

| Option | Environment variable | Description |
| --- | --- | --- |
| `--help` | | Print the available options and exit. |
| `--version` | | Print the version of the Workstation Client and exit. |
| `--registration-token` | `REGISTRATION_TOKEN` | Register the computer with the given registration token. Accepts both single and bulk registration tokens. For more information, see [Registering Workstation Clients](/mendix-workstation/register/). |
| `--diagnostics` | | Run diagnostics and print the result to the standard output as JSON. Pass `all` to run every diagnostic, or a comma-separated list of the diagnostics to run. |
| `--log-level` | `LOG_LEVEL` | The level of detail that the Client logs. Use one of `error`, `warn`, `info`, `debug`, or `trace`. Use `silent` to disable logging. The default value is `debug`. |
| `--user-data-dir` | `USER_DATA_DIR` | The directory in which the Client stores its configuration, logs, session data, and crash dumps. |
| `--background` | | Start the Client without showing its window. The Client uses this option when it starts automatically after system startup. For more information, see [Autostart Configuration for the Workstation Client](/mendix-workstation/autostart-configuration/). |

Options that accept an environment variable can be set either way. A value passed on the command line takes precedence over the environment variable.

### Running Diagnostics {#diagnostics-option}

The `--diagnostics` option accepts the following values, either individually, as a comma-separated list, or through the value `all`:

* `clientId` - The identifier that this Client reports to Workstation Management.
* `credentials.json` - The credentials with which the Client authenticates against Workstation Management. The API key is redacted.
* `log` - The active log level and the number of messages logged per level.
* `management` - Whether the Client is connected to Workstation Management, for how long it has been connected, and any connection errors.
* `station.json` - The station configuration that the Client last received.
* `system` - Version, host, platform, locale, proxy configuration, and resource usage of the computer running the Client.

The result is printed as a JSON object keyed by diagnostic name:

```json
{
"log": {
"level": "debug",
"counts": { "error": 0, "warn": 0, "info": 0, "debug": 0, "trace": 2 }
}
}
```

The same information is available in the Client through the **Diagnostics** option, which requires Developer Mode.

### Log Level and the Workspace Setting

The `--log-level` option applies from the moment the Client starts. As soon as the Client has retrieved its configuration from Workstation Management, the workspace **Log Level** setting determines what is written to the log files instead. For more information, see [Configuring Settings](/mendix-workstation/management-settings/).

Unless Developer Mode is enabled for the station, the workspace setting also caps the level that the Client prints to the terminal. When the requested level is overruled, the Client logs a warning stating which level it fell back to.

### Running Commands Against a Running Client

Only one instance of the Workstation Client runs at a time. If you pass `--registration-token` or `--diagnostics` while the Client is already running, the command is handed to the running instance, and its result and log messages are printed in the terminal where you issued the command. The Client exits with a non-zero status when the command fails, so you can act on the result in a rollout script.
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ The Workstation domain model contains the following entities:

## Using the Nanoflows and Actions {#javascript-actions}

The following section provides more information about using the Workstation nanoflows and Java actions in your Mendix application.
The following section provides more information about using the Workstation nanoflows and JavaScript actions in your Mendix application.

#### SendDeviceRequest
### SendDeviceRequest

Call `SendDeviceRequest` to send a message to a device and return the response or error. Requires Workstation Client 4.0 or later, and a device that supports requests. For more information about the supported message syntax, see [Configuring Devices](/mendix-workstation/management-devices/). This action has the following parameters:

Expand Down Expand Up @@ -124,7 +124,7 @@ Call `Unsubscribe` to end a subscription.

### Private Nanoflows

`CreateStation`, `CommitStation`, `CreateDevice`, and `CommitDevice` are private nanoflows, required be compatible with [strict mode](/refguide/strict-mode/).
`CreateStation`, `CommitStation`, `CreateDevice`, and `CommitDevice` are private nanoflows, required to be compatible with [strict mode](/refguide/strict-mode/).

## Widgets {#widgets}

Expand Down
27 changes: 24 additions & 3 deletions content/en/docs/workstation/management/wks-management-admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The overview page displays the current status of each station, helping you quick
* **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.
* **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 {#create-station}

Expand All @@ -31,11 +31,11 @@ To create a new station, choose one of the following options, depending on your
To create a station from scratch, perform the following steps:

1. Click **Create Station**.
2. Provide a unique **Station Name**.
2. Provide a unique name in the **Provide a Station Name** field.

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).
3. Optional: In the **Add to Station Group** field, select a group to organize your stations (for example, by location, department, or function). For more information, see [Station Groups](#station-groups).
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.
Expand All @@ -52,6 +52,27 @@ This option allows you to import a station's configuration from a previously exp

This option allows you to directly copy an existing station's configuration without needing to import it from the clipboard or from file.

## Station Groups {#station-groups}

A station group is a label that you assign to stations in order to organize them, for example by location in the factory ("line A") or function ("assembly"). Station groups are defined per workspace, and a station belongs to at most one group.

Station groups additionally control which stations may run an app: in the **Enable in station groups** field of an app, select the groups that should have access to it. For more information, see [Managing Apps](/mendix-workstation/management-apps/).

You can assign a group to a station in the following ways:

* While creating the station, in the **Add to Station Group** field. If the group does not exist yet, click **Create Station Group** on the same page.
* Afterwards, by clicking **Edit Station** and selecting a group in the **Station Group** field.

### Managing Station Groups

To review the station groups of a workspace, click **Station Groups** in the workspace menu. The overview lists each group together with the number of **Stations** that belong to it.

From this page you can perform the following actions:

* **Create Station Group** - Click **Create Station Group**, enter a name in the **Station Group Name** field, and then click **Create Station Group**.
* **Rename Station Group** - Click the three-dot menu of the group, and then click **Rename Station Group**.
* **Delete Station Group** - Click the three-dot menu of the group, and then click **Delete Station Group**. The group is removed from every station that used it, but those stations are not deleted.

## Exporting and Importing Stations

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