OSIsoft PI System AF Connection

With the OSIsoft PI System AF Connection shared resource, you can create a connection between the plug-in and a PI AF server or a PI Data Archive server or a PI Data Archive and PI AF Server. This shared resource is used for the AF activities, including the AF TagDefinition, AF TagEventListener, AF TagValues, AF AssetsHierarchy, and AF AttributeEventListener activities.

General

In the General panel of OSIsoft PI System AF Connection Editor, you can specify the package that stores the OSIsoft PI System AF Connection shared resource, and the name and description of the shared resource.

The following table lists the fields in the General panel:
Field Module Property? Description
Package No The name of the package where the new shared resource is added.
Name No The name to be displayed as the label for the shared resource in the process.
Description No A short description for the shared resource.

Configuration

In the Configuration panel of OSIsoft PI System AF Connection Editor, you can specify information of the PI Data Archive server or the PI AF server that the plug-in connects to.

Note: Fields which appear in bold on the UI are mandatory.
The following table lists the fields in the Configuration panel:
Field Module Property? Description
Server Type No The type of server to connect to.
It can be any one of the following:
  • PI Data Archive
  • PI AF Server
  • PI Data Archive and PI AF Server

For the PI Data Archive and PI AF Server, the only Security Type applicable is Windows Integrated Authentication.

Server Name Yes The IP address or name of the machine where the PI Data Archive server or the PI AF server is installed.
Security Type No The authentication mode used for connecting to the PI Data Archive server or the PI AF server or PI Data Archive and PI AF Server:
  • User Name: the user name and password are required for connecting to the PI Data Archive server or PI AF server.
  • PI Trust: you can log on to the PI Data Archive server automatically without entering the user name and password.

    It is not applicable to the PI AF server.

  • Windows Integrated Authentication: you can log on to the PI Data Archive server or PI AF server automatically without entering the user name and password.
Note: To make Windows Integrated Authentication work, user needs to add a username in "Mappings" on the PI AF server and in "Mappings & Trusts" on the PI Data Archive server.
User Name Yes The user name of the PI user used to connect to the PI AF server or the PI Data Archive server.

This field is available only when you select User Name in the Security Type list.

Password Yes The password used to connect to the PI Data Archive server or the PI AF server.

This field is available only when you select User Name in the Security Type list.

Server Role Yes The role of the server you want to use when connecting to the PI Data Archive server or the PI AF server.

Server role is relevant in high-availability environments with two or more replicated servers.

Supported server roles in this field include Any, PreferPrimary, and RequirePrimary.

It is not applicable to the PI AF server.

For more information, see the PI SDK documentation.

Test PI Point Yes The name of an existing tag on the PI Data Archive server.

This point is used to check the connectivity to the PI Data Archive server.

The default value in this field is SINUSOID.

If you use a customized test point, ensure that the connection to the PI Data Archive server is successful. Otherwise, the runtime reconnection to the PI Data Archive server always fails.

It is not applicable to the PI AF server.

Heart Beat Tag Name Yes The name of Heart Beat Tag used during Bulk Tag Registration.

If no value is provided in this field then default Heart Beat Tag is created on running Bulk Tag Registration.

It is not applicable to the PI AF server.

Maximum Number of Reconnect Attempts Yes The maximum number of attempts for the plug-in to reconnect to the server when the server is unavailable.

The default value is -1.

Interval Between Reconnect Attempts (milliseconds) Yes The interval between detected connection failure and automatic reconnection in milliseconds.

The default value is 100.

Test Connection No When you finish the configuration, click this button to test whether the parameters are set correctly.