Install PI Web API

Before you install PI Web API, verify the following:

• The system you plan to use is running a supported operating system. See the System requirements for additional details

• The installer is run as an Administrator.

The PI Web API installer has a graphical user interface, which allows you to perform an installation or upgrade of PI Web API. At the end of an installation or upgrade, the PI Web API Admin Utility is automatically launched.

To install PI Web API:

1. Go to the directory where you downloaded the PI Web API install kit.

   1. Double-click the installation kit.

      You may be prompted by a User Account Control message to allow the installation to run. Select Yes to allow the installation to continue.

   2. In the Self-Extracting Executable window, select , select the directory where you want to extract the files, and select OK.

      The Welcome window opens. A list displays all the modules that will be installed.

      

2. Review the list of modules and scroll over to the comments to ensure there are no warnings displayed.

   Select OK to continue to the Welcome to the PI Web API Setup Wizard window.

3. Select Next to continue to the Custom Setup window.

4. In the Custom Setup window, select the features and components you want to install:

   

   Option	Description
   PI Web API	Optional. Provides programmatic access to the Data Archive and PI AF server and is used by PI AF client applications. This is a primary component.
   PI Web API Core Services	Optional. The core set of resources to access your PI System.
   Open Message Format (OMF) Services	Optional. OMF allows applications to ingress data into the PI System using OMF messages sent to an OMF endpoint.

   Choose from the following actions:

   • To select a single feature, select and select Will be installed on local hard drive.

   • To select a feature, together with dependent features, select and select Entire Feature will be installed on local hard drive.

   • To deselect a feature, select and select Entire feature will be unavailable.

   • Optionally, to change the installation folder from the default location (C:\Program Files\PIPC\WebAPI\), select a primary component, select Browse and select a different location in the Change destination folder window.

5. Select Next to continue to the Application Data Folder window.

6. Review the default folder where application data will be stored. The default folder is stored here: C:\ProgramData\OSIsoft\WebAPI\.

   • Optional. To store data in a different directory, select Change, choose a different location in the Change destination folder window, and select OK.

   • Select Next to continue.

7. In the PI Web API Admins Group window, create a dedicated administrator group to administer PI Web API or select an existing group.

   

   • Recommended. Select Create and use "PI Web API Admins" group.

   • Select Use an existing local group and select a group on the existing group list.

8. Select Next to continue to the Ready to install PI Web API window.

   • Optional. If you need to change anything about the installation, select Back and modify your selections.

9. Select Install.

   You may be prompted by a User Account Control message to allow the installation to run. Select Yes to allow the installation to continue.

10. When the installation is complete, select Finish to close the PI Web API Setup wizard.

    The PI Web API Admin Utility opens in the Change PI Web API Installation Configurations window, so you can configure additional settings required by PI Web API. For more information, see Configure installation settings.

    Note: Selections made during installation remain in the Windows Registry in the following location: Computer\HKEY_LOCAL_MACHINE\SOFTWARE\PISystem\WebAPI.