EnergySys Historian Connector
The Historian Connector runs as a standalone service on a Windows machine and the UI is accessed via a web browser.
The available screens allow users with appropriate roles to configure, schedule and monitor queries.
Event Log Screen
The Event Log screen shows a record of any job executions and other system events, such as errors that have occurred while the system is running. (Events older than 30 days will automatically delete).
Entries are colour coded Red/Green/Amber to help visualise the system status. Each entry has the following information:
Selecting a row will show a popup with more information of the event (Job execution results, error message, etc.) The pagination controls at the top and bottom of the table can be used to view previous Events or show more Events per page.
Tag Queries Screen
The Tag Queries screen shows all defined Tag Queries available and allows for editing, creating or deleting.
Tag Query Fields:
| Screen column | Description |
| Name | The Display Name of the Tag Query when shown in the Scheduled Job screens |
| Tag List | The target Tag List from EnergySys (Auto populated from the EnergySys Service) |
| From Date | The From Date of the query. Can be a calendar picker, free text (dd/MM/yyyy HH:MM) or a selection from the drop down list (Now, Today or Yesterday) |
| From Time | The From Time of the query. Can be selected with a time picker or free text entered in HH:MM format. If left blank, then it is assumed to be midnight. If From Date is set to Now or left blank, then this field will be ignored |
| To Date | The To Date of the query. Can be a calendar picker, free text (dd/MM/yyyy HH:MM) or a selection from the drop down list (Now, Today or Yesterday) |
| To Time | The To Time of the query. Can be selected with a time picker or free text entered in HH:MM format. If left blank, then it is assumed to be 23:59:59 and 999 milliseconds. If To Date is set to Now or left blank, then this field will be ignored |
Editing, creating or deleting:
| Buttons | Description |
| Edit a Tag Query (pencil icon) | Click on the pencil icon in the right-hand column of the one you wish to edit, this will make the row editable |
| Add a Tag Query (link) | Click the link underneath the main Tag Query table, this will add a new editable row with all fields blank or set to default values in the case of drop down lists |
| Delete a Tag Query (trash can icon) | Click the trash can icon in the right-hand column of the one wish to delete |
PI Connectors
Historian Connectors connecting to OSIsoft PI have the following additional fields for Tag Queries:
| Screen column | Description |
| Query Type | A drop down list for the type of reading being retrieved from the Historian |
| Interval (minutes) | The time between reading aggregates in minutes |
| Summary Type | A drop down list for the type of summary data to be retrieved. This will be ignored unless an interval and From Date/Time are also set |
IP21 Connectors
Historian Connectors connecting to IP21 have the following additional fields for Tag Queries:
| Screen column | Description |
| Query Type | the type of reading being retrieved from the Historian (Current Value, Raw Value, TW Average, etc.) |
| Interval (seconds) | the time between reading aggregates in seconds |
PHD Connectors
Historian Connectors connecting to PHD Historians have the following additional fields for Tag Queries:
| Screen column | Description |
| Query Type | A drop down list for the type of reading being retrieved from the Historian (Raw Data, Interpolated or Reduction) |
| Interval (minutes) | The time between reading aggregates in minutes |
| Reduction Type | A drop down list of the type of reduction data to retrieve
|
Preview a Tag Query
Any user can preview the execution of a Tag Query. This will retrieve data from the historian and create a spreadsheet but will not push it to the EnergySys Service.
To preview a Tag Query, click the eye icon in the right-hand column of the one you wish to execute. This will show a feedback pop up displaying the retrieved data, any warnings related to missing tags, any notifications relating to the retrieved data and where the results spreadsheet file was saved.
Scheduled Jobs
The Scheduled Jobs screen shows the current list of Queries that are scheduled to run automatically.
A Scheduled Job will retrieve readings from the Database system using its Query, generate a spreadsheet of the results and submit the file to the EnergySys System for processing.
The Scheduled Jobs screen allows the editing, creating, suspending and manual execution of these scheduled Queries.
Scheduled Job Fields:
| Screen column | Description |
| Name | the name of the job when it is executed and appears in the Event Log screen |
| Tag Query | the Tag Query to execute. Auto populated with the names from the Tag Query screen |
| Start Date | The date and time from which this job will start running. Can be a calendar picker or free text (dd/MM/yyyy HH:MM). Jobs will not execute until the start date is reached. A job entered with a start date in the past will not execute right away. The first execution will be calculated based on the value of this date and the Repeat Every field. If left blank the the start date is assumed to be the current time |
| End Date (optional) | the date and time from when this job will stop running. Can be a calendar picker or free text (dd/MM/yyyy HH:MM). If left blank than the job will run indefinitely |
| Repeat Every | the repeat schedule of this job. Comprised of a free text number field and a drop down of Minutes/Hours/Days/Weeks/Months. This field and the Start Date will determine when the job runs |
| Is Active | a tick box determining if the job is active. If active, the job will be scheduled to run automatically at the next calculated time. If not active, the job will not run automatically. |
The Scheduled Jobs screen allows the editing, creating, suspending and manual execution of these scheduled Queries:
| Buttons | Description |
| Edit a Scheduled Job (pencil icon) | Click on the pencil icon in the right-hand column of the one you wish to edit, this will make the row editable |
| Add a Scheduled Job (link) | Click the link underneath the main Scheduled Jobs table, this will add a new row with blank fields or default values set in the case of drop down lists |
| Delete a Scheduled Job (trash can icon) | Click the Trash Can icon in the right-hand column. Only users with Admin or Configurator roles can delete Scheduled Jobs |
| Manually run a Scheduled Job | click the Play icon in the right-hand column. A small popup showing if the job was executed successfully will be shown and an entry added to the Event Log screen. Manually running a Scheduled Job does not affect the scheduled and job will continue to run at their scheduled time |
If a Scheduled Job was not run for any reason it can be manually re-ran. To manually rerun a job, select the Fast Forward icon in the right-hand column. A popup dialog will be shown asking for a From and To date/time for which you wish to re-run the job for. Selecting the OK button will rerun the job for any time it was scheduled to run between the two entered date/times. Only From and To date/times that fall between the Start and End date of the Selected Job will be accepted.
Rerun Jobs will run as if they were running at the time they were originally scheduled to run. Any From and To dates in the Tag Query that were set to "Today", "Yesterday", etc. will be set to the correct dates for when it was scheduled. A popup showing if the rerun was successfully requested will be shown and an entry will be added to the Event Log screen for the request. The rerun jobs will run in the background and an entry will be added to the Event Log screen for each job.
When a job runs an entry will be added to the Event Log screen detailing the result of the job.
System Restarts
If the Connector is restarted, then the next run time of all Scheduled Jobs are recalculated. Any jobs that were scheduled to run while the Connector was stopped will be missed and not run until the following scheduled time. Any critical jobs should be ran manually after the Connector starts back up.