USER MA NUAL FOR DATAENTRY CONTENTS ________ 1. GENERAL INFORMATION 1.1 Identification 1 .2 Summary 1.3 Environment 1.4 References 2. APPLICATION 2.1 Description 2. 2 Operation 2.3 Equipment 2.4 Performance 3. PROCEDURES AND REQUIREMENTS 3.1 Conventi ons 3.2 Initiation 3.3 Dataentry Operation 3.3.1 Input Data Field Format 3 .3.2 Special Entry Keys 3.3.3 Operating Modes 3.3.3.1 Line Mode 3.3.3.2 Random Display Mode 3.3.3.3 Form Display Mode 3.3 .4 Program Control 3.3.4.1 Chaining 3.3.4.2 Interrupts 4. EXAMPLE 1. GENERAL INFORMATION 1.1 Identification ______________ Sys tem Name: DATAENTRY Developed by: Bohden Cmayl o R5 Regional Office ISM Staff Documentation by: Al an Lee Briscoe R5 Regional Off ice ISM Staff Date: November 1981 Revised: Fe bruary 1982 1.2 Summary _______ DATAENTRY is a general data entry program written in Fortran. This program provides multiple input rec ords, individual field prompts, entry correction, error checking, and multiple output records. Da ta entry applications are easily added to the pro gram, or changed. 1.3 Environment ___________ This program is designed for use by source entry personnel and keypunch op erators in the RO and on the forests with DEC mai nframes. 1.4 References __________ The DEC RSX-11M manuals provide docu mentation on the operating system for the PDP 11/ 34 and 11/70. 2. APPLICATION 2.1 Descripti on ___________ The DATAENTRY progr am is used by personnel that need data entered in to a file on a PDP 11/34 or 11/70 computer. Usin g this program will improve the speed, accuracy, and efficiency of the data entry process. Small and large versions of DATAENTRY are available. Br iefly, the small version will accommodate up to 99 input fields and the large version will accommodate up to 999 input fields. Each data entry app lication is described in an application format fi le containing input field formats and records, ch eck parameters, and output record formats. This file is used by the program to provide you with t he prompts, error checks, etc., when you enter yo ur data. The program provides user prompts for e ach data field. The sequence in which the prompts appear can be automatic or user controlled. Dat a fields that remain constant on each record can be automatically repeated from record to record. As the data is entered, the program will check t he data for certain types of errors. After the da ta for a record is entered it can be reviewed by the user for other errors. The data fields can b e written to an output file in one or more record sequences. 2.3 Operation _________ Any user, with a data processing account on the ho st computer, can use this program to enter data f rom coding forms or other sources. The program generated output file containing the data can be located in the user's account. This output file can then edited or used according to the user's needs. Security and privacy considerations for the data depend on the application. These needs should be discussed with the system manager. 2.4 Equipment _________ T his program will run on any DEC PDP 11 series computer using a RSX-11M operating system and equipped with FORTRAN software. The program provides s creen formatting for the following types of termi nals: VT52, HP2621, TV9 series, VT100. Other term inals can be used, but the program will display i nformation line by line like a hardcopy terminal. 2.5 Performance ___________ The small version of DATAENTRY program runs in approx. 20K words of core, while the large version runs i n approx. 28K words of core. Each application fo rmat file is approx. 1-3 blocks long. The program reacts quickly to operator input and is difficult to "outrun". Reaction time problems may occur if the terminal is not communicating with the ho st computer at a high enough BAUD rate. The program will handle most data entry applications in an efficient and reliable manner. 3. PRO CEDURES AND REQUIREMENTS Before you start a data entr y session, you should have your data and the Dataentry Input Format sheet (See Appendix 1) for your applicat ion. This format sheet was filled in by the person wh o set up the application file that you will direct the program to use. The sheet will show you what types, if any, are available if you want to use Form Mode. The sheet also describes the input record(s) and formats of the f ields within the record(s) and the checks made on the data. If the program will not accept an entry that ap pears to be valid, notify the person who set up the ap plication file. 3.1 Conventions ___________ The conventions listed below ar e used in the following procedures. 1. Double quotation marks "..." enclose user entries. 2. Single quotation marks '...' encl ose program generated information. 3. Parentheses (...) enclose items that may be changed by the user to fit the situation. 4. B rackets <...> enclose commands that are entered with a single key. 5. Where the input to the com puter is variable length, the user must usually e nter "" after the input to transmit the i nput to the computer. This "" is not sho wn in the procedures or examples. In cases where the input is fixed length, the computer will react as soon as y ou have entered the right number of characters. 6. A slash character in a user entry, ie. "/Z", means that the characters or commands immed iately before and after the slash are entered at the same time or the first is held down while the second is pressed. 7. Upper case words are pro cedures. Lower case words are indexing and expla nations. 8. The procedures are divided into par agraphs of related commands and responses. 9. Numeric entries are called digits. Alpha-numeric entries are called characters. 3.2 Initiation __________ USER LOGS ON TO S YSTEM USER ENTERS "(data entry)" W here data entry is the correct syntax for running the program versions available at your site. Ask the syst em manager for this syntax. C OMPUTER STARTS PROGRAM COMPUTER ASKS TERMINAL TY PE USER ENTERS TERMINAL TYPE Enter "" for a list of terminal types. Terminal types recognized by the program are VT52, HP, TV9, VT100, and OTHER. Entering OTHER means the p rogram will operate line by line like a hard copy terminal. If the program does not reco gnize your entry, it will list the terminal types and ask for the type again. If it still does not recognize you entry, it will assume OTHER as the type. COMPU TER LISTS GENERAL APPLICATIONS USER ENTERS "(name )" Name must be the general application name or the filespec of an application file. Th e names or filespec for your application are listed at the top of the Dataentry Input F ormat sheet for your application. The progra m will repeat the index if it does not recognize your entry. If you enter a filespec and it is not in the correct format, the program will halt and y ou will have to start over. If the filespec of an application is entered, skip this paragraph. COMPUTER LISTS SPECI FIC APPLICATIONS USER ENTERS "(name)" Name must be a specific application name or the filespe c of an application file. Otherwise, the pr ogram will halt and you will have to start o ver. COMPUTER ASKS FOR OUTPUT FILENAME USER ENTERS "(filename)" The filename can be any filespec that is acceptable to th e RSX-11M operating system. If you want to append the data that you enter in this session onto the end of a n existing file, add /AP to the end of your filespec. If you enter a filespec and it is not in the correct format, the program will halt and you will have to start over. COMPUTER ASKS 'OK QUESTION ASKED AT THE END OF A RECO RD?' USER ENTERS "N" OR "" 1. If you want to be asked if your entries for a record are ok before they are written to the output file, enter "". Then you will have the option of reaccessing and checking each field. 2. If you want your entries writte n to the output file as soon as the data for the entire record is inputted, enter "N". You will not be able to reaccess your data a t the end of an input sequence. COMPUTER ASKS 'AUTO CARRIAGE RETURN AT FIELD END?' USER ENTERS "N" OR "" 1. If you want the progra m to move to the next field as soon as you h ave filled the current field without having to enter a "", enter "". Any data that overfills the current field will be put into the nex t field. 2. If you wa nt to have to enter "" after each en try in each field, enter "N". If your entry overfills a field while in this mode, none of the entry will be recorded and you will have to enter it agai n. Depending on the structure of your data entry application, the program will ask one of the following questions. If the re is one or more input record type in your appli cation, skip this paragraph. COMPUTER ASKS 'DO YO U WANT RANDOM ACCESS?' USER ENTERS "Y" or "" 1. If you want to be able to choose the entry order of the fields, enter "Y". 2. If you want the fields automatically presen ted in the same order as in the application format file, enter "" for Line Mode. COMPUTER ASKS 'DO YOU WANT FORM MODE?' USER ENTERS "N" OR "" 1. If you want to see all fields at once and input data in the same sequential order as the application file, enter "". 2. If y ou only want the individual fields presented sequentially in the same order as the application format file, enter "N" for Line Mode. Table of Appropriate Responses to the Initialization Questions. Desi red Operational Mode Initialization Question Line Random Form OK at end of record? (Y) or N (Y) or N (Y) or N Auto Carriage Return? (Y) or N (Y) or N (Y) or N Random Mode? (N) Y n/a Form Mode? N n/a (Y) ( ) indicates the default for entering "" 3.3 Dataentry Operation _______ ____________ 3.3.1 Input Data Field Format _______________________ The computer displays the input data fields in the format: NNN:PROMPT:OLD-VA LUE(=or?) --- NNN i s the field number from the application format file. PROMPT is the user prompt or name for the field OLD-VALUE is the p revious value, if any. If the value displayed here is correct, enter "" to leave it unchanged. Entering "" will force output records for all records containing this field. =or? are the characters that mark the end of the field. A = means that the field must be filled and a ? means that field can have variable length data. --- show the length of the field by the number of dashes and are replaced by the data as you enter it. These dashes will not appear in Form Mode, Instead, the new data will overwrite the OLD-VALUE. The pro gram stores the last value entered for eac h HEADER or DATA field until that value is changed. 3.3.2 Special Entry Keys __________________ 1. A blank , when entered as a single character, is a valid entry which blanks the entire field. The program will consider the field to have been accessed when you enter a blank. 2. A ! entered as an entry will blank out the data in the current field plus all following fields. If there are multiple input records, only the fields in that record type will be blanked out. The program will consider all fields with blanks inserted to have been accessed. 3. An en tered will back up to the previous field s o that you can correct errors after leavin g that field. When you enter in a f ield, the program no longer considers that field to have been accessed. You can use to back up if you enter the wrong type and want to get out without forcing any output records. 4. An "@" or "/Z" entered during the i nput sequence controls program branching a nd output. See the Program Control Table i n 3.3.6 5. A "" entered at the s tart of the field will leave the field unc hanged whether it has data in it or not. The program will also consider that you ha ve accessed the field when you enter a "". 3.3.3 Operating Modes _______________ 3.3.3.1 Line Mode _________ This mode is available when there is only one input record or you did not select random mode or form mode during program initiation. The fields are shown one at a time in the same sequence as in the application file. COMPUTER SHOWS FIELD PROMPT The header prompts are shown first. Once data is entered for the headers, they will not appear again unless you wish to change that data and interrupt the program with an "@" or "/Z. U SER ENTERS "(data)" This sequence is repeated until you have accessed all of the fields for a record or interru pted the program with a "@" or "/Z". If you did not select the OK quest ion option, skip this paragraph. COMPUTER ASKS 'ARE ALL FIELDS OK?' USER ENTERS "N" or "" 1 . If you want to review your entries, enter "N". 2. If you do not want t o review your entries, enter "". The program will write the output rec ords. Then the program will show the firs t field prompt for the input record Type t hat it has chained to. 3.3.3.2 Random Display Mode ___________________ This mode is available if there is only one input record sequence and you select rand om access mode during program initiation. COMPUTER SHOWS HEADER AND DATA FIELD NUMB ERS AND PROMPTS COMPUTER ASKS FOR FIELD NUMBER USER ENTE RS "(N)" N is the field number and is not right justified. COMPUTER SHOWS INPUT DATA FIELD PROMPT USER ENTERS "(data)" This sequenc e will repeat until you access all of the required fields or interrupted t he program with an "@" or "/Z. The OK question option does not work in this mode. The program will th en write the output records, if any, return to ask for a field number. 3.3.3.3 Form Display Mode _________________ This mode is available if there is more than one input record type and you select Form Mode during program initiation. COMPUTER ASKS FOR TY PE USER ENTERS "(C)" C is the character name for the input record type that you wish to use to input data. See your Dataentry Input Format sheet for the types available and their names. COMPUTER DISPLAYS INPUT FIELDS All fields including constants and headers for the input record type are shown at once. You will not be able to change consta nt data. You will be able to change header or data fields on each line. Any data that appears after a prompt may be written to the output file dep ending on which fields you access and the output records. USER ENTERS "(data)" The cursor position shows the current field for input. If you did not select the OK question option, skip this paragraph . COMPUTER ASKS 'ARE ALL FIELDS OK?' USER ENTERS "N" or "" 1. If you want to review your entries, enter "N". 2. If you do not want to review your entries, e nter "". The program will wr ite the output records. Then the prog ram will display the input fields for the Type that it has chained to. 3.3.4 Progr am Control _______________ 3.3.4.1 Chaining ________ When the application file is set up, the program can be instructe d to chain, that is, move automat ically from one input record Type to another. None, some, or, all of the Types can chain to anothe r Type, but each Type can only be chained from once. If there are no chaining instructions for a p articular Type, that Type will chain to itself until you interrupt the program. See the Dataentry Input Format sheet for information on which Types chain to other Types. 3. 3.4.2 Interrupts __________ The program will repeat the input sequence until it is interrupted. The program is interrupted by ente ring an "@" or "/Z" during the input sequence. The followin g table show the action that the program takes when you interrupt the input sequence at different p oints. When the program "outputs data" it writes any output recor ds containing any data fields tha t have been accessed since the la st output cycle. Remember that e ntering in a field will mean that the field is no longer considered to have been accessed. I n normal operation, you will probably let the program cycle without many interrupts unless you want to change headers or types. PROGR AM INTERRUPT TABLE POSITION IN INPUT SEQUENCE MODE WHEN ENTERING "@" OR "/Z" LINE RANDOM FORM ____________________________________________ PROGRAM ASKS no output, n/a no o utput, FOR TYPE terminates terminates PROGRAM ASKS no output, no output, n/a FOR FIELD #, terminates terminates NO DATA FIELDS ACCESSED PROGRAM ASKS n/a outputs data, n/a FOR FIELD # asks for AFTER ACCESSING field # DATA FIELDS HEADER FIELD, no output, no output, no output, NO DATA FIELDS terminates asks for asks for ACCESSED field # type HEADER FIELD, no output , outputs data, outputs data, AFTER ACCESSI NG terminates asks for asks for type DATA FIELDS field # FIRST DATA moves to header no output, no output, FIELD, NO fields, if any asks for asks for type OTHER DATA exist, or fiel d # FIELDS ACCESSED terminates FIRST DATA moves to header outputs data, outputs data, FIELD AFTER fields, if any asks for asks for type ACCESSING exist, or field # OTHER DATA FIELDS terminates DATA FIELD ou tputs data, outputs data, outputs data, OTHER THAN moves to first asks for asks for ty pe THE FIRST header field, field # DA TA FIELD if any exist, or first data field 4. EXAMPLE The following is an example of the forms and documents for a simple data entry application. Included is the Dat aentry Input Format sheet, a transcript of a data entr y session, and the output file that resulted from the session. DATAENTRY INPUT FORMATS GENERAL APPLICATION NAME:_____________________________ SPECIFIC APPLICATION NAME:____________________________ APPLICATION FILESPEC:_EX.DAT;_________________________ _______ PROG RAMMER:_BRISCOE____________ DATE:_12/81__________ _______ _____ INPUT RECO RD TYPE NAME:________ CHAINS TO:___________ HDR/ FLD FMT DATA # FIELD NAME PROMPT 0+Z-? LENGTH ERROR CHECKS OR CONSTANT ______________________________________________________________ ______________ TYPE:L CHAINS TO: A_______________ _____ ______ ________________________ ____ ___ _________ _H__ _5_ ________________________ __0__ ______ @RUN,J R05ALB,11 05206520 _ _ _ ________________________ ____ ___ ___________________ _____ _____ ______ AA,ALB,1,100____________ ____________ _H__ _10 ________________________ __0__ ______ @ASG ,A EXAMPLE._________ _ __ _ _______________ _H__ _15 _______ _________________ __0__ ______ @DATA,IL EXAMPLE._______ _ __ _ ____________ _____ _D__ _35 ENTER RETURN____________ __+__ ___1__ ________________________ _ __ ____________ _ _ ____ ___ ________________________ _____ ______ __________________ ______ TYPE:A CHAINS TO: B_______________ _____ ______ ________________________ ____ ___ _________ _H__ _1_ E NTER DATE (MM/DD/YY)___ __-__ ___8__ ________________________ _ _ _____________________ _ _ _D__ _45 ENTER FIXED DIGITS______ __+__ ___ 5__ 00000333337777799999____ _ __ __________________ _ _ ____________________ _D__ _50 ENTER VARIABLE DIGITS___ __Z__ ___3__ 000100_______________ ___ _ __ _____________________ _ _ ___ ___ TYPE:B CHAINS TO: A_______________ _____ _ _____ ________________________ ____ ___ _________ _D__ _ 55 ENTER FIXED CHARACTERS__ __-__ ___5__ AAAAABBBBBCCCCCDDDD D____ _ __ ______________________ _ _ _ ___________________ _D__ _60 ENTER VARIABLE CHARACT ERS __?__ ___4__ A___BB__CCC_DDDD________ _ __ ____ ____________________ _ _ _ __ ___ ____ ____ ___ ________________________ _____ ______ _______ _________________ TYPE:T___ ________________________ __ ___ ______ ________________________ ____ _ H__ _20 ________________________ __0__ ______ @END_________ ___________ _ __ _ ____ _H__ _25 ________________ ________ __0__ ______ @FIN____________________ __ _ ____ _H__ _30 ________________________ __0__ ______ @ @______________________ _ __ _ __ _D__ _40 ENTE R RETURN____________ __+__ ___1__ ________________________ _ __ ____________ __ _ Error checks for + or Z formats are pairs of data. Each member of the pair is as long as the fiel d. Each pair forms a range check for the field. Error che cks for - or ? formats are groups of characters. Each group is as long as the field. The data must exactly match at lea st one group. Constants for 0 formats are variable length character strings. THIS IS THE TRANSCRIPT OF THE DATA E NTRY SESSION. THE TRANSCRIPT STARTS AFTER THE USER HAS LO GGED ON TO A TERMINAL IN DP MODE. USER ENTRIES ARE IN "DOU BLE QUOTES". THE APPLICATION FILE, EX.DAT; IS LOCATED IN THE USER'S UFD. >"DATA" ENTER TERMINAL TYPE ="OTH ER" *** TERMINAL TYPE IS ***. OTHER ***. *** DATAENTRY PROGRAM ***. *** ENTER GENERAL APPLIC ATION: APPLICATION PPB PROGRAM PLANNING STAFF ISM ISM STAFF TIMBER TIMBE R STAFF FISCAL FISCAL STAFF UTILITY O THER UTILITY FILES FOR DATAENTRY ENTER APPLICATION ="EX.D AT" *** APPLICATION EX.DAT NO T FOUND, ASSUMED AS AN INPUT FILE. *** ENTER OPTIONS ***. OUTPUT FILE NAME="XXX.XXX" OUTPUT FILE NAME=XXX.X XX OK QUESTION ASKED AT END OF RECORD (D: Y) ? "" AUTO CARRIAGE RETURN AT FIELD END (D: Y) ? " " DO YOU WANT FORM MODE (D: Y) ? "N" TYPE - ? "L" 35: ENTER RETURN: = "" *** ARE ALL FIELDS OK (D: Y) ? "" R ECORD 1:@RUN,J R05ALB,1105206520AA,ALB,1,100 RECORD 2:@ASG,A EXAMPLE. RECORD 3:@DATA,IL EXAMPLE. 1: ENTER DATE (MM/YY/DD): = -------- "12/28 /81" 45: ENTER FIXED DIGITS: = ----- "12 345" 50: ENTER VARIABLE DIGITS: ? --- "9 9" *** ARE ALL FIELDS OK (D: Y) ? "" RECORD 4:12/28/8112345099 RECORD 5: 099 12345 12/28/81 55: ENTER FIXE D CHARACTERS: = ----- "EEEEE" *** ERROR *** INVALID ALPHA ENTERED, TRY AGAIN. DATA:EEEEE 5 5: ENTER FIXED CHARACTERS: = ----- "DDDDD" 60: ENTER VARIABLE CHARACTERS: ? ---- "CCC" *** ARE ALL FIELDS OK (D: Y) ? "" RECO RD 6:12/28/8112345099DDDDDCCC RECORD 7:CCC DD DDD 099 12345 12/28/81 1: ENTER DATE (MM/ YY/DD):12/28/81= -------- "/Z" TYPE - ? "T" 40: ENTER RETURN: = - "" *** ARE ALL FIELDS OK (D: Y) ? "" RE CORD 8:@END RECORD 9:@FIN RECORD 10:@@ 40: ENTER RETURN: = - "/Z" TYPE - ? "/Z" * END OF DATA ENTRY * * INPUT F IELDS = 7 * OUTPUT RECORDS= 10 THIS IS THE O UTPUT FILE FROM THE DATA ENTRY SESSION. @RUN,J R05ALB,110 5206520AA,ALB,1,100 @ASG,A EXAMPLE. @DATA,IL EXAMP LE. 12/28/8112345099 0 99 12345 12/28/81 12/28/8112345099DDDDDCCC CCC DDDDD 099 12345 12/28/81 @END @FIN @@ OPERATION MANUAL FOR DATAENTRY CONTENTS ______ __ 1. GENERAL INFORMATION 1.1 Identificat ion 1.2 Summary 1.3 Environment 1.4 References 2. OVERVIEW 2.1 System Distr ibution 2.2 System File Inventory 2.3 Syst em Installation 3. FILE STRUCTURES 3.1 Appli cation File 3.2 Application File Section Formats 3.2.1 SQUEEZE Section 3.2.2 HEADER Section 3.2.3 DATA Section 3.2.4 OUTPUT Section 3.2.5 TYPE Sectio n 3.2.6 END Section 3.3 Building an Application File 3.4 Application Index Files 4. EXAMPLE 1. GENERAL INFORMATION 1.1 Ide ntification ______________ System Name: DATAENTRY Developed by: Bohden Cmaylo R5 Regional Office ISM Staff Documentation by: Alan L ee Briscoe R5 Regional Office ISM Staff Date : November 1981 1.2 Summary _______ DATAENTRY is a general data entry program written in Fortran. This program provides multiple inpu t records, individual field prompts, entry correc tion, error checking, and multiple output record types. Data entry applications are easily added to the program. 1.3 Environment ______ _____ This program is designed for use by source entry personnel and keypunch operators in the RO and on the forests with DEC mainframes. 1.4 References __________ The DEC manuals contain documentation on the RSX-11M operating system and DEC Fortran. 2. OVERVIEW 2.1 System Distribution ___________________ The DATAENTRY program and its documentation are distributed on tape by the RO. This tape contains the files necessary to taskbuild and use a number of systems and utilities set up by the RO and De cus. All files on the tape are in the UIC [5,10] . Instructions for taskbuilding the systems on t he tape are in the file TASKBUILD.DOC. You may s elect and build the systems that you want through a series of indirect command files starting with TASKBUILD.CMD. DATAENTRY is distributed in two sizes. The small size will handle up to 99 input fields and the large size will handle up to 999 input fields. 2.2 System File Inventory _____________________ The files on the distribution tape containing the DATAENTRY pr ogram and its documentation include: DATAEN.FTN the Fortran source code for the main program DATAEN.COM the compiler in structions used by an ICF DATAENTRY.DOC the use r and operator documentation DATAENTRY.DTN the general application index DATAENTRY.HLP the HEL P file DATAENBLD.CMD the taskbuild ICF DATAENBLD.ODL the Object Descriptor Library After each version of the program is taskbui lt, the task image is in the file DATAEN.TSK. Yo u can build and use both of these programs, but y ou should rename the task images, so that each ve rsion is in a different file. 2.3 System Installatio n ___________________ The DATAENTR Y program task(s) may be installed via VMR or the startup command file. The system manager should make this decision and be responsible for distributing information on how to run the task(s) at your site. 3. FILE STRUCTURES _______________ 3.1 Application File An application file must be created for each data entry application. This file contains information on fields and fo rmats, input records, and output records, that is used to control the data entry program. The app lication file contains from 3 to 6 sections depending on the complexity of the data entry application. The required sections are the DATA section which describes fields and formats, the OUTPUT section which des cribes the output records, and the END section wh ich ends the file. The optional sections include a SQUEEZE section which removes blanks from the output records, a HEADER section which describes fields that are constant from record to record and a TYPE section which describes one or more different input records. The sections must appear in the order SQUE EZE, HEADER, DATA, OUTPUT, TYPE, and END. If the TYPE section is not used, then the user can inpu t the fields in Line Mode or Random Mode. If the TYPE section is used, then the user can input fi elds in Line Mode or Form Mode. T he HEADER section can be used to input data that changes from data entry session to data entry session, but does not change in an output file from line to line. The program will usually ask for this data only o nce, but it can be changed anytime by the user th rough interrupting the program. A HEADER section can be used with any operating mode. The TYPE s ection is used where there are multiple input rec ords or if the user wishes to use Form Mode with one input record. In this section, the program can also be inst ructed to chain, or move automatically, from one Type to another. If the application file contains a TYPE section, the user will not be able to use Random Mode. 3.2 Application File Section Format s ________________________________ Whenever (small) or (large) appear in the following sections, they refer to the version of DATAENTRY and its capabilities. 3.2.1 SQUEEZE SECTION (optional entry to eliminate _______________ blanks from output data) Card # Column Entry 1 1-7 "SQU EEZE" _______ If this section is present in the application file, then all blanks will be removed from any output records an d the data moved to the left. If you want some blanks in yo ur output records, but still w ant to use SQUEEZE, use $ in your input data where you want blanks. SQUEEZE will convert any $ to a blank in the output records. 3.2.2 HEADER SECTION (optional entries for data that do es ______________ not change from card to card) Card # Column Entry 1 1-6 "HEADER" ____ __ There will be one Card #2 for each header field. 2- 1-3 Field Number. A numeric value between 001-099 ____________ (small), or 001-999(large), right justi fied. Arranged in ascending orde r, but need not be incremented b y 1; ie. 5, 10, 15, 20 is recomm ended to make future additions easier. If there are several types, the field numbers must start higher than last data field number of the previous type. 2- 4-: Field Name Prompt. A variable le ngth prompt for _________________ the u ser. Starts in column 4 and ends in a colon. Do not use '?', '.', or '=' in the prompt. 2- :-: Format Description. Starts after the colon and __________________ ends with a colon. Allowable values a re: Format Description 0 The data is a constant that is entere d after the colon that ends this field. +N Exactly N digits must be entered. ZN N is a value from 1 to 20. Up to N digits can be ente red, they will be right justified with a left zero fill. -N Exactly N characters must be entered. ?N N is a value from 1 to 80. Up to N characters can be entered, they will be left justified with a right hand blank fill. 2- :- Error Checking or Constants. The entry in this ________________________ ___ field de pends on the format type and whether checks are needed on the data. No entry results in only format checking. Allowable checks for each format follows: Format Meaning of Entry 0 The entry is the constant. +N or ZN Entries must be arranged in pairs. Each member of the pair is N digits long. E ach pair contains the low and hi gh value of a range check. To p ass this check, the data must fa ll within one of the ranges if any are listed. Any number of pairs can be entered and a blank is a valid entry. ?N or -N Any group of characters that appears must be N characters long. The data enter ed is checked against these grou ps for an exact match. To be va lid, the data must match one of the groups, or be blank. 3.2.3 DATA SECT ION (required section) ____________ Card # Format Entry 1 1-4 "DATA" ____ There will be o ne Card #2 for each data field. 2- 1-3 Field Number. A numeric value between ____________ 001-099(small), or 001-999(large), right justified. Arranged in ascending order, but need not be incremented by 1 , ie. 5, 10, 15, 20 is recommend ed to make future additions easi er. DATA field numbers must start higher than the highest HEADER field number so that there is an ascending sequence. 2- 4-: Field Name Prompt. A variable leng th prompt for _________________ the use r. Starts in column 4 and ends in a colon. Do not use '?', '.', or '=' in the prompt. 2- :-: Fo rmat Description. Starts after the colon and __________________ ends with a colon. Allowable values are : Format Description 0 The data is a constant that is entered after the colon that ends this f ield. +N Exactly N digits must be e ntered. ZN N is a value from 1 to 2 0. Up to N digits can be entered , they will be right justified w ith a left zero fill. -N Exactly N characters must be entered. ?N N is a value from 1 to 80. Up to N characters can be entered, they will be left justified with a right hand blank fill. 2- :- Error Checking or Constants. The ent ry in this ___________________________ field depen ds on the format type and whether checks are needed on the data. No entry results in only format checking. Allowable checks for each format follows: Format Meaning of Entry 0 The entry is the constant. +N or ZN Entries must be arranged in pairs. Each member of the pair is N digits long. Each pair contains the low and high value of a range check. To pass this check, the data must fall within one of the ranges if any are listed. Any number of pairs can be entered and a blank is a valid entry. ?N or -N Any group of characters that appears must be N characters long. The data entered is checked against these groups for an exact match. To be valid , the data must match one of the groups, or be blank. 3.2.4 OUTPUT SECTION (r equired entries) ______________ Card # Column Entry 1 1 -6 "OUTPUT" ______ 2 1 - This card has the format: NF,F1,C 1,F2,C2,F3,C3,...FN,CN NF is the number of fields on this record. FN is the field number from the header or data section. CN is the starting column number for that field on the output record. Each card can produce an output record. The total number of NF's + FN's + CN's should be less than 500 or you will overflow the memory capacity of the program. Whenever DATA (but not HEADER) fields have been accessed by the user, all output cards containing one or more of the accessed data fields will be written to the output file. If an ou tput card has only HEADER fields, it will never be written to the output file. 3.2.5 TYPE SECTION (optional entries) ____________ Card # Column Entry 1 1-4 "TYPE" _ ___ There will be one card #2 for each Type. This card has the format: T N,F1,F2,F3,...FN 2 1 T is t he type identification character. 2 3-, N is t he number of fields for this type. You cannot have more than 20 fields in one TYPE if you want to use Form Mode. 2 ,-, FN is th e field number from the header or data se ction. As a default, each Type chains to itself. If you want the program to chai n from Type to Type automatically, add on e or more of the following card #3's. Th ere will be one card #3 for each chain that you want the program to perform. This card has the format: A B 3 1 A is the Type name of the first Type, the one chained from. Each Type name can appear in this position only once. 3 3 B is the Type name of the second Type, the one chained to. The total number of card #2's should be less than 25. The to tal number of N's + FN's should be less than 250. Otherwise you will overflow the memory capacity of the program. A TYPE section for one or more input field sequences will allow the use of Form Mode. The use of a TYPE section will also mean that users cannot use Ran dom Mode for inputting data. 3.2.6 END SECTION (required entry) ___________ Card # Column Entry 1 1-3 "END" ___ 3.3 Building an Application File _____________ _______________ 1. The program will output a r ecord for each line in the OUTPUT section that h as had one or more DATA fields accessed. When di fferent records are to be written to the output file in non-sequential order, you must create en ough fields in the DATA section so that each out put record has a unique set of data fields. Othe rwise, after you have entered data for one type, the program will write multiple records to the output file. Examples of this situation are Cert Bills in Fiscal and CIA in Timber. 2. A TYPE section can be included even if there is just o ne input record sequence. This will allow the u ser to use the Form Mode for data entry. 3. If there is a field in your application that is co mmon to several output records, putting that field in the HEADER section will eliminate forcing an output record whenever it appears in the OUTPUT section. 4. All cards in the application format file have a maximum length of 132 columns. No continuation cards are available. 5. When the application file is completed, all field numbers for all data and header fields in all types must be unique and form an ascending sequence. 6. You can use the Type Mode and constant fiel ds to add your runstream onto the front and back of your data. 7. You can esti mate the size of your application file by the fo llowing formula: (total length in characters of all checks and constants) + (total length in characters of field prompts) + (total length in characters of fields to be entered) _____________________________________________________ _____ If this number is less than 1000 characte rs and you have 99 or fewer input fields, your a pplication will probably fit on the small versio n of DATAENTRY. Otherwise, you will have to use the large version. This large version has a capa city of 5000 characters and 999 or fewer input f ields. 3.4 Application Index Files _ ______________________ If you want your applicat ion file to show up in the program generated inde x of general and specific applications, you must use two files. The program is designed to first look for a file called SX:[5,10]DATAENTRY.DTN. T his file contains general application names and d escriptions. Each general application has one li ne in the file. The format of this file is: Dev:[UIC]filename.filetype gen-applic-name description ^ ^ blank blank The gen-applic-name and description are listed in the general application index. When the user enters a gen-app-name, the program locates the filespec at the beginning of the line containing that name. This filespec is the location of the specific applicat ion file for that heading. The format for a specific application file is similiar to the general application file. Each specific application has one line in the file. The format for this file is: Dev:[UIC]filename.f iletype spec-applic-name description ^ ^ blank blank When the user enters a spec-applic-name, the program uses the filespec at the beginning of the line containing that name as the location of the application file. 4. EXAMPLE The following pages are an example of t he forms and documents for a simple data entry applica tion. Included is the Application File, the Dataentry Input Format sheet, a transcript of a data entry sess ion, and the output file that resulted from the sessio n. THIS IS THE APPLICATION FILE. HEADER 1ENTER DATE (MM/YY/DD):-8: 5:0:@RUN,J R05ALB,1105206520 AA,ALB,1,100 10:0:@ASG,A EXAMPLE. 15:0:@DATA,IL EX AMPLE. 20:0:@END 25:0:@FIN 30:0:@@ DA TA 35ENTER RETURN:+1: 40ENTER RETURN:+1: 45 ENTER FIXED DIGITS:+5:00000333337777799999 50ENTER VARIAB LE DIGITS:Z3:000100 55ENTER FIXED CHARACTERS:-5:AAAAABBBB BCCCCCDDDDD 60ENTER VARIABLE CHARACTERS:?4:A BB CCC DD DD OUTPUT 2,5,1,35,37 2,10,1,35,16 2,15, 1,35,18 2,20,1,40,5 2,25,1,40,5 2,30,1,40,3 5,1,1,45,9,50,14,55,17,60,22 5,60,1,55,11,50,21,45,31, 1,41 TYPE L 4,5,10,15,35 A 3,1,45,50 B 2 ,55,60 T 4,20,25,30,40 L A A B B A END DATAENTRY INPUT FORMATS GENERAL APPLICATION NAME:_____________________________ SPECIFIC APPLICATION NAME:____________________________ AP PLICATION FILESPEC:_EX.DAT;_________________________ _______ PROGRAMM ER:_BRISCOE____________ DATE:_12/81__________ _______ _____ INPUT RECORD T YPE NAME:________ CHAINS TO:___________ HDR/ FLD FMT DATA # FIELD NAM E PROMPT 0+Z-? LENGTH ERROR CHECKS OR CONSTANT __ ________________________________________________________________ __________ TYPE:L CHAINS TO: A_______________ _____ __ ____ ________________________ ____ ___ _________ _H__ _5 _ ________________________ __0__ ______ @RUN,J R05ALB,110520 6520 _ _ _ __ ______________________ ____ ___ _______________________ _ _____ ______ AA,ALB,1,100____________ ____________ _H__ _10 ________________________ __0__ ______ @ASG,A E XAMPLE._________ _ __ _ _______________ _H__ _15 ___________ _____________ __0__ ______ @DATA,IL EXAMPLE._______ _ __ _ ________________ _ _D__ _35 ENTER RETURN____________ __+__ ___1 __ ________________________ _ __ ____________ _ _ ____ ___ ________________________ _____ ______ ______________________ __ TYPE:A CHAINS TO: B_______________ _____ ______ __ ______________________ ____ ___ _________ _H__ _1_ ENTER DATE (MM/DD/YY)___ __-__ ___8__ ________________________ _ _ _____________________ _ _ _D__ _45 ENTER FIXED DIGITS______ __+__ ___5__ 00000333337777799999____ _ __ __________________ _ _ ____________________ _D__ _50 EN TER VARIABLE DIGITS___ __Z__ ___3__ 000100__________________ _ __ _____________________ _ _ ______ TYPE:B CHAINS TO: A_______________ _____ _____ _ ________________________ ____ ___ _________ _D__ _55 ENTER FIXED CHARACTERS__ __-__ ___5__ AAAAABBBBBCCCCCDDDDD___ _ _ __ ______________________ _ _ _____ _______________ _D__ _60 ENTER VARIABLE CHARACTERS __?__ ___4__ A___BB__CCC_DDDD________ _ __ ________ ________________ _ _ _ __ ___ ____ ____ ___ ________________________ _____ ______ ___________ _____________ TYPE:T___ ________________________ _____ ______ ________________________ ____ _H__ _20 ________________________ __0__ ______ @END_____________ _______ _ __ _ ____ _H__ _25 ____________________ ____ __0__ ______ @FIN____________________ __ _ ____ _H__ _30 ________________________ __0__ ______ @@___ ___________________ _ __ _ __ _D__ _40 ENTER RE TURN____________ __+__ ___1__ ________________________ _ __ ____________ __ _ Error checks for + or Z formats are pairs of data. Each member of the pair is as long as the field. Each pair forms a range check for the field. Error checks for - or ? formats are groups of characters. Each group is as long as the field. The data must exactly match at least o ne group. Constants for 0 formats are variable length char acter strings. THIS IS THE TRANSCRIPT OF THE DATA ENTRY SESSION. THE TRANSCRIPT STARTS AFTER THE USER HAS LOGGED ON TO A TERMINAL IN DP MODE. USER ENTRIES ARE IN "DOUBLE QUOTES". THE APPLICATION FILE, EX.DAT; IS LOCATED IN THE USER'S UFD. >"DATA" ENTER TERMINAL TYPE ="OTHER" *** TERMINAL TYPE IS ***. OTHER ***. *** DATAENTRY PROGRAM ***. *** ENTER GENERAL APPLICATIO N: APPLICATION PPB PROGRAM PLANNING STA FF ISM ISM STAFF TIMBER TIMBER ST AFF FISCAL FISCAL STAFF UTILITY OTHER UTILITY FILES FOR DATAENTRY ENTER APPLICATION ="EX.DAT" *** APPLICATION EX.DAT NOT FO UND, ASSUMED AS AN INPUT FILE. *** ENTER OPTIONS ***. OUTPUT FILE NAME="XXX.XXX" OUTPUT FILE NAME=XXX.XXX OK QUESTION ASKED AT END OF RECORD (D: Y) ? "" AUTO CARRIAGE RETURN AT FIELD END (D: Y) ? "" DO YOU WANT FORM MODE (D: Y) ? "N" TYP E - ? "L" 35: ENTER RETURN: = "" *** ARE ALL FIELDS OK (D: Y) ? "" RECOR D 1:@RUN,J R05ALB,1105206520AA,ALB,1,100 RECORD 2:@ ASG,A EXAMPLE. RECORD 3:@DATA,IL EXAMPLE. 1: ENTER DATE (MM/YY/DD): = -------- "12/28/81" 45: ENTER FIXED DIGITS: = ----- "12345" 50: ENTER VARIABLE DIGITS: ? --- "99" *** ARE ALL FIELDS OK (D: Y) ? "" REC ORD 4:12/28/8112345099 RECORD 5: 099 12345 12/28/81 55: ENTER FIXED CH ARACTERS: = ----- "EEEEE" *** ERROR *** INVALID ALPHA ENTERED, TRY AGAIN. DATA:EEEEE 55: E NTER FIXED CHARACTERS: = ----- "DDDDD" 6 0: ENTER VARIABLE CHARACTERS: ? ---- "CCC" *** ARE ALL FIELDS OK (D: Y) ? "" RECORD 6:12/28/8112345099DDDDDCCC RECORD 7:CCC DDDDD 099 12345 12/28/81 1: ENTER DATE (MM/YY/D D):12/28/81= -------- "/Z" TYPE - ? "T" 40: ENTER RETURN: = - "" *** ARE ALL FIELDS OK (D: Y) ? "" RECORD 8:@END RECORD 9:@FIN RECORD 10:@@ 40: ENTER RETURN: = - "/Z" TYPE - ? "/Z" * END OF DATA ENTRY * * INPUT FIELD S = 7 * OUTPUT RECORDS= 10 THIS IS THE OUTPU T FILE FROM THE DATA ENTRY SESSION. @RUN,J R05ALB,1105206 520AA,ALB,1,100 @ASG,A EXAMPLE. @DATA,IL EXAMPLE. 12/28/8112345099 099 12345 12/28/81 12/28/8112345099DDDDDCCC CC C DDDDD 099 12345 12/28/81 @END @FIN @@ DATAENTRY INPUT F ORMATS GENERAL APPLICATION NAME:_________________________ ____ SPECIFIC APPLICATION NAME:__________________________ __ APPLICATION FILESPEC:_________________________________ PROGRAMMER:____________________ DATE:________________ INPUT RECORD TYPE NAME:________ CHAIN TO:____________ HDR/ FLD FMT DATA # FIELD NAME PROMPT 0+Z-? LENGTH ERROR CHECKS OR CONSTANT ______________________________________________ ______________________________ ____ ___ _______________ _________ _____ ______ ________________________ ____ ___ ________________________ _____ ______ __________________ ______ ____ ___ ________________________ _____ ______ ________________________ ____ ___ ___________________ _____ _____ ______ ________________________ ____ ___ ________________________ _____ ______ ______________________ __ ____ ___ ________________________ _____ ______ __ ______________________ ____ ___ _______________________ _ _____ ______ ________________________ ____ ___ ___ _____________________ _____ ______ ________________________ ____ ___ ________________________ _____ ______ ______ __________________ ____ ___ ________________________ _ ____ ______ ________________________ ____ ___ _______ _________________ _____ ______ ________________________ ____ ___ ________________________ _____ ______ __________ ______________ ____ ___ ________________________ _____ ______ ________________________ ____ ___ ___________ _____________ _____ ______ ________________________ __ __ ___ ________________________ _____ ______ ______________ __________ ____ ___ ________________________ _____ __ ____ ________________________ ____ ___ _______________ _________ _____ ______ ________________________ ____ ___ ________________________ _____ ______ __________________ ______ ____ ___ ________________________ _____ ______ ________________________ ____ ___ ___________________ _____ _____ ______ ________________________ Error chec ks for + or Z formats are pairs of data. Each member of the pai r is as long as the field. Each pair forms a range check for the field. Error checks for - or ? formats are groups of characters. Each group is as long as the field. The data must exactly match at least one group. Constants for 0 formats are variable length character strings. DATAENTRY INPUT FORMAT INSTRUCTIONS 1. Under GENERAL and SPECIFIC APPLICATION NAME, en ter the names that will appear in the program generate d indexes. 2. Under APPLICATION FILESPEC, enter the filespec for the application file only if yo u are not using the program generated indexes. 3. Under INPUT RECORD TYPE NAME and CHAINS TO, en ter the single character Type names, if any. Unless t he Types are small, put one TYPE on a page. One TYPE cannot have more than 20 fields if you want to use For m Mode. 4. Under HDR/ DATA indicate whethe r the field is a header field or data field with an H or D. 5. Under FLD # put the 1-3 digit fie ld number. For the entire application, all header and data field numbers for all types must be unique and i n ascending order. 6. Under FIELD NAME PRO MPT, you can put anything that will help the user. Fo r example, you might include an indication of whether the field is numeric (N) or alpha/numeric (A/N). 7. Under FMT 0+z-?, enter the format symbol for the fiel d. 8. Under LENGTH enter the length for th e field. 9. Under ERROR CHECKS OR CONSTANT , enter the error checks or the constant for that fiel d.