EMSA Ref. EMSA.2016.009826
SafeSeaNet
Central Ship Database
Web Interface Manual
SSN version: 3.2
Document Version: 1.4
Date: 08/09/2016
SSN User Interface Manual - Central Ship Database
Document History
Version
Date
Changes
1.0
26/11/2014
Provision of information on the use of the SSN web interface within the framework of
the Central Ship Database in SSN
1.1
04/12/2014
Including a new URL to access the web interface
1.2
05/10/2015
Updating the URL to access the web interface
1.3
07/07/2016
Required changes to align with production environment
1.4
08/09/2016
New EMSA template, ship management chapter and others
Table of Contents
1.
Introduction ..........................................................................................................................................................3
2.
Central Ship Database Web Interface................................................................................................................4
2.1
How to access the CSD web interface ........................................................................................................ 4
2.2
Create vessel .............................................................................................................................................. 5
2.2.1
Permissions ..........................................................................................................................................5
2.2.2
Steps ....................................................................................................................................................5
2.3
Search/Update vessel ................................................................................................................................. 8
2.3.1
Permissions ..........................................................................................................................................8
2.3.2
Steps ....................................................................................................................................................8
2.4
Search Vessel History ...............................................................................................................................11
2.4.1
Permissions ........................................................................................................................................11
2.4.2
Steps ..................................................................................................................................................12
2.5
Upload & Validate ......................................................................................................................................14
3.
Ship Management Web Interface .....................................................................................................................15
3.1
How to access the Ship Management Web Interface ...............................................................................15
3.2
Download list of Single Hull Tankers (SHT) ..............................................................................................15
3.2.1
Permissions ........................................................................................................................................15
The user must be granted the SHT_VESSEL_DOWNLOAD permissions. ........................................................15
3.2.2
Steps ..................................................................................................................................................15
3.3
Download list of Banned Ships .................................................................................................................16
3.3.1
Permissions ........................................................................................................................................16
3.3.2
Steps ..................................................................................................................................................16
3.4
Download list of Detained Vessels ............................................................................................................17
3.4.1
Permissions ........................................................................................................................................17
3.4.2
Steps ..................................................................................................................................................17
Page 1 of 21
SSN User Interface Manual - Central Ship Database
Figures
Figure 1 – CSD Services ..............................................................................................................................................3
Figure 2 – Home page ..................................................................................................................................................4
Figure 3 – Click on Central Ship Database tile .............................................................................................................4
Figure 4 – Vessel management sub-menu...................................................................................................................5
Figure 5 – Create vessel page......................................................................................................................................6
Figure 6 –Vessel Processed Successfully....................................................................................................................8
Figure 7 – Search/Update vessel page ........................................................................................................................8
Figure 8 – Previous vessel names................................................................................................................................9
Figure 9 – Update vessel panel (particular) ..................................................................................................................9
Figure 10 – Vessel history button ...............................................................................................................................10
Figure 11 – Update vessel ..........................................................................................................................................11
Figure 12 – Vessel Processed Successfully...............................................................................................................11
Figure 13 – Search vessel history panel ....................................................................................................................12
Figure 14 – Search vessel panel ................................................................................................................................13
Figure 15 – Vessel history data ..................................................................................................................................13
Figure 16 – Version detail history items panel ............................................................................................................14
Figure 17 – SSN Main page / Ship Management .......................................................................................................15
Figure 18 – List of SHT ...............................................................................................................................................16
Figure 19 – List of banned ships.................................................................................................................................17
Page 2 of 21
SSN User Interface Manual - Central Ship Database
1.
Introduction
At the request of the SSN HLSG, EMSA has implemented the Central Ship Database (CSD) with the objective to
obtain and maintain a reliable cooperative source of Ship particulars.
The CSD is intended to be used by EMSA and other users as well as by the Member States as a reference
database for their national systems. The CSD is under development and is expected to develop further in the future
by adding more functionality. Currently the following services are available for the Member States users:
a. Download service: A service enabling the download (using secure FTP) of the data stored in the CSD, which
will be updated on a 3 month basis.
b. Request/response service: This service enables the request of the content of specific ship records in the CSD,
based on ship ID, flag or latest updated records using pre-defined XML messages. Member States can
choose, either to use the data received to initiate the verification of ship details included in their systems, or to
use it to automatically update their own databases.
c. Ship particulars notification web-service: A service to be used by Member States to:
■
■
Notify the insertion of a new ship in the national flag registry, or;
Provide feedback information to the CSD with updates on ship particulars that have been verified manually
by their national authorities (e.g. national flag registries).
d. Ship particulars announcement (“push”): This service proactively announces changes to the ship particulars
of ships already registered in the database, or the creation of new ship records in the CSD. Member States
subscribing to this service can choose, either to use the data received to initiate the verification of ship details
included in their systems, or to use it to automatically update their own databases.
e. Web interface: A user web interface is provided to allow users to consult the ship records available in the
CSD.
Figure 1 – CSD Services
This objective of this document is to provide guidance on how to use of the Web interface access - mentioned in
par. (e) above. Further details on the Web services mentioned in par. (b), (c) and (d) as well as additional
information on the CSD are available at the SafeSeaNet Extranet Page.
Page 3 of 21
SSN User Interface Manual - Central Ship Database
2.
Central Ship Database Web Interface
The central SSN Web Application is available through the Web via the Web Browsers Internet Explorer 9 and
Firefox 16.
2.1
How to access the CSD web interface
a. Open the Web browser and enter the central EMSA portal home page in the production environment :
(https://portal.emsa.europa.eu/home)
Figure 2 – Home page
b. Enter your credentials (username and password) in the EMSA portal, and click the “Login” button. For any
issues concerning the log in process, please request assistance from the EMSA Maritime Support Services
(Tel: +351211209415 – Email: MaritimeSupportServices@emsa.europa.eu)
c. After the login, click the CSD tile, as shown in Figure 3 – Click on Central Ship Database tile
Figure 3 – Click on Central Ship Database tile
d. When the Vessel Management console appears, click on the Vessel Management sub-menu in order to see
the different options shown in Figure 4 – Vessel management sub-menu. For the purposes of the CSD project,
the following options are available:
i.
Page 4 of 21
Create Vessel: To create a new ship in SSN.
SSN User Interface Manual - Central Ship Database
ii.
Search/Update vessel: To update an existing ship in SSN
iii.
Search vessel history: To display the history of updates for a selected vessel.
Figure 4 – Vessel management sub-menu
2.2 Create vessel
2.2.1
Permissions
To create a vessel you must be granted the permission: “CSD_MANAGER”. Users can be configured by EMSA
upon request from NCAs.
2.2.2
Steps
The steps are as follows:
Page 5 of 21
SSN User Interface Manual - Central Ship Database
a. Click on the Create Vessel link. The vessel details are shown in Figure 5 – Create vessel page:
Figure 5 – Create vessel page
1
b. Insert the vessel details following the rules below :
1. Vessel primary identifiers validation (for technical correctness)
■ IMO Number: A 7-digit unique code. IMO number is required to create a vessel unless either IR number or
ER number are provided. The IMO ship identification number is a permanent number assigned to each
qualifying ship for identification purposes (reference www.imo.org).
■ MMSI Number: The Maritime Mobile Service Identity (MMSI) is a series of nine digits.
■ Call Sign: A unique designation for a transmitting station up to 7 characters long. The structure is defined
by the International Telecommunication Union (ITU).
■ Ship name: Roman characters and Arabic figures". (From “A” to ”Z” and from 0 to 9). Additional characters
allowed are dots “.”, dashes “-“ and single apostrophe “ ’ ”. Up to 35 characters long.
2. Other vessel details
■ Enter the EU fishing vessel Registration number IR Number information: If IMO Number is not available
and the vessel is an EU fishing vessel then the IR number has to be quoted.
■ Enter the EMSA reference ER Number information: If the vessel is not provided neither with IMO Number,
nor IR number, then ask EMSA to assign a specific ER Number.
■ Enter the Flag Registry information
■ Enter the vessel Registration XR Number information
■ Enter the Type of Ship information
1
A full explanation of the attributes, length, type and description is included in the “SSN System Interface Guide – Ship Particular Exchange”,
available at SafeSeaNet Extranet page
Page 6 of 21
SSN User Interface Manual - Central Ship Database
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
■
Enter the Year of Construction information
Enter the Gross Tonnage information
Enter the Net Tonnage information
Enter the Reduced Gross Tonnage information
Enter the Length information
Enter the Beam information
Enter the Registered Owner information
Enter the Address information
Enter the Ship Manager/ Operator information
Enter the Address information
Enter the Ship Owner Company IMO Number information
Enter the Deadweight information
Enter the ShipType (AIS based)
Enter the ShipType (PSC)
Enter the ShipType (LMIU based)
Select the Keel Laying Date from the Calendar feature.
Enter the ShipType (UN)
Select the Ship Risk Profile
Select the Inspection Priority
Enter the Breadth
Check the Class society checkbox if the Recognised Organisation is a classification society.
Check the EU Recognised checkbox if the Recognised Organisation is also recognised by the EU.
Check the PMoU Recognised checkbox if the Recognised Organisation is also recognised by the Paris
MoU.
Enter the Hull type information from the dropdown list.
Enter the Ice class information from the dropdown list.
Enter the ISM company number
Enter the keel to mast height
Enter the Length between perpendiculars
Enter the Manoeuvre speed
Enter the Max number of passenger
Enter the Max speed
Enter the Moulded breadth
Enter the Moulded depth
Enter the Ship Inmarsat Call number
Enter the Number of bow thrusters
Enter the Number of stern thrusters
Enter the Number of holds
Enter the Number of RoRo compartments
Enter the Number of cargo tanks
Enter the TEUs
Select if the vessel is Banned (YES/NO), Detained or Single Hull Tanker (YES/NO) information for the
vessel.
Select Service Indicator information
Upload an image file by pressing Add and searching for the file.
Provide an alternative source for the image details (URL Address, Description, and Protocol).
c. Click Next to validate, or Reset to remove the data injected
d. After validating the data (by clicking the button Next), click on Create to save the vessel. Should incorrect data
be provided, the system gives a warning message. If this appears, press the Back button and edit the
corresponding fields. When data have been properly provided, the confirmation message in Figure 6 –Vessel
Processed is displayed.
Page 7 of 21
SSN User Interface Manual - Central Ship Database
Figure 6 –Vessel Processed Successfully
2.3 Search/Update vessel
2.3.1
Permissions
To search and consult you must have CSD_READER permission (all users by default). To update, the user must
be granted with the permission: “CSD_MANAGER” by the NCAs.
2.3.2
Steps
The necessary steps are as follows:
a. Click on the Search/Update Vessel link as shown in Figure 7 – Search/Update vessel page:
Figure 7 – Search/Update vessel page
b. To search for a vessel, the user may insert search criteria as follows:
■
■
■
■
Enter the IMO Number information (7 digits), and/or;
enter the MMSI Number information (9 digits), and/or;
enter the Call Sign information (7 characters maximum), and/or;
enter the Ship Name information (35 characters maximum).
The user can specify the full IMO Number, MMSI Number, Call Sign, Ship Name OR part of these. For
example, the user can type “9332511” or “933” for IMO Number. For the Ship Name and Call Sign, the use of
wild characters “_”and % can be used.
■ “” limit the results to vessels that match the whole word. For example, setting “PACIFI” will not find
results of vessels whose name contain the word PACIFIC. By setting the word PACIFI, the search tool
will find them.
■ % indicates to the search tool that the word is not complete. For example, by setting the words PAC%
VENUS the search tool will find the vessel PACIFIC VENUS, while setting only the words PAC
VENUS will not find the vessel PACIFIC VENUS.
When all of the desired criteria have been entered, click on the Search button.
Page 8 of 21
SSN User Interface Manual - Central Ship Database
■ The results will be displayed as shown in Figure 8 and can contain several ships corresponding to the
criteria set.
Figure 8 – Previous vessel names
■ The table displays the IMO Number, MMSI Number, Call Sign, Ship Name, Banned status (Yes/No), Single
Hull Tanker status (Yes/No), Detained status (Yes/No), Flag, Country and date and time of the update.
■ The list displayed can be sorted against each of the columns shown in the table. Clicking on the labels
sorts the list in ascending or descending order (First click on the sorts list in descending order, and
secondly in ascending order)
■ Click on the Reset button to re-set the fields to the values before the search.
■ Click on the relevant IMO number (or MMSI number) hyperlink to select a vessel. The Update Vessel Panel
will then show all of the available ships’ details (Figure 9 – Update vessel panel (particular)).
Figure 9 – Update vessel panel (particular)
Page 9 of 21
SSN User Interface Manual - Central Ship Database
c. Users can also click on the Vessel History button at the end of the page in order to check the Vessel’s History
details (see Figure 10 – Vessel history button). Additional information on the Vessel history functionality is
provided in 2.4
Figure 10 – Vessel history button
Page 10 of 21
SSN User Interface Manual - Central Ship Database
d. To update the vessel, the user shall amend the relevant fields as appropriate.
e. After having updated the data, click on the Next button to continue. A confirmation page will appear, and after
checking that the data are correct, click on the Update button (see Figure 11 – Update vessel).
Figure 11 – Update vessel
f. Should incorrect data (according to the CSD rules) be provided, the system gives a warning message. When
this happens, press the Back button and edit the corresponding fields. When the data has been correctly
provided, the confirmation message in Figure 12 – Vessel Processed Successfully will appear.
Figure 12 – Vessel Processed Successfully
2.4 Search Vessel History
2.4.1
Permissions
The user must be granted the permission: “CSD_MANAGER”
Page 11 of 21
SSN User Interface Manual - Central Ship Database
2.4.2
Steps
The required steps are as follows:
a. Click on the Search Vessel History link as shown in Figure 13 – Search vessel history panel.
Figure 13 – Search vessel history panel
b. In order to search for a vessel, the user may filter the results with the following ship particulars:
■
■
■
■
IMO Number information (7 digits), and/or;
MMSI Number information (9 digits), and/or;
Call Sign information (7 characters maximum), and/or;
Ship Name information (35 characters maximum).
The user can specify the full IMO Number, MMSI Number, Call Sign, Ship Name OR part of these. For
example, the user can type “9332511” or “933” for IMO Number. For the Ship Name and Call Sign, the use of
wild characters “_”and “%” can be used.
■ “_” limit the results to vessels that match the whole word. For example, setting “PACIFI” will not find
results of vessels whose name contain the word PACIFIC. By setting the word PACIFI, the search tool
will find them.
■ % indicates to the search tool that the word is not complete. For example, by setting the words PAC%
VENUS the search tool will find the vessel PACIFIC VENUS, while setting only the words PAC
VENUS will not find the vessel PACIFIC VENUS.
When all of the desired criteria have been specified, click on the Search button.
■ The results display the different historical version of a ship as shown in Figure 14. If the search criteria
match several vessels, all versions of all vessels will be displayed.
Page 12 of 21
SSN User Interface Manual - Central Ship Database
Figure 14 – Search vessel panel
■ The table gives the IMO Number, MMSI Number, Call Sign , Ship Name, Banned status (Yes/No), Single
Hull Tanker status (Yes/No), Detained status (Yes/No), Flag, Country and date and time of the update.
■ The list displayed can be sorted against each of the columns in the table. Clicking on the labels sorts the
list in ascending or descending order (first click on the sorts list in descending order, and secondly in
ascending order)
■ Click on the Reset button to re-set the fields to the values before the Search.
■ Click on the relevant IMO number (or MMSI number) hyperlink in order to select a vessel and see the
available ships’ details (see Figure 15).
Figure 15 – Vessel history data
■ Click on the “Version’s History items” icon
. A pop up window will display the Reason for Update for
each of the fields (see Figure 16 – Version detail history items panel
Page 13 of 21
SSN User Interface Manual - Central Ship Database
Figure 16 – Version detail history items panel
■ After closing the pop-up window, the user can click on the Back button in order to return to the Search
Vessel History screen (Figure 13 – Search vessel history panel).
2.5 Upload & Validate
The following tools are not currently available:
■
■
■
■
Upload MARS vessels
Validate uploaded MARS vessels
Upload MS vessels
Validate uploaded MS vessels
Page 14 of 21
SSN User Interface Manual - Central Ship Database
3.
Ship Management Web Interface
The Ship Management provides functions to users to download lists of ships from the SSN database based on
different criteria.
3.1 How to access the Ship Management Web Interface
After the login, click the Ship management tile, as shown in Figure 17 – SSN Main page / Ship Management:
Figure 17 – SSN Main page / Ship Management
3.2 Download list of Single Hull Tankers (SHT)
This option allows users to retrieve the list of SHT Vessels registered in SSN.
3.2.1
Permissions
The user must be granted the SHT_VESSEL_DOWNLOAD permissions.
3.2.2
Steps
From the Vessel Management main page select Vessel Management > Download List
Select Download Lists > Single Hull Tanker Vessel. The Single Hull Tankers panel opens (Figure 18).
The current selection is displayed on the top of the main panel:
Management Console > Vessel Management > Download Lists > Single Hull Tanker
Page 15 of 21
SSN User Interface Manual - Central Ship Database
Figure 18 – List of SHT
The complete list of vessels defined as Single Hull Tankers is displayed.
The list can be sorted by each of the columns in the table. Clicking on the labels sorts the list in ascending or
descending order (First click sorts list in descending order and second in ascending order)
To export the results, select one of the export options: CSV, Excel or XML and click on the corresponding
hyperlink. The system will prompt the user regarding with the option to open or save the exported data file.
3.3
Download list of Banned Ships
This option allows users to retrieve the list of banned vessels registered in SSN.
3.3.1
Permissions
The user must be granted the BANNED_VESSEL_DOWNLOAD permissions.
3.3.2
Steps
Select the option Download Lists > Banned Ship. The Banned Vessels panel opens (Figure 19).
The current selection is displayed on the top of the main panel:
> Management Console > Vessel Management > Download Lists > Banned Ship
Page 16 of 21
SSN User Interface Manual - Central Ship Database
Figure 19 – List of banned ships
The complete list of ships defined as Banned is displayed.
To export the results, select one of the export options: CSV, Excel or XML and click on the corresponding
hyperlink. The system will prompt the user regarding the option to open or save the exported data file.
3.4
Download list of Detained Vessels
This option allows users to retrieve the list of detained vessels registered in SSN.
3.4.1
Permissions
The user must be granted the DETAINED_VESSEL_DOWNLOAD permissions.
3.4.2
Steps
Select Download Lists > Detained. The Detained Vessels panel opens (Figure 20).
The current selection is displayed on the top of the main panel:
> Management Console > Vessel Management > Download Lists > Detained
Page 17 of 21
SSN User Interface Manual - Central Ship Database
Figure 20 – List of Detained Vessels
The complete list of ships defined as Detained is displayed.
To export the results, select one of the export options: CSV, Excel or XML and click on the corresponding
hyperlink. The system will prompt the user regarding the option to open or save the exported data file.
Page 18 of 21