Updating the PI Adapter Credentials File

When using a PI Historian Connector the PI Adapter Credentials file contains the information required to connector to the target PI Instance. This file will need to be populated with information available from the customers IT department.


The PI Connector supports Kerberos and Basic Authentication. If Basic Authentication is used then the username and password must be populated in the properties file, for Kerberos Authentication these can be left blank.


Properties Name
PurposeDefault
server_url
The required URL of the PI service
 
username
The username to be used when connecting to the PI instance
 
passwordThe password to be used when connecting to the PI instance for the specified user 
max_number_query_params
The maximum number of Web Ids to retrieve in one query
100
page_size
The maximum result per page to request from PI500
summary_time_type
The Summary Time Type set request from PIAuto
retrieve_web_ids_from_pi
Whether to retrieve Web Ids from PI (will use "ALIAS" attribute from EnergySys Meter Tag objects if false - Meter Tag Object is set in the EnergySys OData Credentials file
true
force_utc_times
Indicates whether to append 'Z' to all datetimes passed to PI
false
pi_timezone
Can be set if the timezone of the PI instance is different to that of the Connector
Connectors timezone


The attached PI Adapter Credentials file must be completed for each PI Historian 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.