OSI PI Adapter Sample

Contents

Prerequisites
Sample Overview
This Sample's Files
Running This Sample in StreamBase Studio
Importing This Sample into StreamBase Studio
Sample Location

This topic describes the use of the OSI PI Adapter suite in a sample application to query and update data in a PI server. For more information about this operator, see OSIsoft PI Adapters.

Prerequisites

In order run correctly, the adapters require that the OSIsoft PI Asset Framework (AF) Client version 2016 R2 or later and the OISsoft PI SDK version 2014 R2 or later be installed on development and deployment machines that are expected to run StreamBase applications that call these adapters. The OSIsoft software can be obtained from OSIsoft.

When you install and configure the OSIsoft software, you establish a set of defaults for server name, user name, password; those defaults are used if not explicitly defined in the adapter properties.

Sample Overview

This sample includes all six different adapters in the OSI PI adapter suite:

  • Snapshot

  • Write

  • Summaries

  • DataPipe

  • AF

  • Event Frames

Each adapter connects a .NET Operator which loads a .NET class called DotNETOperatorSample.DotNETSample from an assembly located in the .\DotNETCode\bin\Release subdirectory of the project. This class has been written to extend StreamBase's StreamBase.SB.Operator class, and is invoked whenever a tuple is received by the operator. The .NET class then processes the tuple (using the StreamBase .NET Client API facilities) and sends another tuple to the operator which is emitted to its output port. In this sample the processing performed by the .NET class is simple: the tuple's intValue value is squared and set in the output tuple's field named answer.

This Sample's Files

This sample has the following files:

  • The sample EventFlow application, OsiPiSample.sbapp.

  • This Readme file, in plain text and HTML formats.

Running This Sample in StreamBase Studio

The steps to run this sample in Studio are as follows:

  1. In the Package Explorer, double-click to open the OsiPiSample.sbapp application.

  2. Make sure each adapter's server tab uses the correct values for your PI and PI AF installations.

  3. Make sure the application is the currently active tab in the EventFlow Editor, then click the Run button. This opens the SB Test/Debug perspective and starts the application. All the adapters are configured to connect to the PI server at startup.

  4. In the Manual Input view, select the SnapshotQuery input stream, and enter a list of tag names to query.

    Click Send Data, and observe that the output stream that received the data is the PISnapshotOutput stream, with one tuple emitted for every tag name requested. Once these tuples are emitted, one more tuple follows with its tagName field set to null, to indicate the end of the list.

  5. In the Manual Input view, select the WriteData input stream, and enter a list of tags to update.

    Click Send Data, and observe that the output stream that received the data is the PIWriteOutput stream. The tuple contains the results of the write operation for every requested tag.

  6. In the Manual Input view, select the SummariesQuery input stream, and enter a list of tag names to query, and some summary types (by setting the summaryTypes field to "minimum, maximum, average", for example).

    Click Send Data, and observe that the output stream that received the data is the SummaryOutput stream, with one tuple emitted for every tag name requested. Once these tuples are emitted, one more tuple follows with its tagName field set to null, to indicate the end of the list.

  7. In the Manual Input view, select the AFCommands input stream and set the command field to QUERY and the queryBase field to a string representing the element to query.

    Click Send Data, and observe that the output stream that received the data is the AFOutput stream, with one tuple emitted for every attribute found under the element. Once these tuples are emitted, one more tuple follows with its tagName field set to null, to indicate the end of the list.

  8. In the Manual Input view, select the EFQueries input stream and enter a value for the searchName and startTime fields, e.g. MySearch1 and *.

    Click Send Data, and observe that the output stream that received the data is the EFOutput stream, with one tuple emitted for every Event Frame found by the query. Once these tuples are emitted, one more tuple follows with its evtframeID field set to null, to indicate the end of the list.

  9. In the Manual Input view, select the SnapshotQuery input stream, and enter a list of tag names to query.

    Click Send Data, and observe that the output stream that received the data is the PIOutput stream, with one tuple emitted for every tag name requested. Once these tuples are emitted, one more tuple follows with its tagName field set to null, to indicate the end of the list.

  10. When done, press F9 or click the Stop Running Application button.

Importing This Sample into StreamBase Studio

In StreamBase Studio, import this sample with the following steps:

  • From the top menu, select File → Load StreamBase Sample.

  • Select OSI PI from the StreamBase Messaging Adapters category.

  • Click OK.

StreamBase Studio creates a project for the OSI PI adapter sample in your current Studio workspace.

Sample Location

When you load the sample into StreamBase Studio, Studio copies the sample project's files to your Studio workspace, which is normally part of your home directory, with full access rights.

Important

Load this sample in StreamBase Studio, and thereafter use the Studio workspace copy of the sample to run and test it, even when running from the command prompt.

Using the workspace copy of the sample avoids the permission problems that can occur when trying to work with the initially installed location of the sample. The default workspace location for this sample is: 

studio-workspace/sample_osipi

See Default Installation Directories for the location of studio-workspace on your system.

In the default TIBCO StreamBase installation, this sample's files are initially installed in:

streambase-install-dir/sample/osipi

See Default Installation Directories for the default location of studio-workspace on your system.