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-message-syntax.md
+16-8Lines changed: 16 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,20 +28,28 @@ This device type requires the following message and response:
28
28
## File Device {#file-device}
29
29
30
30
This device type requires the following message and response:
31
+
32
+
### Important Considerations
33
+
34
+
Before sending messages to the File Device, review the following points:
35
+
36
+
* Path handling - You can provide the paths either as absolute (for example, `/var/log/app.log` or `C:\Data\report.txt`), or as relative paths. Relative paths are always interpreted relative to the allowed folder configured in Workstation Management.
37
+
* Delimiter - The `#` character is used as a delimiter within messages. Paths and data may not contain the `#` character.
38
+
* Case sensitivity - File and directory paths may be case-sensitive depending on the underlying operating system. For example, Linux paths are typically case-sensitive, while Windows paths are not.
31
39
32
40
### Message
33
41
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`.
42
+
*`0#Path` - Initiate watching for changes in the specified `Path`. If `Path` is a directory, the device will watch for changes within that directory (creation, deletion, renaming, or modification of files/subdirectories). If `Path` is a file, the device will watch for changes to that specific file (modification, deletion, or renaming).
43
+
*`1#Path` - Stop watching for changes in the specified `Path`.
44
+
*`2#File path` - Read the content of the file at the specified `File Path`.
45
+
*`3#File path#Data#flag` - Write `Data`to the file at the specified `File Path`. The `flag` can be `w` for overwrite, `a` for append If left blank, the value defaults to `w`.
38
46
39
47
### Response
40
48
41
-
*`R#File name` - `File name` was renamed (also triggered when file is created and deleted)
42
-
*`C#File name` - `File name` was changed
43
-
*`D#Data` - `Data` from file read
44
-
*`E#Error` - `Error` message from operating system
49
+
*`R#Path` - File or directory at the specified `Path` was renamed, created, or deleted.
50
+
*`C#Path` - File or directory at the specified `Path` was changed. This is triggered both when a file is modified and when the contents of a directory changes.
51
+
*`D#Data` - `Data` from file read.
52
+
*`E#Error` - `Error` message from operating system.
45
53
*`S#{0,1,2,3}#directory` - The command `{0,1,2,3}` on `directory` was successful.
0 commit comments