{OPTIONS} Section - Finalist - 10.0

Finalist Guide

Product type
Software
Portfolio
Verify
Product family
Data Quality - Postals
Product
Finalist
Version
10.0
Language
English
Product name
Finalist
Title
Finalist Guide
Copyright
2023
First publish date
1984
Last updated
2024-05-15
Published on
2024-05-15T00:57:22.811031

The {OPTIONS} section contains keywords that are used to indicate the actions required during processing. Note that in the Keyword column below, a vertical bar ('|') is used to separate possible value for each keyword.

Figure 1. Keywords

The following table describes keywords that can be defined in the {OPTIONS} section.

Table 1. {OPTIONS} Section Keywords
Keyword Description
cAddrScan=YES | NO | AddrScan Return Line Option Indicates whether to perform AddrScan processing. For more information on AddrScan processing, refer to AddrScan Option. This keyword is generally only valid when block-style address keywords are specified in the Definition file (iL1, iL2, iL3, etc.). This keyword is generally only valid when block-style address keywords are specified in the Definition file (iL1, iL2, iL3, etc.). However:

If you specify iFirm, AddrScan processes with the SkipFirm option.

If you specify iCity, AddrScan processes with the SkipCSZ option.

If you specify iURB, AddrScan processes with the SkipURB option.

Valid values are:

YES
Perform AddrScan processing. The value YES implies the default option of 95N for returned line setting.
NO
Do not perform AddrScan processing.
Three-character returned line setting
Use the three character AddrScan returned line setting described in Setting Returned Line Options.
Blank
Defaults to 95N.
cCase=U | L | M Indicates whether to return addresses in all upper, all lower, or mixed upper and lower case.
U
Return addresses in all upper case.
L
Return addresses in all lower case.
M
Return addresses in upper and lower case.
cCassMode=YES | NO Indicates whether you want to process in a CASS-certified mode.
YES
Generate the Batch Processing Report and the USPS Form 3553 (CASS Summary Report).
NO
Only generate the Batch Processing Report.
cOverlayCheck=ON | OFF Indicates whether you want to prevent overlapping field specifications.
ON
Prevent output fields from overlaying input fields unless the output and input field formats are identical. The Finalist driver ensures that output fields do not overlay input fields.
OFF
Create an output file with a format that is not identical to the format of the input file. If set to NO, the output file is initially blank and then only populated by output fields specified in the corresponding job definition (DEF) file.
  • blank — Defaults to ON.
cStartAft=(start after value) Indicates how many records in the input file to bypass before beginning address processing. The driver will skip the number of records specified here prior to processing. Valid values are 0 through 99,999,999. The default value is zero.
cStopAft=(stop after value) Indicates the number of the last record to process. Valid values are 1 through 99,999,999 and EOF. If you specify EOF, the driver will process through the last record in the file. The default value is EOF.
cVerboseCount=[count] Indicates the number of records to process before generating progress status messages. For example, if you specify "100", every 100th record, starting with 1, produces the message:

Processing record XXX ...DDD MMM DD HH:MM:SS YYYY

For Windows, the message overlays each preceding instance as processing progresses. If you specify "0", no messages are produced. Windows, Linux, and Unix systems can also prevent the message with the command line option -q. The default value for Windows, Linux, and Unix systems is 1. The default value on the mainframe is 0.

jAddrScanAO=(AddrScan addressing options) Defines the AddrScan addressing options:
#
To prevent AddrScan from concatenating lines beginning with # to existing address lines, enter # in the AddrScanAO field. This field is only available when AddrScan processing is selected (see previous step).
P
To prevent AddrScan from recognizing periods as valid characters and to specify that periods should be removed before scanning address lines, enter a P in the AddrScanAO field. This field is only available when AddrScan processing is selected (see previous step).

The values # and P can populate either position for the jAddrScanAO keyword definition.

jAttach=YES | NO Defines whether or not the processed and corrected data will be attached to your original data. Valid values are described next.
YES
Attach corrected data to my original data. The results of the address lookup will be attached to the address fields in each input record that you process.
NO
Do not attach corrected data to my original data. In order to receive returned address information, you must define the jOverlay keyword to overlay your original input record with the corrected results or specify a new output file using fOutAllFile, fOutValidFile, or fOutErrorsFile in the {FILES} section of the Job File. For a description of the output record, refer to Contents of jAttach Record.
jOverlay=YES | NO Defines whether or not your original data will be overlaid with the corrected results. This selection updates a file in place.

You will receive an error message and your job will fail if you try to use the jOverlay option on the z/OS platform. The jOverlay option is not supported on the z/OS platform.

YES
Overlay original data with corrected results. Address fields in each input record that you process will be overlaid with the results of the address lookup. Note that only fields that have been defined via keyword entries will be overlaid. For example, if the ZIP Code field is not specified by defining an iZip keyword and an oZip=o keyword within the Definition File, the ZIP Code field will not be overlaid.
NO
Do not overlay original data with corrected results. In order to receive returned address information, you must define the jAttach keyword to attach results to your original input record or specify a new output file using fOutAllFile, fOutValidFile, or fOutErrorsFile in the {FILES} section of the Job File.

You can overlay specific input fields with the processing output on a field level basis by specifying jOverlay=NO and defining an input keyword and output keyword. For example, you do not want to overlay your entire input record with the processing output but only want to overlay the input ZIP Code field with the output ZIP Code resulting from Finalist processing. To accomplish this you would specify jOverlay=NO and define an iZip keyword and an oZip=o keyword. The input ZIP Code field will be overlaid with the output ZIP Code. No other input fields will be overlaid with output information.

EXAMPLE

Your input data contains ZIP Code information in the fields you defined as iCity or iState. The driver uses the ZIP Code information to process the address. The driver overlays the city information at the location indicated by the iCity keyword and the state information at the location indicated by the iState keyword. However, since you did not define an iZIP field, the driver has no location for overlaying the ZIP Code information. The returned ZIP Code information is lost. We recommend you use jOverlay=NO if your input file does not contain each address component at a consistent starting position within each record. This will ensure that the driver will return complete address information.

rListProcessorName=(list processor name) If you want to enter a list processor's name, use this keyword to enter a list processor's name to appear on the USPS Form 3553 (CASS Summary Report).
rMailerAddress=(mailer address) If you want to CASS certify under your own company name, use this keyword to enter the street address to appear on the USPS Form 3553 (CASS Summary Report).
rMailerAddress2=(mailer address) If you want to CASS certify under your own company name, use this keyword to enter additional street address information to appear on the USPS Form 3553 (CASS Summary Report).
rMailerAddress3=(mailer address) If you want to CASS certify under your own company name, use this keyword to enter additional street address information to appear on the USPS Form 3553 (CASS Summary Report).
rMailerAddress4=(mailer address) If you want to CASS certify under your own company name, use this keyword to enter additional street address information to appear on the USPS Form 3553 (CASS Summary Report).
rMailerCity=(mailer city) If you want to CASS certify under your own company name, use this keyword to enter the mailer city, state, and ZIP Code to appear on the USPS Form 3553 (CASS Summary Report).
rMailerName=(mailer name) If you want to CASS certify under your own company name, use this keyword to enter the mailer name to appear on the USPS Form 3553 (CASS Summary Report).
cRecsz=(record size value) Allows you to indicate the size (in bytes) of each input record within your input file if each record within your input file is not followed by a carriage return/line feed (CR/LF) pair. This field defaults to a value of CR/LF, indicating that each record is followed by a carriage return/line feed pair. If your records do not end with a CR/LF, you must specify a number in the range of 1 to 32,767 inclusive. If you put an incorrect value here, it will result in the improper reading of input records.
cRecszOut=(record size value) Allows you to indicate the size (in bytes) of each output record. This keyword is only valid for fixed length records.
cInputFileType=ASCIICRLF | ASCIIFIXED | DELIMITED | DBASE | MFFIXED This keyword is required, and indicates what type of input data you have.
ASCIICRLF
Each record in your data file is terminated with a carriage return/line feed (CR/LF) pair. The default value is ASCIICRLF if cRecsz is zero.
ASCIIFIXED
Each record in your data file is a fixed number of bytes in length, and is not terminated by a CR/LF pair. The default value is ASCIIFIXED if cRecsz is non-zero. Set the Job file keyword cRecsz to the number of bytes that each record occupies.
DELIMITED
The fields within each record are delimited by a specific character (for example, comma, etc.), and each record is terminated with a CR/LF pair. When using this option, you are required to specify what the delimiting character is via the DELIMITER keyword.
dBASE
The driver program supports dBASE files. dBASE is a popular PC-based file format. This value indicates your input file is in a dBASE format.

NOTE: dBase does not support attached fields.
MFFIXED
Each record in your data file is a fixed number of bytes in length, and is not terminated by a CR/LF pair (mainframe fixed input file). Set the Job file keyword cRecsz to the number of bytes that each record occupies.
cDelimiter=COMMA | TAB | X | xx (where xx is the hexadecimal value of the character) Indicates the delimiting character when the fields within each of your data records are delimited by a specific character. There is no default value for this keyword. Valid values are described next.
COMMA
The delimiter is a comma (,).
TAB
The delimiter is the tab character.
X
The delimiter is any single character.
xx
The delimiter is any character whose hexadecimal value can be represented using two hexadecimal digits (in the range of 00 to FF).
0xXX
The delimiter is any character whose hexadecimal value can be represented using two hexadecimal digits (in the range of 00 to FF).
x'XX
The delimiter is any character whose hexadecimal value can be represented using two hexadecimal digits (in the range of 00 to FF).
cXTern=YES | NO Defines whether to attach 250 bytes of additional information codes to your output file. This parameter was designed for use with the Precisely VeriMove move update product. For more information, refer to Precisely VeriMove Move Update Product Information Codes.
YES
Return the additional information codes to the output files. To attach the 250 bytes of additional information codes to your output file to use as input to the Precisely VeriMove move update software, specify "YES".
NO
Do not return the additional information codes to the output files. In order to receive returned address information, you must specify a new output file using fOutAllFile, fOutValidFile, or fOutErrorsFile in the [FILES] section of the Job File. For a description of the output record, refer to Contents of jAttach Record.