Client-level failover parameters
- Last UpdatedOct 27, 2025
- 4 minute read
- PI System
- Adapter for RDBMS 1.1
- Adapters
The following is a list of available parameters for client failover:
|
Parameter |
Required |
Type |
Description |
|---|---|---|---|
|
failoverGroupId |
Required |
string |
In the adapter instance, the ID of the failover group where the adapter is registered. Allowed value: <any string identifier> |
|
name |
Optional |
string |
The friendly name of the failover group Allowed value: <any string value> |
|
description |
Optional |
string |
The description of the failover group Allowed value: <any string value> |
|
failoverTimeout |
Required |
datetime |
The failover timeout value of the failover group. This defines how frequently the adapter sends a heartbeat to the failover endpoint. The heartbeat is sent at every FailoverTimeout / 2 interval. Allowed value: a string representation of timespan using hh:mm:ss |
|
mode |
Required |
string |
The failover mode of the registered adapter. Note: This parameter is case sensitive. Allowed values: Hot, Warm, Cold For additional information, see Failover modes. |
|
endpoint |
Required |
string |
The URL of a destination that supports client failover registration. Supported destinations include CONNECT data services and on-premise Failover service. Default value: null
|
|
userName |
Optional |
string |
The username used for Basic authentication to on-premise Failover service endpoint. Allowed value: <any string> Note: If your username contains a backslash, you must add an escape character. For example, OilCompany\TestUser should be entered as OilCompany\\TestUser. |
|
password |
Optional |
string |
The password used for to on-premise Failover service endpoint. Definition: Basic authentication is defined in the Request for Comments document 'a0 RFC 2617 HTTP Authentication 'a0 and is widely supported across vendors, platforms, and HTTP clients. Basic authentication as implemented in PI Web API is simple to use, provides granular, per-user security based on Windows identity, and can help avoid configuration problems like those related to Kerberos delegation. When combined with SSL, as in all PI Web API requests, Basic authentication is reasonably secure. However, basic authentication is less secure than Kerberos, since Windows user credentials must be included in and are transmitted with each request. In addition, Basic authentication requires that PI Web API keeps the decrypted username and password in memory for the duration of the request. Even after the request is completed, the credentials can continue to reside in memory until new data takes its place in memory. You should not use Basic authentication unless you are confident of the security of the server on which you are running PI Web API. Allowed value: <any string> or {{<secretId>}} (see How to reference secrets) |
|
clientId |
Required for CONNECT data services endpoint |
string |
The clientId used for to CONNECT data services endpoint. Definition: Bearer authentication uses the OpenID Connect protocol to obtain information about the user. Clients use an access token obtained from the AVEVA Identity Manager (AIM) Server in the header to identify the user. Note: The AVEVA Identity Manager (AIM) server is required to use Bearer as an authentication method. AIM is a standalone authentication server which needs to be installed and configured to work with the PI Web API. For more information on installing and configuring AIM, refer to the AVEVA PI Server™ Installation and Configuration guide . Allowed value: any string, can be null if the endpoint schema is HTTP |
|
clientSecret |
Required for CONNECT data services endpoint |
string |
The clientSecret used for to CONNECT data services endpoint. Definition: Bearer authentication uses the OpenID Connect protocol to obtain information about the user. Clients use an access token obtained from the AVEVA Identity Manager (AIM) Server in the header to identify the user. Note: The AVEVA Identity Manager (AIM) server is required to use Bearer as an authentication method. AIM is a standalone authentication server which needs to be installed and configured to work with the PI Web API. For more information on installing and configuring AIM, refer to the AVEVA PI Server™ Installation and Configuration guide . Allowed value: <any string> or {{<secretId>}} (see How to reference secrets) |
|
tokenEndpoint |
Optional |
string |
An optional token endpoint where the adapter retrieves a bearer token. When null or not specified, the adapter uses a well-known to retrieve it. Definition: OpenID is an open standard and decentralized authentication protocol promoted by the non-profit OpenID Foundation. It allows users to be authenticated by co-operating sites (known as relying parties, or RP) using a third-party identity provider (IDP) service, eliminating the need for webmasters to provide their own ad hoc login systems, and allowing users to log in to multiple unrelated websites without having to have a separate identity and password for each. Allowed value: well-formed http or https endpoint string |
|
validateEndpointCertificate |
Optional |
boolean |
An optional Boolean flag where, when set to false, the adapter disables the verification of the server certificate. Note: AVEVA strongly recommends only disabling server certificate validation for testing purposes. Allowed value: true or false |
Note: Failover group name, description and failover timeout cannot be changed once created. To change it, the group must be deleted on the failover service side and recreated.