Page tree

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

Property

Default

Description

Context ID

None

Enter the context ID of the help topic that is to appear for the current class. Click Show Help to view the topic associated with the specified context ID and help file.

Help File

None

Enter the file name of the help file (*.hlp ) that contains the help topic for the application class.

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
  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

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 

  • No labels