Monitor the Health of an External Application

Required security profile permissions: API Applications Edit

The Monitor Application tab enables you to configure up to 10 key parameters for an external API (application programming interface)Application Programming Interfaces; APIs allow you to automate certain functionality by connecting your NICE inContact system with other software your organization uses. application that will indicate the current health of the application, for example, UCResponse, which could indicate how long it takes to retrieve data from the UC provider (Lync) or ay string/number value that would represent the health of the external application.

To monitor the external application:

1. Click Admin → Account Settings → API Applications.

2. When the list of API Applications appears, click an external application (see the Type column).
   
3. Click the Monitor Application tab.
   
4. Click the Monitor Application check box.
5. Click the Add Parameter button (this button will be disabled if you have not click the Monitor Application check box).
6. The Monitor Application tab will appear as shown below:
   
7. In the Parameter Name field, type the name of the new parameter.
8. In the Parameter Type field, select the parameter type (number or string).

9. Provide a value for each of the threshold options (Normal, Warning, Error, and Critical).

   The thresholds are used to determine the health of the application. Using the UCResponse example, let's say you set your threshold values to: Normal = 5 (seconds), Warning = 10, Error = 15, and Critical = 20, then you can see the health of the application given the returned values in the Heartbeat Thresholds section.

10. Click Create.
11. The Heartbeat Thresholds section immediately shows you the health of your application.