Options for CONFIG_FILE parameter

ConfigAssetServer

Specifies the name of the PI AF server where configuration data is stored.

ConfigInstance

Specifies the configuration instance. The default value is the same name as the hostname of the server on which PI Web API is installed.

IsFirewallExceptionEnabled

Specifies whether remote clients can access the PI Web API services. The default value is true.

IsTelemetryEnabled

Specifies whether you want to participate in the PI System Customer Experience Improvement Program. The default value is true.

ListenPort

Specifies the communication port for PI Web API. Port numbers can be between 1 and 65535. The default value is 443.

OmfAssetServerName

Required by OMF feature. Specifies the name of PI AF server where OMF data is stored.

OmfAssetDatabaseName

Required by OMF feature. Specifies the name of PI AF Database where OMF data is stored.

OmfDataArchiveName

Required by OMF feature. Specifies the name of PI DA server where OMF data is stored.

SslCertificateThumbprint

Represents in hexadecimal notation the SSL certificate that is bound to the communication port. It can be self-signed or purchased from a certification authority.

ApiServiceAccountType

Specifies the Windows NT Service account type for the PI Web API service. The default value is "Default". To change the account type, type "Custom".

ApiServiceAccountUsername

Specifies the Windows NT Service account name for the PI Web API service. The default value is "NT Service\\piwebapi". You can enter a custom account name in "Domain\\User" format.

ApiServiceAccountPassword

If you enter a custom account name for the PI Web API service, specify the password for that account in plain text.

Note: After configuration is completed, this password does not persist and therefore is not contained in the InstallationConfig.json file.

AuthenticationMethods

Specifies the method(s) of authentication to access the PI Web API Services. The default value is "Kerberos".

IdentityServerUrl

Specifies the URL for the AVEVA Identity Manager that is used to enable OIDC/Bearer authentication. If omitted, the BearerIssuer value in the configuration database will be blank.