OCIMF OVID

OVPQ Editor Desktop

Installation and Operation Manual

Prepared by Marine Information Solutions for OCIMF

Revision 7.0.034 1 March 2013

Table of Contents
1

Downloading and installing the editor ....................................................................................... 3

1.1

Download and Install......................................................................................................... 3

1.2

Initial Use of the Editor ...................................................................................................... 5

Viewing the Vessel Fleet .......................................................................................................... 7

Creating an OVPQ document .................................................................................................. 9

3.1

Creation via an Existing User Account .............................................................................. 9

3.2

Creation via Guest Account .............................................................................................. 9

Editing the OVPQ .................................................................................................................. 10

4.1

Top Menu ....................................................................................................................... 11

4.2

Main Window .................................................................................................................. 11

4.3

Footer ............................................................................................................................. 13

4.4

Selecting Variants ........................................................................................................... 13

4.5

View or Print an OVPQ document ................................................................................... 14

4.6

Submitting/Publishing an OVPQ document ..................................................................... 15

1 Downloading and installing the editor

1.1 Download and Install
The link to the latest version of the OVID OVPQ Particulars Editor is on the home page of the
OVID system after login.

The editor requires the Adobe AIR Framework, a free download available for PC, Macintosh and
Linux. A link to the Adobe website to download the framework is also included.
Ensure the Adobe AIR Framework is installed then click the OCIMF OVPQ Editor link to start the
download. The following guide shows steps involved with installation using the Firefox internet
browser.
1. Download the file with your browser from the above link. Internet browsers download files in
various ways, an example using the Firefox browser is shown below:

2. Locate the file you downloaded and run it.

If you are installing the editor for the first time, you will see the following two screens, click
'Install' to start the installation.

Agree to/modify the default locations and icon creation then click continue.

3. If you are upgrading from a previous version of the editor then you'll see the following
screen. Click 'Replace' to start the installation.

1.2 Initial Use of the Editor

The OVPQ Editor will then run and present you with the 'Login' screen.
On New Editor Installs - You will see the Login screen where you can either use your OVID
website login credentials to register the software or sign in as a Guest User.

On Upgrading the Editor - The editor will automatically log you in with your previous credentials.

The login and registration process will download all required details from the OVID website and
install them in the editor.
If template updates are required, the editor will prompt for which the password must be supplied
again. This can be deferred by clicking the cancel button if required.

2 Viewing the Vessel Fleet

On the 'Home' page, the editor will display a list of all OVPQs created in the editor for vessels
registered in your OVID account.

Highlighting a vessel (via a single click) will show two buttons

Actions - Open the editor screen, View PDF Rendition, Export to your local machine,
Archive or Delete the document.
Publish - Submit and publish the document (see the section Submitting/Publishing an
OVPQ document)

If a further vessel is added to your fleet in the OVID website click your logged in name in the top
menu and select 'Updates' to synchronise these details into the editor.

The OVPQ editor runs offline and consequently does not need an internet connection to open the
software and edit OVPQ documents which are already being edited on your computer. However,
an internet connection is required for the following activities:

Get updates
Download an existing OVPQ document from the OVID website
Submit/publish an OVPQ document to the OVID website

On each of these occasions you must enter only your password in the popup login box as the
account and user name are stored.

3 Creating an OVPQ document

3.1 Creation via an Existing User Account
To create an OVPQ document for one of your vessels click 'Create OVPQ' in the top menu.
The following screen shows a dropdown containing all your vessels and shows document details
for each vessel when selected: -

Select the vessel to create the OVPQ and click 'Create'. The dialogue below will appear; should
you wish to either clear out variants used when creating a vessel or previous data from an existing
OVPQ then select 'No' else select 'Yes'. Selecting 'yes' will require you to enter your password so
that the local OVPQ can be updated from the server.

3.2 Creation via Guest Account

You can create a brand new OVPQ using the Guest account form the Home page. You do not
have to be logged in for this task.

4 Editing the OVPQ

The Main OVPQ Editing screen will look similar to the image below: -

10

4.1 Top Menu

Save: the document is on a 10 second auto-save timer, however, this menu option can be
used to manually save the document
File: this will display a menu allowing you to import/export files on your local machine
without the need for an internet connection
Template: this menu option opens a window allowing the user to configure the vessel
operations and variants (see section below)
View/Print: this button displays a window to select the report output type (see section
below)
Spell check: spell checking is carried out automatically while editing or reviewing text
entered into a large text entry box (feature is not enabled for single line text entry boxes)
with suggested incorrect spelling being underlined (right click to review suggested
alternatives). This button displays a window within which all multi-line text boxes in the
questionnaire with suggested incorrect spelling are displayed.
Show progress: click here to display a window listing all sections in the questionnaire with
their completion status; whereby a green row is complete and a red row is incomplete.
Publish: click here to publish the OVPQ document.
Close: click here to close the editing screen and return to the home screen

4.2 Main Window

Document navigator: the left of the three central display panels shows a document navigator to
open the required chapter and click through the sections within. Sections in chapters will be
marked with either a green tick (section is complete) or red cross (section is incomplete).

11

Question list: the middle of the three central display panels shows a list of questions within the
section. If the question has been completed the response will be displayed below the question text
and a green tick will be shown.

Question response: the right of the three central display panels shows all information relevant to
the question and its response, including question number, question text, an appropriate collection
of controls appropriate to the type of question (e.g. yes/no, free text, numeric, date, etc.) and
comments.

12

4.3 Footer
Completion indicator: all questions, apart from additional comments, are mandatory. The progress
through the total number of mandatory questions is shown in the completion indicator.

Hide/show unanswered questions: this link toggles between whether or not a completed question
is shown in the question list

4.4 Selecting Variants

Select the 'Template' option from the main Editor screen to open up the variant wizard allowing you
to edit the vessel variants.

13

Click Next to go to the second screen and add selections for OVPQ Variants.

Click Finish to close the selection screen. The template is reconfigured and the correct chapters
and sections are displayed.

4.5 View or Print an OVPQ document

You can view and print a PDF of the OVPQ from the 'View/Print' menu option in the main Editor
screen or by selecting the 'Action' button on the vessel selection from the Home screen.
When selected from the main menu, you'll get the following options dialogue: -

From here you can select View Report which will generate a PDF for viewing or printing.

14

4.6 Submitting/Publishing an OVPQ document

Click 'Publish' from the OVPQ document editing screen or 'Publish OVPQ' from the vessel list on
the main screen to submit and publish the document. If the template variant definition process has
not yet been completed the OVPQ document cannot be submitted.
A popup window will request your password authentication to submit the OVPQ document. Upon
successful submission a message will display 'Report submitted'. The OVPQ document is now
made available to users of the OVID website in the form of a PDF.

15