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
39 changes: 26 additions & 13 deletions docs/user-guide/020-manager-ui/10-manager-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,19 @@ The alarms functionality (top right) allows you to automatically generate alarms
![](img/alarms-overview.png)
_Figure 13. The alarms page with an overview of all alarms._

## Notifications

The notifications page (top right, under the dots menu) shows all email and push notifications sent within the selected realm, and lets you send new ones. Reading requires the 'read notifications' role, sending the 'write notifications' role. These features are supported:
* Overview of sent notifications: title, content, status, source, recipient, and the moment of sending and delivery.
* Status: `Sent` when the notification left the platform, `Delivered` when a console confirmed receipt (push only), or `Error` with the reason of failure.
* Source: shows what triggered the notification, being a When-Then rule (global, realm, or asset ruleset), the platform itself (internal), or a client using the [Manager APIs](#manager-apis).
* Recipients: users, users linked to assets, or all users in a realm. The recipient links to the respective user or asset.
* Send a notification: compose an email (subject and body) or a push notification (title, body, priority, a URL to open, and confirm/decline buttons) and send it to the selected recipients.
* Filtering by source and by period (today by default), ordering by column, and paging.

![](img/notifications-overview.png)
_Figure 14. The notifications page with an overview of all sent notifications._

## Settings and access

Admin users of the 'Master' realm see the Realm selector on the top right to switch between Realms. Next to that the dots give you access to a series of general settings as well as account access related settings. We will explain these here:
Expand All @@ -198,17 +211,17 @@ You can link multiple instances of OpenRemote (as Gateways) to a single Central
See the [Edge Gateway documentation](../080-gateways-and-devices/10-edge-gateway.md) for more details.

![](img/manager-interconnect.png)
_Figure 14. Several OpenRemote instances can be interconnected, e.g. connecting multiple instances on edge gateways to one central cloud hosted instance. The Manager Interconnect page, used at the edge instances (left) uses the keys which are created on the central instance by adding Edge gateway Assets (right)._
_Figure 15. Several OpenRemote instances can be interconnected, e.g. connecting multiple instances on edge gateways to one central cloud hosted instance. The Manager Interconnect page, used at the edge instances (left) uses the keys which are created on the central instance by adding Edge gateway Assets (right)._

![](img/manager-interconnect-rate-limiting.png)
_Figure 15. Next to interconnecting you can choose which asset attributes are actually linked as well as the rate at which data is exchanged._
_Figure 16. Next to interconnecting you can choose which asset attributes are actually linked as well as the rate at which data is exchanged._

### Gateway tunnels

On top of the 'Manager Interconnect' functionality, you can remotely access the full Manager UI of the Gateway instances of OpenRemote, by creating Gateway tunnels. See the [Edge Gateway documentation](../080-gateways-and-devices/10-edge-gateway.md) for more details.

![](img/create-gateway-tunnel.png)
_Figure 16. Creating a gateway tunnel and opening the manager UI of the remote instance which is connected as a gateway._
_Figure 17. Creating a gateway tunnel and opening the manager UI of the remote instance which is connected as a gateway._

### Languages

Expand All @@ -219,14 +232,14 @@ OpenRemote currently supports 9 languages: English, German, French, Spanish, Por
The logs page shows information, warnings and errors of the different activities of OpenRemote. You can use it to understand the behaviour of the whole platform or debug issues, e.g. errors connecting agent with device.

![](img/logs-page.png)
_Figure 17. The Logs page to evaluate system behaviour._
_Figure 18. The Logs page to evaluate system behaviour._

### Account

On the Account page you can (re)set you personal information or password. You can also monitor your past sessions or enable 2FA via an Authenticator (default disabled).

![](img/edit-account-change-password.png)
_Figure 18. The account page with contact details (left) and reset passwords (right)._
_Figure 19. The account page with contact details (left) and reset passwords (right)._

### Users and access configuration

Expand All @@ -241,14 +254,14 @@ By linking assets to users, the system will understand which users are connected
When, next to linking an asset to a user, you also set the Realm role to 'Restricted User', users will only have access to the assets they are linked to. Note that you additionally have to indicate on the assets which attributes of the asset they have access to. To do that, set the configuration item 'Access restricted user read/write' on the attribute ([see 'Configure attributes'](#configure-attributes)).

![](img/creating-users.png)
_Figure 19. Creating users for a selected realm, assigning roles. In this example, the user is made a 'restricted user' linked to only 6 assets._
_Figure 20. Creating users for a selected realm, assigning roles. In this example, the user is made a 'restricted user' linked to only 6 assets._

### Roles

With the correct permissions, you can create and edit roles. These roles define which parts of the system a user is allowed to Read or Write, e.g. system settings, assets, attributes, map, or rules. Also see the userguide: [Realms, users and roles](../070-identity-and-security/10-realms-users-and-roles.md).

![](img/role-with-permissions.png)
_Figure 20. Roles are made of a set of permissions_
_Figure 21. Roles are made of a set of permissions_

### Realms

Expand All @@ -257,16 +270,16 @@ Only the Master realm Admin user can create `Realms` by accessing the master rea
You can create a realm by adding a `realmname` name (single word, lower case letters), and a `Friendly name`. You can (temporarily) disable realms, which blocks access for any user.

![](img/realms.png)
_Figure 21. Realms can be created to manage multiple independent projects within one OpenRemote instance_
_Figure 22. Realms can be created to manage multiple independent projects within one OpenRemote instance_

Also see the userguide: [Realms, users and roles](../070-identity-and-security/10-realms-users-and-roles.md).

### Auto provisioning of devices

If you are an OEM, developing and producing your own hardware, you can provision your devices and OpenRemote to automatically have your devices connecting, once they get online. Using certificates (we currently support X.509) your devices will register and automatically generate and connect to an asset of a defined type in the OpenRemote Manager (see figure 22). For details, check out the documentation about ['Auto provisioning'](../080-gateways-and-devices/20-auto-provisioning.md).
If you are an OEM, developing and producing your own hardware, you can provision your devices and OpenRemote to automatically have your devices connecting, once they get online. Using certificates (we currently support X.509) your devices will register and automatically generate and connect to an asset of a defined type in the OpenRemote Manager (see figure 23). For details, check out the documentation about ['Auto provisioning'](../080-gateways-and-devices/20-auto-provisioning.md).

![](img/auto-provisioning-of-devices.png)
_Figure 22. Auto provisioning of devices_
_Figure 23. Auto provisioning of devices_

### Appearance

Expand All @@ -277,18 +290,18 @@ You can change the logo's, use different colours, change the title and default l
For adding map layers you can add GeoJSON files (created e.g. with https://geojson.io/). More advanced settings like visible asset and agent types on the asset and rules page, can be configured directly in a JSON file. For the options available in the JSON file and an example, check out [Configuring the Manager UI](../010-deploying/20-configuring-the-manager-ui.md). For the maps you can set the center point, zoom levels and boundaries.

![](img/appearance-settings.png)
_Figure 23. Appearance settings allow white labeling of your OpenRemote manager_
_Figure 24. Appearance settings allow white labeling of your OpenRemote manager_

## Manager APIs

The Manager APIs let you interact with OpenRemote without using the UI. This can be used to e.g. synchronize attribute data with external clients, accessing configurations, or creating new assets. To authenticate you'll need to create a service user first on the Users page. We have three types of APIs to choose from: HTTP, MQTT, and WebSocket.

### Service users

Service users can be created on the `Users` page, and selecting `Add user` in the `Service user` panel (see figure 24). The `Username` (ClientID) can be set using letters, dashes, and numbers, while the `Secret` will be generated automatically once saved. Note that you also need to select the role(s).
Service users can be created on the `Users` page, and selecting `Add user` in the `Service user` panel (see figure 25). The `Username` (ClientID) can be set using letters, dashes, and numbers, while the `Secret` will be generated automatically once saved. Note that you also need to select the role(s).

![](img/creating-service-users.png)
_Figure 24. Creating service users, with Username, Secret and Roles for a selected Realm_
_Figure 25. Creating service users, with Username, Secret and Roles for a selected Realm_

### HTTP, MQTT, and WebSocket

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.