Breadcrumbs

IMOS - Voyage Reporting System Configuration

Home > Voyage Reporting > System Configuration

Requires the Voyage Reporting module. You must have the Configure System General Permission enabled.

In System Configuration, you can configure general settings, email settings for forms, third-party interfaces, and the Agent Portal, and import Custom Reports from IMOS and Microsoft Power BI.

To save changes, click.

General

To open System Configuration, on the Operations menu, under Setup, click Voyage Reporting System Configuration.

General settings appear.

  • General:

    • Date Format: Each user can select a preferred format for dates: MM/dd/yyyy (12/31/2015) default, dd/MM/yyyy (31/12/2015), ddMMMyyyy (31Dec2015)

    • Warn on Entered Dates Older than XX Days (0 = No Warning): A value between 0 and 999; 0 = No Warning. This feature helps prevent date input errors.

    • Maximum Number of Days in Past Allowable for Incoming Forms: Number of past days allowed for forms to be accepted.

    • Use Browser's Locale Setting for Number Formatting: When Enable Number Formatting is selected for Integer and Decimal fields in the Forms Data Dictionary or Form Designer, number formatting respects browser locale settings.

  • Fuel Consumption:

    • Track Fuel Consumption over Weather Threshold: Select to have the Over Weather Threshold field appear in the ROB control. This field defaults to 0 and cannot exceed the total consumption value.

  • Port Activities:

    • Allow Berth Selection for Relevant Port Activities: Displays a Berth column in the Port Activity control on the Statement of Facts form.

    • Always require matching start and end activities: Validates to ensure that there is a matching pair of OS/OE and DS/DE activities.

  • List Settings (requires the Agent Portal):

    • Replace voyage number with voy ref in the port calls list: Select to replace the Voyage Number column with a Voyage Reference column in the Port Calls list. Note: The Partner must be using IMOS or IMOS v7.9.1960+ for this field to properly populate.

    • Show additional information in Agent Portal: Select to add Operation Type, Vessel Owner, Operations Contact, and Portcall Sequence columns to the Port Calls list.

  • Power BI Settings: To import Power BI reports based on Voyage Reporting form data, you must enter a Power BI Username and Power BI Password.

Note: IMOS can only be linked with one Power BI account.

If you would like to import dashboards created in a second account, then do the following:

  • For Pro Accounts, share the dashboards created in the second account with the Power BI account already linked to IMOS and upload them via the latter (already linked) account.

  • For non-Pro Accounts, export the dashboards from the second account, then import them into the Power BI account already linked to IMOS and upload them via the latter (already linked) account.

For Agents

If you are an Agent using the Agent Portal, on the Settings menu, click System Configuration to configure general settings.

Forms

To configure Forms, on the left side, click Forms.

To see a field definition, hover over its underlined field label. Here are additional field definitions:

  • Setup:

    • Administrator Email for Error Notifications: Email address of the administrator to be notified when the forms fail or have errors due to incorrect data. This is a required field for Voyage Reporting forms to validate when submitted.

  • Outgoing Email:

    • Email Title: The subject heading of the email being sent to the vessel.

    • Email Body: You can customize the instructions that are emailed to the vessel with the forms. Within the text, you can use the following tokens: %CompanyName%, %VesselName%, %FormsList%, %AdminEmail%, %SenderEmail%

  • Form Validation:

    • Validate Forms When Opened (selected by default): Revalidates forms when opened by the operator.

  • Voyage Instructions:

    • Veslink will pretty print the Voyage Instruction Email body when Voyage Instruction forms are sent

    • Veslink will automatically send an email to the vessel when Voyage Instructions forms are submitted: Allows you to submit Voyage Instructions.

    • Send Voyage Instructions as PDF attachments: Send voyage instructions as an attachment in an email.

  • Printing:

    • Use the browser's layout when printing forms.

    • Export Form Data to XML: Enables you to export forms to XML.

Interfaces

To configure Interfaces, on the left side, click Interfaces.

IMOS

To reset the master data, click. Resetting the master data will ensure the data between Voyage Reporting and IMOS are synced. This is recommended when adding new fuel types to a vessel.

DA-Desk

If you have a DA-Desk interface, do the following:

  1. Enter the Principal ID.

  2. Under DA-Desk Invoice Number Preference, select a tag name: InvoiceNumber (default) or InvoiceNo1 (choose this option for DA desk interface). When importing invoices, the Invoice Number will be mapped from the tag name specified.

  3. Apply relevant configurations:

    • (Beta) Use new parallel DA-Desk interface for sending portcall updates.

    • Import DA Invoice In Allowable Payment Currency. Only applicable to Veslink API integration method.

    • Import DA Invoice In Local Currency. Only applicable to Veslink API integration method. When selected, the following data are mapped between DA-Desk and IMOS simplePayment message type (for more information, see the Messaging Service Manual).

IMOS simplePayment Field

Disbursement Type

DA-Desk DIS XML Field

currency

PDA, APR, or PVI

paymentAmout/DAPaymentAmount/DACurrency

currency

Other (FDA)

balanceAmount/DABalanceAmount/DACurrency

currencyAmount

PDA, APR, or PVI

paymentAmout/DAPaymentAmount

currencyAmount

Other (FDA)

balanceAmount/DABalanceAmount

baseCurrencyAmount

PDA, APR, or PVI

paymentAmount/CustomerAccountingPaymentAmount

baseCurrencyAmount

Other (FDA)

balanceAmount/CustomerAccountingBalance

Agent Portal

Note: Requires the Agent Portal.

To configure Agent Portal, on the left side, click Agent Portal.

  • Use Agent Nomination Emails: Select to send an email to Agents when they are nominated for a port call.

    • Email Title: The title of the email. Tokens: %PortName%, %VesselName%, %Eta%

    • CC: Additional email addresses that will receive the Agent Nomination email.

    • Email Body: Tokens: %CompanyName%, %VesselDetails%, %CargoDetails%, %PortCallDetails%

Custom Reports

To configure Custom Reports, on the left side, click Custom Reports.

You can import custom reports of format .form created in Microsoft Power BI (based on Voyage Reporting form data) or the Report Designer. When you import a new report, it appears in the Custom Reports list.

Importing a Report Definition

Note: Only report definitions with a file type FORM File can be imported. If you receive a report definition from another user and you trust the source, make sure to remove .unsafe from the file name so that it converts to a FORM File.

To import a report definition:

  1. In Custom Reports settings, click.

  2. Browse for the report definition FORM File, select it, and then click Open.

  3. Click.

Importing a Power BI Report

To import a Power BI report based on Voyage Reporting form data:

  1. In General settings, make sure your Power BI Username and Power BI Password are entered.

  2. In Custom Reports settings, click.

  3. Enter a Report Title.

  4. Enter the Power BI report URL.

  5. Click Import.

To edit the Report Title, Description, and URL of a Power BI report, in the Custom Reports list, on its line item menu, click Edit Report. The Import Power BI Report form appears.

To delete a Power BI report, in the Custom Reports list, on its line item menu, click Delete Report.