Section 09: Status Messages

From Nlets Wiki
Revision as of 10:40, 22 August 2019 by Nlets Analyst (talk | contribs) (Created page with "__TOC__ ==Status Messages (SM)== This section presents pertinent information regarding status messages that are sent periodically by the Nlets system, Nlets terminals, and m...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Status Messages (SM)

This section presents pertinent information regarding status messages that are sent periodically by the Nlets system, Nlets terminals, and member systems.

All messages are in plain English and use the same structure and header format as Administrative messages (AM).

If a state or other user is going to be out of service and chooses to notify all users on Nlets, an "SM" type message should be used. This message key has been granted the highest priority within the Nlets system.


Manually Generated Status Messages

The following SM messages are manually generated by Nlets' operators:

Status Message: Explanation:
NLETS TEMPORARILY OUT OF SERVICE UNTIL XXXX AAA
(where XXXX = military time and AAA = time zone of originator)

This message is sent to all members should Nlets have
to go off the air for a short period. This message should
be directed to member control terminals.

NLETS IN SERVICE

This message is sent to all members whenever Nlets has
been off the air and is now back on line. This message should
be directed to member control terminals.

Automatically Generated Status Messages

The following status messages are automatically generated by the Nlets' system.

Status Message: Explanation:
.01. USER DOES NOT RESPOND TO MSG TYPE,
NLETS WILL NOT FORWARD

Indicates the user has attempted to send a message type
that is invalid for the destination.

.02. USER OUT OF SERVICE FOR MSG TYPE,
NLETS WILL FORWARD

Indicates that the destination cannot currently accept
the message but once service has been restored Nlets
will forward the message to the destinaiton.

.04. USER OUT OF SERVICE FOR MSG TYPE,
NLETS WILL NOT FORWARD

Indicates that the user has been put on remove status.
This means that any messages of the type on remove status for
this destination will not be stored or forwarded. They must
be resent once the destination state system returns to service.

Top

GJXDM (DEPRECATED)

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

Top

NIEM

Status Message NIEM Specifications

All messages are in plain English and use the same structure and header format as Administrative messages (AM).

If a state or other user is going to be out of service and chooses to notify all users on Nlets, an "SM" type message should be used. This message key has been granted the highest priority within the Nlets system.

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 type detailed below: Status Message (SM).

Message Formats

Status Message (SM)

n2:NLETSMailData
This element will contain all elements specific to this transaction.

  n2:StatusMessageText
  This element will contain the free text status message.
  Nlets recommends the use of <![CDATA[]]> tags to ensure that the response does not contain any characters illegal in XML.

Status Message NIEM Example

Example 1: Status Message from a state.

<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0"
xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
n2:version="4.00" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>SM</nh2:MessageKeyCodeText> 
    <nh2:OriginatingORIID>TXDPS0000</nh2:OriginatingORIID> 
    <nh2:DestinationORIID>OK0000000</nh2:DestinationORIID> 
    <nh2:DocumentControlFieldText>
      <![CDATA[LTN2000157]]> 
    </nh2:DocumentControlFieldText>
    <nh2:MessageReceiveDate>01/01/2010</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>09:00</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>01/01/2010</nh2:MessageSendDate>
    <nh2:MessageSendTime>09:00</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>81232</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>31236</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <n2:NLETSMailData n2:key="SM">
    <n2:StatusMessageText>TX requires 8 character OLN
       Original Message:
       MKE/DQ.
       ORI/OK0000000.
       DST/TX.
       CTL/MRIA000000.
       OLN/D082000000
    </n2:StatusMessageText> 
  </n2:NLETSMailData>
</n2:NLETS>

Example 2: Status Message sent from Nlets.

<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0"
xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
n2:version="4.00" xmlns:n2="http://www.nlets.org/niem/1.0">
  <n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>SM</nh2:MessageKeyCodeText> 
    <nh2:OriginatingORIID>NLSRVCMSG</nh2:OriginatingORIID> 
    <nh2:DestinationORIID>AZNLETS20</nh2:DestinationORIID> 
    <nh2:MessageReceiveDate>01/01/2010</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>09:00</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>01/01/2010</nh2:MessageSendDate>
    <nh2:MessageSendTime>09:00</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>01230</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>61233</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <n2:NLETSMailData n2:key="SM">
    <n2:StatusMessageText>Puerto Rico no longer responds to RQ and DQ Department of Motor Vehicle Queries
         ORIGINAL MESSAGE
         DQ.AZNLETS19.PR.TXTOLN/123456789
    </n2:StatusMessageText> 
  </n2:NLETSMailData>
</n2:NLETS>

Top

Legacy (DEPRECATED)

This section describes the format for a Status Message (SM) and provides a Legacy example.

Status Message Legacy Specifications

All messages are in plain English and use the same structure and header format as Administrative messages (AM).

If a state or other user is going to be out of service and chooses to notify all users on Nlets, an "SM" type message should be used. This message key has been granted the highest priority within the Nlets system.

Message Formats

To send a Status Message, enter the following:

"SM." (2-4 character message type).
Sender's ORI followed by a period.
Destination ORI followed by a period.
The three characters "TXT"
Free-Text Status Message data.
Status Message Legacy Example

Example 1: Status Message forwarded from a state.

SM.TXDPS0000
09:00 01/01/2010 81232
09:00 01/01/2010 31236 OK0000000
TXT
TX requires 8 character OLN
Original Message:
MKE/DQ.
ORI/OK0000000.
DST/TX.
CTL/MRIA000000.
OLN/D082000000

Example 2: Status Message sent from Nlets.

SM.NLSRVCMSG
09:00 01/01/2010 01230
09:00 01/01/2010 61233 AZNLETS20
TXT
Puerto Rico no longer responds to RQ and DQ Department of Motor Vehicle Queries
 
ORIGINAL MESSAGE
RQ.AZNLETS20.PR.TXT
VIN/1234567689

Top