subscription-service/v1
Configuration¶
Path: datasourceConfig >> [required/provided]Datasource >> services >> subscription-service/v1
Type: object
Usage: The subscription-service enables applications to subscribe to provided data. The datasource providing application gets automatically configured out of the subscriptions of the installed applications.
For common applications you do not need to create the configuration manually. In most cases, the application will start with a default configuration which will work fine in most installations, so you do not need to create a subscription configuration. Anyway, you should always check the applications documentation how to configure the datasource access. There might be some details missing, so that you must include configuration details of the connected datasource to provide the correct data.
Attention: There will be no warning or error message if you configure a subscription to datapoints which are not available. If the application does not get the subscribed data messages, you might get information in the log files of the data providing application. Provided databus messages could include confidential data. Please refer to the documentation of the datasource providing application to get known of the details. If available data includes confidential information, verify that you only subscribe trusted consuming applications to this data. If the installed application is not trusted, remove the subsctiption for confidential message id’s out of the subscription-service configuration.
Attention: It is the operator’s responsibility to verify all data access for his setup!
Handling wildcards¶
If a subscription needs specific enviroment configuration which are only known at configuration time, the metaconfig of the application might use wildcards to help you configuring. Depending on the application, wildcards can be specified directly in the datasourceConfig object or in the application documentation. See the two examples below.
example:
{
"datasourceConfig": {
"wildcards": [
{
"key": "$id",
"description": "array index of the parameter"
}
]
},
"requiredDatasource": [
{
"services": {
"subscription-service/v1": {
"subscriptions": [
{
"datapoints": [
{
"address": "CTRL_DATAPOINT($id)",
"description": "configure one datapoint for each required ID"
}]
}]
}
}
}
]
}
Any questions left?
Except where otherwise noted, content on this site is licensed under the The Siemens Inner Source License - 1.1.