ConnectPIDataArchive Properties
- Last UpdatedDec 15, 2025
- 3 minute read
The ConnectPIDataArchive type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| AccessToken | Access token to use when connecting to a PI Data Archive. | |
| AuthenticationMethod | PI authentication method to use when connecting to a PI Data Archive. | |
| ClientCredential | Client id and secret to get access token to use when connecting to a PI Data Archive. | |
| OpenTimeout | Timeout for opening and establishing a connection to the PI Data Archive. Should be set with syntax "hh:mm:ss" If not specified, the default global value from the PISDK configuration is used. (Typically 10 seconds) | |
| OperationTimeout | Timeout used when communicating with the PI Data Archive. Should be set with syntax "hh:mm:ss" If not specified, the default global value from the PISDK configuration is used. (Typically 60 seconds) | |
| Password | Password for PI Username used when connecting to the PI Data Archive. Used in conjunction with PIUsername. Note: Explicit Login has been superseded by connecting via Windows Integrated Security (WIS) or PI Trusts. It is strongly recommended to connect via these authentication methods instead of explicit login. See -AuthenticationMethod parameter for details on connecting via WIS or PI Trusts. | |
| PIDataArchiveConnectionConfiguration | Connection configuration object retrieved from the Known Servers Table (KST). Run "Get-Help Get-PIDataArchiveConnectionConfiguration" for more details. | |
| PIDataArchiveMachineName | Machine name of the PI Data Archive to connect to. This can be a machine name, IP address, or Fully Qualified Domain Name (FQDN). | |
| PIUsername | PI Username to use when connecting to the PI Data Archive. Used in conjunction with Password. Note: Explicit Login has been superseded by connecting via Windows Integrated Security (WIS) or PI Trusts. It is strongly recommended to connect via these authentication methods instead of explicit login. See -AuthenticationMethod parameter for details on connecting via WIS or PI Trusts. | |
| Port | Port number to use when connecting to a PI Data Archive. Default is 5450. | |
| PromptForAccessToken | Browser popup to authorize getting access token to use when connecting to a PI Data Archive. | |
| WindowsCredential | Windows Credential to use when connecting to a PI Data Archive. |
See Also
In This Topic
Related Links
- AccessToken Property
- AuthenticationMethod Property
- ClientCredential Property
- OpenTimeout Property
- OperationTimeout Property
- Password Property
- PIDataArchiveConnectionConfiguration Property
- PIDataArchiveMachineName Property
- PIUsername Property
- Port Property
- PromptForAccessToken Property
- WindowsCredential Property