Introduction

AF SDK (Asset Framework software development kit) is a .NET-based library that provides access to data stored in the PI System. Using AF SDK you can access:

• Hierarchically structured assets and their properties and relationships

• Time-series data from PI Data Archive and other sources

• Event frames that record and contextualize process events

• Data Archive, PI points, and point data

The information in this Getting Started Guide covers basic usage of AF SDK. AF SDK is one of the available developer technologies that can help you maximize the utility of your PI System.

It is recommended that you have a background in .NET application development using C# and a familiarity with the PI System; however, familiarity with AF SDK is not required.

PI developers should also consider becoming familiar with PI SQL Framework, PI Web API, or PI Builder before contemplating development with AF SDK. While AF SDK is powerful and is required in many cases, using it effectively in a complex application is easier if you already have an understanding of PI SQL or PI Web API.

When developing applications for the PI System, you have several options from which to choose, including any of the family of products that make up PI SQL Framework, PI Web API, or AF SDK. However, for best performance from your application, AF SDK has the greatest potential of all of the products in the PI System Access suite.

AF SDK provides a comprehensive, Windows-based programmatic interface to the PI System. It provides an object-oriented approach to interacting with AF structures and data, as well as the PI Data Archive directly.

There are many reasons you might choose to develop software using AF SDK:

• You can quickly build out complex PI AF hierarchies with AF SDK. Many OSIsoft partners prefer to build AF hierarchies this way, rather than use the PI AF Builder plugin to Microsoft Excel.

• AF SDK is well suited to developing middleware applications which are situated between the PI System and other systems. AF SDK gives you flexibility about how to integrate other systems with the PI System, and allows you to do so in the most resource efficient way possible. It is also possible to automate element generation and synchronization between PI AF and other systems.

• You have the ability to create rich and customized client applications with AF SDK. Most client applications that make up the PI Visualization Suite were developed using AF SDK and its predecessors.

AF SDK is designed for use with Microsoft .NET languages such as Visual Basic .NET, C#, and Managed C++. The computer you use for software development and the computer that will eventually run applications developed with AF SDK must have Microsoft .NET Framework 4.0 installed. Note that Microsoft .NET is installed automatically by the PI System Explorer installation program if it is not already installed on your computer.