25
Create Help Utility (CHU) © Copyright 1991-2001 Oasis Software International Distributed by Linoma Software LINOMA SOFTWARE is a division of CONNECTIONS 2000, Inc.

Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

  • Upload
    lenga

  • View
    218

  • Download
    2

Embed Size (px)

Citation preview

Page 1: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Create Help Utility (CHU)

© Copyright 1991-2001 Oasis Software International

Distributed by

Linoma Software LINOMA SOFTWARE is a division of CONNECTIONS 2000, Inc.

Page 2: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 2

Introduction ................................................................................................................................. 3

Linoma Software ........................................................................................................................ 3

Trial Period................................................................................................................................... 5

Purchasing a License ............................................................................................................... 6

How CHU works ......................................................................................................................... 7

One Panel Group VS Many Panel Groups ........................................................................... 7

Installation.................................................................................................................................... 8

Applying a Permanent License Key ...................................................................................................8

Create Help Utility (CHU) on-line Demonstration..................................................................................8

Using the Create Help Utility Command............................................................................... 9

Parameters......................................................................................................................................9

Convert Help..............................................................................................................................20

Uninstalling................................................................................................................................22

License agreement and limited warranty...........................................................................24

Page 3: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 3

Introduction There are different ways to write on-line help for AS/400 applications. Some use the HELP keyword and write their own help routines directly into each program. Others use “HEP” programs from software vendors that require run time modules and/or multi-site licenses. Some just don’t create any help at all. A few take the time to enter HLPARA keywords into their DDS specifications and assign those areas to help documents, help records or help panel groups. Most programmers would prefer the last method. However, defining help specifications in DDS is very time consuming, especially if your users are constantly requesting application changes or you are creating new systems. That is why Oasis Software International developed Create Help Utility (CHU). CHU inserts HLPARA, HLPDOC, HLPRCD or HLPPNLGRP keywords directly into your existing source (or new source if you prefer), then automatically creates help documents, help records or help panel groups based on the display file’s name, formats and fields -all within a few minutes. The help keywords don’t change the display file buffer so your programs won’t need to be recompiled. The best part is, it’s your source! No run time modules to buy. CHU will convert any word processing document, which is an ASCII file, into panel group source. You can use existing documents for your help text or have anyone create new documents using the word processing system of their choice (as long as it can produce an ASCII file). Other CHU features: Works with 24x80 and 27x132 display sizes. Creates help areas for subfiles from SFLPAG and SFLLIN keywords. Optionally reassigns existing help indicators. Creates uniform help for files, formats and fields. CHU is the perfect link between your display files and help.

Instructions

Please take the time to read this manual to gain a full understanding of Create Help Utility (CHU).

Linoma Software

The Company

Linoma Software is dedicated to providing innovative and useful products for the iSeries and AS/400 platforms. Our goal is to help iSeries users take advantage of technologies and become more productive in their everyday work. Since our start in Omaha, Nebraska in 1994, we have built a large base of satisfied clients around the world. You are encouraged to review the many positive testimonials and product reviews on our web site. Customer references can also be supplied upon request. Linoma’s success has been built on being very responsive to our customer’s requirements. If you have any suggestions on how we can improve our products to make your job easier, please let us know.

Page 4: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 4

We would like to hear from you

For comments, questions or to purchase a license Create Help Utility, you can contact us at:

Electronic Sales: [email protected] Support: [email protected] Web site: www.linomasoftware.com Phone numbers Toll-free: 1-800-949-4696 : (402) 334-7513 Fax: (402) 334-2602 Address LINOMA SOFTWARE 11811 “I” Street Omaha, NE 68137 USA

Linoma Logic

Also check out Linoma Logic at www.linomalogic.com, our technology services division. Linoma Logic’s skilled consultants are trained in the latest iSeries, Internet and Java technologies. An IBM Premier Business Partner with a solid reputation, Linoma Logic is recognized for creating innovative and cost-effective I.T. solutions.

Page 5: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 5

Trial Period

The trial version of Create Help Utility will allow your organization to evaluate its value within your own environment. All the features are available for use during the trial period, but with the following restrictions:

§ You will be able to use the CRTHLP command on 10 display files only.

§ The CVTHLP command will be active for 30 days. The above restrictions are removed when a permanent license is purchased. If you exceed the trial limits and need a temporary extension, please contact us.

Page 6: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 6

Purchasing a License

A permanent license to Create Help Utility removes any trial restrictions and gives your organization one-year of free support and upgrades (for the iSeries it’s licensed to).

Pricing

Create Help Utility (CHU) is licensed per iSeries CPU. For pricing information, please visit our web site at www.linomasoftware.com or call us at (402) 334-7513 or 1-800-949-4696 (in the US). After the first 12 months of the purchase date, a maintenance fee is required for receiving continuing support and upgrades. The maintenance fee amounts are listed on the web site.

How to Order

You will need to provide the following information when placing an order for the Toolbox:

§ The iSeries Serial number(s) and their corresponding Processor groups to license § Your Name § Organization name § E-mail address § Country § Voice phone number § Address § Fax number § Where you heard about CHU

Use one of the following methods to place your order:

§ Internet: Visit www.linomasoftware.com and place your order on-line using a credit card.

§ Fax: Purchase orders can be faxed to (402) 334-2602.

§ Phone: Call (402) 334-7513 or 1-800-949-4696 (in the US) and order using a credit card.

§ Mail: Send the proper payment amount to Linoma Software, 11811 I Street, Omaha NE 68137

§ Wire Transfer: Bank wire transfers are also accepted. Call us for details. Upon receipt of a valid payment, we will e-mail or fax you the permanent license key(s).

Page 7: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 7

How CHU works

CHU analyzes your display file source and inserts IBM keywords into your source based on the file, format and field names. The HLPARA keywords at the field level are based on the field descriptions found in the display file. The source member can then be recompiled to create the display file object or can be created automatically by CHU. Help will then be available to your application program.

It is not necessary to create the display file with RSTDSP(*YES) or code for the help in your application programs. The help requests are handled by the display file through help areas. The RSTDSP(*YES) is not needed for the “help” key because the AS/400 manages the help request and the restoring of the previous display when help areas are used. Using RSTDSP(*NO) should make a noticeable decrease in line transmissions to remote workstations. When changes are made to the display file, it may be necessary to use CHU to regenerate the help area keywords. Your help text will remain unchanged. The help area keywords may change - not your help text. When creating help panel groups, CHU creates a help source member (in the source file specified) with the name of each file, format and field found in the display file. Just key the help text into these members and compile or use the CVTHLP (convert help command) included with CHU to convert existing documents (or new) into your source members. Your help is ready to use.

One Panel Group VS Many Panel Groups The following discusses the advantages of using individual panel groups for each file, format and field versus one panel group per display file. Selecting *GEN for the parameter Panel Group Source Member (PNLGRPMBR) creates one panel group for each file, format and field. The fields that appear in multiple display files will then use the same panel group. Any text from your field specifications will automatically be included in your panel group source. UIM links the necessary panel groups together when needed automatically. Having individual panel groups will allow easier maintenance for text and lower system resources through less duplication. If you utilize a reference file, see the additional parameter listing Name for Help Area (HLPARANAM). You can select the *REFFLD option to even further reduce your duplication and maintenance overhead. Any text, which appears in the reference field, will also appear in your panel group. Selecting *FILE for the parameter Panel Group Source Member (PNLGRMMBR) creates one panel group for display file. Within the panel group will be help tags for each field and format. This is recommended if you have a non-unique field name with unique definitions depending on the display file. If some of the fields on the screen are standard, their information can be imported from another panel group. Thus, you can use a combination of both methods. First select *GEN for the parameter (PNLGRPMBR) to create as many unique panel groups as possible. Then for the non-unique situations, select *FILE and import all the standard panel groups that apply. To help you with this, a print report is generated showing which parameters were selected and which panel groups were created.

CHU can create three types of on-line help. Help Panel Groups (PNLGRP), Help Records (HLPRCD) and Help Documents (HLPDOC). Help Records and Help Documents are older types of on-line help. This manual will discuss Help Panel Groups and all the parameters. Then the parameter selections for Help Record and Help Documents will be briefly explained.

Page 8: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 8

Installation Depending on how you received the trial, follow the installations on the CD, with the download or if you were mailed a tape the instructions will be on a separate sheet.

Applying a Permanent License Key If you receive a permanent license key for Create Help Utility, you can apply it by prompting the command CHU/EXTCHU. EXTCHU screen:

Enter the following information on the screen: § License key

Create Help Utility (CHU) on-line Demonstration The demo takes approximately 10 minutes. It walks you through the CRTHLP command and the steps necessary to create on-line HELP using CHU and panel groups. To start the demo, enter the following commands: ADDLIBLE CHUDEMO CALL CHUDEMO

Extend Create Help Utility Date C.H.U. trial expired . . : _1/09/26 YY/MM/DD Time C.H.U. trial expired . . : _9:18:22 HH:MM:SS C.H.U. serial number. . . . . : 49884____ Extension Number . . . . . . . : ________

Page 9: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 9

Using the Create Help Utility Command On a command entry line, type CRTHLP and prompt with F4. The following screen will be displayed.

If this is your first time using CHU look through all the parameter selections before continuing. The parameters are listed first, followed by an explanation of the function keys.

The default parameter selections are underlined.

Parameters File (FILE) Name Specify a display file name (Object name). The source file and member used to create the

display file object will contain the new help area keywords. For this reason, it is important that the source file and member reflect the current display file object. To specify a different source member to contain the help area keywords, see the parameters NEWSRCF and NEWSRCMBR.

Generic* A generic name for a group of display files. *ALL Will create help information in all display files in a specified library. Library *LIBL The library list is used to locate the files. Name Specify the library name that contains the files. *CURLIB The current library for the job is used to locate the files.

SEU LINE COMMANDS Type option, press Enter. 1=Select 2=Change 4=Delete 5=Help 8=Display details Opt Command Description Comments _ ? Show Valid Line Commands Same as HELP command _ ACT Work with Active Jobs WRKACTJOB _ AM Insert Memory After After current line _ BM Insert Memory Before Before current line _ BR Break a line into two lines Or use F8 _ CALC On-Line Calculator _ CB Color Line - Blue hex 3A _ CBI Color Line - Blue and Reverse Image hex 3B _ CBU Color Line - Blue and Underline hex 3E _ CCB Color Block - Blue hex 3A _ CCBI Color Block - Blue and Reverse Image hex 3B _ CCBU Color Block - Blue and Underline hex 3E More...

Create Help Utility (CRTHLP) Type choices, press Enter. File . . . . . . . . . . . . . . . __________ Name, generic*. *ALL Library. . . . . . . . . . . . . __________ Name, *LIBL, *CURLIB Help format. . . . . . . . . . . . __________ HLPDOC, HLPRCD, PNLGRP Help on file level . . . . . . . . *YES *YES, *NO Help on format level . . . . . . . *NO_ *YES, *NO Help on field level . . . . . . . *YES *YES, *NO Help for field types: Input . . . . . . . . . . . . . *YES *YES, *NO Output . . . . . . . . . . . . . *YES *YES, *NO Both . . . . . . . . . . . . . *YES *YES, *NO Help format clear . . . . . . . . *NO_ *YES, *NO Bottom

Page 10: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 10

HELP FORMAT (HLPFMT)

The selections are PNLGRP, HLPDOC and HLPRCD. Each of these will be explained in detail in the following documentation. PNLGRP will create help panel groups, HLPDOC will create help documents and HLPRCD will create help records.

HELP ON FILE LEVEL (FILEHLP) *YES Will create help on file level. *NO Will not create help on file level.

HELP ON FORMAT LEVEL (FMTHLP) *YES Will create help on format level. *NO Will not create help on format level. If *YES is specified, CHU will insert a “HLPARA (RCD)” keyword for each record format processed in the display file. However, CHU will not insert the keyword if the format is a subfile control or user defined format or is a format that has do displayable fields. This is a limitation of DDS not CHU. HELP ON FIELD LEVEL (FLDHLP)

*YES Will create help on all fields in your display file. If you only want certain field types selected see the following parameter information.

*NO Will not create help at the field level.

HELP FOR FIELD TYPES (FLDTYP) Any combination is allowed. INPUT *YES Will create help on fields specified for input only. *NO Will not create help for input fields. OUTPUT *YES Will create help on fields specified for out put only. *NO Will note create help for output fields. BOTH *YES Will create help on fields specified for input and output. *NO Will not create help for fields specified as input an output. HELP FORMAT CLEAR (HLPCLR) *YES Will create the help keyword HLPCLR for each format. *NO Will not create the help keyword HLPCLR. Selecting *YES will clear the active help specifications when the format is executed. For example, if you are on format “A” and go to format “B”, the active help specifications from format “A” will be cleared, so when help is requested you will only get the help for screen “B”. If you select *NO for this parameter and the

Page 11: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 11

cursor is in an area with active help specifications from format “A” and you are on format “B” you will access both format “A” and format “B” help. PARAMETER PNLGRP The following is a brief introduction to panel groups and UIM (User Interface Manager). For information on creating Panel Groups, refer to IBM Manual Guide to Programming Applications and Help Displays SC41-0011-00 or online at http://publib.boulder.ibm.com/html/as400/v5r1/ic2924/index.htm It is recommended you have this manual to fully utilize Panel Groups. There have been numerous other books and articles written about UIM and Panel Groups. UIM tag statements are entered into a panel group source member. UIM tags are used to format and identify your help text. Panel groups are then created by compiling UIM source. UIM and DDS manage your help panel groups. CHU generates your panel group source for you with all the required UIM tags. The following parameters are only valid if parameter HLPFMT is PNLGRP.

Create Help Utility (CRTHLP) Type choices, press Enter. File . . . . . . . . . . . . . . . MWDTEST__ Name, generic*. *ALL Library. . . . . . . . . . . . . *LIBL_ Name, *LIBL, *CURLIB Help format. . . . . . . . . . . . PNLGRP____ HLPDOC, HLPRCD, PNLGRP Help on file level . . . . . . . . *YES *YES, *NO Help on format level . . . . . . . *NO_ *YES, *NO Help on field level . . . . . . . *YES *YES, *NO Help for field types: Input . . . . . . . . . . . . . *YES *YES, *NO Output . . . . . . . . . . . . . *YES *YES, *NO Both . . . . . . . . . . . . . *YES *YES, *NO Help format clear . . . . . . . . *NO_ *YES, *NO Help area type . . . . . . . . . . *AREA *AREA,*FLD Panel group source file . . . . . QPNLSRC___ Name Library . . . . . . . . . . . . *LIBL___ Name, *LIBL, *CURLIB Panel group source member . . . . *GEN______ Name, *GEN, *FILE Panel group library . . . . . . . *LIBL_____ Name, *LIBL, *CURLIB More . . F3=Exit F4=Prompt F5=Refresh F10=Additional parameters F12=Cancel

Page 12: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 12

Create Help Utility (CRTHLP) Type choices, press Enter. Create panel group . . . . . . . . *NO *YES, *NO Insert panel library in DDS . . . *YES *YES, *NO Search index . . . . . . . . . . . *SAME ___ Name, *SAME, *NONE Library . . . . . . . . . . . . *CURLIB_ Name, *CURLIB, *LIBL Search index title . . . . . . . . *SAME__________________________________ _______________________________________________ Insert index library in DDS . . . *YES *YES, *NO Bottom F3=Exit F4=Prompt F5=Refresh F10=Additional parameters F12=Cancel

Page 13: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 13

HELP AREA TYPE (HLPARATYP) *AREA Inserts the help keywords into your DDS based on the position of the field. *FLD Inserts the help keywords based on field name, not location or position. The default *AREA will insert the help keywords into your DDS based on the position of the field. *FLD will insert the help information based on the field name, not on the location. If you have selected *FLD and later move your fields, it will not affect online help. If you use *AREA and move your fields you will need to rerun the CRTHLP command. Your help text will remain unchanged and the help area keywords will change to reflect the new field positions. PANEL GROUP SORCE FILE (PNLGRPSRCF) Name QPNLSRC Specify the source file and library to contain the panel group source members. Library *LIBL The library list is used to locate the panel group source file. Name Specify the library name that contains the panel group source file. *CURLIB The current library for the job is used to locate the panel group source file. PANEL GROUP SOURCE MEMBER (PNLGRPMBR) NAME *GEN Each file, format and field processed by CHU will have a member created in the panel group

source file. Each member can then be compiled to create the individual panel groups. Even though each panel group is a separate object, the UIM manager will bring them together when the HELP key is pressed in the application program.

*FILE The file name being processed by CHU will be used for your panel group source member. All help source will be in this source member.

Name The name of the panel group source member to contain the help source for the file being processed.

PANEL GROUP LIBRARY (PNLGRPLIB) *LIBL The library list will be used to locate the panel groups. *LIBL is not allowed if the parameter CRTPNLGRP is *YES. Name Specify the library name that will contain the panel groups. *CURLIB The current library of the job will contain the panel groups. CREATE PANEL GROUPS (CRTPNLGRP) *YES Will Create panel group objects. *NO Will not create panel group objects.

Page 14: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 14

INSERT PANEL LIBRARY IN DDS (INSPNLLIB) *YES Will insert the panel group library name into the DDS *NO Will not insert the panel group library into the DDS. If *YES has been selected for the parameter CRTPNLGRP and *YES is selected for INSPNLLIB the library name will be inserted into the DDS. If *CURLIB was specified for the parameter PNLGRP the user accessing the help must have the same current library. If a library name was specified for PNLGRP, *Yes for CRTPNLGRP and *YES for INSPNLLIB, that specific library name will be inserted into the DDS. The users accessing the help will not need that library on their library list. *NO for INSPNLLIB parameter will result in no library name being inserted into the DDS. The library containing the panel groups will need to be on their library list. SEARCH INDEX (SCHIDX) Name Specify the name of the Search Index to be used. If it does not exist one will be created by CHU. This will create an object of type *SCHIDX. A search index is a reference to online Help information from one or more panel groups. *SAME If the DDS already contains a search index listing *SAME will use that listing and not alter it. *NONE The index searching will not be added to you DDS. Library Name Specify the library name that contains (or will contain if it is being created by CHU) the Search Index. *CURLIB The current library for the job is used to locate the Search Index (or for creation of the Search Index). *LIBL The library list is used to locate the Search Index. SEARCH INDEX TITLE (IDXTITLE) *SAME The title of the search index will be the same as the name of the search index. Name Specify a search title. INSERT INDEX LIBRARY IN DDS (INSIDXLIB) *YES Will insert the index library into the DDS. *NO Will not insert the index library into the DDS> Insert Index Library in DDS defaults to *YES, if you select *NO then your users will need to have the library containing your search index information in their library list. The Search Index parameters will insert the UIM tags for index searching while the panel group is being created. These parameters will have no effect on any panel groups that already exist.

Page 15: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 15

To add additional root words or synonym words you will have to modify the panel group, for example:

ISCHSYN=’copy’.copy copying duplicate duplicating

For complete information see IBM’s “Guide to Programming Application and Help Displays” or online at http://publib.boulder.ibm.com/html/as400/v5r1/ic2924/index.htm Example DDS Source member modified by CHU including Index Searching.

SOURCE FILE . . . . . . . SSS/SOURCE MEMBER . . . . . . . . . CMUD001 SEQNBR*… + … 1 … + … 2 … + … 3 … + … 4 … + … 5 … + …6 … + … 7 … + … 8 4400 A HELP 4500 A HLPSCHIDX (*CURLIB/SSSIDX) 4600 A ALTHELP(CA01) 4700 A HLPTITLE(‘CMUD001’) 4800 A HLPPNLGRP(CMUD001 SSSPNL/CMUD001) 4900 A R CMU001K1 5000 A BLINK 5100 A OVERLAY 5200 A PUTOVR 5300 A HLPCLR 5400 A H HLPARA (01 002 01 079) 5500 A HLPPNLGRP(UEB01 SSSPNL/UEB01) 5600 A UEB01 78A 0 1 2MSGID(UEB 0001 CMUMSGF) 5700 A OVRDTA 5800 A DSPATR(HI)

Page 16: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 16

Example of a panel group source member created by CHU including Index Searching.

SOURCE FILE . . . . . . . SSSPNL/QPNLSRC MEMBER . . . . . . . CUST# SEQNBR*… + … 1 … + … 2 … + … 3 … + … 4 … + … 5 … + … 6 … + … 7 … + … 8 ******************************************************* * Online Help Information for custno ******************************************************* :PNLGRP. * ******************************************************* :INSCHSYN ROOT=CUSTNO.CUSTNO :Help NAME=CUSTNO. * * HELP heading for top of panel * CUSTNO - Helptext * :XH3. CUSTNO * * Paragraph – Enter the help text after the “:P.” * :P. Application help for CUSTNO * :EHELP. ******************************************************** :EPNLGRP. ********************************************************

Page 17: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 17

There are a number of IBM commands that allow you to work with your search index. The major ones are Work with Search Index Entries (WRKSCHINXE), Work with Search Indexes (WRKSCHIDX), Add Search Index Entry (ADDSCHIDXE) and Create Search Index (CRTSCHIDX).

WRKSCHIDXE command allows you to add and remove entries from a search index.

WRKSCHIDX command shows you a list of search indexes.

ADDSCHIDXE command allows you to load panel group online help information into a search index. CRTSCHIDXE command creates a search index. For complete information see IBM’s “Guide to Programming Application and Help Displays” or Online at http://publib.boulder.ibm.com/html/as400/v5r1/ic2924/index.htm ADDITIONAL PARAMETERS

Create Help Utility (CRTHLP) Type choices, press Enter. Additional Parameters Reassign existing help key . . . . *NONE Name for help area . . . . . . . . *DSPFLD *DSPFLD, *REFFLD DDS Source file . . . . . . . . . *FILESRC Name, *FILESRC Library . . . . . . . . . . . . *LIBL Name, *LIBL, *CURLIB New source member . . . . . . . . *FILESRC Name, *FILESRC Create display file . . . . . . . *NO *YES, *NO New display file . . . . . . . . . *FILE___ Name, *FILE Library . . . . . . . . . . . . *CURLIB Name, *CURLIB Print report . . . . . . . . . . . *YES *YES, *NO Printer file . . . . . . . . . . . CHUPRTF_US Name Library . . . . . . . . . . . . *LIBL_ Name, *LIBL, *CURLIB Output queue . . . . . . . . . . . *PRTF Name, *PRTF Library . . . . . . . . . . . . *LIBL___ Name, *LIBL, *CURLIB Field starting position . . . . . 1 Number Field ending position . . . . . . 10 1-10 Alternate help keyword . . . . . . CA01 *NONE, CA01, CA02, CA03 …

Page 18: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 18

REASSIGN EXISTING HELP KEY (REASGNHLP) *NONE The indicator assigned an existing help keyword is removed and NOT assigned to any other keyword. You are responsible for removing existing help routines from your programs. If your applications do not currently use the help keyword, this Parameter is ignored. Use this parameter if your display file already has the help key specified with an indicator. This is helpful if you do not want to recompile all of your programs used by the display file. If you reassign the indicator to another keyword, your display file buffer will not change and program recompilation is not required. If you use this parameter, select a keyword that is normally not used by your applications, for example, use the HOME function key. NAME FOR HELP AREA (HLPARANAM) *DSPFLD The actual field name from the display file is used to create the help tags. *REFFLD The referenced name of the REFFLD keyword is used to create the help tags. DDS SOURCE FILE (DDSSRCF) *FILESRC The source file the current display file object was compiled from. Name The name of the source file to use. NEW SOURCE FILE (NEWSRCF) *FILESRC The source replaces the original source of the display file. Name Enter the source file to contain the new source member with the help tags inserted. NEW SOURCE MEMBER (NEWSRCMBR) *FILESRC The new source member replaces the original source member of the display file. Name Enter the source member name to contain the new source with the help tags inserted. CREATE DISPLAY FILE (CRTDSPF) *YES A new display file will be created with the help information included. The file is created using the default parameters from the CRTDSPF command. If you use the REF or REFFLD keywords, your library list must contain the library that has the referenced files. *NO The help information is added to the original display file. NEW DISPLAY FILE (NEWDSPF)

Page 19: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 19

*FILE The new display file is the same name and library as the original. Name Enter the name of the new display file to be created from the converted source. Library Name Specify the library name that will contain the new display file. *CURLIB The current library of the job is used to create the new display file. This parameter is ignored if you have selected *NO for the parameter CRTDSPF. PRINT REPORT (PRTRPT) Print a report showing command parameters and each display file processed. *YES Print the report. *NO Do not print the report. PRINTER FILE (PRTF) Name Enter the name of the printer file to be used to print the report. Library *LIBL The library list is used to locate the printer file. Name Specify the library name that contains the printer file. *CURLIB The current library of the job is used to locate the printer file. This parameter is ignored if *NO has been selected for the parameter PRTRPT. OUTPUT Queue (OUTQ) *PRTF The output queue. Name The output queue to print the report. Library *LIBL The library list is used to locate the output queue. *CURLIB The current library of the job is used to locate the output queue. This parameter is ignored if *NO has been selected for the parameter PRTRPT, FIELD STARTING POSITION (FLDSTRPOS) Specifies the starting position of the fields used for the help area names. This parameter is helpful if your naming conventions use a field prefix. _1 Enter a number between 1 and 10. FIELD ENDING POSITION (FLDENDPOS)

Page 20: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 20

Specifies the starting position of the fields used for the help area names. This parameter is helpful if your naming conventions use a field suffix. _1 Enter a number between 1 and 10. ALTERNATE HELP KEYWORD (ALTHLPKWD) CA01 The ALTHELP (CA01) will be inserted in the DDS. *NONE No ALTHELP will be inserted in DDS. CA01-CA24 Specify the command key to be used for Alternate Help.

Convert Help If you have any word processing software that can produce an ASCII file, you can convert your help documents to panel group source members by using the command CVTHLP. If you are creating documents for your help text, it is easiest to make individual documents for each display file, format and field. Then if you need a printed document make a master document which, when printed, pulls the individual documents together. Enter only the help text into a separate document for each file, format and field processed by CHU. The CVTHLP command will merge all required panel group codes with the help text from your document into a panel group source member. If using a PC word processor, transfer the individual documents on to your AS/400 or iSeries so they reside in a folder. Use the CRTHLP command selecting the parameter PNLGRP for the help form. This will create the panel group source for you. Selecting *GEN for the parameter PNLGRPMBR will create individual source members for each file, format and field. If your system is standard where field names are unique, this is the preferred method for maintaining your online help and documentation. The order that you create the documents and the panel groups is not important. They both must exist before you use the CVTHLP command. The CVTHLP command converts the documents you created into the help text for your panel group. CVTHLP will merge all the required panel group codes with the help text from your document into panel group source member. Recompile the panel group source and your help text will be available for your online help.

Page 21: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 21

CONVERT HELP PARAMETERS

DOCUMENT (DOC) Name Specify the document name to be converted to a panel group source member. Generic* A generic name for a group of documents. *ALL Will convert all documents to panel group source members. This parameter is required. If the document names have the extension .HLP or ‘$’, the extension is dropped when creating the panel group name. FOLDER (FLR) Name Specify the folder name that contains the document to be converted. This parameter is required. PANEL GROUP TITLE (PNLTITLE) Specifies the panel group title and extended help title created in the panel group source. *DOC The panel group title is the same as the document name being converted.

Convert Help Document Type choices, press Enter. Document . . . . . . . . . . . . . ___________ Name, generic*, *ALL Folder . . . . . . . . . . . . . . _________________________________________ __________________________________ Panel Group Title . . . . . . . . *DOC_____________________________________ __________________________________ Panel Group Source File. . . . . . QPNLSRC Name Library . . . . . . . . . . . . *LIBL Name, *LIBL, *CURLIB Panel Group Name . . . . . . . . . *DOC_____ Name, *DOC Help Tag Name. . . . . . . . . . . *DOC Name, *DOC Replace Panel Group. . . . . . . . *TXT_ *TXT, *YES, *NO Bottom F3=Exit F4=Prompt F5=Refresh F12=Cancel F13=How to use this display

Page 22: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 22

*NONE No title will be in the panel group. Name Specify the name of the panel group title. PANEL GROUP SOURCE FILE (PNLGRPSRCF) Name *QPNLSRC Specify the source file to contain the panel group source members. Library *LIBL The library list is used to locate the panel group source file. Name Specify the library name that contains the panel group source file. *CURLIB The current library for the job is used to locate the panel group source file. PANE: GROUP NAME (PNLGRPNAM) Specify the panel group source member to be updated. *DOC The panel group name is the same as the document being converted. Name Specify the panel group source member. HELP TAG NAME (HLPTAGNAM) Specify the help tag to e updated. *DOC The help tag name is the same as the document being converted. Name Specify the help tag name. *PNLGRP The help tag name is the same as the panel group name. REPLACE PANEL GROUP (RPLPNLGRP) *TXT Only the text of the panel group is replaced. The first :P. found in the source will designate where the text begins. *YES The panel group member will be replaced. *NO The panel group will not be replaced. Backup and Testing Always keep a copy of your original source members for backup purposes. It is your responsibility to review, compile and test all converted programs.

UnInstalling

Page 23: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 23

Create Help Utility (CHU) can be removed from your iSeries by running the OS/400 command DLTLIB CHU

Page 24: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 24

License agreement and limited warranty

READ CAREFULLY BEFORE USING Create Help Utility (CHU) is a proprietary product of Oasis Software International and distributed by Linoma Software ('LINOMA SOFTWARE') and is protected by copyright laws and international treaties.

LINOMA SOFTWARE LICENSE AGREEMENT

This is a legal agreement between you, the user, and LINOMA SOFTWARE (the 'Agreement'). Loading Create Help Utility (CHU) onto your iSeries or AS/400 indicates your acceptance to be bound by the terms of this Agreement. If you do not wish to agree to the terms of this Agreement, you should promptly return the full software package and all accompanying items to LINOMA SOFTWARE.

Create Help Utility LICENSE A. LINOMA SOFTWARE grants you the right to use Create Help Utility (CHU) on your iSeries or AS/400 computer system. B. You may not alter, modify, decompile, disassemble or reverse engineer Create Help Utility (CHU), or otherwise attempt to

reproduce the source code thereof. C. You acknowledge that Create Help Utility (CHU) is provided pursuant to a license and all title and ownership to Create Help

Utility (CHU) shall remain with Oasis Software International, LINOMA SOFTWARE or its licensors.

TERM

This license is effective until terminated. You may terminate it at any time by destroying Create Help Utility (CHU) together with all copies and merged portions in any form. It will also terminate upon conditions set forth elsewhere in this Agreement, or if you fail to comply with any term or condition of this Agreement.

LIMITED WARRANTY LINOMA SOFTWARE (and/or Oasis Software International) will replace, at no charge, defective media on which Create Help Utility (CHU) is furnished that is returned within 60 days of the date of the original date of purchase. THE FOREGOING WARRANTY IS IN LIEU OF ALL OTHER WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE WITH RESPECT TO Create Help Utility (CHU) AND THE ACCOMPANYING WRITTEN MATERIALS. LINOMA SOFTWARE (and/or Oasis Software International) does not warrant that the functions contained in Create Help Utility (CHU) meet your requirements or that the operation of Create Help Utility (CHU) will be uninterrupted or error free. The entire risk arising out of use or performance of Create Help Utility (CHU) remains with you. IN NO EVENT WILL LINOMA SOFTWARE (and/or Oasis Software International) BE LIABLE TO YOU FOR ANY SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, INCLUDING BUT NOT LIMITED TO ANY LOST PROFITS, LOST SAVINGS OR LOST BUSINESS OPPORTUNITIES ARISING OUT OF THE USE OR INABILITY TO USE Create Help Utility (CHU) EVEN IF LINOMA SOFTWARE (and/or Oasis Software International) HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. LINOMA SOFTWARE's (and/or Oasis Software International) entire liability and your exclusive remedy shall be (a) the replacement of any media not meeting LINOMA SOFTWARE's “Limited Warranty" and which is returned to LINOMA SOFTWARE during the Warranty period, or (b) if LINOMA SOFTWARE is unable to deliver replacement media which is free of defects in materials or workmanship, you may receive a refund of your purchase price by returning Create Help Utility (CHU). This limited warranty gives you specific legal rights. Some states provide other rights, and some states do not allow excluding or limiting implied warranties or limiting liability for incidental or consequential damages. As a result, the above limitations and or exclusions may not apply to you. Furthermore, some jurisdictions have statutory consumer product provisions which may supersede these provisions of the Agreement.

GENERAL

Page 25: Create Help Utility (CHU) - HelpSystems Help Utility ... There are different ways to write on-line help for AS/400 applications. ... Record and Help Documents will be briefly explained

Page 25

If any provision of this Agreement shall be unlawful, void or for any reason unenforceable, then that provision shall be deemed severable from this Agreement and shall not affect the validity and enforceability of the remaining provisions of this Agreement. This Agreement will be governed by the laws of the State of Nebraska.