AVEVA OMF credential
- Last UpdatedOct 13, 2026
- 2 minute read
The AVEVA OMF credential setting handles all OMF endpoints that the OMF Writer modules support. Most fields are optional at the credential level to handle the different authentication options. The modules verify the fields.
See the table below for a full description of all the settings in both the OMF 1.2 Writer and OMF 2.0 Writer credentials.
Code examples: OMF Writer credential setting
Use the OMF Writer credential setting to establish authentication with the following AVEVA Cloud products:
-
Bearer authentication to CONNECT
-
Bearer authentication to PI WEB API
-
Basic authentication to PI Web API
-
Edge Data Store (EDS)
Code example 1: Bearer authentication to CONNECT
Endpoint: https://platform.connect.aveva.com/api/account/accountId/omfIngress/dataStoreName/v1/messages
ClientId: clientID456
ClientSecret: clientSecret456
Code example 2: Bearer authentication to PI Web API
Endpoint: https://web.company.com/piwebapi/omf
ClientId: clientID456
ClientSecret: clientSecret456
TokenEndpoint: https://web.company.com/authentication/token
Code example 3: Basic authentication to PI Web API
Endpoint: https://web.company.com/piwebapi/omf
Username: user123
Password: password123
Code example 4: Edge Data Store (EDS)
Endpoint: http://localhost:5590/api/v1/tenants/default/namespaces/default/omf
OMF Writer 1.2 and 2.0: Credential settings
The following table lists the credential settings for both the OMF Writer 1.2 and OMF Writer 2.0 credentials.
|
Name |
Requirements |
Purpose |
Default |
|---|---|---|---|
|
Endpoint (Required) |
URI |
The OMF Endpoint URL to write data to. The URL must include the http:// or https:// portion. |
|
|
Username (Optional) |
Length: 1-255 |
Basic authentication username. Required for PI Web API Basic authentication. |
|
|
Password (Optional) |
Length: 1-255 |
Basic authentication password. Required for PI Web API Basic authentication. |
|
|
DisableEndpointCertificateValidation (Optional) |
Boolean |
Allow untrusted certificates if checked. Warning: Disabling certificate validation is against AVEVA best practices and only recommended in test environments. |
false |
|
ClientId (Optional) |
String |
OIDC Client ID. Required for any OIDC authentication (PI Web API OIDC, CONNECT Classic, and CONNECT.) |
|
|
ClientSecret (Optional) |
String |
OIDC Client Secret. Required for any OIDC authentication (PI Web API OIDC, CONNECT Classic, and CONNECT.) |
|
|
TokenEndpoint (Optional) |
URI |
Retrieves a token from an alternative endpoint. Optional for Connect OIDC authentication. Required for PI Web API OIDC authentication. |
For additional information, see OMF 1.2 Writer module and OMF 2.0 Writer module.