Install an interface: general steps

This topic provides some general information for installing interfaces. It does not include interface-specific information. Consult the interface documentation for specific information.

In most cases, you should not run interfaces on the Data Archive computer. Running interfaces on a separate computer allows Data Archive to be taken down for maintenance while the interface continues to collect and buffer data. Also, you do not want interfaces to compete for computer resources with Data Archive.

These steps rely on PI Interface Configuration Utility (ICU). If you use PI ICU to configure an interface, then the interface's batch file is maintained by PI ICU and all configuration changes are kept in that file and the module database. To configure an interface using PI ICU, you must install PI ICU on the interface node.

1. Confirm that you can use PI SMT to configure Data Archive.

   You do not need to run PI SMT on the same computer on which you run this interface.

2. Run the installation kit for PI Interface Configuration Utility (ICU) on the interface node.

   This kit runs the PI SDK installation kit, which installs the PI API and the PI SDK.

   Note: Be sure the PI ICU installation kit includes PI API 2016 for Windows Integrated Security or later.

3. Run the installation kit for the interface.

4. If you are running the interface on an interface node, check the computer’s time zone properties.

   An improper time zone configuration can cause Data Archive to reject data that this interface writes.

5. Run the ICU and configure a new instance of this interface.

   Essential startup parameters for this interface are:

   • Point Source

   • Interface ID

   • PI Server

   • Scan Class

6. Use the Connection tool to confirm connection between the interface node and the device.

7. If you will use digital points, define the appropriate digital state sets.

8. Add the appropriate states to the digital state sets that you defined in the previous step.

9. Build input tags and, if desired, output tags for this interface.

10. Start the interface interactively and confirm its successful connection to the Data Archive server without buffering.

11. Confirm that the interface collects data successfully.

12. Stop the interface and configure a buffering application (either PI Buffer Subsystem or PIBufss).

13. Start the buffering application and the interface.

    Confirm that the interface works together with the buffering application by either physically removing the connection between the interface node and the Data Archive computer or by stopping the Data Archive server.

14. Configure the interface to run as a service.

    Confirm that the interface runs properly as a service.

15. Restart the interface node and confirm that the interface and the buffering application restart.