Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Adding an application class help


 This page describes how to add help to an application class using the PATROL Developer Console for Windows and UNIX. 

Application class help properties

The following table describes the help properties of an application class.

Application help properties 

Property

Required/Optional

Default

Definition

Context ID

Required for certification.

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

Required for certification.

None

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

Windows help files have the .hlp file extension.

UNIX help files have the .htm file extension.

Adding application class help on Windows

In this task, you will add online help for the application class.

To add application class help

  1. Click the Help tab on the Application Properties dialog box as shown in the following figure.
  2. Specify the help properties for the application class on the Help tab. Application help properties defines the application class help properties. 
    Application Properties dialog box, Help tab

    application_property_dialog_help_tab.gif
  3. Click Apply to save the properties and the PATROL KM.

Adding application class help on UNIX

In this task, you will add online help for the application class.

To add application class help

  1. On the application definition dialog box, specify the help properties for the application class as shown in the following figure. 

    Application Definition Dialog box, Help properties

    application_definition_dialog_help_properties.gif
  2. Click Apply to save the properties and the PATROL KM.

KM output-application class help

The following figure shows sample output created by the PATROL Developer Console when you add help to an application class. 

KM output-application class help 

devbasic3310-17.gif

To add icons to represent the application class and its states, see Adding an application class icon#Addinganapplicationclassicon-16964.

 

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