Version 5.3.1	SEARCH   CONTENTS   |   PDF PAGE   PDF BOOKS   |   HOME   UP   PREV   NEXT

This section describes the help text utilities supplied with Natural Construct for all supported platforms. The following topics are covered:

• Introduction

• CSHHCOPY Hardcopy Utility

• CSHUNLD Unload Utility

• CSHLOAD Load Utility

• CSHUSAVE Utility

• CSHUSAVN Utility

• Move Data Across Platforms

Introduction

To invoke a help text utility, enter its name at the Next prompt (Direct Command box for Unix). The specification window for that utility is displayed. For example, the following window is displayed when you enter "CSHUNLD":

08-10-10 *** N A T U R A L  C O N S T R U C T  Version 5.3.1 ***      16:35:02  
                       - BATCH HELP TEXT UNLOAD UTILITY -                       
                                                        
 Source Type.....: ___ ('.'=Terminate)                                          
        Major....: ________________________________                             
        Minor....: ________________________________                             
        Language.: __                                                           
 Target Type.....: _                                                            
        Major....: ________________________________ 

Note:
When a description refers to “your print file”, it refers to either print file 1 (mainframe) or device LPT1 (Unix).

CSHHCOPY Hardcopy Utility

The CSHHCOPY utility prints a hardcopy of the help text members, regardless of which teleprocessing monitor you are using. All output is routed to your print file.

The following example shows the CSHHCOPY utility window:

               ***** N A T U R A L   C O N S T R U C T *****                    
                      - BATCH HELP HARDCOPY UTILITY -                           
                                                                                
  TYPE:   MAJOR:                                  MINOR:                        
                                                                                
 LANGUAGE:                                                                      
                                                                                

CSHHCOPY accepts up to 25 help member input combinations in the form:

Type,Major,Minor,Language

As you enter each combination, it is automatically displayed in the window.

The following table shows examples of input values:

CSHUNLD Unload Utility

The CSHUNLD utility unloads selected help members from the help text file to work file 1. A report of the unloaded help members is routed to your print file.

The following example shows the CSHUNLD utility window:

         *** N A T U R A L  C O N S T R U C T  Version 5.3.1 ***                
                       - BATCH HELP TEXT UNLOAD UTILITY -                       
                                                        
 Source Type.....: ___ ('.'=Terminate)                                          
        Major....: ________________________________                             
        Minor....: ________________________________                             
        Language.: __                                                           
 Target Type.....: _                                                            
        Major....: ________________________________                             

CSHUNLD unloads an unlimited number of help text members in up to 25 input combinations in the form:

Source Type,Major,Minor,Language,Target Type,Major

As you enter each input combination, it is automatically displayed in the window.

The following table shows examples of input values:

CSHLOAD Load Utility

The CSHLOAD utility loads selected help members from work file 1 to the help text file. A report of the loaded members is written to your print file.

CSHLOAD accepts up to 25 help member input combinations and replace options in the form:

Type,Major,Minor,Language,Replace (Y/N)

The following table shows examples of input values:

CSHUSAVE Utility

The CSHUSAVE utility loads help text members from a user-defined work file to the help text file. You can use this utility to transfer help text from a pre-existing source, such as a PC text file, to the help text file.

The following example shows the CSHUSAVE utility window:

  CSHUSAVE                ***** Natural Construct *****             CSHUSAV0 
  Nov 18                      Multiple Help Text Import               1 of 1 
                                                                             
                                                                             
   Replace existing entry.......: _ (Y/N)                                    
                                                                             
   Default Parameters                                                        
             Profile............: ________ *                                 
 Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF1 
       help  retrn                                                           

After pressing Enter in this window, a help window is displayed to select the location of the work file. For a description of this file, see Work File 1 Layout.

The following table shows examples of input values:

Work File 1 Layout

There is no limit to the number of help text members contained in work file 1, but the length of each help text line should not exceed 68 characters. Any text beyond 68 characters will be truncated.

Each help member consists of keywords and directives, followed by the lines of help text. The following conventions apply to all keywords and directives:

• Must begin with a slash (/) character

• Must begin in the first column (column 1)

• Can be entered in upper case, lower case, or mixed case

Each help member in work file 1 must begin with "/key=" and contain the name of the help member in the following format:

/key=type component/major component/minor component/language code

Note:
If you do not specify a language code, the default language is assumed.

In addition, the following optional keywords are also supported:

Example of Work File 1 Layout

/key=P/GENERAL-LEDGER/GLMJ/1
/header1=General Ledger System
/header2=Journal Entry Help
/linktext=Journal Entry
This is a sample help member for the journal entry screen.
More sample help
/pagebreak
This line of help is forced onto a new page 
/key=P/GENERAL-LEDGER/GLMA/1
/header1=General Ledger System
/header2=Account Maintenance Help
/linktext=Account Maintenance
/profile=SPECIAL
/intensify=<
/default=>
This is a sample help member for the account maintenance screen.
More sample help
etc.

Example of Batch Input

The following JCL invokes the CSHUSAVE utility in batch:

SYSIN DD *
LOGON SYSCST
CSHUSAVE
Y,MYPROF
/*

This example indicates that existing help members are replaced by any help members with the same name in work file 1 and that MYPROF is used as the default help profile name.

CSHUSAVN Utility

The CSHUSAVN utility saves the current contents of the source buffer to the Natural Construct help text file programmatically — without creating a work file. This utility uses the CSAUSAVN and CSASTD parameter data areas (PDAs).

The following example shows a program (CTESAVN) using the CSHUSAVN utility to save help text to the Natural Construct help text file:

*********************************************************************
* Program  : CTESAVN
* System   : Natural-Construct
* Title    : Call help save subprogram
* Function : This is an example of how CSHUSAVN can be called.
*********************************************************************
DEFINE DATA
  LOCAL USING CSAUSAVN
  LOCAL USING CSASTD
END-DEFINE
DEFINE PRINTER(HELP=1) OUTPUT 'SOURCE'
FORMAT(HELP) LS=68 PS=0
PRINT(HELP) NOTITLE
      'This is sample help text that is written to the source area'
      'It normally comes from a database file or other external'
      'source, or generated based on a high-level specification'
ASSIGN CSAUSAVN.#TYPE-COMPONENT = 'P' /* Program
ASSIGN CSAUSAVN.#MAJOR-COMPONENT = 'TEST-MAJOR'
ASSIGN CSAUSAVN.#MINOR-COMPONENT = 'TEST-MINOR'
ASSIGN CSAUSAVN.#LANGUAGE-CODE = *LANGUAGE
ASSIGN CSAUSAVN.#PROFILE-NAME = 'SYSTEM'
ASSIGN CSAUSAVN.#HEADER1 = 'Sample header 1'
ASSIGN CSAUSAVN.#HEADER2 = 'Sample header 2'
ASSIGN CSAUSAVN.#LINK-TEXT = 'Sample Link'
ASSIGN CSAUSAVN.#INTENSIFY = '<'
ASSIGN CSAUSAVN.#DEFAULT = '>'
ASSIGN CSAUSAVN.#REPLACE-OPTION = TRUE
CALLNAT 'CSHUSAVN' CSAUSAVN CSASTD
IF CSASTD.RETURN-CODE = ' ' THEN
  WRITE 'Help saved successfully'
END-IF
END

Move Data Across Platforms

This section describes how to transfer data across dissimilar platforms (between mainframe and Unix, for example). The following load and unload utilities read and write data from and to work file 1:

A work file written on one platform (such as mainframe) can be read by another platform (such as Unix) if the following conditions are met:

• The work file is an ASCII file.

  To save the work file as an ASCII file on a mainframe platform:

  1. Define work file 1 as a PC file.

  2. Activate a PC connection.

  3. Run the utility (translates from EBCDIC to ASCII).

  To save the work file as an ASCII file on a Unix platform:

  1. Set the work file specification in your NATPARM to any extension other than SAG.

• When you transfer the work file between platforms, the appropriate translation must be done. For example, the file transfer method used to move a file from a PC to a Unix machine must correctly translate the PC’s CR/LFs to CRs.

www.softwareag.com

Copyright © 2006-2010 Software AG, Darmstadt, Germany.

SEARCH   CONTENTS   |   PDF PAGE   PDF BOOKS   |   HOME   UP   PREV   NEXT