File Names - Code-1_Plus - 5.0

CODE-1 Plus Reference for all Platforms

Product type
Software
Portfolio
Verify
Product family
Data Quality - Postals
Product
CODE-1 Plus
Version
5.0
Language
English
Product name
CODE-1 Plus
Title
CODE-1 Plus Reference for all Platforms
Copyright
2024
First publish date
1998
ft:lastEdition
2024-05-15
ft:lastPublication
2024-05-15T00:07:55.920704

CODE-1 Plus has five file names to use for your input file and output files, regardless of their actual dataset names. You use CODE-1 Plus-defined file names on the FILEDF parameter, but you will use your own file names in the JCL you write to run a CODE-1 Plus batch file.

The following file names are valid for the FILEDF parameter:

File Name

Description

C1BMNAM 

Your input name-and-address file. C1BMNAM stands for CODE-1 Plus Batch Match Name file. This file is designated as C1BMNAM in the job control file (JCL, DCL, Script, etc.).

C1BMCOK 

Output file to which CODE-1 Plus writes all of the records that are verified or corrected. C1BMCOK stands for CODE-1 Batch Match Coded OK. This file is designated as C1BMCOK in the job control file (JCL, DCL, Script, etc.).

C1BMNCO 

Output file to which CODE-1 Plus writes all of the records that have valid input ZIP Codes (for example, the ZIP Code was valid somewhere in the U.S.) but were not matched for some reason. C1BMNCO stands for CODE-1 Batch Match Not Coded. This file is designated as C1BMNCO in the job control file (JCL, DCL, Script, etc.).

C1BMIZP

Output file to which CODE-1 Plus writes all of the unmatched records that have invalid input ZIP Codes. An invalid input ZIP Code is one that is not valid anywhere in the U.S. C1BMIZP stands for CODE-1 Batch Match Invalid ZIP. This file is designated as C1BMIZP in the job control file (JCL, DCL, Script, etc.).

C1BMZP4

Output file to which CODE-1 Plus writes all of the records that were ZIP + 4 coded. C1BMZP4 stands for CODE-1 Batch Match ZIP + 4. This file is designated as C1BMZP4 in the job control file (JCL, DCL, Script, etc.).

C1BMSTA

Output file to which CODE-1 Plus writes all of the output statistics. These records are fixed length. The only required field on the parameter is record length, positions 19-22, and may be any numeric value.

Exit Routines

The FILEDF parameter allows you to specify an input exit routine that CODE-1 Plus should call each time it is ready to read a record from your input name-and-address file, or the output exit routine that CODE-1 Plus should call each time it is ready to write a record to your output file. If you are using an input exit routine, CODE-1 Plus calls your exit routine—rather than reading the record—and waits for the exit routine to pass a record back. If you are using an output exit routine, CODE-1 Plus passes the record to the output exit routine, instead of writing the record to the file.

For example, you might have an input exit routine named CODEIT that adds a special code to a record. If you want to add that code to each record before the record is passed to CODE-1 Plus, you would specify CODEIT as the name of the exit routine. Then, every time CODE-1 Plus is ready to accept a record, it passes control to CODEIT, which reads the record, adds the code to the record, and then passes the record to CODE-1 Plus so that CODE-1 Plus can process that record.

When you use the FILEDF parameter to call an exit routine, CODE-1 Plus will call that exit routine with the following four parameters in the linkage section at each I/O request.

Parameter

Description

PARM1

Total of 9 bytes with two components:

  • Bytes 1-8 — File name (C1BMNAM, C1BMCOK, C1BMNCO, C1BMIZP, or C1BMZP4).

  • Byte 9 — Function indicator. This byte contains one of the following codes to tell your program the type of processing to perform:

  • O — Open the input or output file.

  • R — Read a record from the input file.

  • W — Write a record to the output file.

  • C — Close the input or output file.

PARM2

A 5-digit length (less than or equal to 32,760) packed into a 3-byte field (COBOL "PIC S9(5) COMP-3"). This parameter must be filled in by your exit routine if byte 9 of PARM1 is O or R. When byte 9 of PARM1 is R, the input exit routine signals the end of the file by setting it to 0.

PARM3

Output record to be passed from CODE-1 Plus to your program (when EXITFC is W), or the input record to be passed from your program to CODE-1 Plus (when EXITFC is R). The length of this parameter will be the length specified by the exit routine in PARM2 above (maximum of 32,760).

PARM4

Image of your FILEDF parameter and is 80 bytes in length.