Important This documentation space contains information about PATROL Agents when deployed in a TrueSight Operations Management environment. If you are a BMC Helix Operations Management user, see PATROL Agent 22.1 for BMC Helix Operations Management.

Setting up parameter help

This section describes how to add parameter help using the PATROL Developer Console for Windows and UNIX. 

Parameter help properties

The following table describes the help properties of a parameter.

 Parameter help properties

Setting up help for a parameter on Windows

In this task you will add a help file to a parameter.

To add a help file to a parameter

  1. Click the Help tab on the Parameter Properties dialog box for the appropriate parameter as shown in the following figure. 

    Parameter Properties dialog box, Help tab
    parameter_properties_dalog_help_tab.gif
  2. Select, add, or modify the appropriate options that appear on the Help tab.
  3. Click Apply to save the changes to the PATROL KM.

Setting up help for a parameter on UNIX

In this task, you will add a help file to a parameter.

To add a help file to a parameter

  1. Choose Edit>Modify from the List of Parameters window menu bar to change the selected parameter. A Parameter Definition dialog box appears, similar to the one shown in Parameter Definition dialog box, General. The Help options for the selected parameter appear as shown in the following figure. 

    Parameter Definition dialog box, Help

    parameter_definition_dialog_help.gif

KM output-parameter help

Parameter Definition dialog box, Help shows sample output created by the PATROL Developer Console when you add parameter help. 

KM output-application class parameter help 

devbasic3310-73.gif

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*