Section 07: Generic Messages

From Nlets Wiki
Jump to: navigation, search

Generic Messages (LQ/LR)

This section describes generic transactions which provide Nlets users with the capability to inquire on other state's unique databases. Some state files may not be of nationwide value or availability; however nearby states may benefit from access to these files.

Generic Message Requirements

There are no specific formats to allow automated access and response for generic transactions. All coordination is the responsibility of the states.

Rules have been kept to a minimum due to the general nature of the LQ/LR message:

The standard Nlets header must be used for both XML and Legacy messages.

Only a single 2 or 9 character address may be used.

XML inquiries and responses will use the following element to identify the message type for both queries and responses:

Legacy inquiries must use LQ as the message key, while the responses must use LR as the message key.

XML Message Type: Legacy Message Type: Description:
<n2:MessageKeyCodeText>LQ</n2:MessageKeyCodeText>
LQ. Generic query
<n2:MessageKeyCodeText>LR</n2:MessageKeyCodeText>
LR. Generic response

Generic Message Example

New York may have implemented a widget registration file. There may be definite benefits in New Jersey accessing this file. To implement such a capability nationwide is not feasible at this time. Therefore, representatives from New Jersey and New York coordinate an effort to allow access through Nlets utilizing the generic message transaction (LQ/LR).

Nlets will not edit the text of the message (LQ) so New Jersey may include whatever information is required by the receiving state.

They may put an embedded message key and data elements that match New York's internal message formats.

New York will dissect the message, query their widget registration file and return the response over Nlets under the generic message key (LR).

Top

GJXDM (DEPRECATED)

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

Top

NIEM

Generic Message NIEM Specifications

This section includes format specifications and an example of a NIEM generic transaction (LQ/LR).

There are no edits or requirements on generic message queries and responses, other than standard Nlets NIEM formatting. A generic message can be sent to any 2 or 9 character destination and should adhere to the rules set up between agencies for any specific generic transactions.

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: Generic Message Query (LQ) and Generic Message Response (LR).

Query Formats

Generic Message Query (LQ)
n2:NLETSInquiryData
This element will contain all elements specific to this transaction.

  n2:InquiryDescriptionText
  This element contains free text. Include personal descriptors (name, sex) with other relevant data (case
  number, booking number, state ID, miscellaneous number) followed by any additional free text.

Response Formats

Generic Message Response (LR)
n2:NLETSResponseData

  n2:ResponseText


  This element will contain the free text response. Nlets recommends the use of

<!&#91;CDATA&#91;&#93;&#93;>

tags to


  ensure that the response does not contain any characters illegal in XML.

Generic Message NIEM Examples

Example 1: A Generic Message sent to Arizona.

<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>LQ</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>AZNLETS47</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZ</nh2:DestinationORIID>
  </n2:NLETSMessageHeader>
  <n2:NLETSInquiryData n2:key="LQ">
    <n2:InquiryDescriptionText>INQUIRY DATA</n2:InquiryDescriptionText>
  </n2:NLETSInquiryData>
</n2:NLETS>

Example 2: A Generic Response from Arizona.

<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>LR</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>AZ1110000</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS47</nh2:DestinationORIID>
    <nh2:MessageReceiveDate>10/22/2019</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>10:11</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>10/22/2019</nh2:MessageSendDate>
    <nh2:MessageSendTime>10:11</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>00834</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <n2:NLETSResponseData n2:key="LR">
    <n2:ResponseText>RESPONSE DATA</n2:ResponseText>
  </n2:NLETSResponseData>
</n2:NLETS>

Top

Legacy (DEPRECATED)

Generic Message Legacy Specifications

This section includes format specifications and examples of a Legacy Generic message (LQ/LR)

Query Formats

To send a Generic Message, enter the following:

Entry # Char. Explanation
Message Type 2-4 2 to 4 character message type followed by a period
Sender ORI 9 Sender ORI followed by a period
Destination ORI 2 2-character code designating the physical location of the
representative followed by a period.
TXT 3 Fixed field prefix to beginning of message.

Message elements example:

Entry Explanation
"LQ." 2-4 character message type followed by a period
NJ0000000. Sender's ORI (9 character ORI) followed by a period
NY Destination ORI followed by a period
TXT Text (always preceded by "TXT")
WIDGET.SER/5850494 Message
Generic Message Legacy Examples

Example 1: A Generic Message sent to Arizona.

LQ.AZNLETS20.AZ.TXT
MESSAGE

Example 2: A Generic Response from Arizona.

LR.AZ1110000
09:51 09/26/2011 00055
09:51 09/26/2011 00267 AZNLETS20
TXT
MESSAGE

Top

Downloads

Download LQ Schema

Download LR Schema

Download LR Stylesheet

Top