General Information - Help File Transactions (AM)
HELP File Transactions
This section describes Nlets HELP file transactions. Inquiries to Nlets and responses from the Nlets HELP files are available to all Nlets users. There are two types of HELP files:
- HELP files that deal with state or other member HELP records.
- HELP files that deal with general HELP records maintained by Nlets.
State/Province/Federal Member Agency HELP Files
A HELP file is available for each participating state, Canadian province and Federal member agency via a reserved area on the Nlets system. Nlets members do not need to allocate space or do extensive program changes on their system to participate in the HELP program.
Requirements
The HELP message must be an Administrative Message (AM) message type with a single destination address that designates the requested HELP record.
It is recommended that each state's CJIS Systems Agency (CSA) and province review their HELP File information periodically to ensure the information is relevant, current, and accurate.
Test Records
It is beneficial for states to include test records within their HELP File information. These test records can be utilized to determine how an agency will respond to a record query.
ORIs for HELP File Message Transactions
A state/province/agency must send an AM message to the proper ORI to use the HELP files. This designates the specific record to retrieve and action to be taken.
HELP File ORI: aabbbcccc where:
- The first two characters designate the specific state/province file.
- The 3rd, 4th and 5th characters designate which record is to be accessed.
- The last 4 characters of the ORI designate the action to be taken upon the record.
The table that follows demonstrates how to build a HELP file ORI. New HELP file ORIs may be added with approval from Nlets.
State/Province
Code
Identify Record to be Accessed
Identify an Action to be
Taken on the Record
aa
bbb
cccc
AL
ADM (Federal agencies only)
HELP (Inquiry)
AK
BAS (Boat and snowmobile; states only)
UPDT (Replace existing
record with new record)
Etc.
COR (Corrections information; states only)
CNCL (Cancel record)
GUN (Gun information, such as CCW)
APND (Append new
information)
LIC (Vehicle Registration Record)
OLN (Driver's License Record)
PAR (Parole information; states only)
POF (Protection order file; states only)
PRO (Probation information; states only)
SIR (Criminal History Record)
SOR (Sex offender registration
information; states only)
SWQ (State Warrant Record)
Replace HELP Data
The information after the text (<n:MailMessageText> for XML or TXT for legacy) will replace any record already on file when the "UPDT" function is used.
Note: No information can be added to an existing record when using the "UPDT" code.
Add Information to an Existing HELP Record
Use the "APND" (append) function to add or append information to the end of an existing record. Information after the <n:MailMessageText> or "TXT" will be added to the existing HELP record.
Cancel a Message from the HELP File
Use "CNCL" function to cancel/delete an existing record. Any state inquiring to the file after a cancel is issued will receive a message stating "NO HELP INFORMATION AVAILABLE FOR THIS USER."
Federal Agencies/Other Organizations HELP Record
Federal agencies or other organizations with direct lines to Nlets are provided a single unique HELP record; identified by the characters "ADM".
To access a Federal or Associate members HELP record, use their two-character code in the table below, followed by "ADMHELP".
Federal Agency
Two Character Code
Administrative Office of U.S. Courts
UC
Bureau of Alcohol, Tobacco, Firearms, & Explosives
AT
Bureau of Consular Affairs / DOS Passport Services
HQ
Department of the Navy / NCIS
DN
El Paso Intelligence Center (EPIC)
EP
Federal Bureau of Investigation /NCIC
FB
Federal Bureau of Prisons
BP
Federal Motor Carrier Safety Administration (FMCSA)
FM
Federal Protective Service
FP
INTERPOL
IP
National Weather Service / NOAA
WS
Office of Justice Programs / BJS
BJ
Social Security Administration
SA
Transportation Security Administration
TS
U.S. Air Force
AI
U.S. Citizenship and Immigration Services
IR
U.S. Coast Guard
CG
U.S. Customs and Border Protection
TC
U.S. Department of Defense / DCSA
OP
U.S. Department of Interior
DI
U.S. Department of Justice
DJ
U.S. Department of State
DS
U.S. Department of Veteran's Affairs
DV
U.S. Immigration and Customs Enforcement
AX
U.S. Marshals Service
MR
U.S. Postal Inspection Service
PS
U.S. Secret Service
SS
Automated Regional Justice Information Sharing of San Diego (ARJIS)
RJ
National Insurance Crime Bureau (NICB)
NA
National Center for Missing and Exploited Children (NCMEC)
MC
National Vehicle Service
VS
PrePass Safety Alliance
HL
Regional Information Sharing Systems
RS
Canadian Help Records
Several HELP files have been assigned to Canada to assist users in accessing this interface. The Royal Canadian Mounted Police (RCMP) supports many of the files that are accessible through the interface. There will be a single HELP file for these.
Each province/territory in Canada has the following HELP files for vehicle registration and driver's license information.
xxLICHELP = one for each province/territory; 12 in all
xxOLNHELP = one for each province/territory; 12 in all
(xx = Province/territory Identification Code.)
In addition, single HELP records exist for the following information.
ORI
Canadian HELP Record to be Accessed
CNARTHELP
Stolen Article help information
CNBOTHELP
Boat/Motor help information
CNGENHELP
General help information on Canada
CNGUNHELP
Stolen Gun help information
CNLICHELP
General Vehicle Registration help information
CNOLNHELP
General Driver License help information
CNPERHELP
Wanted Persons help information
CNSECHELP
Stolen Securities help information
CNSIRHELP
Criminal History help information
CNVEHHELP
Stolen Vehicles help information
Nlets HELP Records
Nlets has also developed several informational HELP records and made them available to all users. These records are listed below along with the specific destination ORI required to access the information.
Destination ORI
HELP Information Records
FNORIHELP
Contains a list of the Federal codes that are converted to ORION Fed
search codes in the ORION file.
NLBASHELP
Contains a list of states providing a boat/snowmobile HELP file on
Nlets and a test record available to other users over Nlets.
NLFLYHELP
Contains information on how to submit a LEO Flying Armed message.
NLGUNHELP
Contains a list of states that support inquires to their Concealed Carry
of Weapon permit (CCW) files.
NLIMGHELP
Contains information on destinations that support image comparison (facial/plate recognition) search requests.
NLLPRHELP
Contains information on the License Plate Reader Program.
NLNOQHELP
Contains a list of states that support name only driver license and
vehicle registration inquires.
NLOLNHELP
Contains a list of states providing automated driver license and HELP
FILES over Nlets and a test record available to other users over
Nlets. Also should indicate if state supports name only inquiries.
NLORIHELP
Contains list of states that accept Nlets assigned "S".
NLPPCHELP
Contains a list of states that support inquires to their parole, probation
and corrections files.
NLSIRHELP
Contains a list of states providing automated responses to IQ and/or
FQ queries.
NLSONHELP
Contains a list of states that support sex offender notifications.
NLSORHELP
Contains a list of states that support inquiries to their sex offender
registration file.
NLSWQHELP
Contains a list of states that support inquiries on state warrants.
NLTSTHELP
Contains a list of state test records.
NLWLQHELP
Contains a list of states that support Wildlife Violation transactions.
NLWTHHELP
Contains information on states that provide road/weather information
on an automated and non-automated basis.
HELP File Formats
Each user has the responsibility of maintaining their HELP file records in the correct format. The required formats help to standardize the HELP records and make them more useful to all users.
Vehicle Registration HELP Files
The tables below describe information that may be in vehicle license number records
INQUIRIES ON LICENSE NUMBER
YES
NO
AUTOMATED:
IS LICENSE YEAR USED:
IS LICENSE TYPE USED:
IF YES, EXPLAIN: (List any unique types that must be used for inquiry.)
SPECIAL CHARACTERS USED:
PLATES ISSUED TO PERSON OR LICENSEE:
INQUIRIES ON VIN
YES
NO
AUTOMATED:
IS VEHICLE MAKE AND/OR VEHICLES YEAR USED:
DEFINE ACCESS TO ANY FILES THAT ARE NOT ACCESIBLE THROUGH A STANDARD
INQUIRY: (i.e., Vanity plates, motorcycle, etc.)
DEFINE ANY SPECIAL SEARCHES AVAILABLE:
OTHER DATA AVAILABLE: (i.e., Lien or lessee info):
GENERAL COMMENTS:
SPECIAL RESTRICTIONS ON USAGES OF DATA:
HOURS OF SERVICE:
EMERGENCY REQUESTS:
EXAMPLE OF RESPONSE FORMAT: (List any special codes used)
TEST RECORD:
STATE CONTACT: (Address, phone number)
Operator License HELP Files
The table below describes information that may be in Operator License HELP files.
LAST UPDATE:
INQUIRY ON NAME
YES
NO
AUTOMATED:
HIT REQUIREMENTS:
SPECIAL REQUIREMENTS FOR NAME, DOB SEARCHES: (i.e., Middle name required,
suffixes not used, exact match required, age allowable in lieu of exact DOB)
OFFLINE SEARCH AVAILABLE:
OTHER COMMENTS:
INQUIRY ON OLN
YES
NO
AUTOMATED:
PHOTOS AVAILABLE
HOW TO OBTAIN DRIVER HISTORY INFORMATION:
RESTRICTIONS ON USAGES OF DATA:
CLASSES USED:
GENERAL COMMENTS:
HOURS OF SERVICE:
EMERGENCY REQUESTS:
EXAMPLEOF RESPONSE FORMAT: (List any special codes used)
TEST RECORD:
STATE CONTACT: (Address, phone number)
Criminal History HELP File (SIR)
The table below describes information that may be in Criminal History HELP files.
LAST UPDATE:
CRIMINAL HISTORY
YES
NO
TRIPLE I PARTICIPANT
PURPOSE CODES SUPORTED:
EXTENT OF AUTOMATED FILE:
WILL STANDARD INQUIRY SEARCH ALL FILE INFORMATION:
EXPLAIN:
INQUIRY ON NAME
YES
NO
AUTOMATED:
HIT REQUIREMENTS:
SPECIAL ON-LINE REQUESTS FOR NAME AND DOB SEARCHES:
HOW DO YOU HANDLE MULTIPLE HITS:
OFF-LINE SEARCHES AVAILABLE:
AVERAGE RESPONSE TIME:
INQUIRY ON SID
YES
NO
AUTOMATED:
ADDRESS REQUIRED:
SPECIAL REQUIREMENTS:
AVERAGE RESPONSE TIME:
INQUIRY ON MISC
YES
NO
AVAILABLE:
AUTOMATED:
INQUIRY ON SOC
YES
NO
AVAILABLE:
AUTOMATED:
HOW ARE JUVENILE RECORDS HANDLED:
GENERAL COMMENTS:
SPECIAL RESTRICTIONSON USAGE OF DATA:
HOURS OF SERVICE:
EMERGENCY REQUESTS:
RESPONSE FORMAT: (List any special codes or abbreviations used. You are not
required to provide an example of your full criminal history record.)
TEST RECORD:
STATE CONTACT: (Address, phone number)
Boat and Snowmobile HELP Files
The table below describes information that may be in Boat and Snowmobile HELP files.
LAST UPDATE:
BOATS
YES
NO
DO YOU ACCEPT AND PROCESS BQs?
INQUIRIES ON REGISTRATION NUMBER AUTOMATED:
INQUIRIES ON BOAT HULL NUMBER AUTOMATED:
INQUIRIES ON NAME, DOB AUTOMATED:
SPECIAL CHARACTERS USED:
SNOWMOBILES
YES
NO
DO YOU ACCEPT AND PROCESS SQs?
INQUIRIES ON REGISTRATION NUMBER AUTOMATED:
INQUIRIES ON VIN AUTOMATED:
INQUIRIES ON NAME, DOB AUTOMATED:
SPECIAL CHARACTERS USED:
DEFINE ANY SPECIAL SEARCHES AVAILABLE:
OTHER DATA AVAILABLE:
CLASSES OF BOATS USED:
GENERAL COMMENTS:
SPECIAL RESTRICTIONSON USAGE OF DATA:
HOURS OF SERVICE:
EMERGENCY REQUESTS:
EXAMPLES OF RESPONSE FORMAT: (List any special codes used.)
TEST RECORD:
STATE CONTACT: (Address, phone number)