S124 Guidelines for STM

S124 Guidelines for STM

General comments

S124 format by itself is developed for transmission Navigational warnings from shore centers to the ships. The current format corresponds to the next aims: 1) to transmit urgent marine safety information on the vessels; 2) to provide full life cycle transmitted warning beginning from it’screation to cancellation of this warning

The message (navigational warning)may contain the next parts:

Navigational warning Preamble (NW_Preamble)

It’s mandatory part of warning which gives general information about event.

Navigational warning part (NavigationalWarningPart)

It’s not mandatory part that should be filled in ifsome event takes place at the defined coordinates. This part includes geometry information (point, line or polygon) and semantic attributes related to the specified geometry objects.

Information Notice Part (InformationNoticePart)

It’s not mandatory part that contains description of the event, but without exact references to geometry / polygons (it might be related to the whole NAVAREA area, or just to the any specified general area, for example: gulf of Finland. If geographic coordinates can not be determined then Navigational warning should include Information Notice Part.

References part (ReferencesType)

The References part is needed to cancel previous warnings or to specify that current warning may remain in force some time after event’s completion.

At all cases the end user should receive such messages too in order to see when such messages were cancelled by shore center.

Comments on NW Preamble

Each Navigational Warning contains general information about event.

Message Series Identifier (complex attribute) shall consist of country,productionAgency,NameOfSeries,typeOfWarning, WarningNumber, Year. These rulesshould be implemented for managing URN id (by the production system).

For instance, the next rules can be applied to fill in the fields Message Series Identifier for local warnings:

Country=SE

Production Agency=SMA

NameOfSeries=Oregrund VTS

typeOfWarning=local

WarningNumber=int

Year=2017

AttributeSource Date is the date of message’s publication.

Attribute General Category defines category of event.

The user should have possibility to use filter tool by General Category

Attributes General Area (as a main area) and Locality (as a sub-area) are applied to describe geographical coverage.

Below list of proposed general areas for drop-down list:

Skagerrak

Kattegat

Lake Vänern and Trollhätte Canal

The Sound

The Belts

Western Baltic

Southern Baltic

South-eastern Baltic

Central Baltic

Lake Mälaren and Södertälje Canal

Northern Baltic

Gulf of Riga

Gulf of Finland

Sea of Åland and Archipelago Sea

Sea of Bothnia

The Quark

Bay of Bothnia

Other lakes and canals

Attribute Title contain main text information about event. It includes general text for nav warning.

Attribute FixedDateRange – Validity Period when the event takes place. When Validity To (timeEnd/ dayOfEnd) is specified then the Nav warning will be cancelled if otherwise is not specified.

The next use case is possible. For instance, the event as military exercise takes place. Attribute FixedDateRange is filled in in the NW_Preamble (from 21-00 01.05.2017 to 21-00 03.05.2017). But this warning is continuing in force till 00-00 04.05.2017. In this case the References Part shall be filled in in which the conforming Date attribute (cancellationTime) is filled in (see the Use case 4 in the Annex below)

If any time/Date attributes are absent in the Nav Warning(or dateofEnd of event is unknown when warning publishes then this warning will be cancelled in the future after publication such cancellation in the separated or in other Nav warning (see the section 5 – Comments on References part)

Attribute AffectedCharts – references on an ENC or Paper chart’s numbers to which they may referred to or related to (optionally)

Links: NW Preamble can be linked with other parts of messages as Navigational warning Part, References Part, Information Notice Part.

Client software:

The next elements (fields) can be usedfrom NW_Preambleby client applications:

ID – based on gml:idfrom Preamble without letters “PR.“. For instance, if we have the next gml

…

imember

<S124:S124_NWPreamble gml:id="PR.SE.059.17">

<id>urn:mrn:s124:NW.SE.059.17.P</id>

…

Then ID will be as SE.059.17

NameOfSeries + WarningNumber

SourceDate

General area\ Locality

General Category

Valid from – Valid to

Title

AffectedCharts

Comments on Navigational Warning Part

The Navigational Warning Part contains information about geometry/areas and linked attributes.

Each area may have own semantic information as text description (attribute “Subject”) and Validity Period (attribute “FixedDateRange”).

Several Validity Periods are possible for one area, for instance: when some works are carried out during several days at the defined time period

Also the message (Nav Warning) may contain two areas (or more) with different Validity Periods.

In this case each area may have own text description and own Validity Period

Links: Nav Warning Part can be linked to the NW Preamble only.

Client software:

The next elements (fields) can be usedfrom Navigational Warning Partby client applications:

extReferenceId – reference on an event, objects which are out of scope of current format (other services)

Geometry

Subject – descriptive part for the geometry

FixedDateRange – time period for geometry objects. Several periods can be assigned by Operator.

Comments on Information Notice Part

Information Notice Part is the descriptive part of event that has no geometry coordinates.

This part can be applied to specify additional information that relates to the General area in the NW Preamble. For instance, information about ice conditions in the gulf of Finland or some web-site suspension due to technical issues. Also these can be specified other notifications as text about cancellation of previous message.

The Information Notice Partmay contain the next attributes: textual description as attribute “Subject”, and Validity Period (attribute “FixedDateRange”).This Part can be used as an addition to the Information specified in the NW Preamble.

Links: Information Notice Part can be linked to the NW Preamble only.

Client software:

The next elements (fields) can be usedfrom Information Notice Partby client applications:

Subject – descriptive part as a text

FixedDateRange – time period for described event in the attribute “Subject”. Several periods can be assigned by Operator.

Comments on References Part

The main purpose of References Part is to cancel of previous messages without replacing of existing warnings in the onboard storage

The onboard database of navigational warnings for onboard applications shall update by receiving of new navigational warnings that may include messages with cancellation of previous messages.

This part is needed to cancel previous published messages if the time/date of End of event were not filled in in the primary navigational warning. Then the current nav warning will have contained a reference on the previous message. In this case, the Reference part will be included the reference on the Message Identifier and the attribute “ReferenceType” as Cancellation.

For instance: The nav warning like below is possible

imember

<S124:S124_NWPreamble gml:id="PR.FI.034.17">

<id>urn:mrn:s124:NW.FI.034.17.P</id>

messageSeriesIdentifier

NameOfSeries>Finnish nav warn</NameOfSeries

typeOfWarningcoastal</typeOfWarning

warningNumber34</warningNumber

year>17</year>

productionAgency

language>eng</language>

text>Finnish Maritime Authority</text>

</productionAgency

country>FI</country>

</messageSeriesIdentifier

sourceDate2017-01-31</sourceDate

title<text>Cancel 023/17</text</title>

theWarningPartxlink:href="#NW.FI.034.17.1"/>

</S124:S124_NWPreamble>

</imember

imember

<S124:S124_References gml:id="NW.FI.034.17.1">

<id>urn:mrn:s124:NW.FI.034.17.1</id>

referenceTypecancellation</referenceType

messageReference

NameOfSeriesFinnish nav warn</NameOfSeries

typeOfWarningcoastal</typeOfWarning

warningNumber23</warningNumber

year>17</year>

productionAgency

language>eng</language>

text>Finnish Maritime Authority</text>

</productionAgency

country>FI</country>

</messageReference

headerxlink:href="NW.FI.034.17"/>

</S124:S124_References>

</imember

In this case the end-user shall see the next fields only:

ID: FI.034.17

Publish Date: 31.01.2017

Name: Finnish nav warn №34

Text: Cancel 023/17

Also the References part can be used to specify attribute in forcefor nav warning with date of cancellation. If the current Nav Warning shall be cancelled at the defined time in the future then it shall include the reference on it’s own Message Identifier and attribute “cancellationDate” – when the message shall be cancelled. These use case are specified in the Annex “Use cases” below.

Links: References Partcan be linked to the NW Preamble only

Comments on Extension Element

Annex Use cases

Use case: SAR event

Shore center send out SAR-Area to All or designated SAR units
SAR units receive area. Area to be displayed

After some exchange of text messages between units and shore, the Shore center modifies the area bounds. After that it publishes new Area message like below

<?xml version="1.0" encoding="UTF-8"?>
<S124:DataSet xmlns:S124="
xsi:schemaLocation=" ../../schemas/0.5/S124.xsd" xmlns:xsi="
xmlns:gml="
xmlns:S100="
xmlns:xlink=" gml:id="SE.local.52.17">
gml:boundedBygml:EnvelopesrsName="EPSG:4326">
gml:lowerCorner>-6.0000 30.0000</gml:lowerCorner
gml:upperCorner>45.0000 47.0000</gml:upperCorner
</gml:Envelope</gml:boundedBy
imember
<S124:S124_NWPreamble gml:id="PR.SE.local.52.17">
<id>urn:mrn:s124:NW.SE.local.52.17.P</id>
messageSeriesIdentifier
NameOfSeriesOregrund VTS</NameOfSeries
typeOfWarning>local</typeOfWarning
warningNumber>52</warningNumber
<year>17</year>
productionAgency
<language>eng</language>
<text>SWEDISH MARITIME AUTHORITY</text>
</productionAgency
<country>SE</country>
</messageSeriesIdentifier
sourceDate>2017-05-08</sourceDate
generalCategory>SAR and anti pollution operations</generalCategory
generalArea>Sea of Åland and Archipelago Sea</generalArea
<locality<text>North-west of island Orskar</text</locality>
<title<text>Small craft with 5 crew members is in a drift</text</title>
theWarningPartxlink:href="#NW.SE.local.52.17.1"/>
</S124:S124_NWPreamble>
</imember
<member>
<S124:S124_NavigationalWarningPart gml:id="NW.SE.local.52.17.1">
<id>urn:mrn:s124:NW.SE.local.52.17.1</id>
<geometry>
<S100:surfaceProperty>
gml:Surfacegml:id="s.NW.SE.local.52.17.1" srsName="EPSG:4326">
gml:patches
gml:PolygonPatch
gml:exterior
gml:LinearRing
gml:posList
60.60 18.25
60.63 18.32
60.60 18.38
60.525 18.36
60.50 18.35
60.50 18.25
60.60 18.25
</gml:posList
</gml:LinearRing
</gml:exterior
</gml:PolygonPatch
</gml:patches
</gml:Surface
</S100:surfaceProperty>
</geometry>
<Subject<text>Search area have been extended to the North due to weather conditions</text</Subject>
<header xlink:href="#PR.SE.local.52.17"/>
</S124:S124_NavigationalWarningPart>
</member>
imember
<S124:S124_References gml:id="NW.SE.local.52.17.2">
<id>urn:mrn:s124:NW.SE.local.52.17.2</id>
referenceType>cancellation</referenceType
messageReference
NameOfSeriesOregrund VTS</NameOfSeries
typeOfWarning>local</typeOfWarning
warningNumber>51</warningNumber
<year>17</year>
productionAgency
<language>eng</language>
<text>SWEDISH MARITIME AUTHORITY</text>
</productionAgency
<country>SE</country>
</messageReference
<header xlink:href="NW.SE.local.52.17"/>
</S124:S124_References>
</imember
</S124:DataSet> /
The new SAR area has extended bounds. The related information can be specified in the area message accordingly.
Also, in the current message, the Shore center (Operator) can cancel the previous message. In this case the end-user will be seen the new message (new geometry and related attributes) and plus notification about cancellation of previous message. In our casethis is “Cancel SE.local.51.17”. Simultaneously the message status should be changed – from “in Force” on “Cancelled”

When SAR-event is over then the Shore Center sends out the next message about cancellation

Possible scenarios for message’s cancellation

Introduction:

In general, NW Service should provide all actual messages by the received requests.

If these messages include references for cancelation of previous messages then the possibility to receive canceled messages should be provided too.

But there are different situations when we need to see full life cycle of Nav warning including deleted status. Also it’s possible that NW Service won’t operate some time. Then, in this case, we need to handle messages using the filled in attributes.

Use case 1:
Event takes a place in defined bounds.
Also the event has validity period
The S124-message contains two parts only:

S124_NWPreamble – general information
S124_NavigationalPart

In this case cancellation of the message will have happened by the attribute FixedDateRange (timeofDayEnd/dateEnd) in the S124_NWPreamble
imember
<S124:S124_NWPreamble gml:id="PR.RU.055.17">
<id>urn:mrn:s124:NW.RU.055.17.P</id>
messageSeriesIdentifier
NameOfSeries>KALININGRAD NAV WARN</NameOfSeries
typeOfWarningcoastal</typeOfWarning
warningNumber>55</warningNumber
<year>17</year>
productionAgency
<language>eng</language>
<text>KALININGRAD HYDROGRAPHY SERVICE</text>
</productionAgency
</messageSeriesIdentifier
sourceDate>2017-03-12</sourceDate
generalCategory>military exersices</generalCategory
generalArea>Central Baltic</generalArea
<locality<text>SOUTHEASTERN BALTIC</text</locality>
<title<text>SHIPS EXERCISES 132100 THRU 172100 UTC MAR IN AREA TEMPORARILY DANGEROUS TO SHIPPING</text</title>
fixedDateRange
timeOfDayStart>21:00:00Z</timeOfDayStart
timeOfDayEnd>21:00:00Z</timeOfDayEnd
dateStart
<date>2017-03-13</date</dateStart
dateEnd
<date>2017-03-17</date</dateEnd
</fixedDateRange
theWarningPartxlink:href="#NW.RU.055.17.1"/>
</S124:S124_NWPreamble>
</imember
<member>
<S124:S124_NavigationalWarningPart gml:id="NW.RU.055.17.1">
<id>urn:mrn:s124:NW.RU.055.17.1</id>
<geometry>
<S100:surfaceProperty>
gml:Polygongml:id="s.NW.RU.055.17.1" srsName="EPSG:4326">
gml:exterior
gml:LinearRing
gml:posList
55.533333 19.026666
55.533333 19.833333
55.05 19.5833333
54.773333 19.5833333
54.838333 19.338333
55.191666 19.153333
55.333333 19.076666
</gml:posList
</gml:LinearRing
</gml:exterior
</gml:Polygon
</S100:surfaceProperty>
</geometry>
<Subject>
<text>Area bounded by 55-32.0N 019-01.6E 55-32.0N 019-50.0E 55-03.0N 019-35.0E 54-46.4N 019-35.0E 54-50.3N 019-20.3E 55-11.5N 019-09.2E 55-20.0N 019-04.6E</text>
</Subject>
<header xlink:href="#PR.RU.055.17"/>
</S124:S124_NavigationalWarningPart>
</member>
Use case 2:
Event takes place in defined bounds. This event includes two areas.
Also the event has validity period but validity period is specified in the S124_NavigationalPart
The S124-message contains three parts only:
1.S124_NWPreamble – general information without validity period
2.One area is one S124_NavigationalPart. So we have two S124_NavigationalParts. They contain own area and each area has own validity period
In this case, cancellation of the message will have happened by the attribute FixedDateRange (timeofDayEnd/dateEnd) when the latest time/date will have come from two periods in the S124_NavigationalParts
imember
<S124:S124_NWPreamble gml:id="PR.RU.056.17">
<id>urn:mrn:s124:NW.RU.056.17.P</id>
messageSeriesIdentifier
NameOfSeries>KALININGRAD NAV WARN</NameOfSeries
typeOfWarningcoastal</typeOfWarning
warningNumber>56</warningNumber
<year>17</year>
productionAgency
<language>eng</language>
<text>KALININGRAD HYDROGRAPHY SERVICE</text>
</productionAgency
</messageSeriesIdentifier
sourceDate>2017-03-12</sourceDate
generalCategory>military exersices</generalCategory
generalArea>Central Baltic</generalArea
<locality<text>SOUTHEASTERN BALTIC</text</locality>
title<text>SHIPS EXERCISES 132100 THRU 172100 UTC MAR IN AREAS TEMPORARILY DANGEROUS TO SHIPPING. CANCEL THIS MESSAGE 172200 UTC MAR</text</title>
theWarningPartxlink:href="#NW.RU.056.17.1"/>
theWarningPartxlink:href="#NW.RU.056.17.2"/>
</S124:S124_NWPreamble>
</imember
<member>
<S124:S124_NavigationalWarningPart gml:id="NW.RU.056.17.1">
<id>urn:mrn:s124:NW.RU.056.17.1</id>
<geometry>
<S100:surfaceProperty>
gml:Polygongml:id="s.NW.RU.056.17.1" srsName="EPSG:4326">
gml:exterior
gml:LinearRing
gml:posList
55.533333 19.026666
55.533333 19.833333
55.05 19.5833333
54.773333 19.5833333
54.838333 19.338333
55.191666 19.153333
55.333333 19.076666
</gml:posList
</gml:LinearRing
</gml:exterior
</gml:Polygon
</S100:surfaceProperty>
</geometry>
<Subject>
<text>Area A </text>
</Subject>
<fixedDateRange
timeOfDayStart>21:00:00Z</timeOfDayStart
timeOfDayEnd>21:00:00Z</timeOfDayEnd
dateStart<date>2017-03-13</date</dateStart
dateEnd<date>2017-03-17</date</dateEnd
</fixedDateRange
<header xlink:href="#PR.RU.056.17"/>
</S124:S124_NavigationalWarningPart>
</member>
<member>
<S124:S124_NavigationalWarningPart gml:id="NW.RU.056.17.2">
<id>urn:mrn:s124:NW.RU.056.17.2</id>
<geometry>
<S100:surfaceProperty>
gml:Polygongml:id="s.NW.RU.056.17.2" srsName="EPSG:4326">
gml:exterior
gml:LinearRing
gml:posList
55.0 20.0
55.333333 20.0
55.333333 20.5
55.0 20.5
</gml:posList
</gml:LinearRing
</gml:exterior
</gml:Polygon
</S100:surfaceProperty>
</geometry>
<Subject>
<text>Area B </text>
</Subject>
fixedDateRange
timeOfDayStart>21:00:00Z</timeOfDayStart
timeOfDayEnd>21:00:00Z</timeOfDayEnd
dateStart<date>2017-03-17</date</dateStart
dateEnd<date>2017-03-19</date</dateEnd
</fixedDateRange
<header xlink:href="#PR.RU.056.17"/>
</S124:S124_NavigationalWarningPart>
</member>
Use case 3:
Event takes place in defined bounds.
But this event hasn’t validity period.
The event has start date/ time only in the S124_NWPreamble
The S124-message contains only two parts:
1.S124_NWPreamble – general information without validity period
2.S124_NavigationalPart - it contains one area
In this case, cancellation of the message will have happened after receiving of another future message in which will be fill in the References Part: the reference on the required message, and time/ date of cancellation can be specified too. / Another event takes place in which previous message will be cancelled
This S124-message will contain the next parts:

S124_NWPreamble – general information about new event
S124_NavigationalPart - description of geometry for it contains one area
S124_ReferencesPart – message reference on the previous message that is required to cancel

First message with one event
imember
<S124:S124_NWPreamble gml:id="PR.RU.055.17">
<id>urn:mrn:s124:NW.RU.055.17.P</id>
messageSeriesIdentifier
NameOfSeries>KALININGRAD NAV WARN</NameOfSeries
typeOfWarningcoastal</typeOfWarning
warningNumber>55</warningNumber
<year>17</year>
productionAgency
<language>eng</language>
<text>KALININGRAD HYDROGRAPHY SERVICE</text>
</productionAgency
</messageSeriesIdentifier
sourceDate>2017-03-12</sourceDate
generalCategory>military exersices</generalCategory