Associating the Help Text with a Map

The Help Facility › Creating Map-Level Help › Associating the Help Text with a Map

Associating the Help Text with a Map

Naming Conventions

When an application is being migrated at the load module level, both the map module and the help module associated with it must be moved. Therefore, it is suggested that you maintain consistent naming conventions that will make it easy to identify the connection between a map and its associated help load module. In examples provided, the fourth character is used to identify whether the entity is a map (M) or a help load module (H).

Steps

After you create the help text, you must associate it with the appropriate map using either the online map compiler, MAPC, or the batch compiler, RHDCMAP1. An example using MAPC follows:

Note: The following steps assume that the map with which you are associating the help already exists. If not, create the map first following the instructions in "Using the Online Complier".

Access MAPC

On the main menu, enter the name of the map with which you want to associate the help and select the Map-Level help text definition option, as shown:

Add Modify Compile Delete Display Switch ____________________________________________________________________________ CA IDMS Online Map Compiler CA, Inc. Map name . . . . . . . . CHRMEMP1 Map version . . . . . . 1 Dictionary name . . . . SYSDICT Dictionary node . . . . ________ Screen . . . . . . . . . 2 1. General options 2. Map-Level help text definition 3. Associated records 4. Layout 5. Field definition Command ===> Enter F1=Help F3=Exit F10=Action

On the following Map-Level Help Text Definition screen:
- Enter the name of the load module that contains all the help for the map in the Help Name field.
- Specify the PF key that will be used to access help for the map.
  Important. If a value is not entered in the Help key field, the default is the SYSGEN OLM statement value, which defaults to <PF1>. The PF key value assigned for help supersedes that defined for any other purpose. For example, if <PF1> is defined to a dialog as invoking a response, and <PF1> is also defined as the help key, the help system will get control.
- Specify whether the help should be displayed in a full or half window in the Window format field.
- In the Origin of help text field, specify option 2 and provide the name of the IDD module that contains the help text.
- Press <Enter>.
```
                            Map-Level   Help Text Definition       Page  1 of  1
     Map name:  CHRMEMP1  Version:     1

     Help name: CHRMHLP1     Help key:  PF01                    Drop Help (/) _






          Window format . . . . .  1  1. Half   2. Full

          Origin of help text . .  2  1. No text
                                      2. Module   MAP-HELP-EXAMPLE
                                         Version     1





     DC366303 Help text options processed successfully

     Enter  F1=Help  F3=Exit  F4=Prev  F5=Next  F6=Preview
```

Compile the map using the Compile option on the main menu:

Add Modify Compile Delete Display Switch ____________________________________________________________________________ | 1. Compile | | 2. View Messages |line Map Compiler |______________________| | F3=Exit |es International, Inc. |______________________| Map name . . . . . . . . CHRMEMP1 Map version . . . . . . 1 Dictionary name . . . . SYSDICT Dictionary node . . . . ________ Screen . . . . . . . . . 5 1. General options 2. Map-Level help text definition 3. Associated records 4. Layout 5. Field definition Command ===> Enter F1=Help F3=Exit F10=Action