Release notes

Overview

PI SQL Client contains data providers (OLE DB, ODBC and JDBC) that provide access to the PI System in a relational view, accessible through SQL queries. The providers support read-only access to asset and event data stored in the PI Asset Framework (AF). The data model is similar to the current PI OLEDB Enterprise product with some important differences.

PI SQL Client represents a new implementation of query processing. It is designed to be highly performant and scalable while minimizing the impact on system resources. The actual SQL processing takes place in a server component called PI SQL Data Access Server (RTQP Engine).

About Developer Technologies

Developer Technologies are designed to support implementation of custom applications on top of the PI System, as well as integration of PI System data with other applications and business systems such as Microsoft Office or SQL Server, Enterprise Resource Planning systems (ERPs), Web portals, and maintenance systems, to name just a few.

Developer Technologies cover a wide range of use cases in various environments, programming languages, operating systems and infrastructures. Products include:

• SQL-based data access (PI SQL Client, PI OLEDB Provider, PI OLEDB Enterprise, PI JDBC Driver and PI ODBC Driver)

• Service-oriented architecture (PI Web API)

• Programmatic access (PI AF SDK)

Developer Technologies products are available for download from the Technical Support website at no charge. You can develop applications using the Developer Technologies tools and your PI Server. If you do not have access to a PI Server, you can obtain development licenses for the PI Server through membership in the PI Developers Club. For details, see PI Developers Club FAQ.

Deployment of an application into production requires a PI System Access (PSA) license. This runtime license enables end users to access PI System data, including time series data in PI Data Archive and asset metadata in PI AF Server, using any of the Developer Technologies. For more information or questions, contact your Account Manager. In case of technical issues with the PSA license, contact Technical Support.

Fixes

This section lists items that were resolved or added in this release of PI SQL Client.

Enhancements

• Support for TLS 1.3 has been added to OLEDB and ODBC connections when using the Https/Soap protocol. Note that the Windows version also needs to support TLS 1.3 (server and client side). Currently that means using Windows Server 2022 and/or Windows 11.

• Available UOMs have been supported via drop-down list in the GetSummaries/GetSummary wizard.

• When entering a query in PI SQL Commander, the available aliases are listed in code completion.

Known issues

This section lists problems and enhancements that have been deferred until a future release.

Operating systems

PI SQL Client is supported on

• Windows 8.1

• Windows 10

• Windows 11

• Windows Server 2012

• Windows Server 2012 R2

• Windows Server 2016

• Windows Server 2019

• Windows Server 2022

Both 32-bit and 64-bit versions are provided.

The software requires some Microsoft operating system components such as the Microsoft

.NET Framework and Microsoft run-time libraries. These components are included in the installation kit.

Server platforms

This release supports OLEDB and ODBC connections to PI AF Server 2018 and later. JDBC connections require PI AF Server 2018 SP2 and later.

Distribution kit files

The PI SQL Client setup kit (PI SQL Client_2021_.exe) consists of the following files:

Install and upgrade PI SQL Client

On Windows, PI SQL Client is installed via setup kit. It installs or upgrades the PI SQL Client OLEDB provider, the PI SQL Client ODBC and JDBC drivers.

The PI SQL Client installation kit includes PI SQL Commander Lite, which can be used to configure and test connections to AF databases, and to develop SQL queries. Previous versions of PI SQL Commander Lite are automatically upgraded.

The PI SQL Client JDBC driver supports multiple platforms. For non-Windows platforms a separate installation kit is provided.

Installation instructions are in the PI SQL Client Administrator Guides.

Uninstall PI SQL Client

Instructions for uninstalling PI SQL Client are in the PI SQL Client Administrator Guides.

AVEVA's commitment

Because the PI System often serves as a barrier protecting control system networks and mission-critical infrastructure assets, we are committed to (1) delivering a high-quality product and (2) communicating clearly what security issues have been addressed. This release of PI SQL Client is the highest-quality and most secure version of the PI SQL Client released to date. Our commitment to improving the PI System is ongoing, and each future version should raise the quality and security bar even further.

Vulnerability communication

The practice of publicly disclosing internally discovered vulnerabilities is consistent with the Common Industrial Control System Vulnerability Disclosure Framework developed by the Industrial Control Systems Joint Working Group (ICSJWG). Despite the increased risk posed by greater transparency, we are sharing this information to help you make an informed decision about when to upgrade to ensure your PI System has the best available protection.

For more information, refer to our Ethical Disclosure policy: https://www.osisoft.com/ethical-disclosure-policy/.

To report a security vulnerability, refer to: https://www.osisoft.com/report-a-security-vulnerability/.

Vulnerability scoring

We selected the Common Vulnerability Scoring System (CVSS) to quantify the severity of security vulnerabilities for disclosure. To calculate the CVSS scores, we use the National Vulnerability Database (NVD) calculator maintained by the National Institute of Standards and Technology (NIST). We use Critical, High, Medium and Low categories to aggregate the CVSS Base scores. This removes some of the opinion-related errors of CVSS scoring. As noted in the CVSS specification, Base scores range from 0 for the lowest severity to 10 for the highest severity.

Overview of fixed or mitigated vulnerabilities

This section is intended to provide relevant security-related information to guide your installation or upgrade decisions. We proactively disclose aggregate information about the number and severity of PI SQL Client security vulnerabilities that are fixed in this release.

No security-related information is applicable to this release.

Documentation overview

PI SQL Client OLEDB Administrator Guide:

Product description, installation and configuration instructions, and troubleshooting guidelines.

PI SQL Client ODBC Administrator Guide:

Product description, installation and configuration instructions, and troubleshooting guidelines.

PI SQL Client JDBC Administrator Guide:

Product description, installation and configuration instructions, and troubleshooting guidelines.

SQL for RTQP Engine Reference Guide:

For supported SQL statements consult the reference guide of the connected AF Server version.

PI SQL Commander Lite Help:

Working with PI SQL Commander Lite and generating custom TVFs and function tables.

Samples, tutorials and additional development support are provided through the user community, PI Square.

For technical assistance, contact Technical Support at +1 510-297-5828 or log a case through the Customer Portal. Additionally, the Contact Us page on the portal offers contact options for customers outside of the United States.

When you contact Technical Support, be prepared to provide this information:

• Product name, version, and build numbers

• Computer platform (CPU type, operating system, and version number)

• Time that the difficulty started

• Log files at that time

• Details of any environment changes prior to the start of the issue

• Summary of the issue, including any relevant log files during the time the issue occurred

The PI Square community has resources to help you with your technical questions. PI Developers Club program offers specific services to developers and system integrators.