Configure Interface or COM Connector for PI APS dialog box

The Register New command opens the Configure Interface or COM Connector for PI APS dialog box which registers interface instances with PI APS:

Before an interface instance can be registered with PI APS, three prerequisites must be satisfied:

1. The PI APS Connector corresponding to the type of interface must be installed.

2. The PI Server that contains, or will contain, the interface's points must be in the SDK Known Servers Table and in PI APS's server list.

3. The interface must be defined in PI ICU (classic interfaces only, not applicable to PI COM Connectors).

The third prerequisite is noteworthy because an interface can be installed and configured without using PI ICU. PI APS requires an interface to be under PI ICU management because PI APS obtains critical interface parameters (particularly, the PointSource parameters and, if applicable, interface ID) from the PI ICU settings. Also, PI APS Connectors may need to obtain interface parameter settings from PI ICU in order to properly synchronize points for the interface.

Note: Assign a meaningful name to the interface instance in PI ICU instead of accepting the default generic name.

Select APS Connector

This list contains the PI APS Connectors installed on this computer. Select the PI APS Connector for the interface instance that you want to register with PI APS.

Connector Type

There are currently two types of PI APS Connectors:

• Classic interfaces

• PI COM Connectors

This box shows the type of the selected PI APS Connector.

Some data sources have both a classic interface and a PI COM Connector. The correct PI APS Connector type must be installed and selected for the "interface" (as used in this user guide, meaning either a PI COM Connector or actual classic interface) being registered.

Select PI server host

This list contains the PI Servers that PI APS may synchronize. Select the PI Server that contains the interface's points.

Path

This is the path to the selected PI Server. If the selected PI Server is a collective, this shows the path to the primary node. If the primary PI Server is unavailable, the Path box contains a message and the Add button is unavailable.

Select an interface

This list contains all interface instances that operate with the PI Server selected in the Select PI server host box, that are the correct type for the PI APS Connector selected in the Select APS Connector box, and that are not already registered with PI APS. Select an interface to register with PI APS from the list, which contains the display names assigned to the interfaces in PI ICU.

Installation path

The Installation path box (read only) shows the drive letter and path to the directory where the interface files are installed; for example, c:\pipc\interfaces\chiptopi. This information is retrieved from the PI ICU settings of the selected interface.

Point Source

The Point Source box (read only) shows the first PointSource attribute value that identifies the points that this interface can service. If an interface instance is configured with more than one PointSource string, an arrow appears in the box. Clicking the arrow opens a list that shows all PointSource strings. The interface can service all points whose PointSource attribute is set to any of the PointSource strings for the interface. (If the same PointSource string is configured for more than one interface instance, each interface instance only services points that also have the appropriate attribute set to the interface instance ID described below.)

Note: PI APS uses all PointSource strings from the interface configuration to identify existing points. If an interface instance is configured with multiple PointSource strings, PI APS uses the first PointSource string in the PI ICU PointSource list as the value for the PointSource attribute of any created points.

The PI ICU PointSource list determines the /ps=x command-line parameters for the interface where x is a point source value. The Point Source box in the Configure Interface or PI COM Connector for PI APS dialog box shows the PointSource strings from the PI ICU PointSource list. The first PointSource value is assigned to any points that PI APS creates. If necessary, use the PI ICU to change the order of the PointSource strings so that the first one is the appropriate value for the PointSource attribute of created points.

ID Number

The ID number box (read only) applies to some, but not all, interfaces. If multiple instances of the interface have the same PointSource parameter and service points on the same PI Server, each instance of the interface must have a different interface ID. This box shows the setting from the PI ICU InterfaceID# box, which determines the /id=x command-line parameter for the interface where x is the interface ID.

Interface installed on

This box shows the name of the computer where the interface runs. This box is read-only.

Add

The Add button registers the interface instance selected in the Select an interface box.

Clear Fields

The Clear Fields button clears all the fields in the dialog box.

Connection Status

The Test button is available if the selected PI APS Connector provides a routine for testing the connection to the data source. Results returned by the PI APS Connector's connection test function are displayed in the box in the Connection Status area. The connection test is connector specific. See the user guide for the specific PI APS Connector for a description of its connection test and the meaning of its messages.