Skip to end of banner
Go to start of banner

Crew Inspector plugin

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 3 Next »

Description

The Crew Inspector plugin is designed to import data from the Crew Inspector platform.

Latest Version

2023.30.1.1

Release Date

Download Path

Download

Type

Replicator Plugin

Data Flow

The information is one-directional and flows from CrewInpector to Adonis

Crew Personal Details

Crew Inspector Field

Adonis

Comment

seaman_id

External id used to identify the pin. The seamans id is stored in PW001P01_XREF linking it to the Adonis Pin

seaman_name

First Name

middle_name

Middle Name

seaman_surname

Surname

calling_name

Calling Name

sex

Sex

marital_status

Marital Status

Xref codes defined in General Codes > Family > Marital Status Codes

seaman_country

Nationality

2 character country code

pp_dob

Birth day

pp_pob

Place of Birth

pp_country_code

Country of birth

2 character country code

primary_airport

Airport

Expecting the standard 3 char airport code, from CrewInpector, if this can not be provided the end user need to define xref codes in the general codes airports

rank_id

Rank

xref codes defined in General Codes > personnel Details > Ranks.

contract_type

Contract

Xref codes defined in General Codes > Personnel Details > Contract Types

primary_address

Address Line 1

seaman_country

Address Country

2 character country code

primary_postal_index

Postcode

primary_email

email

primary_mobile

mobile

Activities Data

From CrewInspector, we only receive onboard / sea service activities.

Crew Inspector Field

Adonis

Comment

seaman_id

External id used to identify the pin. The seamans id is stored in PW001P01_XREF linking it to the Adonis Pin

id

This is the Crewinspectors unique id identifying an “activity”

The activity sequence nr is found using the xref table PW001P00_XREF if exist the activity exist and will be updated if not it will be created.

on_date

Datefrom

off_date

DateTo

Crew inpector does not provide estimated end date or a flag that the person is still onboard.

vessel_imo_no

The IMO number is used to find the correct vessel in the organization structure.

rank_id

This need to be valid rank in the rank table. Once the rank is found the system uses to find the proper position

xref codes defined in General Codes > personnel Details > Ranks.

Various Documents

In CrewInspector the travel book, competences and medical certificates are all stored in the same table. The CrewInspector fields are similar for all these datagroups.

Competence Data

Crew Inspector Field

Adonis

Comment

seaman_id

External id used to identify the pin. The seamans id is stored in PW001P01_XREF linking it to the Adonis Pin

cert_id

This is the Crewinspectors unique id identifying an “Competence”

The competence sequence nr is found using “cert_id” in the xref table PW001P00_XREF. If the competence exists, it will be updated; if not, it will be created.

cert_stcw_code

Competence Code

xref codes defined in General Codes > Competence > Competences

licence_number

Document No

from_date

Date From

to_date

Date To

to_date

Expiry Date

The crew inpector to date is both used for the expiry date and the date to.

issuer

Issue By

issuer_country

Valid in country

2 character country code

Travel Data

Crew Inspector Field

Adonis

Comment

seaman_id

External id used to identify the pin. The seamans id is stored in PW001P01_XREF linking it to the Adonis Pin

cert_id

This is the Crewinspectors unique id identifying an “Travel Book”

The travelbook sequence nr is found using “cert_id” in the xref table PW001P00_XREF. If the travelbook exists, it will be updated; if not, it will be created.

cert_stcw_code

Travel Book Code

xref codes defined in General Codes > Travel> Travel Books

from_date

Date From

to_date

Date To

licence_number

Document No

issuer_country_name

IssuedWhere

issuer

IssuedBy

issuer_country

IssueCountry

2 character country code

Medical Data

Crew Inspector

Adonis

Comment

seaman_id

External id used to identify the pin. The seamans id is stored in PW001P01_XREF linking it to the Adonis Pin

cert_id

This is the Crewinspectors unique id identifying an “Medical Certificate”

The Medical Certificate sequence nr is found using “cert_id” in the xref table PW001P00_XREF. If the Medical Certificae exists, it will be updated; if not, it will be created.

cert_stcw_code

Medical Certificate Code

xref codes defined in General Codes > Medical > Medical Certificates

from_date

Date From

to_date

Date To

issuer

IssueBy

issuer_country

Issue Country

2 character country code

Housekeeping

The section covers the download, installation, and configuration procedures of the Crew Inspector plugin.

http://download.adonis.no/files/upgrade/PersonnelManager/Plugins/Replicator/CIS/

Installing Plugin

Once the download is complete, follow the link below to get the instructions on how to install the plugin:

Installing and distributing the Replicator plug-in

Setting Parameters

After the plugin is installed, it is necessary to specify parameters for the Site(s). To do this, follow the steps below:

  1. On the left-hand side pane, select the service to which you got connected and navigate to Updatable programs.

  2. In the Updatable programs node, select the plugin to be affected. Right under the selected plugin, select Plugin parameters.

  3. In the Update parameters workspace, select the Site for which you want to add parameters and click the Add button. Clicking the command displays the Add new command dialog where you can enter the parameters one by one:

  4. On entering, click OK to proceed.

Below, you will find the description of parameters required for the Crew Inspector plugin:

Name

Value

Description

SITEID

CANDINA

This will be the siteid value for the service URL.

SERVICE_URL

https://{SiteId}.crewinspector.com

Enter the URL of Crew Inspector

SERVICE_USER

balearia

Enter the username of Crew Inspector

SERVICE_PSW

9fa9cec1

Enter the password to the service.

SERVER_NAME

Specify the server name to which to connect.

AUS_URL

Adonis Upload Service URL

AUS_LOGIN

Adonis_API

Adonis Upload Service Login

AUS_PWD

Adonis Upload Service Password

DATABASE

DB1

Enter the database name to be used.

INTERFACE_NAME

CREWINSP

Enter the interface name defined in APM Setup/General Codes/Miscellaneous/Interfaces

The plugin will search for this value in the C112 table.

This interface_name will be visible in the waitingroom plugin as well.

TRUNCDAYS

30

Default 30. Define the number of days after which the log file will be truncated.

DEBUGLOG

1

0 - No any debug output
1 - Add debug info into log
2 - Store request/response in the debug folder
3 - Add debug info into log & Store request/response in the debug folder

Crew Inspector Code Setup

To import data, it is required to define the Crew Inspector plugin code reference. To do this, first, log into the Adonis Personnel Manager. Once logged in, navigate to the Setup ribbon tab > General Codes > Miscellaneous > Interfaces and proceed with the following steps:

  1. On the ribbon, click New to make the dialog appear:

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

  3. In the Text field, indicate the name of an interface and its alternative name, if needed, in the Alternative field.

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

  5. In the Is Passive 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.

  6. Click OK to proceed.

As a result, a new record appears in the grid of Interfaces:

Scheduler Setup

Once the plugin is successfully installed, select the Crew Inspector plugin in the Scheduler node on the in left-hand pane, and set the desired scheduler options on the workspace:

On setting the scheduler, select the Crew Inspector plugin in the Status node on the left-hand pane to see the import results:

  • No labels