×

Supercharge your Proficy solution! Download a free trial of Proficy Operations Hub, CSense analytics, and more. Explore our Proficy 2024 releases!

Home
Service Interfaces
Workflow Methods
IEquipmentHistorian
IEquipmentHistorian allows you to read from and write to Historian tags.
ReadHistoricalValue (IEquipmentHistorian)
Retrieves historical data from the Historian tag associated with the specified equipment property.

Workflow IPI
Get Started
Tutorials
Orientation
Configure Your Environment
Security
Resource Information and Configuration
Data Administration
Forms and User Displays
Building and Configuring Workflows
eSOP
ActiveX Task Controls
Service Interfaces
- Service Interfaces
- Workflow Methods
  - Workflow Methods
    Workflow provides a set of core service interfaces and call methods for you to use when creating a workflow. This section describes these core service interfaces and the associated call methods.
  - IArchiveManagement
    IArchiveManagement allows you to create an archive file and select the data to include.
  - IAuditTrail
    IAuditTrail allows you to write entries to the audit trail.
  - IDatabaseService
    IDatabaseService provides access to relational data, such as databases.
  - IDirectorySearch
    IDirectorySearch allows you to search the Directory of Resources for a set of resources based on a search query, or for a list of resources based on a resource class.
  - IEmailService
    You can use IEmailService to send emails as part of a workflow process.
  - IEquipment
    IEquipment allows you to read from and write to the Equipment model.
  - IEquipmentConfig
    IEquipmentConfig provides methods for configuring the equipment model.
  - IEquipmentHistorian
    IEquipmentHistorian allows you to read from and write to Historian tags.
    - GetHistorianTagAttributes (IEquipmentHistorian)
      Retrieves the attributes of the Historian tag associated with the specified equipment property.
    - IsHistorianProperty (IEquipmentHistorian)
      Verifies whether the selected property is associated with an Historian tag.
    - ReadHistoricalValue (IEquipmentHistorian)
      Retrieves historical data from the Historian tag associated with the specified equipment property.
    - SetHistorianTagAttributes (IEquipmentHistorian)
      Configures the Historian tag attributes for the specified equipment property.
    - SetHistorianTagValue (IEquipmentHistorian)
      Configures the value of the Historian tag associated with the specified equipment property.
  - IEvent
    IEventManager allows you to read from the Event model and to create an event subscription for a specific event resource.
  - IExtensionData
    IExtensionData allows you to access temporary workflow data that was previously stored in a system repository. This stored data can be associated with both internal and external systems.
  - IITService
    IITService allows you to read from the Proficy System model.
  - ILicense
    The ILicense service method provides access to active licensing information.
  - IMaterial
    IMaterial allows you to read from and write to the Material model.
  - IOpcClient
    IOpcClient allows you to read from the OPC Client model.
  - IOpcUa
    IOpcUa allows you to read from the OPC UA model.
  - IPersonnel
    IPersonnel allows you to read from and write to the Personnel model.
  - IProductionModel
    IProductionModel allows you to read from or write to the Production model.
  - IProductionReport
    IProductionReport allows you to read from the Production model.
  - IProductionRuntime
    The IProductionRuntime service interface relates to production oversight.
  - IProficyHistorian
    IProficyHistorian allows you to manage Historian servers, including reading from and writing to Historian collectors and tags.
  - IPropertyGroup
    IPropertyGroup allows you to read from or write to the properties of a resource.
  - IResourceLinking
    IResourceLinking allows you to work with resource links for all types of resources. You can start, edit, end, and query links between resources in your system.
- iFix Service Provider
Operator Task List in the Workflow Client
Best Practices

ReadHistoricalValue (IEquipmentHistorian)

Retrieves historical data from the Historian tag associated with the specified equipment property.

Inputs	Data Type	Description
calculationMode	HistorianCalculationModes	Specifies the Historian calculation mode to use to filter the data to retrieve.
direction	HistorianDirection	Specifies the Historian direction to use to filter the data to retrieve.
endTime	DateTime	Specifies the end time to use to filter the data to retrieve.
equipmentAddress	DirectoryResosurce	Specifies the equipment instance that owns the property you want to retrieve historical data from. Note: In the Configure Method dialog box, click Next to select a resource. Otherwise, in the Inputs section of the activity configuration panel, click the ellipsis button to select a resource.
interval	UInt32	Specifies the number of intervals within the specified start and end times to use to filter the data to retrieve.
numberOfSamples	UInt32	Specifies the number of data samples you want to retrieve within the specified start and end times.
propertyName	String	Specifies the property you want to retrieve historical data from.
samplingMode	HistorianSamplingModes	Specifies the Historian sampling mode to use to filter the data to retrieve.
startTime	DateTime	Specifies the start time to use to filter the data to retrieve.

Outputs	Description
ProcessValue[]		Returns the historical data for the specified equipment property.