Activating the online HELP facility and accessing documentation
You can use an online HELP facility as an example of the REXX/CICS panel. It allows you to search and display the LIST3270 manual that is supplied with the product. Perform the following steps sequentially to activate the online help.
In these steps, if PTF maintenance has been applied that affects data sets for this procedure, use the target library. Otherwise, use the distribution library.
- Modify the CICSTART member in the CICSTS54.REXX.SCICEXEC data set to reflect the correct RFS filepool and path where the online help files are. If you choose to use the default, no changes to CICSTART are necessary.
- Copy the supplied CICSTS54.REXX.SCICDOC data set to a data set with a highest level data set qualifier that matches the user ID of the user who runs the CICHPREP exec. The reason for this is that the supplied security exit for the REXX/CICS IMPORT and EXPORT commands checks the highest level qualifier and it must match the user ID for the user who issues the IMPORT command.
- Copy the supplied CICSTS54.REXX.SCICPNL data set to a data set with a highest level data set qualifier that matches the user ID of the user who runs the CICHPREP exec. This data set contains the panel definitions that are used by the online help. They must be IMPORTed into the RFS filepool and path defined for the online help.
- Sign onto REXX/CICS using the REXX transaction ID. If you have changed the default transactions, this transaction ID is the one associated with the CICRXTRY exec. Issue the EXEC CICHPREP command. Follow the instructions issued by the exec. This exec reads the LIST3270 format of the manual from the data set you name into the RFS directory specified in CICSTART. It also splits the manual into multiple files for use by the online help. Additionally, the panels used by the online help are imported into the RFS system.
The online HELP facility is now ready for use.
The user can access the online HELP in several ways:
- Enter 'HELP' on the command line from the interactive environment to display a table of contents. You can also enter this command from the command line of the REXX/CICS editor or the REXX/CICS filelist.
- Enter 'HELP xxxxx' to search the INDEX of the manual for the xxxxx entry. If found, you are taken directly to that section of the manual.
- Use a HELP key defined for the editor and the filelist. It is defined in the customizing macros for the editor and the filelist. The supplied default for this key is F1. You can choose to modify the supplied default by modifying these profiles.
Accessing the supplied softcopy documentation
The
supplied CICSTS54.REXX.SCICDOC
data set contains two members:
- The CICR3270 member contains the manual in LIST3270 format, a format that has an 80-character record length. CICR3270 is used as input by the online help facility.
- The CICR3820 member contains the manual in LIST3820 format. The CICBPRNT job in the CICSTS54.REXX.SCICJCL data set contains a sample job, that prints the manual to a device that supports LIST3820 formatted data.