Versions Compared

Key

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

Description

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

Latest Version

20232024.3010.12.1

Release Date

Download Path

Download

Type

Replicator Plugin

Change Log: 

Expand

Version

Date

Description

2023.30.2.1

 

APMPI-1107

Added the ORGANIZATION field to the REPL Setup. All persons are linked to ORGANIZATION

2023.30.3.1

APMPI-1123

Changed the SignOff field to off_date and the EstimatedSignOff field tobest_off_date. Now, the system allows to import activities with Date To in the future as well as Planned activities.

APMPI-1138

The HomeAirport parameter is excluded from the request of the Crew Inspector plugin.

2024.10.2.1

APMPI-1153

Updated the connection to AUS. Within the framework of the task, the following changes are made:

  1. Added the AUS_API_KEY parameter.

  2. Removed the AUS_LOGIN, AUS_PWD parameters.

  3. Removed the Authentication_Token field from the request.

Table of Contents
minLevel1
maxLevel7
excludeContents

Data Flow

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

Crew Personal Details

Crew Inspector

Field

Adonis

Comment

seaman_id

ExternalPIN

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

FirstName

middle_name

Middle Name

MiddleName

seaman_surname

Surname

calling_name

Calling Name

CallingName

sex

Sex

Gender

Limited to M=Male; F=Female; U=Unknown; N=Non-binary

marital_status

Marital Status

ExternalMaritalStatus

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

seaman_country

Nationality

2 character country code

pp_dob

Birth day

BirthDate

DD.MM.YYYY

pp_pob

Place of Birth

PlaceOfBirth

DD.MM.YYYY

pp_country_code

Country of birth

CountryOfBirth

2 character country code

primary_airport

Airport

HomeAirport

Expecting the standard 3 char airport code, from

CrewInpector

CrewInspector, if this can not be provided the end user need to define xref codes in the general codes airports

rank_id

Rank

ExternalRank

xref

Xref codes defined in General Codes >

personnel

Personnel Details > Ranks.

contract_type

Contract

ExternalContractType

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

primary_address

Address Line 1

AddressLine1

seaman_country

Address Country

AddressCountry

2 character country code

primary_postal_index

Postcode

AddressPostcode

primary_email

email

Email

primary_mobile

mobile

Mobile

Activities Data

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

Crew Inspector

Field

Adonis

Comment

seaman_id

ExternalPIN

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

id

ExternalActivityID

This is the

Crewinspectors

Crewinspector's unique id identifying an

“activity”

“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.

ExternalActivityCode

default ONB (onboard)

on_date

Datefrom

SignOn

DD.MM.YYYY

off_date

DateTo

SignOff

DD.MM.YYYY

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

vessel_imo_no

VesselIMO

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

rank_id

ExternalPositionCode

This need to be valid rank in the rank table.

Once the rank is found the system uses to find the proper position xref

Xref codes defined in General Codes >

personnel

Personnel Details > Ranks.

Various Documents

Info

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

ExternalPIN

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

cert_id

ExternalDocID

This is the

Crewinspectors

Crewinspector's unique id identifying

an

a “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

ExternalDocType

xref

Xref codes defined in General Codes > Competence >

Competences

Competence Codes

licence_number

Document No

DocumentNo

DD.MM.YYYY

from_date

Date From

DateFrom

DD.MM.YYYY

to_date

Date To

DateTo

DD.MM.YYYY

to_date

Expiry Date

ExpiryDate

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

issuer

Issue By

IssueBy

Training center or certificate/document provider name

issuer_country

Valid in country

ValidInCountry

2 character country code

Travel Data

Crew Inspector

Field

Adonis

Comment

seaman_id

ExternalPIN

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

cert_id

ExternalDocID

This is the

Crewinspectors

Crewinspector's unique id identifying

an “Travel Book”

a “TravelBook”.

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

ExternalDocType

xref codes defined in General Codes >

Travel>

Travel Documents> Travel

Books

Documents Codes

from_date

Date From

DateFrom

DD.MM.YYYY

to_date

Date To

DateTo

DD.MM.YYYY

licence_number

Document No

issuer_country_name

IssuedWhere

DocumentNo

Unique license/document number of the certificate/document.

issuer

IssuedBy

Company or authority that issued the travelbook

issuer_country

IssueCountry

2 character country code

Medical Data

Crew Inspector

Adonis

Comment

seaman_id

ExternalPIN

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

cert_id

ExternalDocID

This is the

Crewinspectors

Crewinspector's 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

Certificate exists, it will be updated; if not, it will be created.

cert_stcw_code

Medical Certificate Code

ExternalDocType

xref

Xref codes defined in General Codes > Medical > Medical

Certificates

Codes

from_date

Date From

DateFrom

DD.MM.YYYY

to_date

Date To

DateTo

DD.MM.YYYY

issuer

IssueBy

Company or authority that issued the certificate or document.

issuer_country

Issue Country

Issuecountry

2 character country code

Housekeeping

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

...

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

Name

Value

Description

SITEID

CANDINA

This will be the siteid value for the service URL.

ORGANIZATION

CAN001FF

This is unique id reserved for the customer of Crew Inspector, it will be mapped to the XREF_CODE of the ORGANIZATION in APM.

SERVICE_URL

https://{

SiteId

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

https://yourdomain.com/AIWS/AdonisIntegrationWebService.svc/

Adonis Upload Service URL

AUS_LOGIN

Adonis_API

Adonis Upload Service Login

AUS_PWD

Ado*****

Adonis Upload Service Password

DATABASE

DB1

Enter the Adonis 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

0 - No any debug output (default value)
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

...

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

    Image RemovedImage Added

  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.

...