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

Table of Contents
minLevel1
maxLevel7
excludeContents

Data Flow

Adonis is the master system with regard to maintaining crew data.

Crew Personal Details

...

/APWS_CU_Person

...

Crew Inspector Field

...

Sample Value

...

Description/Comments

...

XREF

...

Importance

...

Error/Text

...

Solution

...

Interface

...

CREWINSP

...

Find the Interface from PW001C112.CODE

...

General Codes > Miscellaneous > Interfaces

...

Status
colourGreen
titleMANDATORY

...

001, 002

...

201, 203

...

ExternalPIN

...

seaman_id

...

1725108

...

PW001P01_XREF

...

Status
colourGreen
titleMANDATORY

...

001, 002, 012

...

200; 203, 201

...

FirstName

...

seaman_name

...

SILVIA YANETH

...

 

Status
colourGreen
titleMANDATORY

...

001, 004, 006

...

200

...

MiddleName

...

middle_name

...

 

...

If not Null or ““ then 004, 006 else leave ““

...

200

...

LastName

...

seaman_surname

...

BANEGAS CARDENAS

...

 

Status
colourGreen
titleMANDATORY

...

001, 004, 006

...

200

...

CallingName

...

calling_name

...

SILVIA

...

 

...

If not Null or ““ then 004, 006 else leave ““

...

200

...

SuffixName

...

Not provided by CI

...

 

...

If not Null or ““ then 004, 006 else leave ““

...

200

...

Initials

...

Not provided by CI

...

 

...

If not Null or ““ then 004, 006 else leave ““

...

200

...

Title

...

Not provided by CI

...

 

...

If not Null or ““ then 015 else leave ““

...

200

...

Gender

...

sex

...

M

...

 

Status
colourGreen
titleMANDATORY

...

001, 006, 016

...

200

...

ExternalMaritalStatus

...

marital_status

...

Single

...

General Codes > Family > Marital Status Codes

...

 

...

If not Null or ““ then 002 else leave “

...

203, 201

...

Nationality

...

seaman_country

...

ESP

...

CI needs to use a standard 2 letter code

...

 

Status
colourGreen
titleMANDATORY

...

001, 004, 006

...

200

...

NativeLangauge

...

Not provided by CI

...

 

...

If not Null or ““ then 004, 006 else leave ““

...

200

...

BirthDate

...

pp_dob

...

08.11.1988

...

DD.MM.YYYY

...

 

...

If not Null or ““ then 008 else leave ““

...

200

...

PlaceOfBirth

...

pp_pob

...

VILLAJOYOSA - ALICANTE

...

 

...

If not Null or ““ then 004, 006 else leave ““

...

200

...

CountryOfBirth

...

pp_country_code

...

ESP

...

CI needs to use a standard 2 letter code

...

PWCOUNTRY

...

 

...

If not Null or ““ then 004, 006 else leave ““

...

200

...

ExternalHairColor

...

Not provided by CI

...

PW001C05

...

 

...

If not Null or ““ then 002 else leave ““

...

200

...

ExternalEyeColor

...

Not provided by CI

...

PW001C05

...

If not Null or ““ then 002 else leave “

...

200

...

Height

...

Not provided by CI

...

 

...

If not Null or ““ then 006 else leave “

...

200

...

Weight

...

Not provided by CI

...

 

...

If not Null or ““ then 006 else leave “

...

200

...

HomeAirport

...

primary_airport

...

IBIZA Airport

...

CI needs to define the XREF codes in the General Codes > Travel > Aiport

...

PW001C48

...

 

...

If not Null or ““ then 006 else leave “

...

200

...

TravelTime

...

Not provided by CI

...

 

...

If not Null or ““ then 006 else leave “

...

200

...

HomeAirport2

...

Not provided by CI

...

 

...

If not Null or ““ then 006 else leave “

...

200

...

TravelTime2

...

Not provided by CI

...

 

...

If not Null or ““ then 006 else leave “

...

200

...

ExternalRank

...

rank_id

...

75

...

PW001C02

...

If not Null or ““ then 002 else leave “

...

200

...

ExternalContractType

...

contract_type

...

PW001C32

...

If not Null or ““ then 002 else leave “

...

200

...

AddressLine1

...

primary_address

...

"C/ DEL FARO, 3 - P06- 6º\r\nSAN ANTONIO IBIZA SPAIN"

...

 

Status
colourGreen
titleMANDATORY

...

001, 006

...

200

...

AddressLine2

...

Not provided by CI

...

 

...

If not Null or ““ then 006 else leave “

...

200

...

AddressLine3

...

Not provided by CI

...

 

...

If not Null or ““ then 006 else leave “

...

200

...

AddressCountry

...

seaman_country

...

ESP

...

CI needs to use a standard 2 letter code

...

 

...

If not Null or ““ then 006 else leave ““

...

200

...

AddressPostcode

...

primary_postal_index

...

07820

...

 

...

If not Null or ““ then 004, 006 else leave ““

...

200

...

AddressPlace

...

Not provided by CI

...

 

...

If not Null or ““ then 006 else leave ““

...

200

...

Email

...

primary_email

...

davidbenlloch1@gmail.com

...

 

...

If not Null or ““ then 005, 006 else leave ““

...

200

...

Mobile

...

primary_mobile

...

600227138

...

 

...

If not Null or ““ then 006 else leave ““

...

200

...

Telephone

...

Not provided by CI

...

 

...

If not Null or ““ then 006 else leave ““

...

200

...

Organization

...

vessel_id

...

2335

...

vessel ID can be linked

...

Status
colourGreen
titleMANDATORY
 

...

001

...

200

Activities Data

...

/AUS_CU_Activities

...

Crew Inspector Field

...

Sample Value

...

Description/Comments

...

XREF

...

 Importance

...

Error / Text

...

Solution

...

Interface

...

CREWINSP

...

Find the Interface from PW001C112.CODE

...

PW001C112

...

Status
colourGreen
titleMANDATORY

...

001

...

200

...

ExternalPIN

...

seaman_id

...

114476

...

PW001P01_XREF

...

Status
colourGreen
titleMANDATORY

...

001

...

200

...

ExternalActivityID

...

id

...

1642608

...

 

Status
colourGreen
titleMANDATORY

...

001

...

201

...

ExternalActivityCode

...

ONB

...

If all imported activites are ONB, then we can just flag all ONB

...

Status
colourGreen
titleMANDATORY

...

001,002

...

SignOn

...

on_date

...

03.03.2019

...

DD.MM.YYYY

...

 

Status
colourGreen
titleMANDATORY

...

008

...

200

...

SignOff

...

off_date

...

15.04.2019

...

DD.MM.YYYY

...

 

...

008

...

200

...

SignOffEstimated

...

 

...

008

...

200

...

Onboard

...

Not provided by CI

...

 

...

VesselIMO

...

vessel_imo_no

...

9842774

...

 

Status
colourGreen
titleMANDATORY

...

001, 003, 006

...

200

...

ExternalPositionCode

...

rank_id

...

662

...

PW001C02

...

 

...

201

...

Comments

...

Not provided by CI

...

 

...

If not Null or “then 006 else leave ““

...

200

Competence Data

...

/AUS_CU_Competence

...

Crew Inspector Field

...

Sample Value

...

Description/Comments

...

XREF

...

 Importance

...

Error/Text

...

Solution

...

Interface

...

CREWINSP

...

Find the Interface from PW001C112.CODE

...

PW001C112

...

Status
colourGreen
titleMANDATORY

...

001

...

200

...

ExternalPIN

...

seaman_id

...

114476

...

Status
colourGreen
titleMANDATORY

...

001

...

200

...

ExternalDocID

...

cert_id

...

233

...

Status
colourGreen
titleMANDATORY

...

001, 019

...

200

...

ExternalDocType

...

cert_stcw_code

...

A-V/2, A-V

...

PW001C06

...

Status
colourGreen
titleMANDATORY

...

001, 002

...

200

...

DocumentNo

...

licence_number

...

CGECH-3347

...

Status
colourGreen
titleMANDATORY

...

001

...

200

...

DateFrom

...

from_date

...

31.08.2022

...

Status
colourGreen
titleMANDATORY

...

001, 008

...

200

...

DateTo

...

to_date

...

31.08.2027

...

 

...

if (Dateto=Null or ““) { Leave Null or ““
} else if (ExpiryDate=Null or ““) then {013
} else {008, 009
}

If DateTo is Not Null AND ExpiryDate is Null then copy the DateTo to ExpiryDate.

...

200

...

ExpiryDate

...

to_date

...

 

Status
colourGreen
titleMANDATORY

...

IssueBy

...

issuer

...

TEGUCIGALPA

...

 

...

If not Null or ““ then 006 else leave ““

...

200

...

IssuePlace

...

Not provided by CI

...

 

...

If not Null or ““ then 006 else leave ““

...

200

...

ValidInCountry

...

issuer_country

...

HND

...

CI needs to use a standard 2 letter code

...

 

...

If not Null or ““ then 004, 006 else leave ““

...

200

...

DocumentScanBase64

...

Base64 - Not provided by CI

...

 

...

DocumentFIleName

...

Disregard this, we can’t import just a filename.

...

 

...

If not Null or ““ then 014 else leave ““

...

200

...

Comments

...

Not provided by CI

...

 

...

If not Null or ““ then 006 else leave ““

...

200

Travel Data

...

/AUS_CU_Travel

...

Crew Inspector Field

...

Sample Value

...

Description/Comments

...

XREF

...

 Importance

...

Error/Text

...

Solution

...

Interface

...

CREWINSP

...

Find the Interface from PW001C112.CODE

...

PW001C112

...

Status
colourGreen
titleMANDATORY

...

001

...

200

...

ExternalPIN

...

seaman_id

...

114476

...

Status
colourGreen
titleMANDATORY

...

001

...

200

...

ExternalDocID

...

cert_id

...

105

...

Status
colourGreen
titleMANDATORY

...

001

...

200

...

ExternalDocType

...

cert_stcw_code

...

PW001C06

...

 

Status
colourGreen
titleMANDATORY

...

001, 002

...

201

...

DateFrom

...

from_date

...

22.11.2022

...

Status
colourBlue
titleMANDATORY / OPTIONAL

from PW001C23 Table

...

001, 008

...

200

...

DateTo

...

to_date

...

22.11.2027

...

 

Status
colourBlue
titleMANDATORY / OPTIONAL

from PW001C23 Table

...

If not Null or ““ then 008, 009 else leave ““

...

200

...

DocumentNo

...

licence_number

...

035851

...

Status
colourBlue
titleMANDATORY / OPTIONAL

from PW001C23 Table

...

001, 006

...

200

...

IssuedWhere

...

issuer_country_name

...

HONDURAS

...

 

...

If not Null or ““ then 006 else leave ““

...

200

...

IssuedBy

...

issuer

...

TEGUCIGALPA

...

 

...

If not Null or ““ then 006 else leave ““

...

200

...

Issuecountry

...

issuer_country

...

HND

...

CI needs to use a standard 2 letter code

...

 

Status
colourBlue
titleMANDATORY / OPTIONAL

from PW001C23 Table

...

If not Null or ““ then 004, 006 else leave ““

...

200

...

DocumentScanBase64

...

Base64 - Not provided by CI

...

 

...

DocumentFileName

...

Disregard this, we can’t import just a filename.

...

 

...

If not Null or ““ then 014 else leave ““

...

200

...

Comments

...

Not provided by CI

...

 

...

If not Null or “then 006 else leave ““

...

200

Medical Data

...

/AUS_CU_Medical

...

Crew Inspector

...

Sample Value

...

Description/Comments

...

XREF

...

 Importance

...

Error / Text

...

Solution

...

Interface

...

CREWINSP

...

Find the Interface from PW001C112.CODE

...

PW001C112

...

Status
colourGreen
titleMANDATORY

...

001

...

200

...

ExternalPIN

...

seaman_id

...

114476

...

Status
colourGreen
titleMANDATORY

...

001

...

200

...

ExternalDocID

...

cert_id

...

42

...

 

Status
colourGreen
titleMANDATORY

...

001

...

200

...

ExternalDocType

...

cert_stcw_code

...

Reg IV-2

...

PW001C06

...

 

Status
colourGreen
titleMANDATORY

...

001,002

...

201

...

DateFrom

...

from_date

...

14.02.2023

...

 

...

008

...

200

...

ExpiryDate

...

to_date

...

14.06.2025

...

If not Null or ““ then 008,009 else leave ““

...

200

...

IssuedBy

...

issuer

...

HONDURAS

...

 

...

If not Null or “then 006 else leave ““

...

200

...

Issuecountry

...

issuer_country

...

HND

...

CI needs to use a standard 2 letter code

...

 

...

If not Null or ““ then 004, 006 else leave ““

...

200

...

DocumentScanBase64

...

Base64 - Not provided by CI

...

 

...

200

...

DocumentFileName

...

Disregard this, we can’t import just a filename.

...

 

...

If not Null or “then 014 else leave ““

...

200

...

Comments

...

Not provided by CI

...

 

...

If not Null or “then 006 else leave ““

...

200

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

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

FirstName

middle_name

MiddleName

seaman_surname

Surname

calling_name

CallingName

sex

Gender

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

marital_status

ExternalMaritalStatus

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

seaman_country

Nationality

2 character country code

pp_dob

BirthDate

DD.MM.YYYY

pp_pob

PlaceOfBirth

DD.MM.YYYY

pp_country_code

CountryOfBirth

2 character country code

primary_airport

HomeAirport

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

rank_id

ExternalRank

Xref codes defined in General Codes > Personnel Details > Ranks.

contract_type

ExternalContractType

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

primary_address

AddressLine1

seaman_country

AddressCountry

2 character country code

primary_postal_index

AddressPostcode

primary_email

Email

primary_mobile

Mobile

Activities Data

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

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

id

ExternalActivityID

This is the Crewinspector's 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.

ExternalActivityCode

default ONB (onboard)

on_date

SignOn

DD.MM.YYYY

off_date

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.

Xref codes defined in General Codes > 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

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 Crewinspector's unique id identifying 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

ExternalDocType

Xref codes defined in General Codes > Competence > Competence Codes

licence_number

DocumentNo

DD.MM.YYYY

from_date

DateFrom

DD.MM.YYYY

to_date

DateTo

DD.MM.YYYY

to_date

ExpiryDate

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

issuer

IssueBy

Training center or certificate/document provider name

issuer_country

ValidInCountry

2 character country code

Travel 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 Crewinspector's unique id identifying 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

ExternalDocType

xref codes defined in General Codes > Travel Documents> Travel Documents Codes

from_date

DateFrom

DD.MM.YYYY

to_date

DateTo

DD.MM.YYYY

licence_number

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 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 Certificate exists, it will be updated; if not, it will be created.

cert_stcw_code

ExternalDocType

Xref codes defined in General Codes > Medical > Medical Codes

from_date

DateFrom

DD.MM.YYYY

to_date

DateTo

DD.MM.YYYY

issuer

IssueBy

Company or authority that issued the certificate or document.

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

...