Contents
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.
In order run correctly, the adapters require that the OSIsoft PI Asset Framework (AF) Client version 2018 R2 or later and the OISsoft PI SDK version 2018 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 the server name, user name, password. Those defaults are used if not explicitly defined in the adapter properties.
This sample includes every adapter in the OSI PI adapter suite:
-
Snapshot
-
Write
-
Summaries
-
DataPipe
-
AF (Deprecated. Instead, use the Elements and Attributes adapters)
-
Event Frames
-
Attributes
-
Elements
-
Delete
Each adapter connects a .NET Operator which loads a .NET class. This class has been written to extend StreamBase's StreamBase.SB.Operator
class, and is invoked whenever a tuple is received by the operator.
This sample has the following files:
-
The sample EventFlow application and its layout file,
OsiPiSample.sbapp
andOsiPiSample.sblayout
, respectively. -
This
Readme
file, in plain text and HTML formats.
The steps to run this sample in Studio are as follows:
-
In the Package Explorer, double-click to open the
OsiPiSample.sbapp
application. -
Make sure each adapter's server tab uses the correct values for your PI and PI AF installations.
-
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.
-
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
, and observe that the output stream that received the data is theSummaryOutput
stream, with one tuple emitted for every tag name requested. Once these tuples are emitted, one more tuple follows with itstagName
field set to null, to indicate the end of the list. -
In the Manual Input view, select the
WriteData
input stream, and enter a list of tags to update.Click
, and observe that the output stream that received the data is thePIWriteOutput
stream. The tuple contains the results of the write operation for every requested tag. -
In the Manual Input view, select the
SnapshotQuery
input stream, and enter a list of tag names to query.Click
, and observe that the output stream that received the data is thePISnapshotOutput
stream, with one tuple emitted for every tag name requested. -
In the Manual Input view, select the
EFQueries
input stream and enter a value for thesearchName
andstartTime
fields. For example,MySearch1
and*
.Click
, and observe that the output stream that received the data is theEFOutput
stream, with one tuple emitted for every Event Frame found by the query. Once these tuples are emitted, one more tuple follows with itsevtframeID
field set to null, to indicate the end of the list. -
In the Manual Input view, select the
Subscribe
input stream, and enter a list of tag names to and thesubscribe
command to start a subscription to a tag.Click
, and observe that the output stream that received the data is thePIDataPipeOut
stream, with tuples emitted when data changes on the selected tags. -
In the Manual Input view, select the
DeleteQuery
input stream, and enter a list of tags to delete.Click
, and observe that the output stream that received the data is theDeleteOutput
stream. The tuple contains the results of the delete operation for every requested tag. -
In the Manual Input view, select the
ElementsQuery
input stream and enter values for fields on which you would like to search. If not values are provided, a search of the entire database will result and all values are returned.Click
, and observe that the output stream that received the data is theElementsOutput
stream -
In the Manual Input view, select the
AttributesQuery
input stream and enter values for fields you would like to search on. If not values are provided a search of the entire database will result and all values returned.Click
, and observe that the output stream that received the data is theAttributesOutput
stream -
When done, press F9 or click the Stop Running Application button.
In StreamBase Studio, import this sample with the following steps:
-
From the top menu, select
→ . -
Select
OSI PI
from the Petroleum Industry Adapters category. -
Click OK.
StreamBase Studio creates a project for the OSI PI adapter sample in your current Studio workspace.
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 permission problems. The default workspace location for this sample is:
studio-workspace
/sample_osipi
See Default Installation Directories for the default location of studio-workspace
on your system.