-
Notifications
You must be signed in to change notification settings - Fork 789
Kk wks 38 updates #11410
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: development
Are you sure you want to change the base?
Kk wks 38 updates #11410
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,7 +28,7 @@ A *station* represents a workstation on the shop floor. It can connect to one or | |
|
|
||
| {{< figure src="/attachments/workstation/wks-install1.png" class="no-border" >}} | ||
|
|
||
| 3. Enter a name for your new workspace, and then click **Create Workspace**. | ||
| 3. Enter a name for your new workspace, specify the environment type (**Test**, **Acceptance** or **Production**), and then click **Create Workspace**. | ||
|
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Changing the type from test to anything else won't change the developer mode setting. (Won't deactivate it.) And vice versa. |
||
|
|
||
| {{< figure src="/attachments/workstation/wks-install2.png" class="no-border" >}} | ||
|
|
||
|
|
@@ -196,7 +196,7 @@ Auto-refresh settings are available in Workstation Management at **Settings > Cl | |
|
|
||
| By default, the Workstation Client operates in auto-refresh mode. That is, any changes made to the configuration in Workstation Management are immediately reflected in the Client. | ||
|
|
||
| To change this behavior, set the **Auto-Refresh Mode** toggle to **Off**. You can then force the configuration to refresh by clicking **Refresh on Computer** in Workstation Management, or by clicking **Refresh** in the Workstation Client. | ||
| To change this behavior, set the **Auto-Refresh Mode** toggle to **Off**. You can then force the configuration to refresh by clicking **Sync Clients** in Station Overview, or by clicking **Refresh** in the Workstation Client. | ||
|
|
||
| The **Check Interval** setting is only available when the auto-refresh mode is enabled. It specifies how often a Workstation Client that is disconnected due to a web socket failure should automatically refresh its configuration by polling Workstation Management. By default, this happens every 60 minutes. | ||
|
|
||
|
|
@@ -281,6 +281,18 @@ For production environments, it is recommended to disable *Developer Mode* to pr | |
|
|
||
| #### Device Settings | ||
|
|
||
| ##### Configuration in Management UI | ||
|
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Explain each field separately - for Maia. |
||
|
|
||
| To add a printer device, perform the following steps: | ||
|
|
||
| 1. Navigate to the **Devices** section on the **Station Detail** page. | ||
| 2. Click **Add Device** and select the device type. | ||
| 3. Enter a meaningful name for the device, for example, *Shopfloor Printer*. | ||
| 4. Optional: Select or create a class to help you manage your devices, for example, *Building A Printers*. | ||
| 5. Specify the information required to connect to the device. | ||
|
|
||
| The required information depends on the type of the device. For some devices, like printers, you must only specify the device name. For others, like Serial Port devices, you can use a variety of identifiers such as serial numbers, manufacturer names, and others. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "For others, like Serial Port devices, you can use a variety of identifiers such as serial numbers, manufacturer names, and others." Add a dedicated section for serial devices. Printers cannot be added that way. |
||
|
|
||
| ##### Card Readers | ||
|
|
||
| Card reader devices cannot be configured as separate devices in the **Devices** overview of a **Station** page. Instead, they are automatically detected by the Workstation Client and added to the device list of the Client. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. as discussed, pls. update this section "Auto detecting card readers is enabled by default. This setting can be configured on a Station page by toggling Detect Card Readers."
Same for debugger mode toggl |
||
|
|
@@ -289,9 +301,19 @@ Auto detecting card readers is enabled by default. This setting can be configure | |
|
|
||
| Refer to [Message Syntax - Card Readers](/mendix-workstation/device-syntax/#card-readers) for a more in-depth explaination how to communicate with card readers. | ||
|
|
||
| ### Serial Port Devices | ||
|
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Static vs dynamic port assignment, different methods depending on use case. Cf demo. Static using com ports, dynamic - pnp id or manufacturer. |
||
|
|
||
| Serial Port devices allow you to connect to a device with a serial port. | ||
|
|
||
| ##### Bluetooth Devices | ||
|
|
||
| Add Bluetooth LE (BLE) devices that use the ATT protocol by entering the exact device name as displayed in your OS' device manager | ||
|
|
||
| Refer to [Message Syntax - Bluetooth](/mendix-workstation/device-syntax/#bluetooth) for a more in-depth explaination how to communicate with bluetooth devices. | ||
|
|
||
| ##### File Device | ||
|
|
||
| This section explains the configuration of a file device. Refer to [Message Syntax - File Device](/mendix-workstation/device-syntax/#file-device) for a more in-depth explaination how to communicate with file devices. | ||
| File devices allow you to read and write from a file. Refer to [Message Syntax - File Device](/mendix-workstation/device-syntax/#file-device) for a more in-depth explaination how to communicate with file devices. | ||
|
|
||
| ###### Allowed Folder Configuration | ||
|
|
||
|
|
@@ -316,8 +338,14 @@ Windows and Unix-style paths can be used independently of the operating system t | |
|
|
||
| The administrator can choose to allow either one or a combination of the following permissions: subscribe to change events, read files, and write files. | ||
|
|
||
| ##### Bluetooth Devices | ||
| ##### TCP/IP Client | ||
|
|
||
| Simply add Bluetooth LE (BLE) devices that use the ATT protocol by entering the exact device name as displayed in your OS' device manager | ||
| TCP/IP clients allow you to connect to remote devices over the network. | ||
|
|
||
| Refer to [Message Syntax - Bluetooth](/mendix-workstation/device-syntax/#bluetooth) for a more in-depth explaination how to communicate with bluetooth devices. | ||
| ##### TCP/IP Server | ||
|
|
||
| TCP/IP clients allow you to host connections over the network. | ||
|
|
||
| ##### Printers | ||
|
|
||
| You can integrate your Workstations with printer devices. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -86,3 +86,15 @@ Send instruction in hexadecimal as a string, for example, *FFCA000000* to read t | |
| * `1#` - Card disconnected | ||
|
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Merged in #11455 |
||
| * `2# Response` - Response from device as raw hexadecimal. | ||
| * `3# Error` - Error message from device. | ||
|
|
||
| ## Printers | ||
|
|
||
| This device type requires the following message and response: | ||
|
|
||
| ### Message | ||
|
|
||
| A print command, for example, `P#TESTHELLO#RAW#aGVsbG8=`. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. TWS-919 contains further explanations of the message format that should be added here: Message format:
Example: Breaking down the print command
|
||
|
|
||
| ### Response | ||
|
|
||
| The output of the print command, for example, `hello` in a *TESTHELLO.prn* file. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| --- | ||
|
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Changes merged in this PR: #11454 |
||
| title: "Monitoring Mendix Workstation" | ||
| linktitle: "Monitoring" | ||
| url: /mendix-workstation/monitoring/ | ||
| description: "Describes how to access and use the Usage Report page of Mendix Workstation." | ||
| weight: 35 | ||
| --- | ||
|
|
||
| ## Introduction | ||
|
|
||
| Mendix Workstation provides detailed usage reports that show how stations are being used across your different workspaces and company. This helps you understand and optimize your Workstation deployment. | ||
|
|
||
| Workstation Clients automatically report their daily active usage to the server, tracking which stations were used and on which days. This data powers the usage reports, giving you valuable insights without extra effort. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Note: currently, the report is indeed tracking "active stations". Will change to "active Workstation Clients" as next release i.e. 4.0 GA. |
||
|
|
||
| ## Accessing the Usage Reports | ||
|
|
||
| You can access the Usage Reports by performing the following steps: | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add: Screenshot can be created from test environment. |
||
| 1. To view the reports for all workspaces that you own or administer, go to Workstation Management, and click **My Usage Report**. | ||
|
|
||
| {{< figure src="/attachments/workstation/wks-usage1.png" class="no-border" >}} | ||
|
|
||
| 2. To view the reports for a specific workspace, open the workspace in Workstation Management, and then click **Usage**. | ||
|
|
||
| {{< figure src="/attachments/workstation/wks-usage2.png" class="no-border" >}} | ||
|
|
||
| The Usage Reports display information about the usage trends for each station both daily and over time. | ||
|
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Test type workspaces have developer mode for stations turned on by default