Data endpoints parameters

id

Optional

string

Unique identifier

Allowed value: any string identifier
Default value: new GUID

endpoint

Required

string

Destination that accepts OMF v1.2 messages. Supported destinations include CONNECT data services and PI Server.

Allowed value: well-formed http or https endpoint string
Default: null

username

Required for PI Server endpoint

string

Username for the account used for Basic authentication to the PI Server through the PI Web API OMF endpoint. Leave the field empty if you are using Kerberos or OIDC authentication methods.

Allowed value: any string
Default: null

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 (i.e., Kerberos, NTLM).

password

Optional for PI Server endpoint

string

Basic authentication to the PI Web API OMF 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 OMF endpoint.

Allowed value: any string, can be null if the endpoint URL schema is HTTP

Default: null

clientSecret

Required for CONNECT data services endpoint

string

Authentication with the CONNECT data services OMF endpoint

Allowed value: any string or {{<secretId>}} (see How to reference secrets); can be null if the endpoint URL schema is HTTP

Default: null

debugExpiration

Optional

string

Enables logging of detailed information to disk for each outbound HTTP 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,
Local: yyyy-mm-ddThh:mm:ss. For more information, see Troubleshooting.

Default: null

tokenEndpoint

Optional for CONNECT data services endpoint

string

Retrieves a CONNECT data services token from an alternative endpoint.

Allowed value: well-formed http or https endpoint string
Default: null

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