Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Home > Voyage Reporting > System Configuration

...

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

To save changes, click .

General

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

...

Warning

Note: The Veson IMOS Platform (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 VIP 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 VIP 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.
      Example Errors:

      • An error occurred when receiving an offline forms submission: Could not determine a GMT offset for the form, because a valid port was not entered. 

      • An error occurred when receiving an offline forms submission: Upcoming ports contains a port named 'INCHON', but that name does not match any active ports.

      • An error occurred when receiving an offline forms submission: Could not determine a GMT offset for the form, because a valid port was not entered.

  • 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; they will be replaced by the applicable values when the email is generated:

      • %CompanyName%

      • %VesselName%

      • %FormsList%

      • %AdminEmail%

      • %SenderEmail%

  • Form Validation:

    • Validate Forms When Opened (selected by default): Revalidates forms when opened by the operator. This may clear form errors if, when the form is opened, the data can be processed successfully.

  • 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 (requires Veslink will automatically send an email to the vessel when Voyage Instructions forms are submitted to be checked as well)

  • Printing:

    • Use the browser's layout when printing forms.: Displays a print preview before printing a form.

    • 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 VIP 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:

Excerpt
  1. Enter the Principal ID.

  2. Under DA-Desk Invoice Number Preference, select a tag name:

    • InvoiceNumber (default)

    • 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.

    • You can select only one of the following:

      • 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 the Veson IMOS Platform simplePayment message type (for more information, see the Messaging Service Manual):

VIP simplePayment Field

Disbursement Type

DA-Desk DIS XML Field

currency

PDA, APR, or PVI

paymentAmout/DAPaymentAmount/DACurrency

Other (FDA)

balanceAmount/DABalanceAmount/DACurrency

currencyAmount

PDA, APR, or PVI

paymentAmout/DAPaymentAmount

Other (FDA)

balanceAmount/DABalanceAmount

baseCurrencyAmount

PDA, APR, or PVI

paymentAmount/CustomerAccountingPaymentAmount

Other (FDA)

balanceAmount/CustomerAccountingBalance


Agent Portal

Note: Requires the Agent Portal.

...

  • Use Agent Nomination Emails: Select to send an email to Agents when they are nominated for a port call. This email is sent to the email address associated with the Agent's Agent Portal account.

    • Email Title: The title of the email being sent to the Agent. Within the text, you can use the following tokens; they will be replaced by the applicable values when the email is generated:

      • %PortName%

      • %VesselName%

      • %Eta%

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

    • Email Body: You can customize the body of the email. Within the text, you can use the following tokens; they will be replaced by the applicable values when the email is generated:

      • %CompanyName%

      • %VesselDetails%

      • %CargoDetails%

      • %PortCallDetails%

Custom Reports

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

...

When you import a new report, it appears in the Custom Reports list.

Importing a Report Definition

Note: Only report definitions with 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.

...

  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:

...