Data endpoints parameters
- Last UpdatedMar 03, 2025
- 3 minute read
The following parameters are available for configuring data endpoints:
|
Parameter |
Required |
Type |
Description |
|---|---|---|---|
|
id |
Optional |
string |
Unique identifier Allowed value: any string identifier |
|
endpoint |
Required |
string |
Destination that accepts v1.2 messages. Supported destinations include CONNECT data services and PI Server. Allowed value: well-formed or endpoint string |
|
username |
Required for PI Server endpoint |
string |
Username for the account used for Basic authentication to the PI Server through the PI Web API endpoint. Leave the field empty if you are using Kerberos or OIDC authentication methods. Allowed value: any string Note: If your username contains a backslash, you must add an escape character, for example, type OilCompany\TestUser as OilCompany\\TestUser. If neither Username or ClientID is supplied, the adapter uses use Negotiation instead ( , ). Definition: Kerberos, is a computer-network authentication protocol that works on the basis of tickets to allow nodes communicating over a non-secure network to prove their identity to one another in a secure manner. Kerberos is the only authentication mechanism that is enabled by default in PI Web API. Kerberos provides per-user security that is native to Windows and Active Directory, and that is well supported in Microsoft clients. Kerberos does not rely on credentials being transmitted across the wire, which makes it ideal for use with untrusted connections. Use of Kerberos authentication requires the correct configuration of Active Directory delegation for the account hosting the PI Web API service in Active Directory. Correctly configured delegation requires that an Active Directory Domain Administrator grant delegation privileges to the account hosting PI Web API (or in the case of the default virtual service account, to the computer account of the computer hosting PI Web API). Correctly configured delegation also requires that Service Principal Names be correctly set on the account hosting PI Web API. Refer to 'a0 Commonly encountered problems 'a0 for detailed steps for resolving issues related to Kerberos delegation. |
|
password |
Optional for PI Server endpoint |
string |
Basic authentication to the PI Web API endpoint PI server. Allowed value: any string or {{<secretId>}} (see How to reference secrets) Default: null |
|
clientId |
Required for CONNECT data services endpoint |
string |
Authentication with the CONNECT data services endpoint. Allowed value: any string, can be null if the endpoint schema is HTTP Default: null |
|
clientSecret |
Required for CONNECT data services endpoint |
string |
Authentication with the CONNECT data services endpoint Allowed value: any string or {{<secretId>}} (see How to reference secrets); can be null if the endpoint schema is HTTP Default: null |
|
debugExpiration |
Optional |
string |
Enables logging of detailed information to disk for each outbound request pertaining to the Egress endpoint. The value represents the date and time this detailed information should stop being saved. Examples of valid strings representing date and time: UTC: yyyy-mm-ddThh:mm:ssZ, Default: null |
|
tokenEndpoint |
Optional for CONNECT data services endpoint |
string |
Retrieves a CONNECT data services token from an alternative endpoint. Allowed value: well-formed or endpoint string |
|
validateEndpointCertificate |
Optional |
boolean |
Disables verification of destination certificate. Note: Only use for testing with self-signed certificates. Allowed value: true or false Default value: true |