View IMOS Documentation in the Help Center.

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

The Report Designer, available from the Report List, features a drag-and-drop interface. With the Report Designer, you can create custom reports with Source IMOS or Veslink Forms. The Report Designer provides live preview, so you can see your edits in real time. You can apply filters that can decrease loading times, group data, create custom columns, add aggregate functions, and perform simple calculations. When you are finished, you can export your report.

Note: The legacy Report Editor and reports created in it are still available.

Tutorials

• IMOS On-Prem - Tutorial - Introduction to the Report Designer
• IMOS On-Prem - Tutorial - Using the Report Designer

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 Mode button: .

• Design Mode: Build the report in Design Mode.
  • Design Mode is only available to report owners and Security Administrators.
  • In Design Mode the actions menu appears: . 
    • On the Actions menu, you can create a new report, save the report, save a copy of the report, or edit the report properties.
• Report View Mode: View the report in Report View mode.

User View Changes

When opening a report, the default User View displayed is the original dataset of the created report.

In Report View Mode, you can modify the list layout, including filters, sorting, and grouping, and then save the changes in a User View.

Defining Report Properties

You can create custom reports with Source IMOS or Veslink Forms.

1. To create a custom report in the Report Designer, click  and then click Report.  
   
2. Enter the following properties:
   • Enter the Title, Subtitle, and Description. To Include description in report, select the check box.
     Note: It is important to create reports with unique titles. 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 a data Source:
     • IMOS: IMOS data, shown in the Data Map.
     • Veslink Forms (when paired with a Veslink environment): Includes data from the Veslink forms currently in the local IMOS database.
   • 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 Security Group or Active Directory Group, you can assign either Read Only () or Read and Write () rights for this report.
       • Only Owners and Security Administrators can edit or delete reports.
       • Group members with Read and Write access () can create copies of that report only.
       • Members with Read Only access () can only run the report.
     • Veslink Share
   • Select the Output type: Each Output type has different options.
     • List
     • CSV, PDF, Word, or XML:
       
       • You can select check boxes to specify optional output details:
         • Save report output in the specified folder: Enter a location for storage and easy access by other users.
         • Specify output filename: Enter a filename for the output file.
       • For PDF and Word, font (bold, italic, color) and field (color, alignment) attributes are maintained on export.
     • Excel:
       
       • Template: Select an Excel Template from File Management.
       • You can select check boxes to specify optional output details:
         • Save report output in the specified folder: Enter a location for storage and easy access by other users.
         • Specify output filename: Enter a filename for the output file.
       • Font (bold, italic, color) and field (color, alignment) attributes are maintained on export.
     • Reporting DB:
       
       Note: Use of the Reporting Database, to have custom reports output to a SQL server database, requires a separate license. To set it up, in the Data Center , under Other, click Reporting Databases.
   • IMOS User Distribution and Address Book Distribution (for CSV, Excel, PDF, Word, and XML Output types only): Reports can be distributed to IMOS Distribution Lists and to 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 hyperlink or create a Scheduled Task in the Messaging Service.
     • To prevent distribution of empty reports, select the Distribute Only Report With Data check box.
     • For more information, see the Messaging Service Manual.
   • Layout: Select Default or Custom. With a Custom Layout (for Word, Excel, or PDF), you can alter text size, column and line spacing, page orientation, page margins, logo image upload, headers and footers, and other page properties.
     
3. Click OK. The Report Designer appears with Design Mode selected:
   
   • The report columns appear on the left, with blue headings.
   • The workspace columns are on the right, with orange headings.
4. The primary Tables (related to setup in the Data Center) appear; to also see functional Tables (related to use in voyages), click  and then click Show All Tables.

Designing the Report

To learn about designing a report, see the following:

• IMOS On-Prem - Finding Fields with the Data Map
• IMOS On-Prem - Adding Filters
• IMOS On-Prem - Adding Columns
  • IMOS On-Prem - Adding Custom Columns and Formatting Columns
    • IMOS On-Prem - Formatting Codes for Numbers and Dates
    • IMOS On-Prem - Sample Custom Expressions
    • IMOS On-Prem - Custom Expression Functions
  • IMOS On-Prem - Joining Tables and Fields
• IMOS On-Prem - Adding Groups
• IMOS On-Prem - Adding Aggregate Functions
• IMOS On-Prem - User Views
• IMOS On-Prem - Setting Up a Report Designer Report for Distribution
  • IMOS On-Prem - Datashed Arguments
• IMOS On-Prem - Example Reports - Report Designer
  • IMOS On-Prem - Creating a Voyage Summary Report in the Report Designer
  • IMOS On-Prem - Creating an Estimated Demurrage Report in the Report Designer
• IMOS On-Prem - Example Reports - Veslink Form Data

Saving the Report

To save the report:

• Click the Actions menu, and then click Save.
  • To save a copy of the report, click Save As.
• Click  to exit Design Mode. When you are prompted to save the current view, click Yes.

Editing a Report or Report Properties

You can edit a report that you created. In the Report List, click its title.

While editing, to edit the report's properties (title, subtitle, etc.), on the Actions menu, click Edit Properties.

Searching a Report

1. To search within a report, do one of the following:
   
   
   • Click  and then click Search.
   • Press Ctrl + F.
   The search box appears: 
2. Type a search term and press Enter. The search term is highlighted in the report.
3. Click  or  to highlight the previous or next search result.

Exporting a Report

After creating your report, you can export it. Click  and then click Excel, PDF, Word, CSV, or XML.

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 VIP, including custom elements.