Home > Analytics > Creating a Report in the Report Designer

To access Design Mode and edit reports, Report Designer Module Rights must be selected in Security, under Data Center Actions.

The Report Designer, which can be accessed from the Report List by selecting Design in the Report List Action column, enables you to create custom reports. The Report Designer provides a live preview so you can see your edits in real-time. You can apply filters that decrease loading times, group data, create custom columns, add aggregate functions, and perform simple calculations. When you are finished, you can export your report.

Report Designer Modes

The Report Designer has two modes: Design Mode to create the report and Report View Mode to view the report. To switch between Design Mode and Report View Mode at any time, click the Design button:  
When clicking on the report row, it will open the Design Mode, but if you click the report title hyperlink it will run the report without access to the Design button.

• Design Mode (for reports with Source IMOS only):

  
  To build a report in (only available to report owners and Security Administrators), create or open it from the Report List and then do the following:

  1. Define properties.

  2. Add columns and any of the following:

     • Filters

     • Aggregate functions

• Report View Mode:

  Open

  

In either mode:

• As with any other list, you can search, change your view, save user views (for reports with Source IMOS, in Report View Mode only), and export.

• When opening a report, the default list view displayed is the original dataset of the created report.

• The list view you are currently viewing is highlighted and underlined (e.g., LIST VIEW NAME).

Defining Report Properties

To create a custom report in the Report Designer, do the following:

1. To access the Report List, in Analytics, click .

2. Do one of the following:

   • To create a new report, on the Report List or card panel, click + and then click New Report.

   • To copy a report, in its Report List row, click Copy.

   Open

   

3. On the Report Properties panel, you can do any of the following:

   • Enter Title, Subtitle, and Description. To Include description in report, select the check box.
     Note: It is important to create reports with unique titles (max 64 characters in length). If a new report is created with an already existing name (capitalization will not differentiate the titles), the report cannot be run via Scheduled Tasks.

   • Select Defer updates: Changes you make to your report appear in real-time. To hold updates until after setting up the report, to improve performance and loading times, select this check box. When selected, click Refresh to see the results of your design.

   • Select a data Source:

     • IMOS: Veson IMOS Platform (IMOS) data, shown in the Data Map.

     • Veslink Forms: Includes data from the Voyage Reporting forms currently in the database.

     • Onboard (requires Onboard): Includes data from Onboard voyages and port calls. After replication, Onboard users with Security Groups access can run these reports from the Reports panel.

   • Select the Access type:

     • Private (default)

     • Public: Users with permissions to edit public reports can edit all public reports regardless of report ownership.

     • Security Groups: For each group, you can assign either Read Only () or Read and Write () rights for this report.

     • Veslink Share

   • Select the Output type: Each Output type has different options.

     • List

     • CSV, PDF, Word, or XML:
       

     • Excel:

       • Template: Select an Excel Template from File Management.

     • Reporting DB:

       Note: Use of the Reporting Database requires a separate license. To set it up, contact Veson Nautical Support.

   • IMOS User Distribution and Address Book Distribution (for CSV, Excel, PDF, Word, and XML Output types only): Reports can be distributed to Distribution Lists and those Address Book contacts with the Reports check box selected on the Contacts tab. To distribute the report, either select it in the Report List and click the Distribute link or create a Scheduled Task in the Messaging Service. For more information, see the Messaging Service Manual.

     • To prevent the distribution of empty reports, select the Distribute Only Report With Data check box.

   • If you have the APIs module, you can get the API URL for the report by clicking Get API URL.

4. Click Save.

Viewing Tables and Elements

Note: You must have the Data Dictionary Module Right selected under Quick Links in the Data Center.

In the Data Dictionary, you can view all tables and elements (fields) used throughout the Veson IMOS Platform, including custom elements.