Section 05: Help File Transactions

From Nlets Wiki
Jump to: navigation, search

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.

Each state/province should validate their HELP files annually to insure their relevance and accuracy.

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.

If only a single screen of data can be added to the HELP file, add a record using the "UPDT" function, then send a second screen using the append function.

Cancel a Message from the HELP File

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 HELP record, use one of the two character Federal codes in the table below, followed by "ADMHELP".

Federal Agency Two Character Code
FBI/National Crime Information Center (NCIC) FB
Coast Guard CG
Treasury Enforcement Communications System (TECS) TC
Department of State DS
Department of Justice (JUST) DJ
Interpol IP
Naval Investigative Service DN
NICB NA
Postal Inspection Service PS
Secret Service SS
ATF's Gun Tracing System AT
ICE Law Enforcement Support Center AX
National Center for Missing and Exploited Children (NCMEC) MC

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.
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)

Top

GJXDM (DEPRECATED)

GJXDM has been deprecated. Please contact Nlets for additional assistance with GJXDM.

Top

NIEM

HELP File NIEM Specifications

This section provides NIEM formats and NIEM examples for HELP files that deal with state or other member HELP records. HELP messages are sent in the same format as Administrative Messages. The destination ORI identifies these messages are Help messages, as opposed to standard Administrative Messages. The destination ORI for help file messages will be formulated in this manner:

First two characters: 2 character code of state help file that you are interacting with (your own state for APND, UPDT, CNCL, or the state in question for queries).

Characters 3-5: Code indicating the specific help file you are dealing with.

     BAS - Boat and Snowmobile
     COR - Corrections Information
     GUN - Gun File Information
     LIC - Vehicle License
     NOQ - Name Only Query Information
     OLN - Operator's License
     ORI - Nlets "S" ORI Information
     PAR - Parole Information
     PPC - Parole, Probation and Correction Information
     PRO - Probation Information
     SIR - Criminal History
     SOR - Sex Offender Registry
     SWQ - State Warrant Information
     WTH - Weather Information

The last 4 characters will indicate the type of transaction you are performing and are detailed below.

All Nlets NIEM messages must be based on the Nlets NIEM Message Structure and include the standard Nlets XML Header as detailed in Message Structure. The NIEM header and hierarchy of the elements in this section have been omitted to avoid redundancy. The associated schemas and instances should be consulted to determine the correct XPaths of the elements.

Element Dictionary

Transaction types detailed below include: Help File Update (AM), Help File Append (AM), Help File Cancel (AM) & Help File Query (AM).

Query Formats

Help File Update (AM)
Note: When the update function is used, the last four characters of the destination ORI will be "UPDT".

Mail Data (n2:NLETSMailData)
This element will contain all elements specific to this transaction.

  Mail Text (n2:MailMessageText)
  This contents of this element will replace any record currently on file. Nlets recommends the use of <![CDATA[]]> tags to ensure
  that the response does not contain any characters illegal in XML.

Help File Append (AM)
Note: When the update function is used, the last four characters of the destination ORI will be "APND".

Mail Data (n2:NLETSMailData)
This element will contain all elements specific to this transaction.

  Mail Text (n2:MailMessageText)
  This contents of this element will be added to the record currently on file. Nlets recommends the use of <![CDATA[]]> tags to ensure
  that the response does not contain any characters illegal in XML.

Help File Cancel (AM)
Note: When the cancel function is used, the last four characters of the destination ORI will be "CNCL".
This message clears the file. Any state inquiring to the file after the cancel is issued will receive
a message stating "NO HELP INFO AVAILABLE."

Help File Query (AM)
Note: To request data from a help file, the last 4 characters of the destination ORI will be "HELP".

HELP NIEM Examples

Example 1: Update message to create a new HELP.

<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>AM</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>AZNLETS49</nh2:OriginatingORIID>
    <nh2:DestinationORIID>NLNLEUPDT</nh2:DestinationORIID>
  </n2:NLETSMessageHeader>
  <n2:NLETSMailData n2:key="AM">
    <n2:MailMessageText>(AZNLETS47)
NEW HELP MESSAGE</n2:MailMessageText>
  </n2:NLETSMailData>

The NLNLEHELP file now will return a response of:

<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>AM</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>NLNLEHELP</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS47</nh2:DestinationORIID>
    <nh2:MessageReceiveDate>10/22/2019</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>09:50</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>10/22/2019</nh2:MessageSendDate>
    <nh2:MessageSendTime>09:50</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>00792</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <n2:NLETSMailData n2:key="AM">
    <n2:MailMessageText>(AZNLETS47)
NEW HELP MESSAGE</n2:MailMessageText>
  </n2:NLETSMailData>
</n2:NLETS>

Example 2: Appending a message to the NLNLEHELP HELP file.

<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>AM</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>AZNLETS47</nh2:OriginatingORIID>
    <nh2:DestinationORIID>NLNLEAPND</nh2:DestinationORIID>
  </n2:NLETSMessageHeader>
  <n2:NLETSMailData n2:key="AM">
    <n2:MailMessageText>(AZNLETS47)
NEW UPDATE *APND*</n2:MailMessageText>
  </n2:NLETSMailData>
</n2:NLETS>

The NLNLEHELP file now will return a response of:

<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>AM</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>NLNLEHELP</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS47</nh2:DestinationORIID>
    <nh2:MessageReceiveDate>10/22/2019</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>09:53</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>10/22/2019</nh2:MessageSendDate>
    <nh2:MessageSendTime>09:53</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>00796</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <n2:NLETSMailData n2:key="AM">
    <n2:MailMessageText>(AZNLETS47)
NEW UPDATE *APND*</n2:MailMessageText>
  </n2:NLETSMailData>
</n2:NLETS>
</n2:NLETS>

Example 3: Cancelling a the NLNLEHELP HELP file.

<?xml version="1.0" encoding="utf-16"?>
<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>AM</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>AZNLETS47</nh2:OriginatingORIID>
    <nh2:DestinationORIID>NLNLECNCL</nh2:DestinationORIID>
  </n2:NLETSMessageHeader>
  <n2:NLETSMailData n2:key="AM">
    <n2:MailMessageText>(AZNLETS47)
</n2:MailMessageText>
  </n2:NLETSMailData>
</n2:NLETS>

The NLNLEHELP file now will return a response of:

<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>AM</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>NLNLEHELP</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS47</nh2:DestinationORIID>
    <nh2:MessageReceiveDate>10/22/2019</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>09:57</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>10/22/2019</nh2:MessageSendDate>
    <nh2:MessageSendTime>09:57</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>00805</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <n2:NLETSMailData n2:key="AM">
    <n2:MailMessageText>(AZNLETS47)
NO NLE HELP INFORMATION AVAILABLE FOR THIS USER</n2:MailMessageText>
  </n2:NLETSMailData>
</n2:NLETS>

Top

Legacy (DEPRECATED)

HELP File Legacy Specifications

This section provides formats and examples for HELP files that deal with state or other member HELP records.

Query Formats

Legacy Message to Create/Replace HELP Data

To create a new help file use the update ("UPDT") function, the information after the "TXT" will be used in the help file, If a file already exists it will be replace by the new message.

Note: No information can be added to an existing record when using the "UPDT" code.

Legacy Message to Add Information to an Existing HELP Record

Use the append ("APND") function to add or append information to the end of an existing record.

Information after the "TXT" will be added to the existing HELP record. Nlets also will add a CR/LF immediately before the new information.

If you can add only a single screen of data to the HELP file, add a record using the "UPDT" function, then send a second screen using the append function.

Legacy Message to Cancel a Message from the HELP Files

Use the cancel ("CNCL") function to delete an existing record.

This clears the file with an ETX mark. Any state inquiring to the file after the cancel is issued will receive a message stating "NO HELP INFORMATION AVAILABLE FOR THIS USER."

HELP Legacy Examples

Example 1: Update message to create a new HELP.

AM.AZNLETS20.NLNLEUPDT.TXT
NEW HELP MESSAGE

The NLNLEHELP file now will return a response of:

AM.NLNLEHELP
10:01 08/22/2011 35048
10:01 08/22/2011 08374 AZNLETS20
TXT
NEW HELP MESSAGE

Example 2: Appending a message to the NLNLEHELP HELP file.

AM.AZNLETS20.NLNLEAPND.TXT
NEW UPDATE

The NLNLEHELP file now will return a response of:

AM.NLNLEHELP
10:02 08/22/2011 35079
10:02 08/22/2011 08376 AZNLETS20
TXT
NEW HELP MESSAGE
NEW UPDATE

Example 3: Cancelling a the NLNLEHELP HELP file.

AM.AZNLETS20.NLNLECNCL.TXT

The NLNLEHELP file now will return a response of:

AM.NLNLEHELP
10:02 08/22/2011 35103
10:02 08/22/2011 08377 AZNLETS20
TXT
NO NLE HELP INFORMATION AVAILABLE FOR THIS USER

Top