TN 033: How to Configure OSIsoft PI Drivers in Dream Report

Owned by Admin
Last updated: Oct 25, 2022
3 min read

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

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

  • OSIsoft PI Asset Framework historical values

  • OSIsoft PI Asset Framework real-time values

  • OSIsoft PI historical values

 

OSIsoft PI Asset Framework (Historical and Real-Time) Drivers

  1. The PI Asset Framework Client and the PI SDK must be installed on both OSI PI and Dream Report servers. 
    In version through DR 2020 R2 SP1, on the Dream Report machine, the only supported version of PI AF Client is 2017 SP2.
    This version can be downloaded using this link:
    https://www.dropbox.com/s/4jma0obc35uztzh/PI-AF-Client_2017-SP2_.rar?dl=0

    Version 2023 of Dream Report supports PI AF Client 2018 SP3.

  2. For Dream Report versions 5.x earlier than 5.0 R20-3, upgrade the product to at least 5.0 R20-3 version.  The install can be downloaded at this link:
    https://www.dropbox.com/s/eu3i7abbpzqz9fa/Dream%20Report%205.0%20R20-3.exe?dl=0

    Then, apply the following hotfix:
    https://www.dropbox.com/s/p30g5jrj901t0y6/DRV-OSISOFT-AF-DR-500-R20-3-5.16.16508.0225.zip?dl=0

    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.

    Version 2020 R2 of Dream Report must be upgraded to at least 2020 R2 Build ID 20.1.1.165127.303 (if it is different).  You can download the install, using the following link:


    For Dream Report version 2020 R2 SP1, apply the following hotfix:


    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 not supported - you can connect to only one PI Historian in a Dream Report project.

  4. OSIsoft PI Asset Framework drivers can only connect to a default Asset Framework server.  Check this in the PI SDK and make the necessary changes if needed.  Refer to the screenshot below.

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

  6. 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.

 

OSIsoft PI Historical Values Driver

The OSIsoft PI Historical Values communication driver provides connectivity between Dream Report and OSIsoft Historian over the ODBC interface.  This is a legacy driver; it supports only PI ODBC version 1.2.  Newer versions are not supported.  The preferred method to connect to a PI historian (non-Asset Framework) is to use the Dream Report OPC-HDA driver, with the PI historical data OPC server.

 

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: 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 OSISoft support on how to add them.

 

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

 A: This may be caused by 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.