web/quickref r1.1 user’s guide · display. for example, if you clicked on the os/390 system codes...

Web/QuickRef R1.1User’s Guide

Thursday, October 12, 2000

Chicago-Soft, Ltd.1 Maple Street

Hanover, NH 03755 Phone: (603) 643-4002

FAX: (603) 643-4571

Web: www.chicago-soft.com

Web/QuickRef User’s Guide

Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Page 11Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Page 11Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Page 9Generic Item Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Page 8Looking Up a Specific Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Page 5Clickable Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Page 4Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Page 3Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Page 3Web/QuickRef Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Page 3Web/QuickRef Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Page 3Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Page 3Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .


IntroductionThis document is the user’s guide for Web/QuickRef, a web-based interface to MVS/QuickRef execut-ing on your mainframe computer system. This user’s guide describes the capabilities and features ofWeb/QuickRef, how to install and use the product, and the prerequisites required before Web/Quick-Ref can be made operational.

OverviewWeb/QuickRef is a web-based interface to Chicago-Soft’s MVS/QuickRef product.MVS/QuickRef resides on an IBM or compatible mainframe system and executes under the MVS orOS/390 operating system. Web/QuickRef itself also resides completely on the same mainframe systemand executes under the OS/390 operating system; however, it uses the facilities of IBM’s HTTP webserver to permit browser-based access to information from the MVS/QuickRef main data base or fromone or more MVS/QuickRef user data bases. If your mainframe system is connected to a LAN (LocalArea Network) based intranet or to the Internet, then web browsers executing on any connectedsystem can access MVS/QuickRef data base content through that connection.

Web/QuickRef Elements

Web/QuickRef consists of the following elements:� An assembler program which provides an interface to MVS/QuickRef� a script, written in REXX, which is executed to dynamically create web page content� predefined web pages written in HTML� documentation, including this user guide

Web/QuickRef Prerequisites

Web/QuickRef has the following minimum prerequisites:

� OS/390 V2R5 or a later release level is required� IBM’s HTTP web server must be installed and active (the web server is shipped with the operating

system by IBM to all customers using OS/390 V2R5 or higher)� MVS/QuickRef R5.0 or higher must be installed and active� web browsers must be used that support the HTML 3.2 or higher standard; examples of acceptable

web browsers include Netscape Navigator 3.0 or higher, Microsoft Internet Explorer 3.0 or higher,or Opera Software’s Opera 3.1 or higher

Features


Web/QuickRef HTML screens are used to display the information that each browser user requests.Initial screens are presented that display a list of simple choices; the browser user either clicks on achoice or types in the name of a data base item to display and then presses the Enter key on the PC;Web/QuickRef then either displays the requested reference information or asks the browser user formore information. Figure 1 shows the initial display you will see when Web/QuickRef is first invoked.

Figure 1 - Web/QuickRef Initial Screen

The initial display screen shown in Figure 1 is divided into two sections or frames. The frame on top is amenu from which you can choose the reference information to display, and the frame on the bottom iswhere the information chosen for display in the top frame is actually presented. Initially, the bottomframe contains a short paragraph of ‘help’ text for Web/QuickRef. When a selection is made from themenu in the top frame, and that selection results in a display of reference text or a list of reference textitems from which a choice is to be made, the output is displayed in the bottom frame. When an item listis shown in the bottom frame, you can click with your left mouse button on items in the list to view thereference text for that item.

Categories

Information contained in the MVS/QuickRef main data base is generally of two types, message descrip-tions and non-message oriented reference text. Non-message oriented reference text is grouped into‘categories’ within the data base. The display shown in Figure 2 lists the categories found in the


MVS/QuickRef main data base. Figure 2 was produced by clicking the ‘Categories’ tab on the topframe of the Web/QuickRef screen shown in Figure 1.

Figure 2 - Category Display

Clickable Links

Each link that is available for you to click on in the display is shown underlined. For example, you canget additional information about the ‘codes’ category by clicking on the ‘CODES’ link shown in Figure2. You could get a list of all programming languages whose syntax is documented in the MVS/QuickRefmain data base by clicking on the ‘PROGLANG’ link, and so on.

Figure 3 shows the display that would result when you click on the ‘CODES’ link in Figure 2.


Figure 3 - Products within the ‘CODES’ category

Figure 4 - System Abend Code Item list for OS/390 V2R8


In Figure 3, a list of the products found in the MVS/QuickRef data base for the ‘CODES’ category isshown. You can view all of the items that comprise a product by clicking on that product’s link in thedisplay. For example, if you clicked on the OS/390 SYSTEM CODES link for V2R8 shown in Figure3, the display shown in Figure 4 would result. Figure 4 shows a list of all the system abend codes thatcan be issued under OS/390 V2R8. The output in Figure 4 is in turn another list of clickable links; youcan choose to view the reference text for an item in the list by clicking on it with your left mouse button.,or you can scroll the list up and down as needed.

Suppose you wanted to see information describing the cause and remedies for the A78 abend; to viewthe additional information, just click on the A78 item in the item list shown in Figure 4 and the displayshown in Figure 5 would result, providing you with the desired information.

When there is more information available in the output display than will fit in the current display window,browser scroll bars will appear and you can scroll the display frame down or up to view the additionalinformation.

Whenever information is being displayed and regardless of where you are in the information hierarchy,you can use your browser’s back and forward buttons to navigate backward and forward through thedisplay screens that you have already viewed.

Figure 5 - System A78 Abend Description


Looking Up a Specific Item

If you know which reference item you want to view, rather than clicking various links to find the itemname, you can type its name in the item name entry box which appears in the menu frame shown at thetop of Figure 1.

For example, suppose you wanted to view the reference text for message IEC141I, a description of thecauses for a S013 abend. To see the text, just type the item name IEC141I in the item name box foundin the top frame and click on the ‘submit’ button. The display shown in Figure 6 would result.

When more than one matching item exists in the MVS/QuickRef data base, Web/QuickRef will alwaysdisplay the item that is most appropriate for the release level of OS/390 in use.


Figure 6 - IEC141I Message Description

Generic Item Names

If you are unsure of the exact spelling for an item name, you can type a generic item name prefix; thisis an item name ending in an asterisk, such as IEC16* or ABEN*. When you enter a generic item nameprefix into the item name box shown in the top frame in Figure 1, Web/QuickRef will display a list of all


items found in the data base which match that generic item name prefix. Figure 7 is an example of such alist, generated when an item name of MOVE* was chosen.

Figure 7 - Generic Item Selection List

While viewing the list shown in Figure 7, you can click on the desired item within the item list to view thereference text for that item.


InstallationWeb/QuickRef is distributed electronically via the Internet, or on computer media, either floppy disk,CD-ROM or magnetic tape.

Installation Steps

Web/QuickRef is installed by following these steps:

1) If you have ZIP or GZIP in your OS/390 UNIX System Services environment, FTP upload (INBINARY!) this ZIP archive to an HFS directory and unzip it there. If you don't have a ZIPcapability on the UNIX System Services side of your OS/390 system, unzip this file on a PCand then FTP upload (IN BINARY!) every file in this ZIP archive to a directory in your HFS.

a) Unzip all graphics files (.gif extension) to the HFS directory where you keep your public webgraphics; the default directory for this under the OS/390 HTTP web server is usually:

/usr/lpp/internet/server_root/pub/

All .gif files should be stored in the HFS with lower-case file names!

b) Unzip all HTML files (.html extension) to the HFS directory where you keep your publicweb pages; the default directory for this under the OS/390 HTTP web server is usually:

/usr/lpp/internet/server_root/pub/

All .html files should be stored in the HFS with lower-case file names!

c) Copy the QW.REX REXX exec to the HFS directory where you keep your CGI scripts; thedefault directory for this under the OS/390 HTTP web server is usually:

/usr/lpp/internet/server_root/cgi-bin/

The qw.rex file should be stored in your CGI directory under the name qw, in lower case, withno extension!

d) Allocate a RECFM=U,BLKSIZE=6233 linklib PDS on your OS/390 system. This will bethe Web/QuickRef linklib. Space needed is 30 tracks primary, 10 tracks secondary, with 5directory blocks.

d) Unzip or OGET the file qwiwebrx.obj from the HFS into a PDS member on your S390system. This is the object code for the Web/QuickRef REXX 'called' function. This program is


written in Assembler and is NOT APF authorized, but is RENT and REUS, AMODE(31)RMODE(ANY).

e) Unzip or OGET file IEWL from the HFS into a PDS member on your OS/390 system. Thisfile is linkedit JCL to link the QWIWEBRX object code into an executable load module. Editthe JCL, add a job statement, point the SYSLIB DD to the Web/QuickRef linklib that you justallocated, then submit the job to link the QWIWEBRX object code into the linklib.

f) Unzip or OGET file zaps.jcl from the HFS into a PDS member and edit it. Add a job state-ment. Copy module QWIKREF1 from your production MVS/QuickRef linklib into theWeb/QuickRef linklib you just allocated. Point the SYSLIB DD in the ZAPS member to theWeb/QuickRef linklib. This job alters load module QWIKREF1 with several ZAPs that areneeded in order to make Web/QuickRef operational. Without these ZAPs, Web/QuickRef willnot operate. The ZAPs will NOT affect the normal operation of MVS/QuickRef, and will betransparent to all other MVS/QuickRef users. Submit the job to apply the ZAPs.

2) Prep your web server to find Web/QuickRef and MVS/QuickRef:

a) Modify the MVS/QuickRef options table QWIKOPTS so that it specifies the name of yourMVS/QuickRef main data base via the QDB= parameter. If you have any MVS/QuickRef userdata base(s) defined, make sure that their name(s) are specified via the LOCALDB1= throughLOCALDB9= keywords in the QWIKOPTS table. Reassemble and relink the QWIKOPTStable into the Web/QuickRef linklib.

b) Add a STEPLIB to the IMWEBSRV JCL; the STEPLIB should point to the Web/Quick-Ref linklib where the ZAP'ed copy of QWIKREF1, the QWIKOPTS table, and theQWIWEBRX module reside. If there is already a STEPLIB DD present in your IMWEBSRVstarted task JCL, add the Web/QuickRef linklib to the STEPLIB data set concatenation.

c) Check the 'httpd.envvars' file in use by your web server. This file is usually stored in the '/etc'directory. Find the STEPLIB= statement. If the statement says STEPLIB=CURRENT, go onto d) below. If the statement says STEPLIB=dsn1:dsn2:... then add the data set name of theWeb/QuickRef linklib you allocated previously to the list of data sets defined for the STEPLIB=variable.

d) Stop and then restart the OS/390 HTTP web server IMWEBSRV.

3) Under OMVS, 'cd' to the directory where the 'qwimain.html' file is stored. OEDIT the file andchange all occurrences of the string '204.254.171.15' to the IP address of the system on whichyour IBM OS/390 HTTP web server executes. If you don't know the IP address, then changeall occurrences of '204.254.171.15' to the fully qualified domain name (like www.yahoo.com)of the system on which your OS/390 HTTP web server executes. Save the changed HTML file.


The installation of Web/QuickRef is now complete.

Testing

To access Web/QuickRef, point to its URL with your web browser. For example, if your web site isnamed 'www.zippyco.com', then you would invoke Web/QuickRef by typing this URL into yourbrowser:

http://www.zippyco.com/qw

The above testing example presumes that the 'qw' HTML file is stored in your default HTML directory.The installation of Web/QuickRef is now complete.


web/quickref r1.1 user’s guide · display. for example, if you clicked on the os/390 system codes...

Documents