home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
OS/2 Shareware BBS: 8 Other
/
08-Other.zip
/
JCLDOC.ZIP
/
NEWDOC
< prev
next >
Wrap
Text File
|
1993-02-05
|
34KB
|
815 lines
1
0 "QUICKDOC"
0
0
0
0 MERLYN DATA SYSTEMS IS PLEASED TO ANNOUNCE THE NEW
0 RELEASE OF VERSION 3.32 OF "QUICKDOC". "QUICKDOC" IS A
0 VERSATILE FLOW CHART WRITER THAT TAKES AS INPUT AN "OS" PROC.
0 "QUICKDOC" CAN SIGNIFICANTLY REDUCE THE TIME SPENT BY YOUR
0 STAFF PREPARING AND CHECKING RUN DOCUMENTATION. IT PROVIDES
0 A FLEXIBLE MEANS OF GRAPHICALLY PRODUCING DOCUMENTATION THAT
0 IS SUPERIOR TO MANUALLY PREPARED DOCUMENATATION. "QUICKDOC"
0 USES AS INPUT THE PROC CREATED TO RUN IN PRODUCTION AND
0 OPTIONALLY A FEW EASY TO USE CONTROL CARDS. IN ADDITION TO
0 A FLOW CHART, "QUICKDOC" ALSO PROVIDES THE ABILITY TO
0 REALIGN A PROC, PERFORM LIMITED SYSTAX CHECKING, LIST SYMBOLIC
0 NAMES FROM THE PROC STATEMENT, LIST USER COMMENTS, AND SHOW
0 FILE DESCRIPTIONS ON THE FLOWCHART FROM USER COMMENTS IN THE JCL.
0 THESE OPTIONS WILL HELP REDUCE THE TIME SPENT FORMATTING THE
0 PROC AND REDUCE THE ERROR RATE BEFORE TESTING BEGINS. THE
0 LIST OPTIONS WILL PROVIDE EXTRA INFORMATION TO THE STAFF THAT
0 MIGHT NOT HAVE BEEN PREVIOUSLY AVAILABLE.
0 "QUICKDOC" HAS THE CAPABILITY OF PROVIDING TWO OUTPUT
0 FORMATS, ONE FORMAT IS COMPATABLE WITH CONVENTIONAL PRINTERS
0 SUCH AS THE "IBM" MODELS 3211 AND 1403, THE OTHER FORMAT IS
0 SPECIFICALLY DESIGNED FOR THE "IBM" 3800 AND PROVIDES ROTATED
0 OUTPUT WITH A SPECIAL CHARACTER SET.
0 THE CPU TIME USED BY "QUICKDOC" IS MINIMAL AND GENERALLY
0 WILL RUN BETWEEN TWO AND FIFTEEN SECONDS DEPENDING ON THE
0 SIZE OF THE PROC AND TYPE OF MACHINE. "QUICKDOC" IS DESIGNED
0 TO RUN ON "IBM/370" EQUIPMENT WITH "OS" TYPE SOFTWARE.
0 "QUICKDOC" IS WARRANTED FOR LIFE FROM DEFECTS AND A NONE
0 BINDING INFORMATIONAL WARRANTY IS PROVIDED AT THE END
0 OF THE DOCUMENTATION.
0 WE FEEL THAT "QUICKDOC" WOULD BE A VALUABLE ADDITION TO
0 ANY INSTALLATION. MERLYN DATA SYSTEMS WILL PROVIDE
0 A LIMITED FREE TRIAL TO INTERESTED USERS, IF YOU WOULD LIKE
0 TO OBTAIN FURTHER INFORMATION PLEASE CONTACT US.
0
0
0 ATTACH:
0 DOCUMENTATION
0 3800 SAMPLE
0 3211 SAMPLE
0 3211 SAMPLE REDUCED
0 WARRANTY INFORMATION
C
1
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
"QUICKDOC"
-
0 MERLYN DATA SYSTEMS
0 25 PLEASANT STREET
0 NORWELL MA 02061
- (617) 829 9411 X11
C
1 ---------- QUICKDOC --------
0 COPYRIGHT 1979 BY MERLYN DATA SYSTEMS
0
0
0
0 ---------- QUICKDOC ---------
0 VERSION 3.32
0 APRIL 1989
0
0
0 INTRODUCTION:
0
0 "QUICKDOC" WAS DESIGNED TO AID THE PROGRAMMER IN
0 DESIGN OF JOB OPERATIONAL FLOW CHARTS.
0 THE INPUT CONSISTS OF TWO FILES, THE FIRST IS OS JCL O
0 PROC, THE SECOND IS CONTROL CARDS. THE CONTROL CARD
0 FILE IS OPTIONAL AND THE PROGRAM WILL ASSUME DEFAULT
0 VALUES IF IT IS ABSENT.
0 THE OUTPUT CAN BE IN EITHER OF TWO FORMATS. THE FIRST
0 FORMAT CONTAINS GRAPHICS PLUS TEXT ON AN "IBM 3800".
0 THE SECOND FORMAT CONTAINS TEXT AND FORMATTED TEXT
0 AND IS COMPATABLE WITH CONVENTIONAL PRINTERS. THE
0 LAYOUTS ARE THE SAME ON EACH FORMAT.
0 "QUICKDOC" IS DESIGNED TO RUN ON IBM 370 SOFTWARE
0
0 FEATURES:
0 - SYMBOLIC SUBSTITUTION OPTION FOR FLOW CHARTS
0 - REFORMATS PROC TO SYSPUNCH FILE
0 - LIMITED SYNTAX CHECKING (JCL KEYWORDS)
0 - AUTOMATIC FIELD CENTERING
0 - FULL DATA SET XREF (MAX 10 LEVELS)
0 - SYMBOLIC PROC XREF LIST SUITABLE FOR USE AS DOCUMEN
0 - ABILITY TO INCLUDE COMMENTS FOR ADDITIONAL DOCUMENT
0 - AUTOMATIC CATALOG SEARCH FOR UNITS
0 ] - GENERATION OF GDG RESTART INFORMATION
0 - 8 1/2 BY 11 OUTPUT ON 3800 PRINTERS (MOD1 AND MOD3)
0 - GRAPHIC CHARACTERS ON 3800 PRINTERS (MOD1 AND MOD3)
0
0
0 CAPABILITIES:
0 - 900 DD STATEMENT PER PROC (500 FOR PC VERSION)
0 - 99 STEPS PER PROC
0 ] - 300 SYMBOLICS ON PROC CROSS REFERENCED
0 - RUNS IN 384K OR LESS
0 - CPU TIME USALLY LESS THAN 15 SECONDS
0 - INSTREAM JCL SUPPORTED (NON PROC FORMAT)
C
1 ---------- QUICKDOC ---------
0 COPYRIGHT 1979 BY MERLYN DATA SYSTEMS
0
0
0 INPUT AND OUTPUT DESCRIPTIONS
0
0 INPUT
0 **** DDNAME: PROCIN THIS IS THE INPUT PROC FILE
0
0 EX. //PROCIN DD DSN=SYS1.PROCLIB(QUICPROC),DISP=SHR
0 EX. //PROCIN DD DSN=USERID.DATA,DISP=SHR
0 NOTE THIS INPUT FILE MUST BE VALID OS PROC WITHOUT ANY
0 JCL ERRORS OR RESULTS WILL BE UNPREDICTABLE
0
0
0 **** DDNAME: SYSIN THIS IS THE INPUT CONTROL CARD FILE
0
0 EX. //SYSIN DD *
0 EX. //SYSIN DD DSN=USERID1.DATA,DISP=SHR
0 NOTE THIS INPUT FILE CAN BE EMPTY AND PROGRAMS WILL
0 ASSUME DEFAULT VALUES, SEE CONTROL CARD FORMATS FOR
0 MORE INFORMATION
0
0
0 OUTPUT
0 **** DDNAME: SYSOUD THIS IS THE OUTPUT ERROR MESSAGE FILE
0
0 EX. //SYSOUD DD SYSOUT=A
0
0
0 **** DDNAME: SYSOUT THIS IS THE OUTPUT SORT MESSAGE FILE
0
0 EX. //SYSOUT DD SYSOUT=A
0
0
0 **** DDNAME: FLOWPRT THIS IS THE OUTPUT FLOW CHART FILE
0
0 EX. //FLOWPRT DD SYSOUT=1 **FOR CONVENTIONAL PRINTER**
0 EX. //FLOWPRT DD SYSOUT=1,CHARS=MS93, **FOR 3800 PRINTER**
0 // FCB=MDS3,MODIFY=MDSA
0 NOTE FOR 3800 PRINTER "CHARS,FCB,MODIFY" SHOULD BE CODED
0 EXACTLY AS SHOWN. FOR A CONVENTIONAL PRINTER THE CARRIAGE
0 CONTROL TAPE SHOULD BE STANDARD AT 8 LPI.
0 *** JES USERS SHOULD USE JOBPARM LINECOUNT OF 255
C
1 ---------- QUICKDOC ---------
0 COPYRIGHT 1979 BY MERLYN DATA SYSTEMS
0
0
0
0 **** DDNAME: SYSFLOW THIS IS A WORK FILE AND SHOULD BE CODED
0 AS SUCH
0
0 **** DDNAME: SYSSEC THIS IS THE USAGE CONTROL FILE AND MUST
0 ALWAYS BE PRESENT. MERLYN DATA SYSTEMS WILL SUPPLY
0 THIS FILE.
0
0 EX. //SYSSEC DD DSN=TECH.DOC.SYSSEC,DISP=SHR
0
0 **** DDNAME: CTLIN THIS IS A WORK FILE AND SHOULD BE CODED
0 AS SUCH
0
0
0 **** DDNAME: SYSPUNCH THIS FILE IS THE REALIGNED OUTPUT JCL
0
0 EX. //SYSPUNCH DD SYSOUT=B
0 EX. //SYSPUNCH DD DSN=SYS1.PROCLIB(REFORMAT),DISP=SHR
C
1 ---------- QUICKDOC --------
0 COPYRIGHT 1979 BY MERLYN DATA SYSTEMS
0
0
0
0 CONTROL CARDS AND PARM INFORMATION
0
0 PARM INFO:
0 PARM POSITIONS 1 THRU 4 CONTAIN THE OUTPUT PRINTER TYPE
0 THE VALUES CAN BE "3800" OR "3211"
0 THE 3211 VALUE MEANS THAT THE PRINTER IS A CONVENTIONAL TYPE
0
0 PARM POSITIONS 5 THRU 10 CONTAIN THE INTERNAL SORT CORE
0 SIZE . FOR MORE INFORMATION ON THIS CONSULT THE COBOL
0 MANUAL UNDER SORT SIZE SPECIAL REGISTER INFORMATION
0
0 EX. // EXEC PGM=QUICKDOC,PARM="3800065000"
0 EX. // EXEC PGM=QUICKDOC,PARM="3800"
0 EX. // EXEC PGM=QUICKDOC,PARM="3211"
0 NOTE INTERNAL SORT SIZE DEFAULT IS 45000
0
0
0 CONTROL CARDS:
0 CONTROL CARDS COME IN TWO TYPES: TYPE "H" CONTROL CARDS
0 ARE USED TO PASS HEADING INFORMATION TO THE OUTPUT ROUTINE.
0 THE "KEYWORD" CONTROL CARDS ARE USED FOR FLOW CHART
0 GENERATION CONTROL, (IE CONTROLING FORMATING OF FLOW CHART)
0 "H" TYPE CONTROL CARDS MUST START IN CARD COLUMN 1 BUT
0 "KEYWORD" CONTROL CARDS MAY START IN COLUMNS 1 THRU 16. THE
0 INFORMATION PASSED ON THE "H" TYPE CONTROL CARDS IS AUTO-
0 MATICALLY CENTERED ON THE OUTPUT SO ALIGNMENT ON CONTROL
0 CARDS IS NOT NECESSARY.
0 YOU MAY ENTER MULTIPLE "KEYWORD" CONTROL CARDS ON ONE
0 LINE SEPERATED BY COMMAS, BUT YOU MUST NOT SPLIT THEM
0 OR EXCEED COLUMN 71.
0 YOU MAY NOT ENTER MULTIPLE "H" CONTROL CARDS ON A
0 LINE. "H" CONTROL CARDS AND KEYWORD CONTROL CARDS
0 MUST NOT BE MIXED ON A CARD. THE CONTROL CARDS MAY
0 APPEAR IN ANY ORDER.
0 AT INITIAL INSTALLATION DEFAULT VALUES WERE
0 ESTABLISHED FOR MOST OF THE RUN PARAMETERS. THESE DEFAULTS
0 MAY BE OVERRIDEN BY USING THE CONTROL CARDS LISTED, TO
0 OBTAIN A LIST OF SYSTEM DEFAULTS USE THE "PRINTOPT"
0 CONTROL CARD. YOUR SYSTEMS PROGRAMMER WHO INSTALLED
0 QUICKDOC HAS THE ABILLITY TO MODIFY THE DEFAULT PARA-
0 METERS IF NECESSARY.
0
C
1 ---------- QUICKDOC ---------
0 COPYRIGHT 1979 BY MERLYN DATA SYSTEMS
0
0
0
0 "H" TYPE CONTROL CARDS (START IN COL 1)
0
0 H-PROCMEM THIS IS THE PROCLIB MEMBER NAME. THIS INFORMATION WILL
0 BE GENERATED FROM THE PROC NAME THAT IS ON THE PROC
0 STATEMENT IF THIS CARD OMITTED. OTHERWISE THE INFORMATION
0 ON THIS CARD WILL APPEAR UNDER THE HEADING
0 "PROCLIB MEMBER"
0 THE MAXIMUM DATA LENGTH IS 8 CHARACTERS.
0 EXAMPLE H-PROCMEM=ABCDEFGH
0
0 H-MGRNAME THIS IS THE PROJECT MANAGER NAME. THIS INFORMATION
0 WILL APPEAR UNDER THE HEADING "PROJECT MANAGER"
0 THE MAXIMUM DATA LENGTH IS 35 CHARACTERS.
0 EXAMPLE H-MGRNAME=JOHN DOE JR
0
0 H-JOBNUMB THIS IS THE JOB NUMBER. THIS INFORMATION WILL APPEAR
0 UNDER THE HEADING "JOB NUMBER".
0 THE MAXIMUM DATA LENGTH IS 14 CHARACTERS.
0 EXAMPLE H-JOBNUMB=ABCDEFGH1243GG
0
0 H-SYSNUMB THIS IS THE SYSTEM NUMBER. THIS INFORMATION WILL APPEAR
0 UNDER THE HEADING "SYSTEM NUMBER".
0 THE MAXIMUM DATA LENGTH IS 14 CHARACTERS.
0 EXAMPLE H-SYSNUMB=QQQ-QQ123-44AB
0
0 H-INSTALL THIS IS THE INSTALLATION DESIGNATION. THIS INFORMATION
0 WILL APPEAR UNDER THE HEADING "LOCATION".
0 THE MAXIMUM DATA LENGTH IS 8 CHARACTERS.
0 EXAMPLE H-INSTALL=YOURNAME
0 NOTE THIS CARD IF OMMITTED WILL DEFAULT TO YOUR
0 INSTALLATION STANDARD.
0
0 H-SYSNAME THIS IS THE SYSTEM NAME. THIS INFORMATION WILL APPEAR
0 UNDER THE HEADING "SYSTEM NAME".
0 THE MAXIMUM DATA LENGTH IS 42 CHARACTERS.
0 EXAMPLE H-SYSNAME= GENERATE FLOW CHARTS
0
0
0 NOTES: IF NO CARD IS FOUND FOR A HEADING TYPE BLANKS IS THE
0 DEFAULT (EXCEPT ON H-PROCMEM WHERE THE DEFAULT IS THE
0 NAME ON THE PROC STATMENT AND H-INSTALL WHICH IS
0 SET UP AT SYSGEN TIME)
0 IMBEDDED SPACES ARE PERMITTED
C
1 ---------- QUICKDOC ---------
0 COPYRIGHT 1979 BY MERLYN DATA SYSTEMS
0
0
0
0 "KEYWORD" CONTROL CARDS
0
0 UNIT THIS CARD ASSIGNS FLOW CHART KEYWORDS TO VARIOUS UNIT
0 PARAMETER IN THE JCL. UP TO 25 UNIT CARDS MAY BE INPUT.
0 COMPARISON IS MADE TO ONLY 4 BYTES IN THE JCL THERE FOR
0 ONLY THE FIRST FOUR BYTES IN THE JCL ARE SIGNIFICANT.
0 UP TO FORTY MAY BE ASSIGNED AS STANDARD AT SYSGEN TIME.
0 FORMAT UNIT=(JCLX,FLOW)
0 WHERE JCLX IS CHARACTERS ON UNIT PARAMETER IN JCL AND
0 FLOW IS THE QUICKDOC KEYWORDS ASSOCIATED WITH THIS,
0 VALID VALUES FOR FLOW ARE (TAPE,CARD,PRNT,DISK)
0 EXAMPLE UNIT=(2400,TAPE)
0 UNIT=(3330,DISK)
0 UNIT=(1403,TAPE)
0 UNIT=(28C ,TAPE)
0 UNIT=(151 ,DISK)
0 UNIT=(TAPE,DISK)
0
0
0 DEFAULT THIS CARD ASSIGNS FLOW CHART KEYWORDS TO DD"S WHEN
0 THE QUICKDOC PROGRAM CANNOT DETERMINE WHAT THE UNIT
0 SHOULD BE. A UNIT TYPE CAN NORMALLY BE DETERMINED IF
0 THE FILE HAS A DISP OF OLD OR SHR AND IT IS CATALOGUED,
0 OR IF THE UNIT IS PREVIOUSLY SPECIFIED FOR THAT DSNAME,
0 OR IF THE UNIT IS EXPLICITLY DEFINED FOR THAT FILE.
0 THE INTERNAL DEFAULT FOR THIS CARD IS TAPE
0 FORMAT DEFAULT=FLOW
0 WHERE FLOW IS A VALID QUICKDOC KEYWORD (SEE UNIT LIST)
0 EXAMPLE DEFAULT=TAPE
0 DEFAULT=CARD
0 DEFAULT=DISK
C
1 ---------- QUICKDOC ---------
0 COPYRIGHT 1979 BY MERLYN DATA SYSTEMS
0
0
0
0 DDNAME THIS CARD ASSIGNS FLOW CHART KEYWORDS TO JCL STATEMENTS
0 THAT USE A DDNAME.
0 FORMAT DDNAME=FLOW
0 WHERE FLOW IS A VALID QUICKDOC KEYWORD (SEE UNIT LIST)
0 EXAMPLE DDNAME=TAPE
0 DDNAME=DISK
0
0
0 PUNCH THIS CARD CAUSES THE REALIGNED PROC DATA TO BE PUNCHED
0 TO THE SYSPUNCH OUTPUT FILE.
0
0 NOPUN THIS CARD CAUSES THE REALIGNED PROC DATA NOT TO BE PUNCHED
0 TO THE SYSPUNCH OUTPUT FILE.
0
0 NOVERLAY THIS CARD ELIMINATES THE "+" BORDER AROUND THE OUTPUT
0
0
0 SYNTAX THIS CARD CAUSES LIMITED SYNTAX CHECKING TO BE PERFORMED
0 ON THE INPUT PROC. UNLIKE THE OS SYNTAX CHECKER THE SCAN
0 DOES NOT TERMINATE AT THE FIRST SPACE ENCOUNTERED SO ANY
0 CHARACTERS AFTER A BLANK WILL BE INTERPERTED AS A SYNTAX
0 ERROR.
0
0 NOSYNTX THIS CARD DISABLES THE SYNTAX CHECKING OF THE PROC.
0
0
0
0 CONFLICT THIS CARD CAUSES UNIT CONFLICTS TO BE DISPLAYED
0 A UNIT CONFLICT IS WHEN A DATA SET NAME HAS TWO DIFFERENT
0 UNITS IN THE SAME PROC.
0 THE INTERNAL DEFAULT IS FOR CONFLICTS TO BE DISPLAYED
0 NOCONFLT THIS CARD CAUSES UNIT CONFLICT TO BE DISPLAYS TO BE
0 SUPPRESSED.
0
0
C
1 ---------- QUICKDOC --------
0 COPYRIGHT 1979 BY MERLYN DATA SYSTEMS
0
0
0
0 XREFLIST THIS CARD CAUSES THE SYMBOLIC PROC LISTING TO BE
0 GENERATED AND PRINTED.
0
0 NOXREF THIS CARD CAUSES THE SYMBOLIC PROC LISTING TO BE
0 SUPPRESSED
0
0
0 SORTWK
0 SORTLIB
0 STEPCAT
0 STEPLIB
0 SYSPRINT
0 THESE CARDS WILL CAUSE A UNIT TO BE GENERATED WHEN A
0 DD STATMENT WITH A MATCHING NAME IS ENCOUNTERED.
0 THE UNIT WILL BE PRINTED ON THE OUTPUT FLOWCHART. THE
0 SORTWK CARD WILL ONLY SHOW ONE SORTWORK SYMBOL
0 REGARDLESS OF THE NUMBER OF SORTWK STATMENTS IN THE
0 STEP. THE SYSPRINT CARD WILL ALLOW ANY DDNAMES
0 BEGINNING WITH "SYS" TO BE PRINTED.
0
0 NOSORTWK
0 NOSORTLB
0 NOSTEPLB
0 NOSTEPCT
0 NOSYSPR
0 THESE CARDS WILL SUPPRESS THE PRINTING OF SYMBOLS WITH A
0 MATCHING DDNAME.
0
C
1 ---------- QUICKDOC ---------
0 COPYRIGHT 1979 BY MERLYN DATA SYSTEMS
0
0
0
0 SYMBOLIC THIS CARD ALLOWS SYMBOLIC VARIABLES TO BE REPLACED
0 ON THE OUTPUT FLOW CHART.
0
0 FORMAT SYMBOLIC=(PGM,UNIT,DSN,SYSOUT,DISP)
0 WHERE PARAMETERS INSIDE PARENTHESES ARE FIELD TYPES
0 THAT WILL BE REPLACED WITH VALUES ON PROC STATMENT
0
0 IE. IF PGM IS SPECIFIED AND JCL IS PGM=&PGM1
0 AND PROC STATMENT IS PGM1=QUICKDOC
0 OUTPUT ON FLOWCHART WILL NOW SHOW PGM=QUICKDOC
0
0 THE VALID PARAMETER FOR SYMBOLIC ARE:
0 PGM UNIT DISP SYSOUT DSN
0 NOPGM NOUNIT NODISP NOSYSOUT NODSN
0
0 PARAMETERS BEGINNING WITH "NO" SUPRESS SUBSTITION OF THE
0 INDICATED TYPE.
0 EXAMPLE SYMBOLIC=(PGM,UNIT,DSN,SYSOUT,DISP)
0 SYMBOLIC=(PGM,NOSYSOUT)
0 SYMBOLIC=(DSN)
0 SYMBOLIC=(DISP,SYSOUT)
0
0 THE PARAMETER AND ITS NEGATIVE IN THE SAME RUN WILL CAUSE
0 THE LAST ONE ENCOUNTERED TO BE USED. THEY MAY BE CODED
0 IN ANY ORDER.
0
C
1 ---------- QUICKDOC ---------
0 COPYRIGHT 1979 BY MERLYN DATA SYSTEMS
0
0
0
0 PROC TO RUN QUICKDOC
0
//QUICPROC PROC SOUT=A,
// SYSPUN=B,
// COPYS=3,
// PRINR=3800,
// SORTSP=44000,
// CHRS=MS93,
// FCB=MDS3
//*
//*
//* ************************************************
//* * *
//* * "QUICKDOC" COPYRIGHT 1979 *
//* * BY MERLYN DATA SYSTEMS *
//* * LICENSED TO *
//* * *
//* * *
//* * *
//* * *
//* ************************************************
//*
//SA EXEC PGM=QUICKDOC,REGION=384K,PARM='&PRINR&SORTSP'
//STEPLIB DD DSN=SYS1.DOCLIB,DISP=SHR
//SORTLIB DD DSN=SYS1.SORTLIB,DISP=SHR
//SYSOUD DD SYSOUT=&SOUT
//SYSOUT DD SYSOUT=&SOUT
//SYSPRINT DD SYSOUT=&SOUT
//SYSPUNCH DD SYSOUT=&SYSPUN
//SYSSEC DD DSN=QUICKDOC.CONTROL,DISP=SHR
//PROCIN DD DDNAME=PROCIN
//SYSIN DD DDNAME=SYSIN
//SYSFLOW DD DSN=&&YTT11,SPACE=(TRK,(5,1),RLSE),
// UNIT=SYSDA,
// DISP=(NEW,PASS,DELETE),
// DCB=(LRECL=100,RECFM=FB,BLKSIZE=1000)
//CTLIN DD DSN=&&YXT11,SPACE=(TRK,(15,1),RLSE),
// UNIT=SYSDA,
// DISP=(NEW,PASS,DELETE),
// DCB=(LRECL=1000,RECFM=FB,BLKSIZE=1000)
//FLOWPRT DD SYSOUT=&SOUT,CHARS=&CHRS,FCB=&FCB,
// MODIFY=MDSA,
// COPIES=©S
//SORTWK01 DD UNIT=SYSDA,SPACE=(TRK,(2))
//SORTWK02 DD UNIT=SYSDA,SPACE=(TRK,(2))
//SORTWK03 DD UNIT=SYSDA,SPACE=(TRK,(2))
//SORTWK04 DD UNIT=SYSDA,SPACE=(TRK,(2))
//SORTWK05 DD UNIT=SYSDA,SPACE=(TRK,(2))
//SORTWK06 DD UNIT=SYSDA,SPACE=(TRK,(2))
0 SAMPLE RUN JCL
0
//YOUR JOB CARD
/*JOBPARM L=255
//GEN EXEC QUICPROC
//PROCIN DD DSN=SYS1.PROCLIB(ANYPROC),DISP=SHR
//SYSIN DD *
H-SYSNAME=GENERATE DOCUMENTATION
H-MGRNAME=YOUR NAME
H-JOBNUMB=YOUR JOBNUMBER
DDNAME=CARD
DEFAULT=DISK
UNIT(SYST=DISK)
UNIT(ONLI=TAPE)
SYNTAX
NOPUN
//
C
1 ---------- QUICKDOC --------
0 COPYRIGHT 1979 BY MERLYN DATA SYSTEMS
0
0
0
0 SUPPLEMENTAL INFORMATION
0 UNIT SEARCH PRIORITY
- UNIT SYMBOLS ARE DETERMINED IN THE FOLLOWING MANNER:
- IF UNIT IS SPECIFIED ON THE SYMBOLIC CONTROL CARD
0 THE SYMBOL IS RESOLVED USING THE INFORMATION ON
0 THE PROC STATEMENT.
0 THIS RESOLVED UNIT IS MOVED TO AN OUTPUT HOLD AREA
- IF A UNIT KEYWORD IS FOUND ON THE DD CARD THIS EXPLICIT
0 UNIT IS MOVED TO THE OUTPUT HOLD AREA.
- THE DSN IS CHECKED FOR ANY SYMBOLICS AND THEY ARE RESOLVED
0 IF POSSIBLE, THIS DSN IS THEN PUT IN A HOLD AREA.
- IF THE UNIT HAS NOT BEEN DETERMINED, THE SYSTEM CATALOG IS
0 SEARCHED USING THE DSN PREVIOUSLY PUT IN THE HOLD AREA
0 IF A MATCH IS FOUND THE UNIT IS MOVED TO THE HOLD AREA.
- THE UNIT EQUATE TABLE IS THEN SEARCHED TO MATCH ANY UNITS
0 TO A FORMAT THAT IS USABLE TO THE FLOWCHART OUTPUT ROUTINE
0 THIS NEW UNIT IS PLACE BACK INTO THE OUTPUT HOLD AREA.
- IF A UNIT HAS NOT BEEN IDENTIFIED AND THE DISP IS 'SHR'
0 DISK IS MOVED TO THE OUTPUT HOLD AREA.
- THE LAST RESORT, IF THE UNIT STILL HAS NOT BEEN IDENTIFIED,
0 IS TO MOVE THE UNIT ON THE DEFAULT CONTROL CARD TO THE
0 OUTPUT HOLD AREA.
- NULLFILE AND DUMMY FILES HANDLING
0 NULLFILES WILL NOT BE DISPLAYED ON THE FLOW CHART IF THEY
0 DO NOT HAVE A DISPOSITION. IF A DISP IS PRESENT THEY WILL
0 BE DISPLAYED AND COULD CAUSE INVALID CROSS REFERENCES TO BE
0 GENERATED.
- CONCATINATED DATA SETS
0 QUICKDOC WILL TREAT EACH DATA SET SEPERATLY BUT PUT THE DD
0 NAME OF THE FIRST ON EACH. QUICKDOC WILL ALSO TRY TO MAKE
0 THE DEVICE TYPE OF EACH AGREE.
C
1 ---------- QUICKDOC ------
0 COPYRIGHT 1979 BY MERLYN DATA SYSTEMS
0
0
0 COMMENT PROCESSING
0 "QUICKDOC" HAS THE ABILITY TO PROCESS USER COMMENTS ONTO A
0 SEPERATE OUTPUT LISTING. THE FORMAT OF THESE COMMENTS IS:
0 //* C= WITH 65 POSITIONS OF DATA FOLLOWING THE EQUAL SIGN
0 THE USER MAY SPECIFY AS MANY COMMENTS AS IS DESIRED.
0 THESE COMMENTS MAY APPEAR ANYWHERE IN THE PROC.
0 INFORMATION THAT MIGHT BE INCLUDED IS:
0 PARM AND DATE CARD FORMATS
0 COMMON SYSTEM OR USER ABEND INFORMATION
0 RESTART INFORMATION
0 DATASET NAME TO SYSTEM ID EQUATES
0 INFORMATION SHOWING INTER AND EXTRA JOB FLOW
0 REPORT DISTRIBUTION
0 A CONTACT PERSON
0
0 DD STATMENT DESCRIPTION CAN BE GENERATED ON THE FLOW CHART BY
0 PLACING A STATEMENT FOLLOWING THE DDCARD. THE
0 DESCRIPTION MAY BE UP TO 20 POSTIONS AND
0 SHOULD PRECEED THE NEXT DD STATEMENT.
- EX. //* D=20 POSITION DESC.
0
0
0 UNIT=AFF,VOL=REF
0 "QUICKDOC" WILL NOT SHOW TWO FILES GOING TO THE SAME UNIT,
0 THIS WOULD CAUSE MISLEADING DOCUMENTATION TO BE GENERATED
0 AND THE OUTPUT WOULD BE CONFUSING TO THE OPERATOR.
C
1 ---------- QUICKDOC -------
0 COPYRIGHT 1979 BY MERLYN DATA SYSTEMS
0
0
0
0 ERROR HANDLING AND CODES
0 "QUICKDOC" WAS DESIGNED TO HANDLE MOST USER ERRORS, BUT, IN
0 SOME CASES THE OUTPUT PRODUCED MAY BE UNDESIRABLE. IN THOSE
0 INSTANCES THE ERROR SHOULD BE CORRECTED AND THE JOB RERUN.
0
0 ERROR MESSAGES
- *** QD0100 SYMBOLIC XREF TABLE LIMIT REACHED
0 CAUSE: MORE THAN 75 SYMBOLIC NAMES ON PROC STATEMENT
0 COMMENT: IF SYMBOLIC SUBSTITUTION ON FLOW CHART WAS REQUESTED
0 VARIABLES WILL NOT BE REPLACED AFTER THE SEVENTY FIFTH
0 NAME. NO ERRORS WILL RESULT IN THE FORMATTED PROC OUTPU
0 THE CARD DISPLAYED FOLLOWING THE MESSAGE WAS THE ONE IN
0 ERROR.
- *** QD0101 EXPECTED CONTINUATION NOT RECEIVED
0 CAUSE: MISSING COMMA OR OTHER ERROR ON PROC STATEMENT
0 COMMENT: LOADING OF SYMBOLIC CROSS REFERENCE TABLE IS TERMINATED
0 AND SYMBOLIC REPLACEMENT ERRORS MAY RESULT. THE CARD
0 DISPLAYED FOLLOWING THE MESSAGE IS IN ERROR.
- *** QD0102 UNDETERMINED JCL ERROR
0 CAUSE: QUICKDOC COULD NOT DETERMINE LOGICAL BREAK ON JCL SCAN
0 COMMENT: THIS ERROR COULD BE CAUSED BY A COMMENT AFTER THE JCL
0 INFORMATION. "QUICKDOC" DOES NOT TERMINATE THE JCL SCAN
0 ON AN ENCOUNTERED BLANK AND THIS ERROR COULD BE ERRONEO
0 THE CARD IN ERROR IS DISPLAYED ON THE SAME LINE AS MESS
- *** QD0103 KEYWORD SYNTAX ERROR
0 CAUSE: QUICKDOC ENCOUNTERED AN INVALID JCL KEYWORD
0 COMMENT: THIS ERROR COULD BE CAUSED BY A COMMENT AFTER THE JCL
0 INFORMATION. "QUICKDOC" DOES NOT TERMINATE THE JCL SCAN
0 ON AN ENCOUNTERED BLANK AND THIS ERROR COULD BE ERRONEO
0 THE CARD IN ERROR IS DISPLAYED ON THE SAME LINE AS MESS
- *** QD0104 UNBALANCED QUOTES ON LINE
0 CAUSE: THE LINE CONTAINS AN ODD NUMBER OF QUOTES
0 COMMENT: THIS MAY NOT BE AN ERROR IF A FIELD IS CONTINUE ON THE
0 NEXT LINE. THE CARD IN ERROR IS DISPLAYED ON THE SAME
0 LINE AS THE MESSAGE.
- *** QD0105 UNBALANCED PARENS ON LINE
0 CAUSE: THE LINE CONTAINS AN ODD NUMBER OF PARENTHESIS
0 COMMENT: THIS MAY NOT BE AN ERROR IF A FIELD IS CONTINUE ON THE
0 NEXT LINE. THE CARD IN ERROR IS DISPLAYED ON THE SAME
0 LINE AS THE MESSAGE.
C
1 ---------- QUICKDOC ------
0 COPYRIGHT 1979 BY MERLYN DATA SYSTEMS
0
0
- *** QD0106 INFORMATION SHOULD START BEFORE CC 17
0 CAUSE: CONTROL CARD INPUT (KEYWORD FORMAT) SHOULD START IN
0 COLUMNS 1 THRU 16
0 COMMENT: CONSULT DOCUMENTATION FOR PROPER FORMAT. THE CARD THAT
0 IMMEDIATELY PRECEDES THE MESSAGE IS IN ERROR.
- *** QD0107 ERROR IN KEYWORD CARD BYPASSED
0 CAUSE: QUICKDOC COULD NOT IDENTIFY INPUT
0 COMMENT: CONSULT DOCUMENTATION FOR PROPER FORMAT. THE CARD THAT
0 IMMEDIATELY PRECEDES THE MESSAGE IS IN ERROR.
- *** QD0108 TOO MANY UNIT EQUATES ALL DROPPED AFTER THIS CARD
0 CAUSE: MORE THE 25 UNIT EQUATE STATEMENTS SUBMITTED
0 COMMENT: ALL UNIT EQUATE STATEMENTS AFTER MESSAGE WILL BE IGNORE
- *** QD0109 ** SYMBOL NOT DEFINED IN PROCEDURE
0 CAUSE: DURING SYMBOLIC SUBSTITUTION ROUTINE A SYMBOLIC NAME
0 WAS ENCOUNTERED THAT WAS NOT ON THE PROC STATEMENT.
0 COMMENT: VALUE IN QUESTION IS DISPLAYED AFTER MESSAGE
- *** QD0110 ERROR ON THIS PARM
0 CAUSE: SUBPARAMETER NAME IN SYMBOLIC CONTROL CARD INVALID
0 COMMENT: CONSULT DOCUMENTATION FOR PROPER NAME. THE SUBPARAMETER
0 IN ERROR IS DISPLAYED WITH MESSAGE.
- *** QD0111 PERMANANT UNIT TABLE EXCEEDED
0 CAUSE: THE UNIT TABLE ALLOWS ONLY 40 ENTRIES THIS CARD
0 WOULD CAUSE THE TABLE LIMIT TO BE EXCEEDED.
0 COMMENT: GET PRINT OF OPTION LIST AND CONTACT SYSTEM PROGRAMMER
C
1 ---------- QUICKDOC --------
0 COPYRIGHT 1979 BY MERLYN DATA SYSTEMS
0
0
0
- *** QD0200 ** UNIT CONFLICT **
0 CAUSE: UNIT ON DATASET NAME WAS PREVIOUSLY DEFINED AS A
0 DIFFERENT TYPE.
0 COMMENT: THE SECOND UNIT WILL BE REPLACED BY THE FIRST UNIT
0 UNLESS "CONFLICT=NO" WAS SPECIFIED, THEN NO ACTION OCCU
- *** QD0300 ABNORMAL SORT RETURN
0 CAUSE: RETURN CODE FROM SORT WAS NOT ZERO
0 COMMENT: SEE SYSOUT DATASET FOR MORE INFORMATION
- *** QD0301 INVALID HEADER DESCRIPTION
0 CAUSE: AN "H" TYPE CONTROL CARD WAS INVALID
0 COMMENT: SEE DOCUMENTATION FOR PROPER FORMAT
- *** QD0302 INVALID UNIT DESCRIPTION CARD
0 CAUSE: A UNIT WAS NOT PROPERLY DEFINED FOR THE FLOWCHART ROUTI
0 COMMENT: THIS ERROR IS GENERALLY CAUSED BY EITHER NOT HAVING A
0 UNIT EQUATE STATEMENT FOR A UNIT TYPE OR, NOT REPLACING
0 A SYMBOLIC UNIT VARIABLE.
- *** QD0304 INTERNAL DESCRIPTION TABLE OVERFLOW
0 CAUSE: TABLE LIMITS EXCEEDED
0 COMMENT: THIS ERROR IS SERIOUS CONTACT MERLYN DATA SYSTEMS
C
1 ---------- QUICKDOC ------
0 COPYRIGHT 1979 BY MERLYN DATA SYSTEMS
0
0
0 SYSTEM PROGRAMMER INFO
0 INSTALLATION.
0 'QUICKDOC' IS DISTRIBUTED ON A STANDARD LABEL TAPE CONTAINING
0 FIVE FILES. INSTALLATION IS ACCOMPLISHED BY UNLOADING THE
0 JCL ON THE FIRST FILE AND RUNNING THAT TO INSTALL THE
0 OTHER FILES.
0 THE JCL TO PUNCH THE FIRST FILE :
0 //JOB CARD
0 //SYSIN DD DUMMY,DCB=BLKSIZE=80
0 //SYSPRINT DD SYSOUT=A
0 //SYSUT1 DD DSN=FILE1,DISP=OLD,VOL=SER=TAPENO,
0 // UNIT=TAPE
0 //SYSUT2 DD SYSOUT=B
0 //
0
0 AFTER PUNCHING THE FIRST FILE AND MODIFYING IT TO YOUR
0 INSTALLATION STANDARDS, RUN THE JOB TO UNLOAD THE TAPE.
0 THE FIRST RUN OF QUICKDOC WILL PRODUCE THE DEFAULT CONTROL
0 FILE AND PRINT THE OPTIONS. AFTER THIS RUN YOU SHOULD CALL
0 MERLYN DATA SYSTEMS TO GET THE CODE TO TURN QUICKDOC ON. THIS
0 IS A VERY MINOR PROCEDURE AND WILL NOT BE TO DIFFICULT.
0 QUICKDOC COMES WITH WHAT WE FEEL ARE THE BEST OPTIONS AS
0 DEFAULT, BUT ALL OF THEM MAY BE CHANGED. THE CHANGE CONTROL
0 CARDS ARE EXACTLY THE SAME AS THE NORMAL CONTROL CARDS EXCEPT
0 THEY ARE PREFIXED WITH A "P" (PERMANANT).
0 EXAMPLE. NORMALLY CODE DDNAME=CARD
0 TO CHANGE DEFAULT CODE PDDNAME=CARD
0 THERE ARE ONLY TWO "H" TYPE CARDS THAT HAVE DEFAULTS, ONE IS
0 IS THE H-INSTALL CARD, TO CHANGE THE DEFAULT OF THE INSTALL
0 OPTION CODE P-INSTALL= THE OTHER IS NOT PREVIOUSLY DEFINED
0 BUT IT THE INSTALLATION ADDRESS. THIS WILL BE CODED P-LOCTION=
0 AND HAS A MAXIMUM LENGTH OF 85 CHARACTERS.
0 EXAMPLES
0 P-INSTALL=XXX (MAX OF 8 CHARACTERS)
0 P-LOCTION=YOUR INSTALLATION, ANYWHERE USA. (MAX 85)
0
0 NOTE THESE TWO CARDS MUST START IN COLUMN 1.
0
0
C
1 ---------- QUICKDOC -------
0 COPYRIGHT 1979 BY MERLYN DATA SYSTEMS
0
0
0
0 PRODUCT WARRANTY
0 MERLYN DATA SYSTEMS WILL PROVIDE FREE EACH NEW RELEASE
0 OF "QUICKDOC" FOR FIVE (5) YEARS. THE PRODUCT IS WARRENTED
0 FOR LIFE AGAINST FAILURES CAUSED BY PROGRAMMING FAULTS OF
0 MERLYN DATA SYSTEMS, PROVIDED THAT WRITTEN NOTIFICATION
0 IS RECEIVED ACCOMPANIED BY FULL DOCUMENTATION OF THE PROBLEM.
0 MERLYN DATA SYSTEMS AGREES TO CORRECT THE PROBLEM WITHIN
0 THIRTY (30) DAYS OF RECEIPT OF THIS NOTIFICATION. UPON FAILURE
0 OF MERLYN DATA SYSTEMS TO COMPLY WITH THIS WARRANTY THE
0 SOURCE MATERIAL AND DOCUMENTION WILL BE RELEASED TO THE USER
0 FROM THE CUSTODIAN. MERLYN DATA SYSTEMS DOES NOT WARRENT
0 THIS PRODUCT IN THE EVENT THAT THE USER FAILS TO COMPLY WITH
0 THE CONTRACTUAL OBLIGATIONS OR, IN THE EVENT THAT THE MANUFACTU
0 MODIFIES HIS SYSTEM DESIGN SO THAT IT IS NO LONGER FEASIBLE TO
0 UPGRADE OR MAINTAIN "QUICKDOC". MERLYN DATA SYSTEMS WILL,
0 AFTER FIVE YEARS, PROVIDE AT A REASONABLE COST NEW RELEASES
0 OF "QUICKDOC" SHOULD THE USER SO DESIRE.
0
0
0
0
0
0 THIS WARRANTY IS SUPPLIED FOR INFORMATIVE PURPOSES IN THIS
0 DOCUMENTATION AND IS NOT BINDING. CONSULT THE PURCHASE AGREEMEN
0 FOR COMPLETE SERVICE AGREEMENT AND COST.
0
0 WRITTEN NOTIFICATION SHOULD BE BY RETURN RECEIPT MAIL.
C
1 ---------- QUICKDOC --------
0 COPYRIGHT 1979 BY MERLYN DATA SYSTEMS
0
0
0
- SUBROUTINE USAGE
- CENTER : CENTERS INFORMATION IN FIELD DEFINED BY USER
0 MAX FIELD LENGTH 133 BYTES
- EXAMPLE: 01 FIELD-LENGTH PIC S999 COMP-3.
0 01 HEADING-TO-CENTER PIC X(133).
- CALL CENTER USING HEADING-TO-CENTER FIELD-LENGTH.
-
------------------------------------------------------------------------
-
- MULTIMV : MOVES VARIABLE NUMBER OF BYTES FROM FIELD ONE TO
0 FIELD TWO.
0 MAX NUMBER OF BYTES MOVED 65535.
- EXAMPLE: 01 BYTES-TO-MOVE PIC S9(5) COMP-3.
0 01 FROM-FIELD PIC X(133).
0 01 TO-FILED PIC X(833).
0 CALL MULTIMV USING FROM-FIELD BYTES-TO-MOVE
TO-FIELD.
--->NOTE: MULTIMV WILL MOVE DATA REDARDLESS OF BOUNDRYS, CARE
SHOULD USED WITH THIS SUBROUTINE.
-
------------------------------------------------------------------------
-
- CALLROT : ROTATES FULL PAGE OF OUTPUT 90 DEGREES
- EXAMPLE: 01 DATA-0.
0 03 D-LINE OCCURS 99 TIMES PIC X(91).
0 01 DATA-90.
0 03 D-LINE90 OCCURS 91 TIMES PIC X(99).
0 CALL CALLROT USING DATA-0 DATA-90.
- FORMAT ALL 99 LINES OF PAGE IN DATA-0.
0 CALL CALLROT
0 WRITE OUTPUT FROM DATA-90, FIRST WRITE USE TOP-OF-FORM
0 NEXT 90 WRITES USE SINGLE SPACE
--->NOTE: CALLROT REQUIRES ROTATED CHARACTER SET.
C
