Configuring the Proficy Historian Source block

Requirements

This block requires the installation of the Proficy Historian Client SDK on the CSense machine. You have the option to select between Proficy Historian OLE DB Provider or Proficy Historian User API while connecting. Both the options are provided by installing the Proficy Historian Client SDK.

Properties

Connection

The data source provider for this Proficy Historian.  

Click here for an example on setting up a Data Link source to Proficy Historian.

Sampling mode

The mode of sampling data from the archive.

Select one of the following sampling modes that is available for the execution mode you want to use:

Sampling Mode

Available in Historical Execution Mode?

Available in Real-time Execution Mode?

Calculated Available.   The calculation is performed over the data window specified in this property page by the Window Begin Time and Window End Time. Available.   The calculation is performed over the data window that extends from the current time minus the sampling interval to the current time.
Interpolated Available. Not available.
Current Value Not available. Available.
Lab Available. Not available.
Raw by Time Available. Not available.
Trend Available. Not available.

NOTE: When you select the sampling mode as Raw by Time, the retrieval returns 2000 samples at a time in batches, for the selected time window. For example, if there are 10000 samples in the selected time window, 2000 samples are returned in five batches.

Execution mode

Select one of the following execution modes:

    • Historical execution mode

This mode does not support reconnection behavior. In the event of a disconnection, blueprint execution stops.

    • Real-time execution mode

This mode supports reconnection behavior. In the event of a disconnection, execution does not stop, but the data (which remains the same as when a connection was last available) is considered "bad" quality. The system attempts every 60 seconds to re-establish a connection. On reconnecting, since this is a historian source, the execution timestamp (determined by the sampling interval) is compared with the timestamp for each field; this determines the latest available sample for the relevant field. As a result, on reconnecting, you may see that values for some fields are updated, while values for other fields remain unchanged.

Calculation mode

The calculation to use when using the Calculated Sampling Mode.

Select one of the following when using the Calculated Sampling Mode:

  • Average

  • Count

  • Maximum

  • Maximum time

  • Minimum

  • Minimum time

  • Raw average

  • Raw standard deviation

  • Raw total

  • Standard deviation

  • Time good

  • Total

Sampling period

The interval, in seconds, at which to sample data; i.e., the execution rate. This applies to Historical or Real-time execution mode. The range for this value is from 0.000001 seconds to 30 days.

Field timestamping

Specifies how the timestamp of each field is determined.

Select one of the following options:

  • Unchanged

  • Set to execute time

Import Options

Select which data to retrieve.

Select one of the following options:

  • Use only data in this time window:

    • Allows the user to specify a window start and end time for loading data. All data in the window is loaded.

  • Use the latest data available:

    • Allows the user to specify duration. All data from the current system time minus the duration is loaded.

Note: When the Raw by Time sampling mode is used together with either of these import options in Historical Execution Mode then, if there is no data point available on the window start time, a data point is returned for the window start time with the following:

    - Value: value of the last known data point prior to the window start time.

    - Quality: quality at the last known data point prior to the window start time.

    - Timestamp: window start time.

If there is no known data point prior to the window start time, a data point is returned for the window start time with the following:

    - Value: zero.

    - Quality: bad quality.

    - Timestamp: window start time.
 

Window Begin Time

For Historical execution mode, this specifies the start of the time window for the selected tags. (This property applies to only some Import_Options.)

Window End Time

For Historical execution mode, this specifies the end of the time window for the selected tags. (This property applies to only some Import_Options.)

Duration

The duration of the data import window. (This property applies to only some Import_Options.)

Configuring Blueprint Execution Schedules

Blueprint execution rates are determined by the individual source blocks contained in a blueprint and their respective configuration options.

You can use the First execute configuration options available on most source blocks to configure the timestamp for the first execution of the blueprint. For more information, see Configuring Blueprint Execution Schedules.

Select Tab

Select the fields you want to import from the specified data set and set the data types.  

NOTE: Proficy Historian has a default limit of returning 5000 fields, so you will need to apply a filter or import a subset if the fields you are specifically requesting are not shown in the returned fields. Five data types are supported:

  • String (S)

  • Double (D)

  • Integer (I)

  • Timestamp (T)

  • Quality (Q)

Convert between these data types by selecting the required fields from the list and clicking on the conversion buttons provided. Only valid conversions are supported.

Click Refresh to update the field list if property changes have been made.

Preview Tab

Provides a sample preview of the data set as read using the currently specified properties.

Return to top


Related topics:

  

CSense 2023- Last updated: June 24,2025