IMOS - Vessel Data Integration

View IMOS Documentation in the Help Center.

This is an additional solution and requires a separate license.

This article describes how to set up and use the Vessel Data Integration:

Setup

To set up a vessel data integration with IMOS, contact Veson Nautical Support via the Help Center.

Q88 (and Baltic99) restrict access by IP address, so every client machine IP has to be registered with Q88 in order to have access. You can provide an IP range (recommended) or individual IP addresses.

The following configuration flags enable importing and updating vessels using external data feeds.

Baltic99

Name/Flag

Description

Allow Baltic99 Search
CFGAllowBaltic99Search

Enables Baltic99 search in the Vessel List; requires a valid license. CFGQ88Baltic99FleetURL and CFGBaltic99Authorization must also be enabled.

Q88 Baltic99 Fleet URL
CFGQ88Baltic99FleetURL

Specifies the URL used to retrieve the Q88 and Baltic99 fleet lists; requires a valid license.

For Baltic99, CFGAllowBaltic99Search and CFGBaltic99Authorization must also be enabled.

Baltic99 Authorization
CFGBaltic99Authorization

Company-specific Baltic99 authorization string; requires a valid license. CFGAllowBaltic99Search and CFGQ88Baltic99FleetURL must also be enabled.

Fairplay

Name/Flag	Description
Allow Fairplay Search CFGAllowFairplaySearch	Enables Fairplay search in the Vessel List; requires a valid license. CFGFairplayUsername, CFGFairplayPassword, CFGFairplayDistillateFuelType, and CFGFairplayResidualFuelType must also be enabled.
Fairplay Username CFGFairplayUsername	Username for the Fairplay subscription; requires a valid license. CFGAllowFairplaySearch, CFGFairplayPassword, CFGFairplayDistillateFuelType, and CFGFairplayResidualFuelType must also be enabled.
Fairplay Password CFGFairplayPassword	Password for the Fairplay subscription; requires a valid license. CFGAllowFairplaySearch, CFGFairplayUsername, CFGFairplayDistillateFuelType, and CFGFairplayResidualFuelType must also be enabled.
Fairplay Distillate Fuel Type CFGFairplayDistillateFuelType	The IMOS Fuel Type Code for Fairplay's Distillate Fuel type; requires a valid license. CFGAllowFairplaySearch, CFGFairplayUsername, CFGFairplayPassword, and CFGFairplayResidualFuelType must also be enabled.
Fairplay Residual Fuel Type CFGFairplayResidualFuelType	The IMOS Fuel Type Code for Fairplay's Residual Fuel type; requires a valid license. CFGAllowFairplaySearch, CFGFairplayUsername, CFGFairplayPassword, and CFGFairplayDistillateFuelType must also be enabled.
Fairplay Certificate DNS CFGFairplayCertificateDNS	Certificate DNS for Fairplay vessel import.

Q88

Name/Flag	Description
Basic Q88 Interface CFGBasicQ88Interface	Enables Q88 vessel import; requires a valid license. CFGAllowQ88Search, CFGQ88Baltic99FleetURL, and CFGQ88Authorization must also be enabled.
Allow Q88 Search CFGAllowQ88Search	Enables Q88 search in the Vessel List; requires a valid license. CFGBasicQ88Interface, CFGQ88Baltic99FleetURL, and CFGQ88Authorization must also be enabled.
Q88 Baltic99 Fleet URL CFGQ88Baltic99FleetURL	Specifies the URL used to retrieve the Q88 and Baltic99 fleet lists; requires a valid license. For Q88, CFGBasicQ88Interface, CFGAllowQ88Search, and CFGQ88Authorization must also be enabled.
Q88 Authorization CFGQ88Authorization	Company-specific Q88 authorization string; requires a valid license. CFGBasicQ88Interface, CFGAllowQ88Search, and CFGQ88Baltic99FleetURL must also be enabled.

SIRE

Name/Flag	Description
Allow OCIMF Search CFGAllowOCIMFSearch	Enables OCIMF search in the Vessel List with a valid license.

SIS3

Name/Flag	Description
Allow Sis3 Search CFGAllowSis3Search	Enables SIS3 search in the Vessel List; requires a valid license.
Sis3 Username CFGSis3Username	Username for SIS3 subscription; requires a valid license.
Sis3 Password CFGSis3Password	Password for SIS3 subscription; requires a valid license.
Sis3URL CFGSis3URL	URL for SIS3 subscription; requires a valid license.

Importing a Vessel

To import a vessel:

On the Vessel form, click
.
If CFGEnableVesselImportFromEstimate is enabled, on a Voyage Estimate Column or Details view, if you search for a Vessel that does not already exist in the database, you will have the option to import from configured external vessel data sources.

Updating a Vessel

To update an imported vessel, on the Vessel form, click

.

Related Configuration Flags

Name/Flag	Description
Enable Vessel Import from Estimate CFGEnableVesselImportFromEstimate	When enabled, if a user searches for a Vessel in a Voyage Estimate that does not already exist in the database, instead of asking the user to create a new Vessel, they will have the option to import from configured external vessel data sources.
Autovsl Add Fuel Types CFGAutovslAddFuelTypes	When enabled, for vessels already existing in IMOS, any fuel types existing in an external system but not in IMOS are added to the vessel upon import. Otherwise, external data for fuel types missing in IMOS is ignored.