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. This shared resource is used for the AF activities, including the AF TagDefinition, AF TagEventListener, and AF TagValues 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 AF server that the plug-in connects to.

The following table lists the fields in the Configuration panel:
Field Module Property? Description
Server Name Yes The IP address or name of the machine where the PI server is installed.
Security Type No The authentication mode used for connecting to the PI server:
  • User Name: the user name and password are required for connecting to the PI server.
  • PI Trust: you can log on to the PI server automatically without entering the user name and password.
User Name Yes The user name of the PI user used to connect to the PI server.

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

Password Yes The password used to connect to the PI server.

This field is only available 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 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.

For more information, see the PI SDK documentation.

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

This point is used to check the connectivity to the PI server. The default value in this field is SINUSOID.

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

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

The default value is -1.

Number of Reconnect Attempts Before Suspending Impacted Services(s) Yes The total number of automatic reconnection attempts.

The default value is 5, which indicates that there is no restriction on the times of reconnection.

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

The default value is 1000.

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