The Historian Connector retrieves time-series data from supported data historian systems and transfers it to the platform for processing. It runs as a Windows service and includes a web-based interface for configuring tag queries, scheduling jobs, and monitoring activity.

Three historian systems are supported: PI, IP21, and PHD. Each has a dedicated installer and its own credential file. The connector interface and scheduling behaviour are the same across all three — only the query types and credential properties differ.

Connector interface

The interface is accessed through a web browser. It displays the current system time and time zone used by the connector, which may differ from the local time of the machine running the browser.

Event log

The Event Log records all connector activity. Each entry shows the job or event description, execution result (success, failure, warning, or exception), a summary message, timestamp, and duration. Events are colour-coded by status. Older entries are automatically removed after a defined retention period. Selecting an entry shows additional detail including any error messages.

Tag queries

The Tag Queries screen displays the configured queries used to retrieve data from the historian. Each query defines a name, the tag list used to map retrieved data, and the from/to date-time window for retrieval. Date values can be entered manually or selected from options such as Now, Today, or Yesterday.

Queries can be previewed before scheduling. A preview retrieves data and generates a spreadsheet for inspection without submitting anything to the platform.

PI query options

Query Type — the type of reading to retrieve (GetValuesAdHoc, GetRecordedAdHoc, GetInterpolatedAdHoc, GetSummariesAdHoc)
Interval (minutes) — aggregation interval
Summary Type — the type of summary calculation applied to values

PI uses the PI Web API. Authentication supports Kerberos (no credentials required in the file) or Basic (username and password required).

IP21 query options

Query Type — CurrentValue, Raw, TWAvg, Min, Max, Sample-Interpolated, Sample-Stepped, and several nearest-good-data-point variants
Interval (seconds) — time interval between aggregated readings

Most query types use the IP21 TagDataAdvanced function.

PHD query options

Query Type — Raw Data, Interpolated
Interval (minutes) — aggregation interval
Reduction Type — the type of calculated value returned (average, minimum, maximum, delta, or regression results)

Scheduled jobs

The Scheduled Jobs screen shows queries configured to run automatically. When a job runs, the connector executes the tag query, generates a results file, and submits it to the platform. Each job has a name, tag query, start date, optional end date, repeat interval (configurable in minutes, hours, days, weeks, or months), and an active/inactive toggle.

Jobs can be executed manually at any time without affecting the configured schedule.

If a job was missed or needs reprocessing, it can be rerun manually for a selected time range. The connector executes the job for each scheduled time within the range, adjusting date parameters to match the original execution time.

If the connector service restarts, all scheduled jobs recalculate their next execution time. Jobs scheduled during downtime do not run automatically and must be executed manually if the missed data is required.

Credential files

Each historian type requires its own credentials file. These are uploaded via the Manage Credentials screen in the connector interface.

PI (pi-adaptor-credentials.properties)

Property	Description	Default
`server_url`	URL of the PI Web API service	—
`username`	Username for Basic Authentication (leave blank for Kerberos)	—
`password`	Password for Basic Authentication (leave blank for Kerberos)	—
`max_number_query_params`	Maximum tags per query request	100
`page_size`	Maximum results per response	500
`summary_time_type`	Summary time type for aggregated values	Auto
`retrieve_web_ids_from_pi`	Whether to retrieve tag identifiers from PI directly	true
`force_utc_times`	Whether to convert timestamps to UTC before sending to PI	false
`pi_timezone`	Timezone of the PI system if different from connector timezone	Connector timezone

IP21 (ip21-adaptor-credentials.properties)

Property	Description	Default
`server_url`	URL of the IP21 service	—
`username`	Username for authentication	—
`password`	Password	—
`max_number_query_params`	Maximum tags per query request	100
`query_well_data_function_name`	Function used to retrieve well data	WS_ENGSYS_WellDataV5
`query_meter_data_function_name`	Function used to retrieve tag data	WS_TagDataAdvanced

PHD (phd-adaptor-credentials.properties)

Property	Description	Default
`username`	Username for authentication with the PHD instance	—
`password`	Password associated with the username	—
`host`	Hostname or address of the PHD service	—
`port`	Network port used by the PHD service	—
`ignore_outliers`	Whether to ignore additional readings returned during reduction queries	false
`retrieve_tag_nos_from_phd`	Whether to retrieve tag identifiers directly from PHD; if disabled, identifiers from platform configuration are used	false
`phd_timezone`	Timezone of the PHD system if different from the connector server timezone	Connector server timezone