OMF Health Messaging configuration

This section provides instructions for configuring the interface to use OMF Health Messaging. This is accomplished through a config file.

Interfaces that are OMF Health Messaging enabled are installed with a template configuration file (%PIHOME%/Interfaces/<interface name>/<interface name>.config_new) that contains blank endpoint configurations for the two OMF endpoints offered by AVEVA: CONNECT and PI Web API.

Refer to CONNECT configuration and PI Web API configuration for detailed instruction on configuring each of those endpoints.

For additional information on endpoints, refer to Asset Framework elements and stream configuration.

The first step is to use the PI Interface Configuration Utility to create an instance of the interface.

1. OMF Health Messaging requires that the interface instance runs as a service and not interactively. In the Service tab of the ICU, create an instance of the interface to be run as a service. This will enable the OMF Health Configuration button, as shown in this screenshot:

   

   Note: It is advised to use the NT Service account.

2. Select the OMF Health Configuration button to open the endpoint configuration file. If you have not configured an OMF endpoint, the template configuration file is used.

   • If sending data to a PI Web API endpoint, a PI AF structure will be created on the machine designated by the Endpoint field of the PI Web API endpoint configuration block.

   • Multiple endpoints of the same or differing types can be configured simultaneously. To do this, add an additional endpoint configuration block. Individual endpoint configurations are denoted by specifying EndPointType=<endpointType>. The interface then assumes all configuration information existing between this line and a) the end of the file or b) the next endpoint configuration, corresponds to that endpointType.

     Note: After the interface service is configured and started, the User, Password, ClientID, and ClientSecret fields is stored in the Windows Credential Manager and erased from the config file. If you need to update the credentials, stop the service, update the config file, and then restart the service.

     Tip: It is suggested that you review the section titled Change the Run-As account before updating the service configuration because the Windows credential manager is used to store config file secrets and updating the run as account will affect this behavior.