Skip to content

parameter-service/v1

Configuration

Path: datasourceConfig >> [required/provided]Datasource >> services >> parameter-service/v1

Type: object

Usage:

The parameter-service enables applications to read and write data on a connected datasource. Unless this service has the possibillity to impact a connected datasource, the datasource providing application has the possibillity to enable access protection. This means, that all datapoints which are not stated in the requiredDatasource section of the consuming application will be forbidden and access will be rejected. Please review the documentation of the corresponding application, how the access has to be configured.

Attention: It is the operator’s responsibility to verify all data access for his setup!

Attention: Allowing writing access to parameters might be a security risk for connected datasources - such like a SINUMERIK machine.

Attention: Always refer to the application documentation to get details about the configuration needs of the specific application.

Example Sample configuration for write can be found below. 

{
    "datasourceConfig": {
      "requiredDatasource" : [
        {
          "datasourceId" : "SINUMERIK_NCU1",
          "services" : {
            "parameter-service/v1" : {
              "access" : [
                {
                  "accessType" : "w",
                  "datapoints" : [
                    {
                      "address" : "/NC/"
                    }
                  ]
                }
              ]
            }
          },
          "type" : "SINUMERIK"
        }
      ]
    }
}

In the configuration above, user can write data to variables starts with "/NC/" for parameter service in "datasourceId" with "SINUMERIK_NCU1" and data source type as "SINUMERIK".

Any questions left?

Ask the community

Except where otherwise noted, content on this site is licensed under the The Siemens Inner Source License - 1.1.