Develop > Tailoring > Data management > Help systems > Field help editor > Preparing to create field help

Preparing to create field help

To create field help efficiently, make these changes in your local Service Manager system.

  • Show the context–sensitive help debug information.
  • Activate the command line for the System Administrator (or the operator you want to enable to create field help) on your local server.
  • Set up the columns displaying the help record list.
  • Turn on the Administration perspective.

Show context–sensitive help debug information

  1. Start the Service Manager client.
  2. Log on or close the Connections dialog box.
  3. Click Window > Preferences.

    The Preferences dialog box opens.

  4. Click Service Manager > Appearance.

    The Appearance dialog box opens.

  5. Select Show context–sensitive help debug information.
  6. Click Apply.
  7. Click OK.

Exit the Service Manager client, and then restart it.

Service Manager now displays the file (table), form, and field information when you press Ctrl+H for a field.

  • You can use such field help information to add or edit field help records or identify field names to be used in stored queries.
  • The Web client uses the "viewcontexthelp=true" URL parameter to display field help information.

Activate the command line

  1. Start the Service Manager client.
  2. Log on to your local server as a System Administrator.
  3. Type operator on the command line and click Execute Command.

    Service Manager displays the operator form (operator.g).

  4. Type System.Admin as the log-on name (or specify the operator you want to set the permissions for), and then click Search.
  5. Open the Startup tab and select Activate Command Line at Startup.
  6. Click Save.
  7. Click Ok to exit the record.
  8. Click Back to exit the form.
  9. Exit the Service Manager client, and then restart it.

    Service Manager now displays the Command Line to that operator.

Set up the columns displaying the help record list

  1. Open the help table in the Help Editor and click Search to display the help records.
  2. Click More or the More Actions icon.
  3. Click Modify Columns.
    Service Manager displays a form that enables you to edit the columns in the record list.
  4. Type or select the following, one per line in this order:
    • topic
    • file.name
    • format.name
    • field.name
    • term
    • brief
    • detail
    • Pending Review
    • sysmodtime
  5. Click Proceed.
    Service Manager displays the record list with the columns you selected.

Turn on the Administration perspective

You can turn on the Administration perspective by doing one of the following:

  1. Click Window > Open Perspective > Other, and then select Administration.
  2. In the Service Manager System Navigator on the left side of the window, click Administration Perspective.

Service Manager now displays Administration tabs at the bottom of your forms.

Related topics

Creating field help
Field help editor
How does Service Manager determine which help record to display?
Online Help system

Add or edit help records
Access the help table
Review field help records