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} --help`.
* On Linux, call `mendix-workstation --help`.

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`, or `debug`. 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.
8 changes: 4 additions & 4 deletions content/en/docs/workstation/connector/wks-commons.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Workstation Commons"
url: /mendix-workstation/commons/
description: "Describes the configuration and usage of the Workstation Commons module, which is available in the Mendix Marketplace."
weight: 30
weight: 35
---

## Introduction
Expand Down Expand Up @@ -37,9 +37,9 @@ The `Managed` subfolder contains variants of this function. They check the conne

Each Device Utils function covers a single operation on a device type and builds the matching Workstation device message from plain parameters, so you can work with service UUIDs, paths, and print jobs directly.

For the message syntax behind these functions and the replies each device type sends, see [Managing Devices](/mendix-workstation/management-devices/) in the Mendix Workstation documentation.
For the message syntax behind these functions and the replies each device type sends, see [Device Message Syntax](/mendix-workstation/device-syntax/) in the Mendix Workstation documentation.

#### Bluetooth
#### Bluetooth {#bluetooth}

These functions target a characteristic on a BLE device.

Expand Down Expand Up @@ -87,5 +87,5 @@ The following are reusable web snippets for the screens which most Workstation a
## Read More

* [Mendix Workstation](/mendix-workstation/)
* [Managing Devices in Workstation Management](/mendix-workstation/management-devices/)
* [Device Message Syntax](/mendix-workstation/device-syntax/)
* [Workstation Connector](https://marketplace.mendix.com/link/component/254335/)
Loading
Loading