Configure health endpoints

The AVEVA Adapter for Structured Data Files can be configured to produce and store health data at a designated Health endpoint. You can use health data to ensure that your adapters are running properly and that data flows to the configured OMF (Open Message Format) endpoints.

A Health endpoint designates an OMF (Open Message Format) endpoint where adapter health information is sent. You can configure multiple Health endpoints.

Postman

To configure health endpoints using Postman:

1. To initialize the configuration, use the PUT method in conjunction with the http://localhost:5590/api/v1/configuration/system/healthendpoints REST endpoint.

   Note: If you installed the adapter to listen on a non-default port, update 5590 to the port number in use.

2. Copy and paste an example configuration for endpoints into the Body section.

   For sample JSONs, see the Examples section.

3. Update the example JSON parameters for your environment.

4. Select Send to push the configuration to the adapter.

EdgeCmd

To configure health endpoints using EdgeCmd:

5. Using a text editor, create an empty text file.

6. Copy and paste an example configuration for health endpoints into the file.

7. Update the example JSON parameters for your environment.

   For sample JSONs, see the Examples section.

8. Save the file. For example, ConfigureHealthEndpoints.json.

9. Open a command line session. Change directory to the location of your saved file.

10. Use the following edgecmd command with the name of your JSON file. For this example, we will use ConfigureHealthEndpoints.json for the saved file.

    edgecmd -port <port number> -cid <ComponentID> set healthEndpoints -file /.ConfigureHealthEndpoints.json

For a list of other REST operations you can perform, like updating or replacing a health endpoints configuration, see the REST URLs.