Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI to CONNECT Agent EAP

TABLE OF CONTENTS

Install or upgrade the PI to CONNECT Agent

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedSep 28, 2026
  • 6 minute read

Configure access to Data Archive Security tables, PI point data, and optional AF server

For the following Data Archive security configuration items, you will need to enable read access to the PI identity, PI group, or PI user that the PI to CONNECT Agent is connecting as.

  • Archive data (PIARCDATA Security table)

  • The PI points configuration table (PIPOINT Security table)

  • The PI points and data to be transferred

For AF Server security configuration, ensure the AF Identity that the PI to CONNECT Agent is connecting as has read access to the elements and attributes to be transferred.

Note: Due to a known issue, the Run As user of the PI to CONNECT Agent must have read access to all AF databases, even databases for which no data is being transferred. Otherwise, the agent will encounter issues with AF indexing, causing the agent to stop collecting data on restart.

Install the PI to CONNECT Agent

To install or upgrade the standalone PI to CONNECT Agent:

  1. In the navigation rail, select Data connections. Then select Go to Downloads page.

  2. Select Download in the PI to CONNECT Agent tile.

  3. Open the downloaded PI to CONNECT Agent installation file, then select Yes to confirm running the installation file.

    The Welcome page of the PI to CONNECT Agent wizard opens.

  4. On the Welcome page, select Next.

    The Service Account page opens.

    Note: The Service Account page is shown only for new installations.

  5. On the Service Account page, select the service account type for the connection:

    • NT Service – Select NT account for the service to run as NT SERVICE\PIToCONNECTAgent.

    • This account – Specify a username and password (domain\account) for the Run as user for the PI to CONNECT Agent service.

      Note: For Windows integrated security, the service account selected on this page determines the account to use for PI identity mapping and AF mapping. The Run as user can be changed after the installation from the Windows Service control panel. Changing this account may require configuration changes to PI mapping and AF mapping, but changing the account will not otherwise affect the access to local resources needed by the agent.

  6. Select Install.

  7. After the agent is installed, select Close.

    The PI to CONNECT Agent Configuration Utility opens. See Run the PI to CONNECT Agent Configuration Utility for instructions.

    Note: Agent registration is not complete until you add and configure a Data Archive server in the PI to CONNECT Agent Configuration Utility.

Silent installation

There are several use cases for performing a silent installation of the PI to CONNECT Agent.

  • Silent installations are useful for automating deployments.

  • Silent installations avoid browser logins to PI to CONNECT. A new, interactive installation requires that Internet Explorer Enhanced Security be disabled, and some customers cannot disable this security.

  • Installations of the PI to CONNECT Agent on Windows Server Core Operating System are supported only with silent installation.

Silent installs for new installations

Use these instructions to set up a new installation of the PI to CONNECT Agent, configured with connections to CONNECT, without needing to run the PI to CONNECT Configuration Utility. You can use the command lines in this section for upgrades as well, but account ID, PI to CONNECT service instance, Data Archive, and AF server cannot be changed during an upgrade. For the minimal command line needed for upgrades, see Silent installs for upgrades or minimal new installations.

  1. Create a client-credentials client with an assigned role of Data Manager and piusage-writer and add a secret. When targeting an agent to a site, check Enable data ingestion to a site and select a site from the dropdown.

    Note: Be sure to securely store the Client Id and Client Secret where you can access it again, because this is the only time you will have access to this information. You will need this information to proceed with the silent install.

  2. If targeting the agent to a site, after the client credential is created, create a role assignment with site constraint to the selected site.

  3. Find the ACCOUNTID and record it where you can access it.

    From the app bar, select User Profile and select your account name. Record the Id shown on the Account Details window.

  4. Find the PI to CONNECT service instance ID and record it where you can access it.

    In the navigation rail, select Account. Then select Services & applications. Select the Data Store service group. The PI to CONNECT service instance ID is the same as the service group Instance ID. Record the Instance ID shown in the side sheet.

  5. Open a Windows command prompt as an administrator.

  6. Change to the folder where you have downloaded the PI to CONNECT Agent installation kit.

  7. If you do not need to configure an Alternate Display Name for your Data Archive or AF servers, enter the following command, replacing x.x.x in the exe name with the version number of the installer. This command will immediately register the agent with the actual Data Archive name specified by the DATAARCHIVE command line argument.

    Note: The ACCOUNTID, CLIENTID, CLIENTSECRET, and SERVICEINSTANCEID keywords are required for the agent to connect to CONNECT at installation time. All keywords are case sensitive. SERVICEACCOUNT and SERVICEPASSWORD provide the Run As user and password, respectively, for the PI to CONNECT Agent service.

    PIToCONNECTAgent_x.x.x.exe ACCOUNTID=[accountid] CLIENTID=[clientid] CLIENTSECRET=[clientsecret] SERVICEINSTANCEID=[serviceInstanceID] DATAARCHIVE=[DataArchiveName] AFSERVER=[AFServerName] SERVICEACCOUNT=[user] SERVICEPASSWORD=[password] AGENTDESCRIPTION="Your Description" /quiet

  8. If you need to configure an Alternate Display Name for your Data Archive or AF servers, enter the following command. The Data Archive, AF server, and Alternate Display Names will be configured in a subsequent step.

    Note: The ACCOUNTID, CLIENTID, CLIENTSECRET, and SERVICEINSTANCEID keywords are required for the agent to connect to CONNECT at installation time. All keywords are case sensitive.

    PIToCONNECTAgent_x.x.x.exe ACCOUNTID=[accountid] CLIENTID=[clientid] CLIENTSECRET=[clientsecret] SERVICEINSTANCEID=[serviceInstanceID] AGENTDESCRIPTION="Your Description" /quiet

  9. Check that the PI to CONNECT Agent service is running.

    From an administrative command prompt, run the command net start | find "PI" and verify that "PI to CONNECT Agent" is in the list.

  10. Check the event logs for any errors.

    1. Right-click on Start and select Event Viewer.

    2. Select Applications and Services Logs and double-click PI to CONNECT.

    On Windows Server Core, access Event Viewer by connecting to it remotely.

  11. Check the setup logs.

    1. Open a command prompt and navigate to %ProgramData%\OSIsoft\Setup\log.

    2. Logs can be listed from oldest to newest with the command dir /od.

  12. (Optional) Configure an Alternate Display Name for Data Archive and/or AF server.

    Note: For a silent installation, specify an Alternate Display Name to use the PI to CONNECT Agent Configuration Utility.

    1. Open an administrative command prompt and navigate to %ProgramData%\AVEVA\PIToCONNECT.

    2. Run the command notepad.exe appsettings.json.

    3. To specify an alternate display name for the Data Archive, add the following AlternateDisplayName entry. If you did not specify AFSERVER and DATAARCHIVE on the command line above, you will need to add the server names in this step as well as specifying the alternate display name.

      "PIDataArchiveServerNames": [

      {

      "Name": "MyActualDataArchiveServerName",

      "AlternateDisplayName": "AlternateDisplayName",

      "ConnectionTimeout": 10,

      "OperationTimeout": 60

      }

      ],

    4. To specify an alternate display name for AF, add the following AlternateDisplayName Entry:

      "PIAssetFrameworkServerNames": [

      {

      "Name": "MyActualAFServerName",

      "AlternateDisplayName": "AlternateDisplayName",

      "ConnectionTimeout": 10

      }

      ],

    5. Save the changes and restart the PI to CONNECT Agent service from an administrative command prompt with the commands:

      net stop pitoconnectagent

      net start pitoconnectagent

  13. Verify your agent is visible on the Agents page in the portal.

    Silent installs for upgrades or minimal new installations

    These instructions can be used to upgrade the PI to CONNECT Agent. They can also be used for a new installation of the PI to CONNECT Agent, but the installation requires configuration with the PI to CONNECT Agent Configuration Utility for the new installation.

    1. Open a Windows command prompt as an administrator.

    2. Change to the folder where you have downloaded the PI to CONNECT Agent installation kit.

    3. Run the following command, replacing x.x.x in the exe name with the version number of the installer:

      PIToCONNECTAgent_x.x.x.exe /quiet

      The above command is sufficient for an upgrade. For a new installation, run the PI to CONNECT Agent Configuration Utility to register the PI to CONNECT Agent after the silent installation completes.

      In This Topic