PI data connection properties
- Last UpdatedAug 25, 2025
- 1 minute read
Refer to the following table for the key configurable properties of PI data connection.
Connection properties
|
Property |
Description |
Valid values |
|---|---|---|
|
ConnectionTimeout |
Enables you to modify the amount of time that the connector attempts to make a connection before it times out. If a timeout occurs, the connector is put into an error state and an event notification is issued. |
[hh:mm:ss] Minimum is 1 second (00:00:01) Maximum is 30 seconds (00:00:30) |
|
EnableHealthCheck |
Enables or disables health checks; that is, a periodic ping process that monitors connection health to verify valid connectivity. |
True, False |
|
HealthCheckPeriod |
The amount of time between health checks. |
[hh:mm:ss] Minimum is 1 second (00:00:01). Maximum is 30 seconds (00:00:30). |
|
HealthCheckTimeout |
The amount of time to wait for a healthy connection before a non-working connection is verified. |
[hh:mm:ss] Minimum is 1 second (00:00:01). Maximum is 23 hours, fifty nine minutes, fifty nine seconds (23:59:59). |
|
Password |
The password used for the PI connection to connect to a PI server. Use this only for an explicit connection. Leave it empty to use the default connection. |
Password for the valid PI server user account |
|
PiServer |
The name of the PI server. |
Hostname of a PI server |
|
UserName |
The PI server requires this user name. You can leave this empty if you want to use the default PI authentication. |
Valid user name for an account created on the PI server |