Updating the EnergySys OData Credentials File
The esys-OData Credentials File is required on any Connector that looks to get information from the Energysys instance in order to be able to perform the Connector Requests. In the case of PI, IP21 and PHD this is required to get the list of tags that are to be queried. For the Measurement Connector this is only required if Remote Execution is to be configured.
| Properties Name | Purpose | Default |
| service_url | The required URL of the OData Service for the EnergySys Instance | No default but this is a required value to be specified - See note below. |
| tag_list_object_name* | Specified the object in the EnergySys instance that contains the list of tags to be queried. Required for PI, IP21 and PHD Connectors. | PR_METER_LIST_MEMBER |
| asset_timezone_override | Specifies the EnergySys Instances Timezone. If not set will attempt to retrieve the Timezone from the ES_ASSET object of the EnergySys instance, if this cannot be retrieved (due to permissions in EnergySys) will default to UTC. | defaults to UTC |
| max_records_per_page | The maximum number of OData records to receive per request | 5,000 |
| tag_list_timeout | The time (in seconds) that the Connector will wait to receive an updated Tag List from the EnergySys instance. If none is received it will use the cached tag list (if available) | 30 seconds |
| tag_cache_check_timeout | The time (in minutes) to periodically clear cache of unused tag lists | 30 minutes |
| tag_list_replace_pipe_with_slash | Whether to automatically change '|' characters to '\' when retrieving meter names from Energysys. If meter names held within EnergySys contain '/' it is required that the webID should be stored with the Meter in the EnergySys object | false |
| remote_query_execution_enabled | Indicator if remote execution queries are to be checked for. Only applicable to Measurement connectors. | false |
| remote_query_execution_object_name | The name of the EnergySys Object that contains records for Remote Query Executions | EU_REMOTE_QUERY_EXEC |
| remote_query_execution_connector_name | The identifier of this connector when querying for remote executions on EnergySys Foundation (required If remote_query_execution_enabled is set to true) | connector |
| remote_query_execution_check_interval_mins | The interval (in minutes) between calls to check for remote query executions. The minimum allowed value is 1 | 1 minute |
*The tag_list_object_name requires the system name of an Object (the object can be virtual) in EnergySys that will be queried to retrieve the Meter Tag Lists' members. These tags will then be submitted to the Historian connector.
The Object must contain the following attributes with matching system names:
- NAME: name of the Meter Tag List
- METER: name of the Tag to retrieve
- ALIAS (optional): alias of the Tag to retrieve (e.g. the WebID in PI WebAPI)
Setting the value of the Service URL
The Service URL needs to be entered into the esys-OData credentials file and be determined from the OData URL of the target EnergySys instance. From the Instance Details screen of your EnergySys instance you can get the OData URL (Configuration > System > Instance Details)
Copy the OData URL and update to insert api. after https:// and also to change /odata/ to /odata-cert/.
https://test.eu1.energysys.com/odata/resource.svc/09DD44A6CE161AFEE0540208203946CB
becomes
https://api.test.eu1.energysys.com/odata-cert/resource.svc/09DD44A6CE161AFEE0540208203946CB
The attached EnergySys Odata Credentials file must be completed for each Connector installation.
Changes to the credentials file must be imported into the Connector on the Manage Credentials screen and will need an Administrative account in order to perform this action. As soon as the properties file is uploaded it become active for use in the Connector.