Skip to content
Draft
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
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
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,7 +31,7 @@ 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.

Expand Down
76 changes: 45 additions & 31 deletions content/en/docs/workstation/management/wks-management-devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,17 +56,16 @@ Serial Port devices allow you to connect to a device with a serial port.
To add a serial port device, perform the following steps:

1. In Workstation Management, navigate to the **Devices** section on the **Station Detail** page.
2. Click **Add Device** and, and then click **Serial Port**.
3. Click **Next**.
4. Enter a meaningful name for the device.
5. Optional: Select or create a class to help you manage your devices.
6. Click **Next**.
7. In the **Detect Serial Device By** section, select one of the following values, depending on whether the serial port device uses static or dynamic port assignment:
2. Click **Add Device**, select **Serial Port**, and then click **Next**.
3. Enter a meaningful name for the device.
4. Optional: Select or create a class to help you manage your devices.
5. Click **Next**.
6. In the **Detect Serial Device By** section, select one of the following values, depending on whether the serial port device uses static or dynamic port assignment:

* For static port assignment, select **Port**.
* For dynamic port assignment, select **Identifiers**.

8. For static port assignment, configure the following connection parameters:
7. For static port assignment, configure the following connection parameters:

* **Port** - Required; the identifier of the serial port
* **Baudrate** - Required; the Bits per Second rate
Expand All @@ -75,7 +74,7 @@ To add a serial port device, perform the following steps:
* **Flowcontrol** - Optional; the handshake mechanism between the server and receiver, used to prevent data overflow
* **Stop Bits** - Required; the bits when data transmission ends.

9. For dynamic port assignment, configure the following connection parameters:
8. For dynamic port assignment, configure the following connection parameters:

* At least one of the following required identifiers:

Expand All @@ -90,16 +89,16 @@ To add a serial port device, perform the following steps:
* **Flowcontrol** - Optional; the handshake mechanism between the server and receiver, used to prevent data overflow
* **Stop Bits** - Required; the bits when data transmission ends.

10. Click **Next**.
11. In the **Split Incoming Message By** section, select one of the following options:
9. Click **Next**.
10. In the **Split Incoming Message By** section, select one of the following options:

* **Delimiter** - Messages received from the device are split by the specified character or characters marking the end of the message, for example, `\r\n`.
* **Time and Size** - Messages received from the device are split by time interval in milliseconds and maximum message size in bytes.
* **Do Not Split** - Messages received from the device are not automatically split.

12. In the **Characters Added to Message** field, specify the character or characters marking the end of the message sent to the device, for example, `\r\n`.
13. In the **Encoding** field, select the message encoding.
14. Click **Add Device**.
11. In the **Characters Added to Message** field, specify the character or characters marking the end of the message sent to the device, for example, `\r\n`.
12. In the **Encoding** field, select the message encoding.
13. Click **Add Device**.

## TCP/IP Client

Expand All @@ -110,7 +109,7 @@ TCP/IP clients allow you to connect to remote devices over the network.
To add a TCP/IP client, perform the following steps:

1. In Workstation Management, navigate to the **Devices** section on the **Station Detail** page.
2. Click **Add Device**, and then select **TCP/IP Client**.
2. Click **Add Device**, select **TCP/IP Client**, and then click **Next**.
3. In the **Device Name** field, enter an identifying name for the device.
4. Optional: Select or create a class to help you manage your devices.
5. Click **Next**.
Expand Down Expand Up @@ -139,11 +138,10 @@ Add Bluetooth LE (BLE) devices that use the ATT protocol by entering the exact d
To add a Bluetooth device, perform the following steps:

1. In Workstation Management, navigate to the **Devices** section on the **Station Detail** page.
2. Click **Add Device** and, and then click **Bluetooth**.
3. Click **Next**.
4. Enter the exact device name as it is displayed in your operating system's Device Manager.
5. Optional: Select or create a class to help you manage your devices.
6. Click **Add Device**.
2. Click **Add Device**, select **Bluetooth**, and then click **Next**.
3. Enter the exact device name as it is displayed in your operating system's Device Manager.
4. Optional: Select or create a class to help you manage your devices.
5. Click **Add Device**.

### Message Syntax

Expand All @@ -162,28 +160,44 @@ This device type requires the following message and response:

## Keyboard Wedge {#keyboard-wedge}

You can configure Workstation to connect with devices that emulate a keyboard by sending data as key strokes, such as barcode scanners, RFID readers, or measurement devices. Keyboard events are captured wherever the current focus is, for example in the web app or in an input field.
You can configure Workstation to connect with devices that emulate a keyboard by sending data as key strokes, such as barcode scanners, RFID readers, or measurement devices. Because these devices present themselves to the operating system as a standard keyboard, keyboard events are captured wherever the current focus is, for example in the web app or in an input field. The operator does not have to place the cursor in a specific input field first.

The Workstation Client recognizes messages from a keyboard wedge device by combining several criteria. It measures the rate at which the characters arrive, which for a device is faster than a person can type, and it uses the configured prefix, suffix, and message length requirements to tell the device apart from other sources of key strokes such as macro pads or automation scripts.

Because a keyboard wedge device is indistinguishable from a keyboard at the operating system level, this recognition is a best-effort mechanism. The Workstation Client cannot tell two sources apart if they produce messages with the same character throughput, length, and prefix and suffix. Give each keyboard wedge device a distinctive combination of these settings when you configure more than one device, or when macro pads or automation scripts are in use on the same computer.

### Limitations

Keyboard wedge devices are supported on Windows and macOS only. Support for Linux ARM, including Raspberry Pi will follow soon.

### Configuring Keyboard Wedges

To add a keyboard emulator device, perform the following steps:

1. In Workstation Management, navigate to the **Devices** section on the **Station Detail** page.
2. Click **Add Device**, and then select **Keyboard Wedge**.
2. Click **Add Device**, select **Keyboard Wedge**, and then click **Next**.
3. In the **Device Name** field, enter an identifying name for the device.
4. Optional: Select or create a class to help you manage your devices.
5. Click **Next**.
6. Configure the following connection parameters:

* **Inter Character Timeout (ms)** - The maximum allowed amount of time between keystrokes.
* **Keyboard Layout** - The keyboard layout of the device. To use the active keyboard layout as defined by your operating system, select **System**.
* **Suffix** - A series of characters denoting the end of a message.
* **Minimum Message Length** - The shortest message that can be sent to the Connector from this device, excluding the prefix and suffix.
* **Maximum Message Length** - The longest message that can be sent to the Connector from this device, excluding the prefix and suffix.
* **Prefix** - A series of characters denoting the start of a message.
| Parameter | Description |
| --- | --- |
| **Inter Character Timeout (ms)** | Required; the maximum allowed amount of time in milliseconds between key strokes for them to be considered as coming from a device. The value must be a positive integer. The default value is `50`. |
| **Keyboard Layout** | Required; the keyboard layout of the device. To use the active keyboard layout as defined by your operating system, select **System**. Select **en-US** as a fallback when the system keyboard layout is not compatible with the device. For example, many barcode scanners send characters from the Latin alphabet, which the system layout cannot resolve if the operating system uses a non-Latin layout such as Chinese. The default value is **System**. |
| **Suffix** | Required; a series of characters denoting the end of a message. The suffix is removed from the payload before it is forwarded to the Workstation Connector. The default value is `\r`, which corresponds to the carriage return that most keyboard emulating devices send after a scan. |
| **Minimum Message Length** | Optional; the shortest message that can be sent to the Connector from this device, excluding the prefix and suffix. Leave the field empty to accept messages of any length. |
| **Maximum Message Length** | Optional; the longest message that can be sent to the Connector from this device, excluding the prefix and suffix. Leave the field empty to accept messages of any length. If you set both values, the maximum must be greater than or equal to the minimum. |
| **Prefix** | Optional; a series of characters denoting the start of a message. The prefix is removed from the payload before it is forwarded to the Workstation Connector. |

7. Click **Add Device**.

Configure the prefix, suffix, and message length limits to match the data that your device sends. The more specific these settings are, the more reliably the Workstation Client attributes an incoming message to the correct device.

### Message Syntax {#keyboard-wedge-syntax}

Keyboard wedge devices are input-only, so Mendix applications do not send messages to them. When the Workstation Client recognizes a complete message, it forwards the payload to the Workstation Connector with the prefix and suffix removed.

## Printer

You can integrate your Workstations with printer devices.
Expand All @@ -193,7 +207,7 @@ You can integrate your Workstations with printer devices.
To add a printer device, perform the following steps:

1. In Workstation Management, navigate to the **Devices** section on the **Station Detail** page.
2. Click **Add Device**, and then select **Printer**.
2. Click **Add Device**, select **Printer**, and then click **Next**.
3. In the **Device Name** field, enter an identifying name for the device.
4. Optional: Select or create a class to help you manage your devices.
5. Click **Next**.
Expand Down Expand Up @@ -239,7 +253,7 @@ The file device allows Mendix applications to interact with the local file syste
To add a file device, perform the following steps:

1. In Workstation Management, navigate to the **Devices** section on the **Station Detail** page.
2. Click **Add Device**, and then select **File Device**.
2. Click **Add Device**, select **File Device**, and then click **Next**.
3. In the **Device Name** field, enter an identifying name for the device.
4. Optional: Select or create a class to help you manage your devices.
5. Click **Next**.
Expand Down Expand Up @@ -323,7 +337,7 @@ TCP/IP clients allow you to host connections over the network.
To add a TCP/IP server, perform the following steps:

1. In Workstation Management, navigate to the **Devices** section on the **Station Detail** page.
2. Click **Add Device**, and then select **TCP/IP Server**.
2. Click **Add Device**, select **TCP/IP Server**, and then click **Next**.
3. In the **Device Name** field, enter an identifying name for the device.
4. Optional: Select or create a class to help you manage your devices.
5. Click **Next**.
Expand All @@ -340,4 +354,4 @@ To add a TCP/IP server, perform the following steps:

9. In the **Characters Added to Message** field, specify the character or characters marking the end of the message sent to the device, for example, `\r\n`.
10. In the **Encoding** field, select the message encoding.
11. Click **Add Device**.
11. Click **Add Device**.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Navigate to the **Settings** page in a workspace to configure settings that are

## Log Settings

The Workstation Client always stores logs to the file system it is installed on (for more information, see [Troubleshooting the 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.
The Workstation Client always stores logs to the file system it is installed on (for more information, see [Troubleshooting the Workstation Client](/mendix-workstation/troubleshooting-workstation-client/)). No logs are sent 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.

### Log Level

Expand Down Expand Up @@ -41,7 +41,7 @@ The **Check Interval** setting is only available when the auto-refresh mode is e

## Local Device Testing

When enabled, this allows local device communication between the Workstation Client and Workstation Management App to use the **Test Your Station** feature of Studio Pro. You can use this option to test your devices.
When enabled, this allows local device communication between the Workstation Client and Workstation Management to use the **Test Your Station** page. You can use this option to test your devices.

## Delete Workspace

Expand Down
13 changes: 9 additions & 4 deletions content/en/docs/workstation/management/wks-management-team.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,14 @@ For more information about the available roles, see [User Roles](#user-roles).

To change a user's role or remove them from the workspace, click the three-dot icon in the right column of the user list. This action requires the Owner or Workspace Admin role.

### Transfer Workspace Ownership

By default, the user who created a workspace is assigned the owner role. For an owner to hand over the workspace to another user, click the three-dot icon in the right column of the user, click **Transfer Ownership**, and confirm this action by clicking **Transfer Ownership** on the confirmation popup.

{{% alert color="info" %}}
Only the current owner can transfer ownership, so make sure owners hand over their workspaces before they leave your company. If an owner has already left, contact Mendix Support to have the ownership transferred.
{{% /alert %}}

## Workspace Roles {#user-roles}

You can assign the following roles to your users:
Expand All @@ -41,10 +49,7 @@ You can assign the following roles to your users:
* Registering and deregistering computers to and from stations
* Refreshing computer configurations
* Managing workspace settings
* Deleting a workspace or transfering ownership to a new owner

By default, the user who created a workspace is assigned the owner role. Contact Mendix Support if a Workspace owner has left the company to transfer the ownership.

* Deleting a workspace or transferring ownership to a new owner
* Viewing bulk registration tokens
* Copying existing bulk registration tokens
* Creating new bulk registration tokens
Expand Down
Loading
Loading