OMF Health Messaging configuration

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

The interface provides a config file containing blank endpoint configurations for the two OMF endpoints offered by AVEVA: CONNECT data services and PIWebAPI. Refer to CONNECT data services configuration (UFL) and PIWebAPI configuration for detailed instruction on configuring each of those endpoints.

Note: The OMF to PIWebAPI endpoint only uses Basic authentication. Add this authentication method to the Configuration database on the PI AF server selected during installation by adding a new value, "Basic", to the array. For more information, refer to the Configuration with PI System Explorer section in the PI Web API User Guide.

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 and identify one or more endpoints.

   Multiple endpoints of the same or differing types can be figured simultaneously.

   • To do this, add an additional endpoint configuration block. Individual endpoint configurations are denoted by specifying EndPointType=<endpointType>. The interface 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 will be 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.