TN 041: How to Configure AVEVA PI Drivers in Dream Report 2020x, 2023x

This document describes the software and configuration requirements in order to connect Dream Report to AVEVA (OSI) PI. This document is applicable to Dream Report versions 2020x, 2023.x

Dream Report has a set of drivers to connect to AVEVA PI:

Open

These drivers are used as in the following scenarios:

PI Asset Framework Drivers (Historical and Real-Time),
PI Asset Framework (SDK v2018 SP3) Drivers (Historical and Real-Time)

1. The Asset Framework Client and the PI SDK must be installed on both PI and Dream Report servers.
   The Asset Framework drivers (Historical and Real-Time) are applicable for systems using AF Client 2017 SP2.
   The PI Asset Framework (SDK v2018 SP3) drivers (Historical and Real-Time) are applicable for systems with AF Client 2018 SP3 and later.
   
   

   In Dream Report version through 2020 R2 SP1, on the Dream Report machine, the only supported version of AF Client is 2017 SP2.
   This version can be downloaded from this link:
   PI-AF-Client_2017-SP2_.rar
   
   

   Starting from version 2023, Dream Report supports AF Client 2018 SP3.
   Starting from version 2023 R2, Dream Report supports AF Client 2023.
   
   

2. Version 2020 R2 of Dream Report must be upgraded to at least 2020 R2 Build ID 20.1.1.165127.303.  You can download the install, using the following link:
   Dream Report 2020 R2.exe
   
   For Dream Report version 2020 R2 SP1, apply the following hotfix:
   Ods.OSIPI.AssetFramework_DR-2020-R2-SP1-16900_0726.zip

   To apply the hotfix, stop your Dream Report project, close the Studio, and paste the provided .dll files into the System folder of Dream Report (by default C:\ODS\Dream Report\System), replacing the original ones.

   You can check your version and Build ID in Dream Report Studio, Help > About Dream Report.
   
   

3. Multiple PI Historians are supported starting from PI Client 2023.
   With older versions, the driver can connect to only one PI Historian and to a default Asset Framework server in a Dream Report project.  Check this in the PI SDK and make the necessary changes if needed.  Refer to the screenshot below.
   
   

4. To collect historical data, the PI Trust protocol must be configured in the PI Data Archive and PI SDK.  Refer to the screenshot below.
   
   

5. To get data for a long time period, you will need to increase the Connection Timeout parameter in the PI SDK.  Refer to the screenshot below.

Open

PI Historical Values (Web API) Driver

The PI Historical Values (Web API) driver provides data connectivity between Dream Report and PI Historian over Web API.  The driver can connect to an Historian through an Asset Framework Server or directly to the PI Historian database.  When working in Asset Framework environment, follow the requirements in the above section.

The PI Historical Values (Web API) driver can connect to any Asset Framework servers (not only the default one) and several Historians, so it can be used in place of the Asset Framework and Asset Framework (SDK v2018 SP3) historical values drivers if upgrading to AF Clients 2023 is not possible.  However, we recommend upgrading the AF Client to version 2023 and use the Asset Framework (SDK v2018 SP3) historical values driver.

To use the PI Historical Values (Web API) driver, a PI license which allows for using Web API SDK is required.  Please contact your AVEVA PI distributor for more details.

PI Asset Framework Event Frame Historical Batches and PI Asset Framework Historical Alarms Drivers

The Asset Framework Event Frame Historical Batches and Asset Framework Historical Alarms drivers allows users to connect to PI Event Frame.  Please, follow the “PI Asset Framework Drivers (Historical and Real-Time) and PI Asset Framework (SDK v2018 SP3) Drivers (Historical and Real-Time)” section of this document. Additional information on the requirements for these drivers can be found in the “Communication Drivers“ section of the Dream Report User Manual.

PI Historical Values Driver

The PI Historical Values communication driver provides connectivity between Dream Report and Historian over the ODBC interface.  This is a legacy driver; it supports only PI ODBC version 1.2.  Newer versions are not supported, and we no longer recommend using this driver.

Most Frequently Asked Troubleshooting Questions

Q: In the Asset Framework Driver Configuration window, the Test Connection is successful, but there are no items when I’m browsing for tags in reporting objects. 

A: This could be due to a couple of things:

1. Check your Asset Framework database configuration.  To be used in Dream Report, tags must be seen as elements in the PI System Explorer.  If there are no elements defined in the database, please contact AVEVA PI documentation/support on how to add them.
   
   

   Open

   

2. Make sure the PI Trust Settings are configured properly.
   
   

Q: My tags are available in the Studio, but my report shows N/A.

A: This may be caused by:

1. Insufficient rights of the account under which the Dream Report Runtime Engine is running.  Please refer to FAQ 011 in our knowledge base:
   FAQ 011: When running my Dream Report project as a Windows Service, some things don’t work.
   
   

2. Make sure that the PI SDK is installed on the same PC where Dream Report project is located.