Adding links to help plug-ins

z/OSMF tasks provide a help link, help button, or message ID link on every page, window, or message that is provided in the user interface. When users click the corresponding widget, user assistance is displayed for the current context.

Procedure

To provide context-sensitive help for your applications, complete the steps that follow:

Create a help topic for each page, window, and message that can be displayed in your applications. For instructions, see Creating help plug-ins.
Add a help link, help button, message ID link, or another widget to each page, window, and message.
For each widget, specify the URL for the related help topic. The URL must have the following format:
```
https://<host>:<port>/<context-root>/helps/SSB2H8_2.1.0/<help-plugin-name>/<help-topic>
```
where:
host

Hostname or IP address of the system where z/OSMF is installed.

port

Secure application port for the z/OSMF configuration. If you specified a secure port for SSL encrypted traffic during the configuration process (through the IZUPRMxx parmlib member keyword HTTP_SSL_PORT), specify the same port in the URL. If you omit the port, it is assumed that you are using port 443, the default.

context-root

Context root of the z/OSMF application. By default, the context root is zosmf.

help-plugin-name

Name of the help plug-in that contains the help topic to which you want to link.

help-topic

Filename of the help topic to which you want to link.

Example

Figure 1 provides sample code for linking a button to a specific help topic in the z/OSMF help system.

Figure 1. Sample code for linking to a help topic

<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
  <script type="text/javascript">
   function open_help() 
   {
    window.open(
    "https://abc.com:81/zosmf/helps/SSB2H8_2.1.0/com.ibm.task.help.doc/about.html","help"
    );
   }
  </script>
 </head>
 <body>
  <input value="Help" onclick="open_help()" type="button">
 </body>
</html>