0.002/01/90 TONY SANTOS 1.0 PROGRAM NARRATIVE ----------------- THIS PROGRAM IS USED TO PRINT SYSTEM AND PROGRAM DOCUMENTATION. THERE ARE TWO TYPES OF INPUT RECORDS, FIRST IS THE JOB INFORMATION RECORD WHICH CONTAINS THE PROGRAMMER NUMBER AND ROOM NUMBER FOR THE JOB CARD. THE SECOND IS THE PROGRAM INPUT RECORD WHICH CONTAINS THE SYSTEMS OR PROGRAMS FOR WHICH DOCUMENTATION IS TO BE PRINTED. THE DOCUMENTATION FOR A SINGLE PROGRAM CAN BE PRINTED BY SPECIFYING 'P' AND THE PROGRAM ID ON THE INPUT RECORD OR ALL DOCUMENTATION FOR A SUBSYSTEM CAN BE PRINTED BY SPECIFYING THE SUBSYSTEM AND 'ALL' AS THE PROGRAM NUMBER. FOR EXAMPLE, 'REGALL ' WILL PRINT ALL OF THE REGISTRATION DOCUMENTATION. SYSTEM DOCUMENTATION CAN BE PRINTED BY SPECIFYING 'S' AND THE SYSTEM PREFIX ON THE INPUT RECORD. THE PROGRAM WILL ALSO PRINT UP TO SEVEN DIFFERENT SECTIONS OF PROGRAM DOCUMENTATION AND THREE SECTIONS OF SYSTEM DOCUMENTATION. PROGRAM DOC5301 READS THE INPUT RECORDS AND THE INDEX FILE FROM THE PDS SPECIFIED ON THE INPUT CARD AND FORMATS THE JCL THAT WILL EXECUTE PROGRAM DOC5302. THE INDEX SUPPLIES THE PROGRAM WITH THE PROGRAM NAME AND COLLEGE ID. THE PROGRAM ALSO READS THE TRANS- ACTION SEGMENT OF THE CONTROL DATABASE TO GET THE SUBSYSTEM NAME. OUTPUT FROM THE PROGRAM IS A JCL FILE WHICH IS INPUT TO THE SECOND STEP OF THE DOC530 PROC WHICH SUBMITS THE FILE TO THE INTERNAL READER OF THE SYSTEM. THE PROGRAM DOC5302 READS THE INPUT RECORDS GENERATED BY DOC5301 AND PRINTS THE DOCUMENTATION. DOC5302 STARTS A NEW PAGE WHENEVER THE LINE COUNTER 'LINE-CNT' IS EXCEEDED OR SECTION 3.0 STARTS MORE THAN 30 LINES DOWN THE PAGE OR IF AN '*' IS FOUND IN COLUMN 1. 2.0 SAMPLE JCL ---------- 2.1 RUN JCL ------- //TNDOC530 JOB (XXXX,YYYY),DOC530,CLASS=Q, // MSGCLASS=A,MSGLEVEL=(0,0),REGION=2048K /*ROUTE XEQ HOST //DOC530 EXEC DOC530,COLLEGE=XX,AGENCY=XXX,INDX=XXXXXXXXXXX, // RUNTYPE=YYYY //PARMCARD DD * -- FIRST INPUT RECORD -- -- SYSTEM AND/OR PROGRAM INPUT RECORD(S) -- /* //STEP02 EXEC READJOBS //SYSIN DD DSN=&&DOCJCL,DISP=(OLD,DELETE) // SYMBOLIC DESCRIPTION -------------------- AGENCY COLLEGE AGENCY CODE NUMBER, REQUIRED ENTRY (E.G. AGENCY=293) RUNTYPE DESIGNATES IF RUN USES PROD OR TEST (E.G. RUNTYPE=TEST) COLLEGE TWO CHARACTER COLLEGE NAME ABBREVIATION, REQUIRED ENTRY (E.G. COLLEGE=TN) INDX DENOTES THE LIBRARY WHERE THE INDEX OF PROGRAMS IS LOCATED (NOTE: THE ENTIRE QUALIFIED DATA SET NAME MUST BE SUPPLIED AS IN THE DEFAULT BELOW) DEFAULT - SOAD.SIS.PARTPROD.DOC (E.G. INDX='SOAD.SIS.PARTPROD.NEWDOC') 2.2 INPUT PARAMETERS: ---------------- POS CONTENTS --- -------- FIRST INPUT RECORD 01-04 PROGRAMMER NUMBER 05-08 ROOM NUMBER 09 JOB CLASS ('J' OR 'A') 10-13 FORM NUMBER (I.E. '0034') 14 NUMBER OF COPIES OF DOCUMENTATION 15 CLASS TO EXECUTE IN ('O' OR 'F') 16-31 DATA SET WHERE DOCUMENTATION IS LOCATED THERE CAN BE MULTIPLE SYSTEM AND PROGRAM INPUT RECORDS. THERE CAN BE AS MANY AS 10 PROGRAMS OR SUBSYSTEMS ON EACH PROGRAM INPUT RECORD AND AS MANY AS 25 SYSTEMS ON EACH SYSTEM INPUT RECORD. PROGRAM INPUT RECORD: 01 P - PROGRAM DOCUMENTATION 02-08 PROGRAM DOCUMENTATION SECTIONS: BLANK - ALL SECTIONS 1 - PROGRAM NARRATIVE 2 - SAMPLE JCL (BATCH) USER OPERATING INSTRUCTIONS (ONLINE) 3 - JOB SETUP INSTRUCTIONS (BATCH) SCREEN LAYOUT (ONLINE) 4 - FILES 5 - SPECIAL OUTPUT MESSAGES (BATCH) SPECIAL FEATURES (ONLINE) 6 - SPECIAL FEATURES (BATCH) PROGRAM OPTIONS (ONLINE) 7 - PROGRAM OPTIONS (BATCH) PROGRAM CHANGE HISTORY (ONLINE) 8 - PROGRAM CHANGE HISTORY (BATCH) 09-11 SUBSYSTEM (I.E. 'REG' ) 12-15 4 DIGIT PROGRAM NO. (I.E. '055 ') OR 'ALL ' FOR ALL DOCUMENTATION IN THE SUBSYSTEM. SYSTEM INPUT RECORD: 01 S - SYSTEM DOCUMENTATION 02-04 SYSTEM DOCUMENTATION SECTIONS (I.E. 1,2,3,4) BLANK - ALL SECTIONS 1 - INTRODUCTION 2 - SYSTEM NARRATIVE 3 - DATA BASE DESIGN 4 - PROGRAM DOCUMENTATION 05-07 SYSTEM (I.E. 'REG') 3.0 JOB SETUP INSTRUCTIONS ---------------------- SPECIAL FORMS QUEUE: MAIL FORMS BUFFER: STANDARD ALIGNMENT INSTRUCTIONS: ALIGN TO ALLOW FOR HOLE PUNCHES IN LEFT MARGIN PRINTED OUTPUT: PROGRAM/SYSTEM DOCUMENTATION FORMS TYPE: 9 1/2 X 11 SPECIAL INSTRUCTIONS: NONE 4.0 FILES ----- 4.1 DATABASE SEGMENTS USED: ----------------------- A. CONTROL DATABASE 1. TRANSACTION SEGMENT (READ ONLY) 4.2 ADDITIONAL FILES USED: --------------------- 1. TNNORTC.SIS.DOC 2. TNNORTC.SIS.DOC(INDEX) 4.3 INPUT/OUTPUT RECORD LAYOUT: N/A -------------------------- 5.0 SPECIAL OUTPUT MESSAGES: N/A ----------------------- 6.0 SPECIAL FEATURES ---------------- 6.1 CALLING PROGRAMS: N/A 6.2 SUBPROGRAMS CALLED: N/A 6.3 MESSAGE SEGMENT CODES: N/A 7.0 PROGRAM OPTIONS: N/A --------------- 8.0 PROGRAM CHANGE HISTORY ---------------------- 8.1 VERSION NO: V1.0 CHANGE DATE: 10-05-83 PROGRAMMER NAME: KEN BALLARD PROGRAM CHANGE REQUEST NO: N/A DESCRIPTION OF CHANGE: N/A VERSION NO: V1.2 CHANGE DATE: 01-10-84 PROGRAMMER NAME: KEN BALLARD PROGRAM CHANGE REQUEST NO: N/A DESCRIPTION OF CHANGE: CHANGED PROGRAM TO ACCEPT THE NAME OF THE PDS WHERE THE DOCUMENTATION IS LOCATED VERSION NO: V1.4 CHANGE DATE: 03-05-84 PROGRAMMER NAME: KEN BALLARD PROGRAM CHANGE REQUEST NO: SR-002, NR-028 DESCRIPTION OF CHANGE: CHANGED PROGRAM TO ACCEPT JOB CLASS AND FORM NUMBER FROM AN INPUT RECORD. VERSION NO: V1.8 CHANGE DATE: 07-30-84 PROGRAMMER NAME: KEN BALLARD PROGRAM CHANGE REQUEST NO: N/A DESCRIPTION OF CHANGE: CHANGED PROC TO CONFORM TO SIS PROC STANDARDS. CHANGED PROGRAM TO PRINT COLLEGE ID IN SYSTEMS DOCUMENTATION. VERSION NO: V1.9 CHANGE DATE: 08-22-84 PROGRAMMER NAME: KEN BALLARD PROGRAM CHANGE REQUEST NO: N/A DESCRIPTION OF CHANGE: CHANGED LINES LIMIT IN HARD CODED JCL FROM 28 TO 99. VERSION NO: 2.0 CHANGE DATE: 04-15-85 PROGRAMMER NAME: RON LOPEZ PROGRAM CHANGE REQUEST NO: STC-VW-072 DESCRIPTION OF CHANGE: ADD TO DOCUMENTATION: /*ROUTE XEQ HOST PROGRAM CHANGE REQUEST NO: STC-SR-012 DESCRIPTION OF CHANGE: CHANGE PROC TO POINT TO SOAD.SIS.PARTPROD.DATADICT AND TO CODE SYMBOLLIC PARAMETERS IN THE PROC. VERSION NO: V2.2 CHANGE DATE: 06-19-85 PROGRAMMER NAME: KEN BALLARD PROGRAM CHANGE REQUEST NO: STC-TC-006 DESCRIPTION OF CHANGE: CHANGED INPUT RECORD TO ACCEPT NUMBER OF COPIES TO PRINT AND ALSO CHANGED PROGRAM TO PERFORM A TOP OF FORM WHENEVER AN '*' IS FOUND IN COLUMN 1. VERSION NO: V3.4 CHANGE DATE: 10-22-87 PROGRAMMER NAME: ELIZABETH BANI PROGRAM CHANGE REQUEST NO: STC-TC-172 & STC-TC-269 DESCRIPTION OF CHANGE: 1. CHANGED 'BLOCK CONTAINS' CLAUSE FOR 'DOC-IN' FILE DESCRIPTION FROM '85 RECORDS' TO '0 RECORDS' IN DOC5302 PROGRAM BECAUSE IT DID NOT ALLOW PRINTING DOCUMENTATION FROM THE NEW TSO DATA SETS AS THEY ARE SET UP WITH BLOCK SIZE EQUAL TO 7440, INSTEAD OF 6800, AS WAS DONE IN THE PAST. 2. CHANGED 'BLOCK CONTAINS' CLAUSE FOR 'INDX-IN' FILE DESCRIPTION FROM '85 RECORDS' TO '0 RECORDS' IN DOC5301 PROGRAM BECAUSE IT DID NOT ALLOW PRINTING DOCUMENTATION FROM THE NEW TSO DATA SETS AS THEY ARE SET UP WITH BLOCK SIZE EQUAL TO 7440, INSTEAD OF 6800, AS WAS DONE IN THE PAST. VERSION NO: V3.7 CHANGE DATE: 02-18-88 PROGRAMMER NAME: TONY SANTOS PROGRAM CHANGE REQUEST NO: STC-SO-379 DESCRIPTION OF CHANGE: ADDED A FIELD TO THE INPUT PARAMETER CARD WHICH WILL CREATE THE JOB CARD TO BE EXECUTED IN CLASS 'O' '99' LINES OR CLASS 'F' '50' LINES. USE CLASS 'O' IF YOU WANT ALL OF THE DOCUMENTEAION, BUT CLASS 'F' IF ONLY PART OF THE DOCUMENTATION IS REQUIRED. VERSION NO: V4.08 CHANGE DATE: 11-14-89 PROGRAMMER NAME: DARRELL SCRUGGS PROGRAM CHANGE REQUEST NO: 00003976 DESCRIPTION OF CHANGE: MADE CHANGES TO PGM = DOC5302. INCREASED SIZE OF PAGE NUMBER FROM Z9 TO ZZ9. AND CHANGED ALL 'IF LINE-CNT > 55' TO 'IF LINE-CNT > 57'. VERSION NO: V4.09 CHANGE DATE: 12-14-89 PROGRAMMER NAME: DARRELL SCRUGGS PROGRAM CHANGE REQUEST NO: 00004505 DESCRIPTION OF CHANGE: CHANGED THE WORDING IN COMMENTS SECTION TO REFER TO THE LINE COUNTER RATHER THEN THE VALUE IN THE LINE COUNTER.