Skip to content

Commit b210b2a

Browse files
authored
Update edge-gateway.md (#58)
1 parent 76a9c99 commit b210b2a

File tree

2 files changed

+32
-5
lines changed

2 files changed

+32
-5
lines changed

Diff for: docs/user-guide/gateways-and-devices/edge-gateway.md

+32-5
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Just create a new Asset of type Gateway and the manager will provision a Keycloa
2525

2626
![](img/manager-gateway-asset.png)
2727

28-
### 2. Entering credentials in the edge gateway
28+
### 2. Entering credentials in the edge gateway (Connection details)
2929
1. On the edge gateway login to the manager UI and select the realm you wish to connect to the central manager (only applicable to superusers).
3030
1. Go to the Manager interconnect page (top right menu)
3131
1. Enter the host (e.g. `demo.openremote.io`)
@@ -36,12 +36,39 @@ Just create a new Asset of type Gateway and the manager will provision a Keycloa
3636
1. Click Save
3737
1. In the top right of the dialog the status should change to `CONNECTED`
3838

39-
### 3. Limit data rate at which edge gateway synchronises
40-
1. On the Manager interconnect page select the asset type and attributes which you want to synchronise with the central instance.
41-
2. Select whether you want to limit the data rate and set the time interval.
42-
39+
### 3. Limit data rate at which edge gateway synchronises (Data sharing)
40+
1. Select the asset type and attributes which you want to synchronise with the central instance
41+
1. Select whether you want to limit the data rate and set the time interval
42+
4343
![image](img/manager-interconnect-rate.png)
4444

45+
### 4. Add/remove attributes and/or configuration items during synchronisation (Asset synchronization)
46+
1. Allows customisation of the attributes and/or configuration items that are sent to the central instance on a per asset & attribute basis (wildcards can also be used)
47+
1. Until we have a UI to do this configuration you will need to write/copy/paste JSON into the textarea using the following schema:
48+
```
49+
{
50+
"*": { <-- Applies to all assets
51+
"excludeAttributes": ["notes"],
52+
"excludeAttributeMeta": {
53+
"*": ["accessPublicRead"],
54+
"location": [] <-- Don't exclude any meta items for location attribute
55+
},
56+
"addAttributeMeta": {
57+
"*": { <-- MetaMap
58+
"accessRestrictedRead": true
59+
},
60+
}
61+
},
62+
"CityAsset": {
63+
"excludeAttributes": ["city"]
64+
}
65+
}
66+
```
67+
3. If a definition exists for a specific asset type or attribute then that should be used instead of any * wildcard definition
68+
4. If a definition exists for a specific attribute within `excludeMetaItems` then that should be used instead of any * wildcard definition
69+
70+
![image](img/manager-asset-synchronisation.png)
71+
4572
## Interaction with Gateway Manager UI via Gateway tunnels
4673

4774
On top of the Interaction via the Gateway, you can remotely access the full Manager UI of the Gateway instances of OpenRemote, by creating Gateway tunnels. Note that you first have to [technically configure the (edge) gateway and central instance of OpenRemote to enable the tunnelling set-up](../../developer-guide/gateway-tunnelling-setup.md). Next you can access the Manager UI of the Gateway instance via the 'Gateway Tunnels' (Settings) or via a 'Gateway Widget' on the Insights dashboards.
Loading

0 commit comments

Comments
 (0)