Register an interface instance with PI APS

OSIsoft strongly recommends that you read Principles of operation for PI APS before you register an interface instance with PI APS.

If you are familiar with PI APS, this section summarizes the steps for registering an interface instance with PI APS. If you are not familiar with registering interface instances with PI APS, the summary in this chapter does not provide the in-depth discussions of configuration settings that are essential for successful configuration. Important concepts, detailed explanations, recommendations, and potential hazards are presented in PI APS Configuration Utility, particularly in Settings menu. Do not attempt to register an interface instance with PI APS before reading the complete discussions of the configuration dialog boxes in the PI APS Configuration Utility. Also, read the documentation for the specific PI APS Connector because the PI APS Connector may have additional configuration requirements or considerations.

1. If necessary, install the PI APS Connector for the interface or PI COM Connector whose points are to be synchronized on the same computer as PI APS.

   For example, to synchronize points for instances of the PI to PI Interface, install the PI to PI Interface - APS Connector on the PI APS computer.

2. If the points to synchronize belong to a PI COM Connector, skip this step.

   For points that belong to a classic interface:

   1. Run the PI Interface Configuration Utility (PI ICU) and configure the classic interface instance for which PI APS is to synchronize PI points.

   Configuring the interface instance in PI ICU is a prerequisite for registering it with PI APS. For more information about using PI ICU, see the PI Interface Configuration Utility user guide.

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

   Most interface instances are configured with a single PointSource string. If an interface instance is configured with multiple PointSource strings, however, the first string in the PI ICU Point Source list is the default PointSource attribute value for points created by PI APS.

   1. Confirm that the first PointSource string in the PI ICU Point Source list is the appropriate default for points created by PI APS.

3. Configure the connection with PI Server:

   1. Run the PI APS Configuration Utility and select SDK Connections on the Interface menu.

   2. Confirm that the server list on the PI Connections Manager dialog box contains the PI Server that you want to synchronize. If not, use the PI Connections Manager dialog box to add the PI Server.

   3. Configure PI mappings or PI trusts on the remote PI Server that allow the PI APS Synchronization Engine and PI APS Synchronization Trigger service to automatically connect.

   4. Optional: Configure a PI mapping or PI trust for the PI APS Configuration Utility. See Required PI Server configuration for PI APS.

   Note: The list of PI Server connections managed by the PI Connections Manager dialog box is shared by all applications on this computer.

   By default, PI APS uses all PI Servers listed in the PI Connections Manager dialog box. To restrict PI APS to specific PI Servers, click Options on the Tools menu to open the Options dialog box and select the Loading tab. See Loading tab.

4. Register an interface instance by doing one of the following:

   • Click on the toolbar.

   • Select Register New from the Interface menu.

5. Configure the PI APS Connector for the newly added interface instance:

   1. Review settings by opening dialog boxes with the following commands on the Settings menu on the main window of the PI APS Configuration Utility:

      • Rules

      • Sync Schedule

      • User-set Defaults

      • Connector-specific

   2. Review the settings on these dialog boxes and make any necessary changes.

      You might need to change these settings because registration presets synchronization rules to non-automatic selections and the default per-point synchronization settings to disable synchronization on each point. The preset options are designed to prevent PI APS from changing the PI point database until explicitly enabled. Therefore, it is likely that the default settings need to be changed for individual interface instances and sites.

   3. Follow any additional instructions in the documentation for the specific PI APS Connector for this interface to configure PI APS to manage the interface instance.

      PI APS Configuration Utility contains important details about these dialog boxes. OSIsoft strongly recommends that you read this information before attempting to configure your first interface instance.

   Note: Check the configuration settings before enabling the interface because the initial per-point synchronization settings for existing points are assigned during the first synchronization of the interface, which occurs immediately when an interface with default scheduling settings is enabled.

6. Enable synchronization for the selected interface instance with either the toolbar button or the Enable APS for Interface command on the Tools menu.

   All interface instances are initially disabled after registration and require you to enable them. If the toolbar button is unavailable or the menu command has a check next to it, then the interface instance is already enabled for PI APS and does not need to be enabled.

   Note: If the interface instance is configured for periodic synchronization, enabling the interface instance implicitly initiates the first synchronization scan for the interface.

If the Synchronization Engine is idle, it might require several seconds for the first synchronization scan to begin. If the Synchronization Engine is synchronizing another interface instance, that synchronization scan must complete before synchronization begins for the new interface instance.