While the audience is gathering. During breaks etc While the audience is gathering. During breaks etc. Simple messages can be added in bold and white letters on the dark blue sea, eg. ”Welcome!”, ”Back at 15.15”
Release Notes 2017-11-15 Changed recommendation of service name for ship (slide 11) 2017-10-16 Renamed serviceType to Port Call Synchronization 2017-09-28 Changed Service Type from acronyms to full names 2017-09-26 Removed the part with Certificates and created a HOW-TO Handle Certificates in SeaSWIM 2017-05-24 Mikael Olofsson Updated the document to reflect using the MC STAGING as STM TEST environment
HOW-TO Register Service Instances This HOW-TO explains the procedure to register Service Instances based on STM Project Voyage Information Service, VIS, REST Design. It includes also guidelines for naming the service and the metadata in Service Instance As XML.
Terminology Service Registry SR Catalogue of information about services. Core service in MCP Maritime Connectivity Platform MCP A set of applications for handling identities, certificates and service information that constitutes a service oriented platform for secure digital exchange of information on internet. Service An action, or set of actions that provides support or work for someone. The set of actions can be fully automated or incude manual work. XML Format for the filed used to register service instance XSD Schema for the XML file
References MCP Portals Document Example and Template Schemas https://test-management.maritimecloud.net/ https://staging-management.maritimecloud.net/ https://management.maritimecloud.net/ Document Example and Template https://www.stmvalidation.eu/developers-forum/service-catalogue/ Schemas https://staging-management.maritimecloud.net/#/pages/sr/howto https://management.maritimecloud.net/#/pages/sr/howto
Steps to register new service Prepare Service Instance as XML Tips! Chose a similar service instance in the portal and download XML, and edit a copy to represent your service Logon to the MCP Portal in the environment you target https://test-management.maritimecloud.net/ (MCP TEST) https://staging-management.maritimecloud.net/ (MCP STAGING) incl SIM https://management.maritimecloud.net/ (MCP PRODUCTION) Select Service Registry - Designs Select the desired design e.g. Voyage Information Service Design 2.2 Press ”Register new instance” ”Upload Instance XML file” and browse for your prepared XML file ”Upload Instance Document file” and browse for your document (PDF) describing the Service Instance (Optional) Mark ”Link to vessel” and select Vessel (requires that the vessel has been registered as Vessel) Press ”Register instance”
Steps to update status on service - Status Scenario: You have tested your service and now want to change status to ”released”. Logon to the MCP Portal in the environment you target Select the Service Instance to update Press ”Update instance” Change status to ”released” 3. Press Download XML 3.1. Update status in the XML 3.2. ”Upload Instance XML file” and browse for your updated XML file
Steps to update service instance registration - XML Scenario: You want to change e.g. the description, URL or service coverage on the service. Logon to the MCP Portal in the environment you target Select the Service Instance to update Press Download XML Update the XML and save Press ”Update instance” ”Upload Instance XML file” and browse for your updated XML file
Steps to update service instance registration - Document Scenario: You want to update service instance description document on the service. Logon to the MCP Portal in the environment you target Select the Service Instance to update Press ”Update instance” ”Upload Instance Document file” and browse for your document (PDF) describing the Service Instance
Steps to update link between service and vessel Scenario: You have registered your ship as a Vessel and want to link the Service instance to the Vessel. Logon to the MCP Portal in the environment you target Select the Service Instance to update Press ”Update” in the ID INFORMATION section Set a checkbox in the ”Link to a vessel” and select the vessel (requires that you have registered the ship as Vessel in Identity Registry) Press ”Update” Please observe that you need to issue and download new certificates!
Guidelines for Service Registration Name Name of ship Name of service provided Name of shore centre Operational service name ID urn:mrn:stm:service:instance:<org>:vis:imo:nnnnnnn urn:mrn:stm:service:instance:<org>:vis:mmsi:nnnnnnnnn urn:mrn:stm:service:instance:<org>:vis:<name> Keywords VIS, RTZ, TXT,S124,Voyage Information Service, etc Description Short description of service provided, version on payloads, accepted payloads, acceptance of subscription etc ServiceType Ship Voyage Information Route Optimization Route Crosscheck Enhanced Monitoring Port Call Synchronization Winter Navigation Route Catalogue SAR IMO and MMSI IMO with 7 digits MMSI with 9 digits <blank> Geometry WKT <blank> mean ”The World” Status provisional released deprecated deleted URL The base URL for the service without the REST method. If versioning of API is used, add the version here in the URL. No trailing slash.
Guidelines for Service Registration of a SHIP Name Name of Ship preferrably without national characters Preferrably same as AIS ID urn:mrn:stm:service:instance:<org>:imo:nnnnnnn urn:mrn:stm:service:instance:<org>:mmsi:nnnnnnnnn Keywords SHIP,VIS,RTZ,TXT,S124,Voyage Information Service, etc Description Short operational description of service provided, including recommended use (subscriber or send once). May also contain information such as ”Schedule is required”. ServiceType Ship Voyage Information IMO and MMSI IMO with 7 digits MMSI with 9 digits <blank> Geometry WKT <blank> means ”The World” Status provisional released simulated (only used in STAGING today) deprecated deleted URL The base URL for the service without the REST method. If versioning of API is used, add the version here in the URL (if not part of swagger). No trailing slash.
Guidelines for Service Registration for Shore Centre (incl VTS) Name Name SC Name VTS ID urn:mrn:stm:service:instance:<org>:vis:sc:<name> urn:mrn:stm:service:instance:<org>:vis:vts:<name> Keywords VTS,SC,VIS,RTZ,TXT,S124,Voyage Information Service, etc Description Short description of service provided, version on payloads, accepted payloads, acceptance of subscription etc ServiceType Enhanced Monitoring MMSI MMSI with 9 digits <blank> Geometry WKT Status provisional released deprecated deleted URL The base URL for the service without the REST method. If versioning of API is used, add the version here in the URL (if not part of swagger). No trailing slash.
Guidelines for Service Registration of Service Provider Name Service name Operational service name ID urn:mrn:stm:service:instance:<org>:vis:ros:<name> urn:mrn:stm:service:instance:<org>:vis:rcs:<name> urn:mrn:stm:service:instance:<org>:vis:rcat:<name> Keywords VIS, RTZ, TXT,S124,Voyage Information Service, etc Description Short description of service provided, version on payloads, accepted payloads, acceptance of subscription etc ServiceType Route Catalogue Route Optimization Route Crosscheck Port Call Synchronization Evaluation Service IMO and MMSI <blank> Geometry WKT <blank> mean ”The World” Status provisional released deprecated deleted URL The base URL for the service without the REST method. If versioning of API is used, add the version here in the URL (if not part of swagger). No trailing slash.
Service Instance ID Example urn:mrn:stm:service:instance:sma:imo:7907245 urn:mrn:stm:service:instance:sma:imo7907245 urn:mrn:stm:service:instance:sma:mmsi:265177000 urn:mrn:stm:service:instance:sma:prs:nordic urn:mrn:stm:service:instance:sma:prs
Service Name Ship <SHIP NAME> Example: YMER Route Optimization xxx Route Optimization Example: Energy efficiency Route Optimization Enhanced Monitoring Example: Gothenburg SC Gothenburg VTS
OBS! Avoid trailing slash Service URL https://smavistest.stmvalidation.eu/SMA002 OBS! Avoid trailing slash
Service status Status Description provisional Used for placeholders and services used only in internal tests released Used for services that are ready to be consumed by all. Can be released for test in MCP STAGING or released for production in MCP PRODUCTION simulated Used for services for simulation environment deprecated No longer in use deleted Service instance deleted
Update of Service Types Description Ship Voyage Information A VIS-based instance representing a ship that distributes/shares routes, capable of receiving route proposals, exchanging text messages and receiving area messages (S-124) Route Optimization A VIS-based instance that receives routes and sends an optimized route back, with or without a complementary TXT message. Route Crosscheck A VIS-based instance that receives routes and performs safety check based on vessel´s draught, air draught, no go areas etc. Result is either a cross-checked route or a TXT message with the result. Enhanced Monitoring A VIS-based instance that receives routes for enhanced monitoring, capable of sending back proposed routes and text messages to ship, e.g. VTS, SC Winter Navigation A VIS-based instance that receives routes and may send back ice snippets, route proposals and text messages for winter navigation Route Catalogue A VIS-based instance that can distribute route templates (or ready-made proposals of routes), e.g. Pilot Routes. Port Call Synchronization A VIS-based instance that receives routes for port call synchronization and capable of receiving routes and sending back recommended time to arrival/departure. SAR A VIS-based instance that receives routes and capable of sending SAR areas, search patterns and text messages Navigational Warnings A VIS-based instance that receives routes and sends back navigational warnings in concerned area. Fleet Operation A VIS-based instance representing a fleet operation centre capable of receiving routes.
Geometry To test and create WKT http://arthur-e.github.io/Wicket/sandbox-gmaps3.html Examples when registering a service with a specific coverage Gothenburg area POLYGON((12.07 57.64,11.85 57.53,11.37 57.54,11.39 57.74,12.07 57.73,12.07 57.64)) The Sound area POLYGON((13.398548828125058 55.49151133617802,12.63705468750004 55.4728347119196,12.273000000000025 56.187,12.52800000000002 56.222,13.398548828125058 55.49151133617802))
At the end – you could add text in black like ”Thank You !”