Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "BaSyx / Documentation / Components / DataBridge / Features / Routes Configuration"

(Created page with "= 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...")
 
(Routes Configuration)
Line 2: Line 2:
 
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.
  
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 here [link].
+
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'''.
  
 
== Sample Single Route Configuration ==
 
== Sample Single Route Configuration ==
Line 17: Line 17:
 
</pre>
 
</pre>
  
The datasource, transformers, and datasinks should be defined in their respective configuration files. For details please see Protocol Integration [link].
+
The datasource, transformers, and datasinks should be defined in their respective configuration files. For details please see [[BaSyx_/_Documentation_/_Components_/_DataBridge_/_Features | Features]].
  
 
Similary, you can configure multiple routes.
 
Similary, you can configure multiple routes.

Revision as of 06:50, 1 February 2023

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 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.

Back to the top