Skip to main content
Skip table of contents

IMOS - Port

 This is a Key Topic, with high value for all users.

To view an existing port, do one of the following:

* Enabled by configuration flag.


General Information

General information appears at the top of the Port form.

  • The following Port Types are available:
    • Standard Port: Standard Ports are those that are included in the Distances tables.
    • Port (No Distance Link): Ports without a Distance Link are custom ports not included in Distances.
      • Enter Port Aliases. Time Zone Code is required; if the new port is an Alias, this value is inherited from the master Port record.
    • Alias Port: Alias Ports are ports created in place of an existing port.
      • An Alias Port has all the attributes of another port, allowing it to be included in Distance calculations using that port's location.

      • Enter the port for which this is an Alias. Any changes made will only affect this Alias port; they will not affect the Alias To port.

    • Waterway Port: Waterway Ports are ports located on an inland body of water.
  • U.N. Code: Maintained by Distances updates. This field can be overwritten manually, though it might change again when new Distances are released.
  • Latitude and Longitude are displayed in a degree-minute-second format, where minutes are rounded.
  • Pilot Station: Select to designate the port as a Pilot Station. *
  • Alerts: Can be used to capture issues; the Port field is highlighted in light red on several forms after an Alert is entered for it. An Alerts column can also be selected to appear in the Port List.

* Enabled by configuration flag.

Fuel Zones and Low Sulfur Areas

If a port is located within a Fuel Zone, its name appears: 

  • A port is assigned to the smallest Fuel Zone within which it is located. For example, HUENEME is assigned to USA 25NM zone, but it is also located in US 200NM:
  • To override the low sulfur status, select the Use High Sulfur Fuel check box. Any future in-port consumption at that port uses high sulfur fuel.
  • For other ports, the field is blank: 
    • To specify a port as a low sulfur area, select the Low Sulfur ECA check box.
    • You can also specify an Emission Control Area as a low sulfur area, automatically setting the area and all ports in it to low sulfur. You must have the most recent Distances update installed. To confirm, make sure that ECA Fuel Zone ports are in your Port List, and confirm that the Low Sulfur ECA check box is selected in all of them.

    Low Sulfur Fuel Use: Port Selections and Fuel Grades Consumed

    Port Selections

    Fuel Grades Consumed in LS Port

    • Not Low Sulfur

    G and H

    • Low Sulfur
    • Without Configuration flags

    All L grades

    • Low Sulfur
    • Without Allow <1% IFO
    • With CFGLSPortConsumptionDefaultGrades

    L grades specified in CFGLSPortConsumptionDefaultGrades

    • Low Sulfur
    • With Allow <1% IFO
    • With CFGLSPortConsumptionDefaultGrades
    • Without CFGLSPortConsumptionLSFOGrades

    L grades specified in CFGLSPortConsumptionDefaultGrades

    • Low Sulfur
    • With Allow <1% IFO
    • With CFGLSPortConsumptionLSFOGrades

    L grades specified in CFGLSPortConsumptionLSFOGrades

    • Configuration flag with grades not on the vessel

    No L grades

Port Aliases Grid

This grid enables you to associate the current Port with Alias Ports.

If a Port has Port Type set to Alias Port, you can select it in this grid.

Berth Grid

On this grid, to view or edit information about a berth in the port, right-click its row and then click Berth.

Pilot Stations Grid

Note: Configuration flag CFGEnablePortPilotStations must be enabled.

This grid enables you to designate specific Pilot Stations within ports.

  • You can select one Default Pilot Station per Port.
  • If a Port has the Pilot Station check box selected, you can select it in this grid.

Berth Cargo Compatibility Grid

Note: Configuration flag CFGEnableBerthCargoCompatibility must be enabled.

Add rows to define compatible cargoes for each berth, including a valid date range:

If Cargo Name is set to (ALL), settings in the row apply to all cargoes.

How is berth-cargo compatibility determined?

When applying the Berth Cargo Compatibility validation to cargo operations in Berth Management in the Voyage Manager:

  • The From Date and To Date for a compatibility row are compared to the arrival specified on the berth for the cargo handling line.
  • The order of precedence when applying compatibility rows to a cargo operation is:
    1. The latest-starting row with dates and a matching Cargo Name specified
    2. The latest-ending row with dates and a matching Cargo Name specified
    3. The latest-starting row with dates specified and (ALL) for the Cargo Name
    4. The latest-ending row with dates specified and (ALL) for the Cargo Name
    5. The unbounded-time row with a matching Cargo Name specified
    6. The unbounded-time row with (ALL) for the cargo name
    7. The (DEFAULT) row

If no matching row is found, the cargo operation is allowed by default.

Berth Vessel Compatibility Grid

Note: Configuration flag CFGEnableVesselCompatibility must be enabled.

Add rows to define compatible vessels for each berth, including a valid From Date.

If Vessel Name is set to (DEFAULT), settings in the row apply to all vessels.

Fuel Type/Grade Availability Grid

When configuration flag CFGEnablePortFuelAvailability is enabled, a Fuel Type/Grade Availability grid appears on the Port form, in which the Fuel Types and Grades that are available at the port can be captured.

Port List

All ports appear on the Port List. In the Data Center

, next to Port, click List.

The Port List is a standard IMOS list, so you can sort it, filter it, do a Quick Search, and create custom Views for it. You can use logical operations to filter particular columns in the list.

Updating Ports and Distances

When a version of IMOS is released, the build contains all the ports that are currently identified. Over time, new ports are added, and older ports are updated. A monthly file of updated ports and distances is added to the Client Center. The file must be downloaded and added to IMOS, and the scripts must be run, each month. Complete instructions are with the file.

Adding a Port

If you need a port added, contact Veson to have it added. In the meantime, you can add it, but it will not have distances associated with it; the miles to and from it in an itinerary will be blank.

  • To update the miles, delete the port you added and re-enter the standard port after it is added to the Distances tables.
  • When you enter a port name:
    • If the name is new, you are asked if you want to use the name for a new port. 
    • If the port already exists, its record appears. A new port with the same name as an existing port cannot be added. 
  • To rename the manually created port:
    • Edit the port name and save. Once you are asked if you want to use the name for a new port, select No.

    • Then you are asked if you would like to rename the current port.

Related Configuration Flags
Enable Default Data Submission Agent Per Port

When enabled, adds a Data Submission Agent field to the Port form. The agent selected here will be populated by default for any port call of this port. It takes precedence over Default Data Submission Agent.

Enable Port Fuel Availability

When enabled, a new Fuel Availability grid is added to the Port form in the Data Center where the Fuel Types and Grades that are available at the port can be captured.

Enable Standards

Hides the Port Expense field on some forms, enables standards for expenses, and adds a Port Expenses Details form and a Port Expenses Details button on the Port Expenses Summary to open it. When detail-level port expenses are being used, the PortExp column in the Voyage Manager Itinerary behaves the same as the PortExp column in the Voyage Estimate itinerary:

  • For a port with no detail-level port expenses, you can edit its PortExp amount in the Voyage Manager Itinerary Cargo Tab. The voyage P&L shows this amount as estimated expenses for that port.
  • For a port with a single detail-level expense, that amount appears and can be edited in the voyage itinerary PortExp field. An estimated expense entered before creating the detail-level expense is no longer displayed in the voyage P&L.
  • For a port with multiple detail-level expenses, the itinerary PortExp field shows the sum of the detail-level expenses for that port and cannot be edited.
  • When CFGVoyageExpenseAllocation is set to Y, a Voyage Expense Allocation section will be added to the Voyage Estimate Profit & Loss Report, and optionally to the Voyage Profit & Loss Report.

An ECA Factor field also appears on COA, Cargo/VC In, and CP Terms Details forms. When ECAFactor is used in an ECA Recovery Charge Results/Fee expression and an ECA Factor value is entered on a contract, an ECA Recovery Charge Extra Freight Term is generated on that contract.

  • When a COA is created from a Voyage Estimate, ECA Factor is copied from CP Terms to the COA.
  • When a COA Lifting is created, ECA Factor is copied from the COA to the Cargo.
  • When a cargo is scheduled, ECA Factor is copied from the cargo to the back-created Voyage Estimate.
Enable Scrubber Type
When enabled, a scrubber drop-down menu appears on the Port, Voyage Bunkers, Bunker Planning, and Vessel forms accessed through a Voyage Estimate. On the Port and Vessel forms, the drop-down menu reflects scrubber values allowed at the port and equipped in the vessel. On the Voyage Estimate and Voyage, it reflects the scrubber type used for bunker calculations. On the Vessel form, the Use Scrubbers check box is replaced with the new Scrubber Type drop-down menu. The Fuel Zones form has two tabs to support Scrubber and Non-Scrubber configurations. These new options facilitate bunker calculations to use the IMO 2020 regulations.
Port Full Text Search

In Port fields, enables you to search for Port names by any part of the port name, instead of by prefix only. For example, if you type ton in a Port field, Boston will appear in the results drop-down menu.

If this flag is set to N, you have to type B* (for example, Bos) to get a match.

Enable Berth Cargo Compatibility
When enabled, a Berth Cargo Compatibility grid is shown on the Port form.
Enable Vessel Compatibility
When enabled, a Berth Vessel Compatibility grid is shown on the Port form.
Enable Port Pilot Stations
Enables functionality around port pilot stations both in Master Data and through the Voyage Estimate and voyage itineraries.
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.