Coding Accuracy Support System (CASS)
Table of Contents:
- What is CASS
- Platform Availability
- Release Cycle
- How to check if Installed
- How to update data pack
- Check for API Version
- Usage – To Run CASS
- Input requirement
- Stop processing event
- Report generation
- Output component fields
- Sample PS Form 3553
- Troubleshooting Tips
1. What is CASS
The CASS™ certification process is designed in cooperation with the mailing industry to improve the accuracy of postal codes, i.e., Five-Digit ZIP Code®, ZIP + 4®, delivery point (DPCs), and carrier route codes that appear on mailpieces.
Additional information on CASS can be found on the USPS site here.
2. Platform Availability
Please note, CASS is currently only available for the following platforms:
3. Release Cycle:
CASS library follows a 2-year cycle and it expires at the end of each cycle (July 31st every odd year). Data files used by CASS also expire after 105 days from the release date of the data files.
Please be aware that the CASS dataset expiration dates are set by the postal authority. Please ensure that you have the latest library and data installed to avoid loss of service through these products
CASS is updated on a monthly basis and made available on the 15th of each month.
|Loqate Release Date||Certification Expiry Date*|
Please check Install Manager for the latest version CASS.
4. How to check if Installed
Important Note: Please ensure Loqate is installed outside of program files. Even if you enable read/write permissions while inside program files, there may still be permissions issues, we recommend installing Loqate outside of program files.
There are two methods to check if CASS is installed.
Option 1: Use command line
- navigate your Loqate API directory
- run the following command:
./lqtBatch.exe –d <your data directory>
Notes: if CASS is active, your screen will show ‘CASS API Status : Active’ and will display information similar to the below screen
Option 2: Using demo.exe
1) Click on lqtDemo.exe program (available in Loqate API folder)
2) Click on first tab” “GKR”
3) Click “Browse” to select Loqate data folder
4) Click the “Select a file” drop down menu to find “CASSInfo”
5) “Expiry Date” of CASS is shown (refer below screenshot)
5. How to update data pack
Run install manager following the instructions on the support site listed here.
When you get to the data pack selection screen below you will need to select both the library and USA Verify Dataset CASS. Note: At this time, CASS is only available for Windows 32 and Linux 64. Please select the corresponding library for the platform you’re using.
|CASS Library (windows 32) or CASS Library (Linux 64)|
|USA Verify Dataset CASS|
6. Check for API Version
Follow the instructions on the support site here to obtain your API version .
7. Usage – To Run CASS
To use lqtBatch, pass “cass” as the parameter for -p option
- –p invokes the process
e.g. lqtBatch … -p cass
This invokes the Cass process similar to how the Verify and Parse processes are invoked.
CassTool loads a DLL library at runtime. If the library is not available or if it cannot be loaded due to some error, CassTool would not process the input record.
Check ProcessResult’s status and error message to get more info.
8. Input requirement
- We are using the same input format as USPS. CASS process requires the following fields as input:
- Address1 (may contain Premise, Subbuilding, Thoroughfare)
- Address2 (optional input field: Apt/Suite/Others)
- Locality (may contain Locality only or Locality, AdministrativeArea, and PostalCode combined)
- AdministrativeArea (if it is not in Locality field)
- PostalCode (if it is not in Locality field)
- DependentLocality (optional. urbanization for Puerto Rico addresses)
- Organization (optional)
9. Stop processing event
CASS tool will stop processing when it detects false positive events.
This is a security measure embedded in CASS tool. This security measure is designed to prevent the artificial creation of an address list by detecting when a submitted address appears to have been constructed artificially and not obtained legitimately.
When such event happens, please get ProcessResult’s status and error message and contact Loqate with this information.
10. Report generation
Please note if you choose to use Loqate to generate the CASS report, you can fill in our company name and software to the PS Form 3553.
PS3553 is for bulk mailing purpose, not for certification. It has to be present together with the CASS report when passing the mail bag to USPS.
For additional information on CASS™ please visit the USPS site here.
PS Form 3553 ( -r PS3553 ) is the CASS summary report that may be submitted to USPS together with the mailing list.
CASS report ( -r CASS ) is for CASS certification purpose.
CASS tool can be used together with the new report tool to generate reports.
- To get CASS Report in command line on Windows:
- ./lqtBatch.exe -r CASS -i <insert your input file>
- * pipe ‘|’ can be used as a separator when specifying multiple reports
- To get PS Form 3553 ( -r PS3553 ) in command line on Windows:
- ./lqtBatch.exe -r PS3553 -i <insert your input file>
11. Output component fields
The following page include detailed information regarding the CASS Fields:
./lqtBatch.exe -d data/ -p cass -i sample.txt -o casstesting.txt -oh -of “AutoZoneIndicator|CarrierRoute|CMRAIndicator|CongressionalDistrict|DefaultFlag|DeliveryPointBarCode|DPVConfirmedIndicator|DPVFootnotes|eLOTCode|eLOTNumber|EWSFlag|FalsePositiveIndicator|FIPSCountyCode|Footnotes|LACSLinkCode|LACSLinkIndicator|LACSStatus|NoStatIndicator|PMBNumber|PMBType|PrimaryAddressLine|RecordType|ReturnCode|ResidentialDelivery|SecondaryAddressLine|SUITELinkFootnote|VacantIndicator”
|Parameter||Description||Example from Sample Script|
|-d||The -d parameter is used to specify the location of the Loqate Global Knowledge Repository. The default value is “data/”, that is the ‘data’ subdirectory.||-d data/|
|-p||invokes the process||-p cass|
|-i||The -i parameter is used to specify the input UTF-8 text filename containing the data to be processed. Note: if the sample file isn’t in you Loqate API directory, you will need to specify the full path of the location
|-o||The -o parameter is used to specify the output UTF-8 text filename to contain the processed data. Note: if a path isn’t specified, it will be printed in your current Loqate API folder.
|-oh||The -oh parameter is used to specify that a header line should be output to the output file.|
|-of||The -of parameter is used to specify the output file format using the same syntax as the -if parameter. A list of the default values can be found on the support site here.
|Important Note**: You will need to use this option to output the CASS fields.|
12. Sample PS Form 3553
The following page includes a sample output from running PS Form 3553 (-r PS3553 ) . The outputs provided by Loqate match with the PS Form 3553, simply copy the output results onto your form for each respective field.
13. Troubleshooting Tips
- Error message: “cass module could not be found”
Step 1: check to ensure you have the library installed.
-Note: you don’t need to re-install. However, an easy way to check is to run install manager, if both the library and CASS datasets are not listed then you have it installed. If they are listed, then you will need to rerun install manager to install the missing components.
Step 2: Once you confirmed you have the required components; ensure you are in the correct installation directory of Loqate
- Error message: 2018-06-28 – If you do not update your data, CASS will stop working and you will receive error message: “CASS has expired”
Resolution: update CASS data using install manager. Please follow the section in this document titled: “How to update data pack”
- Error message: Datapack installation was partial – this means that your datapack installation was interrupted. Usually due to internet connection issue or pause and restarting can cause issues as well.
Resolution: Rerun install manager and select the packs that did not get updated. If you do not see the datapack available in the list, then that means you’ve already downloaded the datapack.
- Disk space: Please ensure you have enough disk space to download, otherwise you will receive a size read error message.
Resolution: If you are out of diskspace, please clear space and rerun install manager.