Section 11: Homeland Security

From Nlets Wiki
Jump to: navigation, search

Homeland Security (HS & HSL)

This section of the Nlets User Guide presents pertinent information regarding Homeland Security (HS) and Homeland Security Law Enforcement Only (HSL) messages.

The purpose of the Homeland Security message (HS) is to notify First Responders, i.e. the Police, Public Safety and other emergency type agencies in the event of National, Regional or local area threat situation. The Homeland Security Law Enforcement Only (HSL) option gives the sender that capability of sending only to Law Enforcement Agencies. The HSL option will add the caveat "LAW ENFORCEMENT DISSEMINATION ONLY".

Requirements

These unique message keys allow receiving Nlets System Agencies to distinguish it from a normal Administrative message.

  • The Homeland Security message (HS & HSL) can only be sent by agencies designated by "Homeland Security Officials" and is delivered with the highest priority allowed by Nlets.
  • Based on the "CCD/" field, a different unique caveat is placed in the text of the message and is followed by the free form text entered by the sending agency.
  • Only those designated agencies need to program this key for sending purposes.
  • Receiving agencies should program this key in such a way as to avoid manual delay in passing this message on to appropriate agencies within their jurisdiction.
  • Messages may include up to 5 addresses (state or regional codes).

Homeland Security Message Field Requirements

The following fields are required.

XML Tag: Legacy
Entry:
Field
Size:
Data
Requirements:
Translation:
n2:ConditionCode
CCD/ 1 Must be R, O, Y, B, G or T Identify condition code
n2:MailMessageText
Free text Max.
14,400
Free text No special format used

Top

GJXDM (DEPRECATED)

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

Top

NIEM

Homeland Security NIEM Specifications

This section provides NIEM format and examples for Homeland Security (HS) and Homeland Security Law Enforcement Only (HSL) messages.

The purpose of the Homeland Security message (HS) is to notify First Responders, i.e. the Police, Public Safety and other emergency type agencies in the event of National, Regional or local area threat situation. The Homeland Security Law Enforcement Only (HSL) option gives the sender that capability of sending only to Law Enforcement Agencies. The HSL option will add the caveat "LAW ENFORCEMENT DISSEMINATION ONLY".

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: Homeland Security Alert (HS,HSL).

Message Formats

Homeland Security Alert (HS,HSL)

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

  Condition Code (n2:ConditionCode)
  This element identify the condition code; must be R,O,Y,B,G or T.

  Alert Text (n2:MailMessageText)
  This free text element contains the text of the homeland security alert.

Homeland Security NIEM Examples

Example 1: A Homeland Security Message received by a user.

<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>HS</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>DCFBIWAE6</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS20</nh2:DestinationORIID>
    <nh2:MessageReceiveDate>01/09/2011</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>18:14</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>01/09/2011</nh2:MessageSendDate>
    <nh2:MessageSendTime>18:14</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>76148</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>45216</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <n2:NLETSMailData n2:key="HS">
    <n2:MailMessageText>THERE HAS BEEN AN UNSUBSTANIATED THEAT TO ALL TALL BUILDINGS IN THE
       CONTINENTAL UNITED STATES.
       ETC, ETC.
       END OF MESSAGE.
    </n2:MailMessageText> 
  </n2:NLETSMailData>
</n2:NLETS>

Top

Legacy (DEPRECATED)

Homeland Security Legacy Specifications

This section provides Legacy format and examples for Homeland Security (HS) and Homeland Security Law Enforcement Only (HSL) messages.

Message Formats

The format for Homeland Security messages (HS) is as follows:

Entry # Char. Explanation
HS. 2 Message type followed by a period
Message Header 13-36 Standard input message header, may include control field
and up to 5 addresses (state or regional codes).
TXT 3 Fixed filed prefix to beginning of message
CR,LF,DEL 3 Control characters (optional)
CCD/ 4 Prefix to identify condition code
Condition code 1 Must be R,O,Y,B,G or T
Free text Max.
14,400
No special format used
Homeland Security Legacy Examples

Example 1: A Homeland Security Message received by a user.

HS.DCFBIWAE6
18:14 01/09/2011 67726
18:14 01/09/2011 76578 AZNLETS20
TXT (AP,PA009015Y,CN)
***** HIGH PRIORITY MESSAGE *****
***** HOMELAND SECURITY ALERT *****
***** CONDITION YELLOW (ELEVATED) *****
THERE HAS BEEN AN UNSUBSTANIATED THEAT TO ALL TALL BUILDINGS IN THE
CONTINENTAL UNITED STATES
ETC, ETC.
END OF MESSAGE.

Top

Downloads

Download HS Schema

Download HSL Schema

Top