Skip to content

Document advanced per-attribute synchronization #130

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.

Sign up for GitHub

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

Merged
MartinaeyNL merged 1 commit into from
Jan 14, 2026
Merged

Document advanced per-attribute synchronization #130

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
105 changes: 105 additions & 0 deletions docs/user-guide/gateways-and-devices/edge-gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,111 @@ Just create a new Asset of type Gateway and the manager will provision a Keycloa

![image](img/manager-interconnect-rate.png)

You can set advanced per-attribute synchronisation using the JSON editor. See [GatewayAttributeFilter](https://github.com/openremote/openremote/blob/a321ea3e972d2e88e79225cf2459a5a026878e54/model/src/main/java/org/openremote/model/gateway/GatewayAttributeFilter.java)
```
[
{
"matcher": {
"recursive": false,
"realm": {
"name": "master"
},
"types": [
"ThingAsset"
],
"attributes": {
"operator": "OR",
"items": [
{
"name": {
"predicateType": "string",
"match": "EXACT",
"caseSensitive": true,
"value": "attribute1",
"negate": false
},
"negated": false
},
{
"name": {
"predicateType": "string",
"match": "EXACT",
"caseSensitive": true,
"value": "attribute2",
"negate": false
},
"negated": false
}
]
},
"limit": 0
},
"duration": "PT1M",
"durationParsedMillis": 60000
},
{
"matcher": {
"recursive": false,
"realm": {
"name": "master"
},
"types": [
"ThingAsset"
],
"attributes": {
"operator": "OR",
"items": [
{
"name": {
"predicateType": "string",
"match": "EXACT",
"caseSensitive": true,
"value": "attribute3",
"negate": false
},
"negated": false
},
]
},
"limit": 0
},
"duration": "PT10M",
"durationParsedMillis": 600000
},
{
"matcher": {
"recursive": false,
"realm": {
"name": "master"
},
"types": [
"ThingAsset"
],
"attributes": {
"items": [
{
"name": {
"predicateType": "string",
"match": "EXACT",
"caseSensitive": true,
"value": "attribute4",
"negate": false
},
"negated": false
}
]
},
"limit": 0
},
"valueChange": true,
"durationParsedMillis": null
},
{
"skipAlways": true
}
]
```

### 4. Add/remove attributes and/or configuration items during synchronisation (Asset synchronization)
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)
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:
Expand Down