Skip to main content
Version: 4.2

PI Service Registration

To access PI database of the industrial control system and read the data in real time.

Configuring PI Server​

Add the supOS platform to the trust list of the PI server for it to get data.

  1. Log in to the PI database server.
  2. Select Security > Identities, Users, & Groups > PI Users, and then click to add a new user.
  3. Enter the username and password, and then click Create.
  4. Double-click the created username, select the Mappings&Trusts tab in the pop-up window.
  5. Click Add under Trust name.
  1. Enter the trust information, and then click OK.
    • Trust Name: The trust name for supOS.
    • IP Address: The IP address on which the PI tool kit runs and has access to the PI server.
      info

      Enable port 5450 of the PI server when the computer cannot access the server under normal network.

    • NetMask: Subnet mask.
  1. Select Security Settings on the main page, and then change the level to Disable explicit login for pi.
    info

    It takes effect upon restarting the PI server.

  1. (Optional) Set the value of update queue when there are more than 5000 data points access.
    1. Select Tuning Parameters on the main page.
    2. Under the Update Manager tab, double-click MaxUpdateQueue.
    3. Set the value higher than the access points, and then click OK.

Configuring PI Tool Kit​

PI tool kit connects the supOS platform and the PI database.

  • Get the PI tool kit from technical support.
  • A computer that can access the PI server with Windows10 or Windows Server 2016 operating system.
  1. Double-click "PiWebApi_XXX.exe" and follow the instructions to install the tool kit.
  2. Find the server.xml file under the installation path of the tool kit, and then open it with notepad.
  3. Change the file content and save it.
<conf>
  <PI>
    <Address>server_ip</Address>
    <Account>trusted_Username</Account>
    <Password>Password_of_the_trusted_username</Password>
  </PI>
  <Server>
    <Address>127.0.0.1</Address>
    <Port>8087</Port>
  </Server>
  <History>
    <Port>30257</Port>
    <Port>30258</Port>
    <Port>30259</Port>
  </History>
</conf>
  1. Double-click the "meta.csv" file, and change the content to match with the Digital States on the PI server, so the supOS platform can recognize the converted digital type.
info

Presently, the PI server only supports to convert Digital States to Boolean.

    • Name: Same with that in the PI server.
    • Sno: The State Number on the PI server.
    • State: The State Name on the PI server, and corresponds with Sno.
    • Vtype: Leave it as default.
  1. Double-click the start.bat file to start the tool kit service.
tip

Double-click the stop.bat file to stop the service when necessary.

Adding PI Database​

  1. Log in to supOS, and then click at the upper-right corner to go to the design center.
  2. Select Global Configuration > Heterogeneous Resources > PI, and then click New.
    • Heterogeneous Database Address/Heterogeneous Database Port: Enter the IP and port of the PI server.
    • supOS Address: Enter the IP address of the supOS server for standalone deployment and the IP of k8sworkermain node server for cluster deployment.
  1. Click OK.
  2. Select Object Model Management > Object Instance > Entity Template > Link Template, check whether the added PI database is listed.
    • After adding PI database, a new object instance with the same name is added with the connected data.
    • You can filter tags connected to supOS through the PI database.