Skip to content

Commit 3f55e3d

Browse files
Merge pull request #10315 from mendix/kk-wks-fix-links
Kk wks fix links
2 parents 81f3fe2 + 0d4f9ab commit 3f55e3d

File tree

3 files changed

+28
-8
lines changed

3 files changed

+28
-8
lines changed

content/en/docs/workstation/wks-build-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ To change a user's role, or remove them from the workspace, click the three dot
8181
Now that you are ready to start using Mendix Workstation Client, you can implement your own custom logic for interacting with devices. The following nanoflows and Java actions are essential for establishing connections, sending or receiving messages, and managing device interactions:
8282

8383
* **GetStation** - Retrieves the computer information connected to the Client.
84-
* **SendMessage** - Sends data or commands to the connected device. For more information about the supported message syntax, see [Message Syntax for File, Smart Card, and Bluetooth Devices](/mendix-workstation/message-syntax/).
84+
* **SendMessage** - Sends data or commands to the connected device. For more information about the supported message syntax, see [Message Syntax for File, Smart Card, and Bluetooth Devices](/mendix-workstation/device-syntax/).
8585
* **SubscribeToMessages** - Subscribe a nanoflow to be called when the device is sending a message.
8686
* **SubscribeToErrors** - Subscribe a nanoflow to be called on device connection errors.
8787
* **Unsubscribe** - End the subscription to device messages or errors.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ After configuring the server and client pair, test their connectivity by perform
143143
8. In the same way, send a message from the **Test Server** to the **Test Client** device.
144144

145145
{{% alert color="info" %}}
146-
Different device types have different requirements for the message syntax. For more information, see [Message Syntax for File, Smart Card, and Bluetooth Devices](/mendix-workstation/message-syntax/).
146+
Different device types have different requirements for the message syntax. For more information, see [Message Syntax for File, Smart Card, and Bluetooth Devices](/mendix-workstation/device-syntax/).
147147
{{% /alert %}}
148148

149149
## Quitting the Workstation Client

content/en/docs/workstation/wks-message-syntax.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Message Syntax for File, Smart Card, and Bluetooth Devices"
3-
linktitle: "Message Syntax"
4-
url: /mendix-workstation/message-syntax/
3+
linktitle: "Device Syntax"
4+
url: /mendix-workstation/device-syntax/
55
description: "Provides information about the message syntax required for different device types."
66
weight: 40
77
---
@@ -31,10 +31,10 @@ This device type requires the following message and response:
3131

3232
### Message
3333

34-
* `0# Directory` - Watch for changes in `Directory`. If `Directory` is a file path, then watch for changes in the file. `Directory` is relative to the folder configured in Workspace management. Environment variables (for example, `%public%`) are supported.
35-
* `1# Directory` - Stop watching for changes in `Directory`.  
36-
* `2# File path` - Read file at `File path`.
37-
* `3# File path # Data # flag` - Write to file at `File path`. The `flag` can be `w` for overwrite, `a` for append If left blank, the value defaults to `w`.
34+
* `0#Directory` - Watch for changes in `Directory`. If `Directory` is a file path, then watch for changes in the file. `Directory` is relative to the folder configured in Workspace management. Environment variables (for example, `%public%`) are supported.
35+
* `1#Directory` - Stop watching for changes in `Directory`.  
36+
* `2#File path` - Read file at `File path`.
37+
* `3#File path#Data#flag` - Write to file at `File path`. The `flag` can be `w` for overwrite, `a` for append If left blank, the value defaults to `w`.
3838

3939
### Response
4040

@@ -44,6 +44,26 @@ This device type requires the following message and response:
4444
* `E#Error` - `Error` message from operating system
4545
* `S#{0,1,2,3}#directory` - The command `{0,1,2,3}` on `directory` was successful.
4646

47+
### Example Test
48+
49+
The section below shows a sample test that you can run to verify the configuration.
50+
51+
1. Create a new Workspace in the Workstation Management.
52+
2. Create a new Station.
53+
3. Add a `File Device` with the following configuration to this Station:
54+
* **Device Name** - *Write files to test folder*
55+
* **Allowed Folder** - For example, on a Windows computer you can use a path like `C:\MyTestFolder`
56+
* **Allow writing files** - **Yes**
57+
* Use the default values for everything else
58+
4. Register the Station to your computer (assuming the Workstation Client is installed there).
59+
5. In your Workspace, navigate to **Test Your Station** and click on the configured file device.
60+
6. Enter `3#test.txt#Hello from Mendix` in the **Send Message** field, and then press **Send Message**.
61+
62+
The test should show a response like `S#3#C:\MyTestFolder\test.txt` to indicate that the text file *test.txt* was succesfully written to *MyTestFolder*.
63+
64+
7. Go to *C:\MyTestFolder* and verify that it contains the text file.
65+
8. Open the test file and verify that it contains the text *Hello from Mendix*.
66+
4767
## Smart Cards
4868

4969
This device type requires the following message and response:

0 commit comments

Comments
 (0)