Versions Compared

Key

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

Page Properties

Description

Export to OCIMF

Latest Version

2020.7.10.3

Release Date

Download Path

Download

Type

APM Plugin

Description

The SIRE Officer Metrix Interface plug-in is intended for collecting APM data and exporting it to OCIMF.

Table of Contents
minLevel1
maxLevel7
excludeContents

Functionality

This section will guide you through the procedure of exporting the required data to OCIMF / SIRE Officer Metric.

Exporting Data

On performing all the necessary setup as well as

assigning

assigning ranks and

competences

competencies to crew members, you can now export data to OCIMF / SIRE Officer Metric. For this,

simply switch

simply switch to the Tools ribbon bar and click the Export button. From the drop-down list, select the OCIMF / SIRE Officer Metric option to make the following dialog appear on the screen:

Image Removed
Image Added

Within the dialog, proceed as described below:

  1. On the toolbar, define the settings for crew selection:

    • Company. From the drop-down list, select the

company which
    • company to which crew members are linked

to
    • .

    • Vessel. From the drop-down list, select the vessel to which crew members are linked

to
    • .

    • Date From. Specify the date

 when
    •  when crew members are active (those with the Current onboard activity) on the selected vessel(s).

      Info

      The grid displays a list of crew members with the Current onboard activity only.


  1. Specify the records you would like to be exported by selecting the corresponding checkboxes. In addition, you can use the Tag All button to select all the records and Untag All to cancel the applied selection.

  2. Click Export to see the export in progress:
    Image Modified

    Info

    When exporting crew data, the plugin checks whether a document is available for the selected vessel in OCIMF. In case the document exists, it is used for exporting crew data. Otherwise, a new document is created.


  3. When successfully completed, click Close to finish.

Housekeeping

Before getting started with the plugin, cover the sections below to perform a one-time setup

. AnchorInterface Code SetupInterface Code Setup

.

Interface Code Setup

To

configure the

configure the SIRE Office Metric Interface plugin, go to

the 

the Setup

 ribbon

 ribbon tab

> 

General Codes

 > Miscellaneous > Interfaces and

 > Miscellaneous > Interfaces and proceed with the following steps:

  1. On the ribbon,

click 
  1. click New

 to
  1.  to make the dialog appear:

Image Removed

  1. Image Added
  2. Enter a Code (mandatory field), a unique alpha-numeric APM code.

  3. In

the 
  1. the Text

 field
  1.  field, indicate the name of an interface and its alternative name, if needed, in

the 
  1. the Alternative

 field
  1.  field.

  2. In

the 
  1. the Sort

 field
  1.  field, define the order number of a record (where 0 means the first record in the list).

  2. In

the 
  1. the Is Passive

 field
  1.  field, specify whether the code is to be active or passive. Passive codes appear as disabled. It is recommended to set a code to Passive if it will no longer be in use.

Click 
  1. Click OK

 to
  1.  to proceed.


As a result, a new record appears in the grid

of 

of Interfaces:

Image Modified

Connection Settings Configuration

To configure the SIRE Office Metric Interface connection settings, navigate to the

 Tools ribbon  button

 Tools ribbon tab and click the

 Export

 Export button. From the drop-down list,

select 

select OCIMF / SIRE Officer Metric. This opens the following dialog:

Image Removed
Image Added

Within the dialog, click the Settings button to view the dialog:

Image Modified 

Define the settings as described below:

  • OCIMF Service Url is a URL link to the OCIMF web service.

  • Secret Token is an authentication data that replaces user credentials. Tokens are issued via PDF for the exclusive use of a named vessel operator.

  • XREF Code is the OCIMF code name you have specified in

3660742829

Click Save to continue.

Rank Codes Setup

To configure the rank codes, go to

the 

the Setup

 ribbon

 ribbon tab

>  

General Codes

 

 > Personal Details

 >button

 > Rankand proceed with the following steps:

  1. Click the New

 
  1.  button in

the group
  1. the Actions

 
  1.  group of

the ribbon
  1. the Manage

 
  1.  ribbon tab.

The dialog
  1. The General Code Editor (Ranks)

 
  1.  dialog appears:
    Image Modified

  2. Create a new rank record by filling in the fields below:

    • Enter a Code 

Code 
    • (mandatory field), a unique alpha-

numeric 
    • numeric APM

 code
    •  code.

    • In the Text

 field
    •  field, indicate the name of an interface and its alternative name, if needed, in

the 
    • the Alternative

 field
    •  field.

    • In the Sort

 field
    •  field, define the order number of a record (where 0 means the first record in the list).

  1. Within the dialog, go to the Options tab > Interface - xref subtab and select the Q88/Officer Matrix option for the rank. The record automatically becomes passive.

    Info

    The export to the Q88 function enables users to compile all the data required for the Q88 site in the XML file that may be uploaded.


  2. Switch to the XREF tab and click

the 
  1. the Append

 button
  1.  button. Clicking the command enables the fields to be filled out:

    • Interface. Select OCIMF from the drop-down list. If the OCIMF selection is unavailable, you need to define the SIRE Office Metric interface by following the instructions

in 3660742829
    • in SIRE Officer Metrix Interface#Interface Code Setup.

    • Xref Code. Enter a cross-reference provided by OCIMF for this particular record.

      Info

      Xref codes are not random values, but those provided by OCIMF. It is recommended to make a cross references list agreed with OCIMF beforehand.


    • Comment. Enter any comment you want to add.
      Image Modified

  1. When completed, click OK to confirm the changes.

As a result, a passive rank record becomes available in the grid:

Image Removed
Image Added


Linking Ranks to Q88

You can now link an existing rank to the Q88 rank name. To do this, navigate to the Setup

 ribbon

 ribbon tab

>  

General Codes

 

 > Personal Details

 >

 > Ranks and double click the rank which you want to link to the Q88 rank name. This makes the dialog appear:
Image Modified

Within the dialog, follow the steps below:

  1. Navigate to the Options tab > the Interface - xref subtab.

  2. In the Q88/Officer Matrix drop-down list, select the rank code you have defined specifically for the code rank. The Q88/Officer Matrix drop-down list displays all rank records that you linked

to 
  1. to Q88/Officer Matrix interface.

  2. Click OK to save the changes

. AnchorCompetence Codes Setup

Competence Codes Setup

Competence Codes Setup

To configure the competence codes, go to

the 

the Setup

 ribbon

 ribbon tab

>  

General Codes > Competence

 >button

 > Competence Codes and proceed with the following steps:

  1. Click the New

 
  1.  button in

the group
  1. the Actions

 
  1.  group of

the ribbon
  1. the Manage

 
  1.  ribbon tab.

The dialog
  1. The General Code Editor (Competence)

 
  1.  dialog appears:
    Image Modified

  2. Within the dialog, create a new competence record by filling in the fields below:

    • Enter a

 Code
    •  Code (mandatory field), a unique alpha-

numeric 
    • numeric APM

 code
    •  code.

    • In the Text

 field
    •  field, indicate the name of an interface and its alternative name, if needed, in

the 
    • the Alternative

 field
    •  field.

    • In the Sort

 field
    •  field, define the order number of a record (where 0 means the first record in the list).

    • In the STCW Code field, enter a code that specifies the standard of competence achieved by a crew member.

  1. Within the dialog, go to the Options tab > the Details subtab and set the Document Type to Certificate of Competence:

Image Removed
  1. Image Added
  2. Switch to the XREF tab and click

the 
  1. the Append

 button
  1.  button. Clicking the command enables the fields to be filled out:

    • Interface. Select OCIMF from the drop-down list. If the OCIMF selection is unavailable, you need to define the SIRE Office Metric interface by following the instructions

in 3660742829
    • in SIRE Officer Metrix Interface#Interface Code Setup.

    • Xref Code. Enter a cross-reference provided by OCIMF for this particular record.

      Info

      Xref codes are not random values, but those provided by OCIMF. It is recommended to make a cross references list agreed with OCIMF beforehand.


    • Comment. Enter any comment you want to add.
      Image Modified

  1. When completed, click OK to confirm the changes.

As a result, a new competence record becomes available in the grid:

Image Removed
Image Added

Adding Proficiency Level Competence

To determine the proficiency level of English, you can create a competence with specific options. For this, go to

the 

the Setup

 ribbon

 ribbon tab

>  

General Codes > Competence

 >button

 > Competence Codes and follow the steps below:

  1. Click the New

 
  1.  button in

the group
  1. the Actions

 
  1.  group of

the ribbon
  1. the Manage

 
  1.  ribbon tab.

The dialog
  1. The General Code Editor (Competence)

 
  1.  dialog appears:
    Image Modified

  2. Within the dialog, create a new competence record by filling in the fields below:

    • Enter a Code 

Code 
    • (mandatory field), a unique alpha-

numeric 
    • numeric APM

 code
    •  code.

    • In the Text

 field
    •  field, indicate the name of an interface and its alternative name, if needed, in

the 
    • the Alternative

 field
    •  field.

    • In the Sort

 field
    •  field, define the order number of a record (where 0 means the first record in the list).

    • In the STCW Code field, enter a code that specifies the standard of competence achieved by the seafarer.

  1. Within the dialog, go to the Options tab > the Details subtab and set the Document Type to Language Proficiency:
    Image Modified

  2. Switch to the XREF tab and click

the 
  1. the Append

 button
  1.  button. Clicking the command enables the fields to be filled out:

    • Interface. Select OCIMF from the drop-down list. If the OCIMF selection is unavailable, you need to define the SIRE Office Metric interface by following the instructions

in 3660742829
    • in SIRE Officer Metrix Interface#Interface Code Setup.

    • Xref Code. Enter a cross-reference provided by OCIMF for this particular record.

      Info

      Xref codes are not random values, but those provided by OCIMF. It is recommended to make a cross references list agreed with OCIMF beforehand.

    • Comment. Enter any comment you want to add.
      Image Modified

  1. When completed, click OK to confirm the changes.

As a result, a new competence record becomes available in the grid:

Image Removed
Image Added


Now, you can create a competence with the defined competence code in the Competence datagroup for a selected crew member under the following conditions:

  • Crew members have the Current sea-service activities;

  • Crew members have the corresponding competence document for Rank.

Defining Certificate Options

Based on the certificate type you have defined in

3660742829

SIRE Officer Metrix Interface#Competence Codes Setup, you can define the options as described below. To do this, open the competence code which you want to define options for and switch to the Interface - xref subtab on the Options tab:
Image Modified

The following options are available:

  • Certificate of competence. For this certificate type, select one of the options: Class 1, Class 2, EOOW, OOW or None.

    Info

    The options are available only in case the Certificate of Competence document type has been set on the Details subtab.


  • STCW certificate. For this certificate type, define one of the options: Para 1, Para 2 or N/A.

    Info

    The options are available only in case the STCW option has been set on the Details subtab.


  • Radio Qualification Certificate. Select the option if the certificate relates to radio qualifications.

  • Is Tanker Certificate. Select the option if it is a Tanker Certificate. On selecting, the Tanker Certification options become available: Chemical, Gas, Oil, All/General.

  • Administrative Accepters / Endorsement certificate. Select the option if it is an endorsement certificate.

  • Watch Keeping Certificate. Select the option if it is a

watch keeping
  • watchkeeping certificate.

Nationality Setup

You can now determine nationality names. To do this, navigate to the Setup ribbon tab and click the Tables button. From the drop-down menu, select the Regions Editor option. The functionality becomes active from the Manage ribbon tab, where you can view the list of available countries as well as the corresponding nationality names:

Image Removed
Image Added

Make sure the nationality names in the grid

matches

match the names used by SIRE Office Metric Interface.

Installation

To install the plugin, navigate to Install APM Plugin and follow the step-by-step instructions carefully.

Access Rights

On installing the plugin, make sure that the access rights are granted to you. For this, log into Adonis Control Center and proceed with the following steps:

  1. Switch to the Plugins tab

  2. On the left-hand Security Levels pane, select the users' security levels you want to assign permissions to.

  3. In the working area, select the OCIMF/ SIRE Office Metric interface checkbox in the Enabled column:
    Image Modified

  4. Click Save on the ribbon.