A resource data forwarding rule defines the devices and the resource of which data shall be forwarded. For each resource data forwarding rule Hagleitner senseManagement creates the necessary infrastructure that can be used by 3rd party software systems to subscribe to the forwarded data.
Resource data forwarding rules rules are defined on the Client Service and are translated to directives for the Resource Data Observation Service.
Managing forwarding rules is bound to the capability DEVICE_FORWARDING.
Only users with permission EDIT_DEVICE_FORWARDING_RULES can create and modify forwarding rules. Only users with permission VIEW_DEVICE_FORWARDING_RULES can view forwarding rules, this includes viewing connection strings for the SignalR Hub Group and the Azure Service Bus queue created for each forwarding rule.
Resource data forwarding rules are created for customers and stored with customers. A forwarding rule can therefore only forward data of devices of one customer.
Table 54 describes the general attributes stored with resource data forwarding rules.
Attribute |
Notes |
|---|---|
ID |
UUID. Mandatory. ID of the rule set by HsM |
Name |
Mandatory. Name of the rule. Can be freely defined by the user. |
Description |
Optional. Detailed description of the rule. Can be freely defined by the user. |
Is Active |
If true the resource data forwarding rule is considered active, i.e. it will be used by the Resource Data Observation Service. If false the rule is inactive and will not be used by the Resource Data Observation Service i.e. will not forward any data. This setting can be used to temporarily disable a rule without loosing all of the rule's settings. Even if set to false, the infrastructure (SignalR Hub Group, Azure Service Bus Queue) will not be deleted. |
Table 54: General attributes of ad resource data forwarding rule
Devices to be monitored
Basically a resource data forwarding rule will forward data of a all devices registered at the customer the rule was created for. However a device filter can be used to limit the set o devices that shall be monitored.
Resource data to be forwarded
A device data forwarding rule can either be configured to forward all data of the monitored devices or just the data of resource belonging to a specified resource equivalent.
When configured to only forward data of a specified resource equivalent data of devices that do not have a matching resource will not be forwarded at all.
Consuming forwarded data
For each resource data forwarding rule HsM automatically creates the an Azure Service Bus queue and a SignalR endpoint to consume the forwarded data. The connection data you need to connect your tools to this infrastructure is created and is connected to the forwarding rule.
The Azure Service Bus queue created for each forwarding rule has a maximum size of 1 GB, messages are kept on the queue for 4 days.
Connection datum |
Description |
|---|---|
Azure service bus queue name |
Name of the Azure Service Bus queue that was created for this resource data forwarding rule. The name is created by HsM when a resource data forwarding rule is created and cannot be modified by users. The queue name is generated by the Resource Data Observation Service and cannot be modified by users. |
Azure service bus connection string |
The connection string contains the Azure Service Bus endpoint and credentials for authenticating. The credentials are only valid for the Service Bus queue created for this resource data forwarding rule. The connection string is created by HsM when a resource data forwarding rule is created or rotated. |
SignalR connection string |
The connection string contains the HTTP endpoint for the SignalR and credentials for authenticating. The credentials are only valid for the SignalR group connected with this resource data forwarding rule. The connection string is created by HsM when a resource data forwarding rule is created or rotated. |
Table 55: Connection data generated for Azure Service Bus and SignalR with every resource data forwarding rule.
