Difference between revisions of "Section 20: Road-Weather Transactions"

From Nlets Wiki
Jump to: navigation, search
(Response Formats)
(Road Weather NIEM Examples)
Line 83: Line 83:
 
  <syntaxhighlight lang="xml">
 
  <syntaxhighlight lang="xml">
 
<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: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>
+
<n2:NLETSMessageHeader>
    <nh2:MessageKeyCodeText>HQ</nh2:MessageKeyCodeText>
+
<nh2:MessageKeyCodeText>HQ</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>WS0000000</nh2:OriginatingORIID>
+
<nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS49</nh2:DestinationORIID>
+
<nh2:DestinationORIID>IN</nh2:DestinationORIID>
  </n2:NLETSMessageHeader>
+
<nh2:DocumentControlFieldText>NLTEST0001</nh2:DocumentControlFieldText>
  <n2:NLETSInquiryData n2:key="HQ" />
+
</n2:NLETSMessageHeader>
 +
<n2:NLETSInquiryData n2:key="HQ">
 +
<n2:InquiryDescriptionText>WEATHER</n2:InquiryDescriptionText>
 +
</n2:NLETSInquiryData>
 +
</n2:NLETS>
 
</n2:NLETS>
 
</n2:NLETS>
 
  </syntaxhighlight>
 
  </syntaxhighlight>

Revision as of 10:44, 1 December 2019

Road Weather Transactions (HQ/HR)

An agency may request out-of-state road and weather information by sending an inquiry (HQ) through Nlets to a participating state. A road/weather information file will be maintained by each participating state. Inquiries and responses are exchanged via Nlets similar to the way motor vehicle inquiries and responses are exchanged.

The NOAA weather wire services (NWWS) are now transmitted to the states via the Nlets network. This allows states to select between various weather data options that affect their state.

The states participating in the Nlets Road/Weather Program may be obtained by sending an Administrative Message (AM) to the ORI "NXWTHHELP".

Should Nlets users choose to send weather inquiries to any of the states listed as not participating, they should not expect a response of any kind. This does not preclude requesting weather conditions for a specific community or area using an administrative (AM) message.

Query Requirements

  • Up to 5 two character state codes are permitted per inquiry.
  • At the present time there is no fixed response.
  • If a state is unable to support automated responses, manual responses are acceptable.
IMPORTANT NOTE: Each state's road/weather file must contain enough information and must be
updated often enough to be meaningful.
  • Road/weather inquiries do not have to be in a fixed format except for the time and date fields preceding the text information in an inquiry and the "TIM/" and "DAT/" field following the "TXT" in a response.

Should a state choose not to support road/weather inquiry, a standard response should be returned.

Top

GJXDM (DEPRECATED)

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

Top

NIEM

Road Weather NIEM Specifications

This section provides format specifications and examples for NIEM Road/Weather transactions (HQ/HR).

Road/weather inquiries/responses do not have to be in a fixed format except for the time and date field preceding the text information in an inquiry and following the "text" in a response.

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: Road Weather Query (HQ) and Road Weather Response (HR).

Query Formats

Road Weather Query (HQ)

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

Road Weather Response (HR)

n2:NLETSResponseData

n2:ResponseText

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

<![CDATA[1234567890]]>

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

Road Weather NIEM Examples

Example 1: Road/Weather query sent by a user.

<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>HQ</nh2:MessageKeyCodeText>
		<nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
		<nh2:DestinationORIID>IN</nh2:DestinationORIID>
		<nh2:DocumentControlFieldText>NLTEST0001</nh2:DocumentControlFieldText>
	</n2:NLETSMessageHeader>
	<n2:NLETSInquiryData n2:key="HQ">
		<n2:InquiryDescriptionText>WEATHER</n2:InquiryDescriptionText>
	</n2:NLETSInquiryData>
</n2:NLETS>
</n2:NLETS>

Example 2: Road/Weather response received by user.

<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>HR</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>WS0000000</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS49</nh2:DestinationORIID>
    <nh2:MessageReceiveDate>10/22/2019</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>09:33</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>10/22/2019</nh2:MessageSendDate>
    <nh2:MessageSendTime>09:33</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>00778</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <n2:NLETSResponseData n2:key="HR">
    <n2:ResponseText>CURRENT WEATHER INFORMATION:

              WEATHER REPORT FOR STATE OF OKLAHOMA
                 
          WEATHER UPDATES ARE NO LONGER RECEIVED BY OLETS

          1015 CDT                               01/06/19

     CURRENT ROAD INFORMATION:

                OKLAHOMA DRIVING CONDITIONS 
                 
     NO REPORTS OF HAZARDOUS ROAD CONDITIONS AT THIS TIME 

            "HAVE A GREAT DAY FROM THE SOONER STATE"

            1015 CDT                        01/06/19</n2:ResponseText>
  </n2:NLETSResponseData>
</n2:NLETS>

Example 3: Road/Weather message received from National Weather Wire.

<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>HR</nh2:MessageKeyCodeText>
    <nh2:OriginatingORIID>WS0000000</nh2:OriginatingORIID>
    <nh2:DestinationORIID>AZNLETS47</nh2:DestinationORIID>
    <nh2:MessageReceiveDate>10/22/2019</nh2:MessageReceiveDate>
    <nh2:MessageReceiveTime>09:34</nh2:MessageReceiveTime>
    <nh2:MessageSendDate>10/22/2019</nh2:MessageSendDate>
    <nh2:MessageSendTime>09:34</nh2:MessageSendTime>
    <nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
    <nh2:SendMessageNumeric>00779</nh2:SendMessageNumeric>
  </n2:NLETSMessageHeader>
  <n2:NLETSResponseData n2:key="HR">
    <n2:ResponseText>FXUS64 KMEG 151528 AFDMEG  Area Forecast Discussion National Weather Service Memphis TN 1028 AM CDT Mon Apr 15 2019
  .UPDATE... Beautiful weather is on tap for the Mid-South today. Temperatures have warmed into the 50s area wide and will approach 70F by mid- afternoon.
Clouds have moved east with the departing trough, so we'll maintain clear skies today.
Winds are currently light from the south but will increase this afternoon in response to a tightening pressure gradient as a trough and attendant upper- level jet eject into the Northern Plains.
Winds will increase to  10-15 mph this afternoon along and west of the Mississippi River  with gusts to 20 mph at times.
Southerly winds will relax a bit  overnight but warm advection and boundary layer mixing will keep  temperatures quite a bit warmer than this morning.
No big changes  were included in the forecast update.  Johnson  &amp;&amp;
.PREV DISCUSSION... /issued 416 AM CDT Mon Apr 15 2019/
DISCUSSION...  Currently...Weak surface highs pressure sits over the region with clear skies and light winds.
Good radiational cooling conditions helping temps fall into the 30s across parts of the Mid-South.
Expect frost across parts of the Mid-South especially locations  in the Frost advisory which covers much of West Tennessee.
Patchy fog is also occurring near the TN River and across North Mississippi.
Today through Wednesday...High pressure will prevail today with sunny skies and slightly below normal temperatures.
Return flow will commence along and west of the River this afternoon. As a  result expect warmer temps tonight with lows in the upper 40s and  lower 50s.
As the high moves east southerly flow will increase on  Tuesday pushing highs well into the 70s. Expect a breezy day  across the Delta.
Breezy conditions continue into Wednesday as  moisture continues to increase. Weak isentropic lift may result  in a few showers during the AM west of the MS River.
A weak upper  level disturbance combined with some instability could produce a  few thunderstorms west of the river Wednesday afternoon. Highs  will again be in the 70s.
Wednesday night through Thursday night...A potent upper level  system will move out of the SW U.S. Wednesday night.
Moisture and instability will increase across the lower MS Valley with  increasing shear as the upper trough pushes across the southern  plains.
Convection with severe weather potential will develop over the ARKLATEX and spread NE overnight...gradually weakening as it  moves into a less favorable environment.
A few strong to severe  storms are possible late Wednesday night mainly west of the MS  River. That first round will continue to spread east Thursday  morning and weaken.
Another round of convection will likely  develop across the area as a potent mid level shortwave rounds the base of the main upper trough and punches into the area during  the day on Thursday.
Of course details of severe weather chances  will depend on many things, like ongoing convection, how quickly  the surface system occludes and the strength/timing of the  shortwave etc.
Given the strong shear combined with a moist and  somewhat unstable boundary layer strong to severe storms will be  possible across the Mid-South Thursday.
Models are in good  agreement with moving most of the activity east of the Mid-South  by Thursday evening. Right now it looks like another 1.5 to 2.5  inches of rain possible with this event.
Friday and Friday night...A deep upper low will drop into the region by Friday with more showers and highs only in the 50s. Showers will begin tapering off Friday night with lows in the  40s.
Weekend...Looks sunny albeit a bit chilly on Saturday with strong NW flow on the backside of the departing upper low. Temps will climb into the 70s on Sunday.
SJM  &amp;&amp;  .AVIATION... /12Z TAFs/  VFR. Light winds becoming south at 6-11kts.
Higher gusts at JBR.  JAB  &amp;&amp;
.MEG WATCHES/WARNINGS/ADVISORIES... AR...None. MO...None. MS...None. TN...None.
&amp;&amp;  $$ 
    </n2:ResponseText>
  </n2:NLETSResponseData>
</n2:NLETS>

Top

Legacy (DEPRECATED)

Road Weather Legacy Specifications

This section provides format specifications and examples for Legacy Road/Weather transactions (HQ/HR).

Query Formats

Road/weather inquiries (HQ) do not have to be in a fixed format except for the time and date field preceding the text information.

The format for a road/weather inquiry is as follows.

Entry # Char. Explanation
HQ. 2 Message type followed by a period.
Message Header 3-27

Standard input message header, may include control
field and up to five 2 character state codes followed
by a period.

TXT 3 Fixed filed prefix to beginning of message.
CR,LF,DEL 3 Control characters (optional).
WEATHER 7

Used for further identification of inquiry request (with
message type HQ.). This field will not be edited by
Nlets but should be used for all inquires.

Response Formats

Road/weather responses (HR) do not have to be in a fixed format.

Following is the format a state should return to the sender if the information is unavailable:

Entry # Char. Explanation
HR. 2 Message type followed by a period.
Message Header 68-82 Standard output message header.
TXT 3 Fixed filed prefix to beginning of message.
CR,LF,DEL 3 Control characters (optional).
WEATHER INFORMATION
NOT AVAILABLE
33 Message notifying requesting agency that the
information requested is unavailable.
Road Weather Legacy Examples

Example 1: Road/Weather query sent by a user.

HQ.AZNLETS20.OK.TXT
WEATHER

Example 2: Road/Weather response received by a state.

HR.OKSUPV000

08:36 04/15/2019 06857
08:36 04/15/2019 00119 AZNLETS20
TXT
CURRENT WEATHER INFORMATION:

WEATHER REPORT FOR STATE OF OKLAHOMA

WEATHER UPDATES ARE NO LONGER RECEIVED BY OLETS

1015 CDT 01/06/19

CURRENT ROAD INFORMATION:

OKLAHOMA DRIVING CONDITIONS

NO REPORTS OF HAZARDOUS ROAD CONDITIONS AT THIS TIME

"HAVE A GREAT DAY FROM THE SOONER STATE"

1015 CDT 01/06/19

Example 3: Road/Weather message received from National Weather Wire.

HR.WS0000000

08:33 04/15/2019 00334
08:33 04/15/2019 00081 AZNLETS20
TXT
FXUS64 KMEG 151528 AFDMEG
Area Forecast Discussion National Weather Service Memphis TN 1028 AM CDT Mon Apr 15 2019
.UPDATE... Beautiful weather is on tap for the Mid-South today. Temperatures have warmed into the 50s area wide and will approach 70F by mid- afternoon.
Clouds have moved east with the departing trough, so we'll maintain clear skies today.
Winds are currently light from the south but will increase this afternoon in response to a tightening pressure gradient as a trough and attendant upper- level jet eject into the Northern Plains.
Winds will increase to 10-15 mph this afternoon along and west of the Mississippi River with gusts to 20 mph at times.
Southerly winds will relax a bit overnight but warm advection and boundary layer mixing will keep temperatures quite a bit warmer than this morning.
No big changes were included in the forecast update. Johnson &&
.PREV DISCUSSION... /issued 416 AM CDT Mon Apr 15 2019/
DISCUSSION... Currently...Weak surface highs pressure sits over the region with clear skies and light winds.
Good radiational cooling conditions helping temps fall into the 30s across parts of the Mid-South.
Expect frost across parts of the Mid-South especially locations in the Frost advisory which covers much of West Tennessee.
Patchy fog is also occurring near the TN River and across North Mississippi.
Today through Wednesday...High pressure will prevail today with sunny skies and slightly below normal temperatures. Return flow will commence along and west of the River this afternoon.
As a result expect warmer temps tonight with lows in the upper 40s and lower 50s. As the high moves east southerly flow will increase on Tuesday pushing highs well into the 70s.
Expect a breezy day across the Delta. Breezy conditions continue into Wednesday as moisture continues to increase.
Weak isentropic lift may result in a few showers during the AM west of the MS River.
A weak upper level disturbance combined with some instability could produce a few thunderstorms west of the river Wednesday afternoon. Highs will again be in the 70s.
Wednesday night through Thursday night...A potent upper level system will move out of the SW U.S. Wednesday night.
Moisture and instability will increase across the lower MS Valley with increasing shear as the upper trough pushes across the southern plains.
Convection with severe weather potential will develop over the ARKLATEX and spread NE overnight...gradually weakening as it moves into a less favorable environment.
A few strong to severe storms are possible late Wednesday night mainly west of the MS River. That first round will continue to spread east Thursday morning and weaken.
Another round of convection will likely develop across the area as a potent mid level shortwave rounds the base of the main upper trough and punches into the area during the day on Thursday.
Of course details of severe weather chances will depend on many things, like ongoing convection, how quickly the surface system occludes and the strength/timing of the shortwave etc.
Given the strong shear combined with a moist and somewhat unstable boundary layer strong to severe storms will be possible across the Mid-South Thursday.
Models are in good agreement with moving most of the activity east of the Mid-South by Thursday evening. Right now it looks like another 1.5 to 2.5 inches of rain possible with this event.
Friday and Friday night...A deep upper low will drop into the region by Friday with more showers and highs only in the 50s. Showers will begin tapering off Friday night with lows in the 40s.
Weekend...Looks sunny albeit a bit chilly on Saturday with strong NW flow on the backside of the departing upper low. Temps will climb into the 70s on Sunday.
SJM &&
.AVIATION... /12Z TAFs/
VFR. Light winds becoming south at 6-11kts. Higher gusts at JBR.
JAB &&
.MEG WATCHES/WARNINGS/ADVISORIES...
AR...None. MO...None. MS...None. TN...None.
&& $$

Top

Downloads

Download HQ Schema

Download HR Schema

Download HR Stylesheet

Top