Welcome to the Veson Nautical Knowledge Base. In the Help Center, you can view the same articles and contact support as needed.

IMOS On-Prem - Styling Gantt Bar Templates

Owned by Adaptavist ScriptRunner for Confluence Cloud
Last updated: Jan 17, 2024 by Melanie Whitelock
3 min read

Error rendering macro 'excerpt-include' : No link could be created for 'IMOS'.

IMOS provides several schedules on Gantt charts, including the Cargo Schedule, Vessel Schedule (in Operations and Cargo Matching), and Port Schedule. These schedules populate the Gantt bars and their associated tooltips with information based on templates defined in IMOS configuration flags.

Styling Templates

Configuring

Each IMOS schedule has an associated template configuration flag, specified below. Modifying the value of the configuration flag will modify the template specifying the shown text. Unlike most IMOS configuration flags, it is not necessary to restart IMOS to see the effects; refreshing the respective IMOS schedule will immediately show the new template style.

Formatting

Variables

The IMOS Gantt bar styling follows a specific format. Text contained between two "at signs," (@...@) is considered a variable name and will populate with different text depending on the circumstance. For example, on the Cargo Schedule, (CARGO) may populate with the text "beans" or "steel," depending upon the associated IMOS Cargo object.

Plain Text

Aside from variables, the template will consider all other text as-is, and display it without modification. Typing only the words "Hello World" will display the words "Hello World" on all Gantt bars for the schedule:

Suggestions

An IMOS administrator determines the formatting that is applied to each schedule. Formatting is set at the system level and is the same for all IMOS users, regardless of any other user-specific settings. Administrators may want to consider a mix of variables and plain text to make labels efficient. For example, see the difference between a Cargo Schedule Gantt bar with just variables:

Template:  (CARGO)  (CARGOQTY)  (EXTERNALREF)

and one with plain text included:

Template:  (CARGO) - Qty:  (CARGOQTY) Ref:  (EXTERNALREF)

Including plain text in a template makes the text easier to read and quicker to understand.

Tooltips

The template style selected will also apply to the tooltips that appear when hovering over a Gantt bar. This is useful if the visible Gantt bar is not long enough to display the full text of the defined template.

Cargo Schedule

Configuration Flag

cargoScheduleSmallBarTemplate

Example

cargoschedule_example.txt

Variables

Variable Name

Description

(VSLNAME)

Either the nominated or performing vessel of the Cargo

(SHIPMENTNO)

Shipment No field of the Cargo

(EXTERNALREF)

External Reference field of the Cargo

(ALLGRADES)

If multi-grade Cargo and Charterer's View are enabled, a comma-separated list of all of the grades handled within the single Cargo

(COMMID)

Commercial ID of the first leg of the Cargo itinerary

(LABEL)

Default variable that shows the Cargo and Cargo Quantity

(VSLCODE)

Vessel Short Code for the nominated or performing vessel

(CARGO)

Cargo Name

(GRADE)

First Grade of the Cargo

(CARGOWINDOW)

Laycan From and Laycan To date times

(CHARTERER)

Cargo Charterer

(COAID)

Cargo COA ID if linked to a Cargo COA

(CARGOID)

Cargo ID

(PURCHASEID)

Cargo Purchase ID

(VOYNO)

Voyage Number of the Cargo's performing voyage

(CPFORM)

CP Form

(LOADPORT)

First Load Port of the Cargo itinerary

(DISCPORT)

Last Discharge Port of the Cargo itinerary

(CARGOQTY)

CP Quantity of the Cargo

(CARGOUNIT)

CP Unit of the Cargo

(CONTRACTTYPE)

Cargo contract or Voyage Charter contract

(RECEIVER)

First specified Receiver of the Cargo

(SUPPLIER)

First specified Supplier of the Cargo

(CPDATE)

CP Date of the Cargo

Vessel Schedule

Configuration Flag

vesselScheduleSmallBarTemplate

Example

vesselschedule_example.txt

Variables

Variable Name

Description

(LABEL)

Default label displaying the Vessel Code and Voyage Number, as well as the voyage start and end dates

(VSL_CODE)

Performing Vessel Code

(VSL_NAME)

Performing Vessel Name

(VOY_NO)

Voyage Number

(START_DATE)

Voyage Commence Date

(FINISH_DATE)

Estimated/Actual voyage Complete Date

(COUNTERPARTY)

Voyage Counterparty

(FIRSTPORT)

First port of the voyage (including C, R ports, etc.)

(LASTPORT)

Last port on the itinerary of the voyage (including T and Z ports)

(FIRSTLPORT)

First Load Port of the voyage

(LASTDPORT)

Last Discharge Port of the voyage

(FIRSTLAYCAN)

Laycan of the first Cargo

(FIRSTBL)

Month and day of the first BL

(EXTERNALREF)

External Reference of the voyage

(VOYREF)

Voyage Reference

(FIRSTCARGOREF)

External Reference of the first Cargo

(FIRSTCARGOSHIPMENTNO)

Shipment Number of the first Cargo

Port Schedule

Configuration Flag

portScheduleSmallBarTemplate

Example

portschedule_example.txt

Variables

Variable

Description

(VSL_CODE)

Vessel Code of the performing vessel

(VSL_NAME)

Vessel Name of the performing vessel

(PORT_NAME)

Port Name of the specific port call

(VOY_NO)

Voyage Number of the vessel calling the port

(START_DATE)

Estimated/Actual time of arrival for the specific port call

(FINISH_DATE)

Estimated/Actual time of departure for the specific port call

(SHIPMENTNO)

Shipment Number of first Cargo of the voyage containing the port call

Cargo Matching Vessel Schedule

Configuration Flag

cargoMatchingVesselScheduleSmallBarTemplate

Variables

Variable Name

Description

(VSLNAME)

Either the nominated or performing vessel of the Cargo

(SHIPMENTNO)

Shipment No field of the Cargo

(EXTERNALREF)

External Reference field of the Cargo

(ALLGRADES)

If multi-grade Cargo and Charterer's View are enabled, a comma-separated list of all of the grades handled within the single Cargo

(COMMID)

Commercial ID of the first leg of the Cargo itinerary

(LABEL)

Default variable that shows the Cargo and Cargo Quantity

(VSLCODE)

Vessel Short Code for the nominated or performing vessel

(CARGO)

Cargo Name

(GRADE)

First Grade of the Cargo

(CARGOWINDOW)

Laycan From and Laycan To date times

(CHARTERER)

Cargo Charterer

(COAID)

Cargo COA ID if linked to a Cargo COA

(CARGOID)

Cargo ID

(PURCHASEID)

Cargo Purchase ID

(VOYNO)

Voyage Number of the Cargo's performing voyage

(CPFORM)

CP Form

(LOADPORT)

First Load Port of the Cargo itinerary

(DISCPORT)

Last Discharge Port of the Cargo itinerary

(CARGOQTY)

CP Quantity of the Cargo

(CARGOUNIT)

CP Unit of the Cargo

(CONTRACTTYPE)

Cargo contract or Voyage Charter contract

(RECEIVER)

First specified Receiver of the Cargo

(SUPPLIER)

First specified Supplier of the Cargo

(CPDATE)

CP Date of the Cargo

(LINE_BREAK)Line break


 Related Configuration Flags
Name/FlagDescription
Cargo Schedule Small Bar Template
cargoScheduleSmallBarTemplate

Set the data to display on Cargo Schedule Gantt bars and their tooltips. CFGChartererView and CFGEnableMultiGrade must also be set.

Vessel Schedule Small Bar Template
vesselScheduleSmallBarTemplate

Set the data to display on Vessel Schedule Gantt bars and their tooltips.

Port Schedule Small Bar Template
portScheduleSmallBarTemplate

Set the data to display on Port Schedule Gantt bars and their tooltips.

Still need help? Visit the Veson Nautical Help Center.

Copyright © 2017-2024 Veson Nautical LLC All Rights Reserved - Privacy Notice | End User Terms of Use