Skip to content
Merged
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
14 changes: 12 additions & 2 deletions content/en/docs/workstation/client/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,25 @@ title: "Mendix Workstation Client"
linktitle: "Workstation Client"
url: /mendix-workstation/client/
description: "Describes how to set up and administer the Mendix Workstation Client."
weight: 31
weight: 12
no_list: false
description_list: true
---

## Introduction

Installed on each local workstation, the [Workstation Client](https://marketplace.mendix.com/link/component/247448) establishes a secure and reliable connection between a workstation and the hardware, peripherals, or local data sources attached to that workstation. It handles the traffic between connected devices and the client application using the configurations provided by the Workstation Management and the functionality of the Workstation Connector.

### Users
## Basic Concepts

For more information about the terms used in this document, such as *station* or *device*, refer to the [Mendix Workstation glossary](/mendix-workstation/glossary/).

## Users

Workstation Client is used by central IT, support teams, operators, and supervisors.

## Accessing the Workstation Client

The Workstation Client is available for download from the Mendix Marketplace. For more information, see [Installing the Workstation Client](/mendix-workstation/install-client/).

## Read More
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ aliases:

After [creating one or more workspaces](/mendix-workstation/management-config/) for your organization, you can proceed by installing the Workstation Client on the computers which you want to register as stations in Workstation Management.

## Prerequisites
## Prerequisites {#prerequisites}

Before you install the Workstation Client, ensure that you fulfill the following prerequisites.

Expand Down
16 changes: 12 additions & 4 deletions content/en/docs/workstation/wks-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ url: /mendix-workstation/connector/
description: "Describes how to install the Workstation Connector and build an app to work with Mendix Workstation."
aliases:
- /mendix-workstation/build-app/
weight: 12
weight: 13
---

## Introduction
Expand All @@ -21,11 +21,19 @@ The connector handles the following tasks:
* Exchanging messages with devices
* Subscribing for triggering app logic on event when receiving messages from a device

### Users
## Basic Concepts

For more information about the terms used in this document, such as *station* or *device*, refer to the [Mendix Workstation glossary](/mendix-workstation/glossary/).

## Users

Workstation Client is used by central IT, support teams, operators, and supervisors.

### How the Connection Works
## Accessing the Workstation Connector

The Workstation Connector is available for download from the Mendix Marketplace. For more information, see [Installing and Configuring the Workstation Connector](#install-connector).

## How the Connection Works

The Workstation Connector must authenticate itself to the Workstation Client so that the Client trusts the app using the Connector and establishes a connection. To achieve this, a key pair has to be generated by the Workstation Connector. The public key must be configured in the corresponding app in the Workstation Management. Workstation Client configuration must be up-to-date so that the public key can be verified.

Expand All @@ -40,7 +48,7 @@ The Workstation Connector connects with Workstation Client using a local WebSock
* Mendix Workstation 3.0.0 or newer
* Mendix Studio Pro 9.24.11 or newer

## Installing and Configuring the Workstation Connector
## Installing and Configuring the Workstation Connector {#install-connector}

To install and configure the Workstation Connector, perform the following steps:

Expand Down
16 changes: 12 additions & 4 deletions content/en/docs/workstation/wks-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,23 @@ weight: 10

## Introduction

Use this guide to help you get started with Mendix Workstation. Review the system, access, and network prerequisites, and then follow a step-by-step walkthrough to help you set up and test the connection.

This guide helps you configure and test a minimum working version of Mendix Workstation. By following these steps, you will complete the following:
This guide helps you configure and test a minimum working version of [Mendix Workstation](/mendix-workstation/) to help you develop or test Workstation configurations. By following these steps, you will complete the following:

* Create a basic configuration within Workstation Management.
* Set up a pair of virtual TCP/IP Client and Server devices for testing.
* Install the Workstation Client on your computer.
* Verify the connection between your virtual devices directly from Workstation Management.

For more detailed information about implementing Mendix Workstation in a production setting, refer to the following topics:

* [Workstation Management](/mendix-workstation/management/)
* [Workstation Client](/mendix-workstation/client/)
* [Workstation Connector](/mendix-workstation/connector/)

## Prerequisites

For information about the system and access requirements specific to Mendix Workstation, see [Installing the Workstation Client: Prerequisites](/mendix-workstation/install-client/#prerequisites).

## Creating a Workspace and Station {#create-workspace}

A *station* represents a workstation on the shop floor. It can connect to one or more apps or devices. A *workspace* is a grouping of one or more stations. For example, a workspace may group together all the stations which belong to the same factory or factory line.
Expand Down Expand Up @@ -170,4 +178,4 @@ For more information, see [Security Best Practices for Mendix Workstation](/mend
### Maintenance Guidelines

* Periodically review and update workstation and device configurations.
* Monitor workstation health and resolve any connectivity issues promptly.
* Monitor workstation health and resolve any connectivity issues promptly.
Loading