...
- Name (string, mandatory): it is the key that identifies the resource within the data point definitions. The name can freely be chosen but has to be unique.
- Type (enum, mandatory): type of encoding. Currently, XML, JSON, URL encoded and Text is available.
- Resource (string, mandatory): it defines the content that is excepted at the HTTP server. The structure and type depends on the used encoding and on the direction (polling or update). A detailed description as well as some examples can be found here.
xio.HTTP.DatapointDefinitions.dat
...
Name (string, mandatory): defines the name of the data point. In combination with path, it has to be unique.
Path (string, optional, default ""): defines the structure that is used to represent the data points. In combination within name, it must be unique.
Data type (enum, optional, default "STRING"): defines the type of the data point. Allowed values are: BOOL,STR,BYTE,CHAR,INT8,UINT8,INT16,UINT16,INT32,UINT32,INT64,UINT64,FLOAT,DOUBLE,DATE,TIME
Access mode (enum, optional, default "R"): defines the access rights of the data point. Allowed values are R (read-only), W (write-only), RW (read and writable).
Polling Url (string, optional, default ""): here the URL is specified with is used to retrieve the data point values. The server makes polling using HTTP GET requests to this URL. If empty, polling is not available.
Polling interval (ms) (number, optional, default "5000"): here the polling interval in milliseconds is specified.
Polling Resource (string, optional, default ""): here the resource that is used for polling is specified. It must match with the name that is used in the xio.HTTP.ResourceDefinitions.
Polling Parameters (string, optional, default ""): here a list of parameters that are used to replace the placeholders within the polling resource ({0}, {1}, ...) can be defined. The parameters have to be separated by comma ,
Update Url (string, optional, default ""): here the URL is specified with is used to update the data point values. The server makes HTTP PUT, POST or POST GET requests to this URL. If empty, updating the values is not possible.
Update Method (enum, optional, default "POST"): here the web update request method is specified. Allowed values are "POST" and "PUT".
Update Resource (string, optional, default ""): here the resource that is used for updating is specified. It must match with the name that is used in the xio.HTTP.ResourceDefinitions.
Update Parameters (string, optional, default ""): here a list of parameters that are used to replace the placeholders within the update resource ({0}, {1}, ...) can be defined. The parameters have to be separated by comma ,
Persistent (bool. optional, default "F"): if enabled, the last data point value is restored after server start up.
Historical (bool. optional, default "F") ( NETx BMS Server 2.0 only): if enabled, all data point changes are stored within the SQL database.
Synchronize (bool. optional, default "T"): if enabled, the value is synchronized with the backup server if used.
...
- Polling: for getting data point values out of a JSON document, a JPath expression has to be specified. This JPath expression is used to select a JPath element and its content. More information about JPath can be found here.
- Updating: for updating a data point value, the JSON fragment that is expected by the HTTP server has to be specified. This JSON fragment must contain the "ValueTag" (specified within xio.http.cfg, default @value@).
URL encoded
URL encoded can be used to send value via URL parameters. URL encoded is only available for updating resources. The resource definition must be as follows:
- Polling: Not allowed
- Updating: for updating a data point value, URL parameters string must be provided. It will be appended to the the update URL and must have the form: "<parameter1 name>=<parameter1 value>&<parameter2 name>=<parameter2 value>&..."This JSON fragment must contain the "ValueTag" (specified within xio.http.cfg, default @value@).
...