Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "BaSyx / Documentation / Components / DataBridge / Features / Routes Configuration"
(→Routes Configuration) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
= Routes Configuration = | = Routes Configuration = | ||
| − | A route is a sequence of steps, executed in order by DataBridge, that consume and process a message. A route starts with a source and is followed by a chain of endpoints and processors such as transformers and sinks. | + | A route is a sequence of steps, executed in order by DataBridge, that consume and process a message. A route starts with a source and is followed by a chain of endpoints and processors such as transformers and sinks. The names utilized in the route configuration have to be equal to the ''uniqueId''s defined in the respective jsons. |
A route in DataBridge can be configured using Json file. You can specify the Data Sources, Transformers, Data Sinks, and Route trigger. Specifying the trigger in the route instructs the DataBridge about when the route would be started. More information on different types of triggers can be found in [[BaSyx_/_Documentation_/_Components_/_DataBridge_/_Features | Features]] under '''Route Types'''. | A route in DataBridge can be configured using Json file. You can specify the Data Sources, Transformers, Data Sinks, and Route trigger. Specifying the trigger in the route instructs the DataBridge about when the route would be started. More information on different types of triggers can be found in [[BaSyx_/_Documentation_/_Components_/_DataBridge_/_Features | Features]] under '''Route Types'''. | ||
| Line 42: | Line 42: | ||
== Naming Conventions == | == Naming Conventions == | ||
The name of the routes configuration file should be '''routes.json'''. | The name of the routes configuration file should be '''routes.json'''. | ||
| + | |||
| + | == Working Example == | ||
| + | There is a working example with overall [https://github.com/eclipse-basyx/basyx-java-examples/tree/main/basyx.examples.deviceintegration/src/main/resources device integration] scenarios. | ||
Latest revision as of 08:45, 1 February 2023
Contents
Routes Configuration
A route is a sequence of steps, executed in order by DataBridge, that consume and process a message. A route starts with a source and is followed by a chain of endpoints and processors such as transformers and sinks. The names utilized in the route configuration have to be equal to the uniqueIds defined in the respective jsons.
A route in DataBridge can be configured using Json file. You can specify the Data Sources, Transformers, Data Sinks, and Route trigger. Specifying the trigger in the route instructs the DataBridge about when the route would be started. More information on different types of triggers can be found in Features under Route Types.
Sample Single Route Configuration
[
{
"routeId": "namedRoute",
"datasource": "property1",
"transformers": ["jsonataA"],
"datasinks": ["ConnectedSubmodel/ConnectedPropertyA"],
"trigger": "event"
}
]
The datasource, transformers, and datasinks should be defined in their respective configuration files. For details please see Features.
Similary, you can configure multiple routes.
Sample Multiple Routes Configuration
[
{
"routeId": "namedRoute",
"datasource": "property1",
"transformers": ["jsonataA"],
"datasinks": ["ConnectedSubmodel/ConnectedPropertyA"],
"trigger": "event"
},
{
"datasource": "property2",
"transformers": ["jsonataA", "jsonataB"],
"datasinks": ["ConnectedSubmodel/ConnectedPropertyA", "ConnectedSubmodel/ConnectedPropertyB"],
"trigger": "event"
}
]
Naming Conventions
The name of the routes configuration file should be routes.json.
Working Example
There is a working example with overall device integration scenarios.