How do I configure alarm filters for XML API clients?

Purpose

Perform this procedure to configure a filter to control or limit the alarms that the NFM-P forwards to XML API clients over JMS. See  How do I filter alarms for XML API clients using the NFM-P GUI? and the NSP NFM-P XML API Developer Guide for more information.

Note: In order to perform the procedure, you require a user account with XML API access.

Steps
 
1 

Choose Administration→Security→NFM-P User Security from the NFM-P main menu. The NSP NFM-P User Security - Security Management (Edit) form opens.

2 

Click on the Users tab.

3 

Choose a user from the list and click Properties. The User (Edit) form opens.

4 

In the XML API Session panel, click Select to assign a public alarm filter. The Select Public Alarm Filter for XML API form opens.

5 

Perform one of the following:

  1. Select a filter in the list. Go to Step 6 .

  2. Create an alarm filter.

    Use the following steps:

    1. Click Create. The Create AlarmObject Filter form opens.

    2. Configure an appropriate filter for the XML API client by selecting a filter from the Attribute parameter pull-down menu. You can modify the filter string to meet the operational requirements for an XML API client by configuring the Function, Value, and Operators pull-down menus as appropriate.

    3. Click Add to add the filter.

    4. Add additional filter criteria for the alarm filter as required.

    5. Click Save. The Save Filter form opens.

    6. Configure the required parameters.

      Note:

      The Public parameter must be enabled. Only public filters are applied to XML API clients.

    7. Save your changes and close the Save Filter and Select Public Alarm Filter for XML API forms.

6 

Choose the newly created filter from the list, and click OK. The Select Public Alarm Filter for XML API-User form closes, and the selected filter is applied.

7 

Save your changes and close the forms.

End of steps