This guide includes detailed descriptions for each CODE-1 Plus parameter including:
-
Description of the purpose and use of each parameter
-
Description of all fields available for defining each parameter including:
-
Field positions
-
Field name
-
Description for each field
For example, the following description for the CR OUT parameter appears later in this guide. Following the CR OUT parameter example is an example for defining each field of the CR OUT parameter.
CR OUT
Optional. Use CR OUT to identify the location to store the carrier route data on the output record.
Position |
Field Name |
Description |
---|---|---|
1-6 |
Keyword |
Required. CR OUT is the only acceptable entry. |
8-10 |
Carrier Route Return Code Location |
Output record location for the 1-character carrier route return code. If defined, contains one of the following codes:
|
12-14 |
Carrier Route Code Location |
Output record location for the 4-character carrier route code. Stored in one of the following formats:
|
60 |
Information Dropped Storage Conditions |
Code indicating whether the carrier route code should be stored in cases where information was dropped during the match process:
|
62 |
Maximum Address Correctness |
Maximum acceptable address probability of correctness to store the carrier route. Enter a number between 0 and 9, where 0 indicates the best case and 9 indicates the worst case. Default is 9. |
64 |
Maximum Overall Correctness |
Maximum acceptable overall probability of correctness to store the carrier route. Enter a number between 0 and 9, where 0 indicates the best case and 9 indicates the worst case. Default is 9. |
68 |
Multiple Carrier Route Storage Conditions |
Code indicating whether or not the standardized carrier route code should be stored if multiple matching carrier route codes were found:
|
70 |
Multiple ZIP Code Storage Conditions |
Code indicating whether the standardized carrier route code should be stored if multiple matching ZIP Codes were found:
|
72 |
Disposition Indicator |
Code indicating what to store when the standardized carrier route code was not stored because no match was found or due to storage conditions:
|
Example Instructions for Defining CR OUT Parameter Fields
The following is an example of a parameter definition for defining carrier route code storage using the CR OUT parameter.
-
Positions 1-6 are reserved for specifying the name of the parameter to be defined. In this example, to define the CR OUT parameter, enter CR OUT in the Keyword field, positions 1-6.
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+CR OUT
-
Define the output record location for the 1-character carrier route return code in the Carrier Route Return Code Location field, positions 8-10.
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+CR OUT 345
-
Define the output record location for the 4-character carrier route code in the Carrier Route Code Location field, positions 12-14.
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+CR OUT 345 350
-
Indicate whether the carrier route code should be stored in cases where information was dropped during the match process in the Information Dropped Storage Conditions field, position 60.
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+CR OUT 345 350 X
-
Define the maximum acceptable address probability of correctness to store the carrier route in the Maximum Address Correctness field, position 62.
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+CR OUT 345 350 X 5
-
Define the maximum acceptable overall probability of correctness to store the carrier route in the Maximum Overall Correctness field, position 64.
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+CR OUT 345 350 X 5 5
-
Indicate whether or not the standardized carrier route code should be stored if multiple matching carrier route codes were found in the Multiple Carrier Route Storage Conditions field, position 68.
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+CR OUT 345 350 X 5 5 M
-
Indicate whether the standardized carrier route code should be stored if multiple matching ZIP Codes were found in the Multiple ZIP Code Storage Conditions field, position 70.
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+CR OUT 345 350 X 5 5 M M
-
Indicate what to store when the standardized carrier route code was not stored because no match was found or due to storage conditions in the Disposition Indicator field, position 72.
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+CR OUT 345 350 X 5 5 M M B
Sample Completed CR OUT Parameter Definition
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....+CR OUT 345 350 X 5 5 M M B