Home > Integrations > Vessel Data Integration
...
| Info |
|---|
Requires the Integrations module. |
This article describes how to set up and use the Vessel Data Integration:
| Table of Contents | ||
|---|---|---|
|
Setup
| Info |
|---|
To set up a vessel data integration with the Veson IMOS Platform (VIPIMOS), contact Veson Nautical Support via the Help Center. Q88, Q88 Dry (and previously known as Baltic99), and Oceanbolt restrict access by IP address, so every client machine IP has to be registered with Q88 and Q88 Dry 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.
Oceanbolt Vessel Particulars/Q88 Dry (Baltic99)
Name/Flag | Description |
|---|---|
Allow Baltic99 Search | Enables Baltic99 vessel import; requires a valid license. CFGQ88Baltic99FleetURL and CFGBaltic99Authorization must also be enabled. |
Q88 Baltic99 Fleet URL | 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 | Company-specific Baltic99 authorization string; requires a valid license. CFGAllowBaltic99Search and CFGQ88Baltic99FleetURL must also be enabled. |
Oceanbolt Vessel Particulars/Q88
Name/Flag | Description |
|---|---|
Basic Q88 Interface | Enables Q88 vessel import; requires a valid license. CFGAllowQ88Search, CFGQ88Baltic99FleetURL, and CFGQ88Authorization must also be enabled. |
Allow Q88 Search | Enables Q88 search in Vessel List; requires a valid license. CFGBasicQ88Interface, CFGQ88Baltic99FleetURL, and CFGQ88Authorization must also be enabled. |
Q88 Baltic99 Fleet URL | 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 | Company-specific Q88 authorization string; requires a valid license. CFGBasicQ88Interface, CFGAllowQ88Search, and CFGQ88Baltic99FleetURL must also be enabled. |
Fairplay
Name/Flag | Description |
|---|---|
Allow Fairplay Search | Enables Lloyd's Fairplay vessel import; requires a valid license. CFGFairplayUsername, CFGFairplayPassword, CFGFairplayDistillateFuelType, and CFGFairplayResidualFuelType must also be enabled. |
Fairplay Username | Username for the Fairplay subscription; requires a valid license. CFGAllowFairplaySearch, CFGFairplayPassword, CFGFairplayDistillateFuelType, and CFGFairplayResidualFuelType must also be enabled. |
Fairplay Password | Password for the Fairplay subscription; requires a valid license. CFGAllowFairplaySearch, CFGFairplayUsername, CFGFairplayDistillateFuelType, and CFGFairplayResidualFuelType must also be enabled. |
Fairplay Distillate Fuel Type | The |
Veson IMOS Platform 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 | The |
Veson IMOS Platform 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 | Certificate DNS for Fairplay |
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
vessel import |
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.
AXS
Name/Flag | Description |
|---|---|
Allow AXS Search | Enables AXS Marine vessel import; requires a valid license. CFGAxsMarineWebServiceUrl and CFGAxsMarineToken must also be enabled. |
AXS Marine Web Service URL | URL of AXS Marine webservice; requires a valid license. |
AXS Marine Token | Token for AXS Marine webservice subscription. |
SIRE
Name/Flag | Description |
|---|---|
Allow OCIMF Search | Enables OCIMF search in the Vessel List with a valid license. |
OCIMF Account Number CFGSIREVettingAccountNo | Account Number for SIRE subscription; requires a valid license. |
OCIMF Username CFGSIREVettingUserName | Username for OCIMF subscription; requires a valid license. |
OCIMF Password CFGSIREVettingPassword | Password for OCIMF subscription; requires a valid license. |
OceanSMART
Name/Flag | Description |
|---|---|
Allow OceanSMAR Search | Enables OceanSMART vessel import; requires a valid license. |
OceanSMART Username | Username for OceanSMART subscription; requires a valid license. |
OceanSMART Password | Password for OceanSMART subscription; requires a valid license. |
Searching for Vessels
Note: The integration only returns searches for vessels that have been published on Q88 and Baltic99 by the vessel owner. For example, searching for a Q88 vessel whose IsPublished field is set to 0 will not return any results in Vessel List or External Vessel Import.
...
To search for vessels from external sources in the Vessel List, click the data source button and then select the source:
| Table of Contents | ||||
|---|---|---|---|---|
|
Importing a Vessel
To import a vessel:
On the Vessel toolbar, click Import.
If CFGEnableVesselImportFromEstimate is enabled, on an Estimate column or details, 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 toolbar, click Update.
| Expand | ||||||
|---|---|---|---|---|---|---|
| ||||||
|