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 | |
Type | Replicator Plugin |
Data Flow
Adonis is the master system with regard to maintaining crew data.
Crew Personal Details
| Crew Inspector Field | Sample Value | Description/Comments | XREF | Importance | Error/Text | Solution |
---|---|---|---|---|---|---|---|
Interface | CREWINSP | Find the Interface from PW001C112.CODE | General Codes > Miscellaneous > Interfaces | MANDATORY | 001, 002 | 201, 203 | |
ExternalPIN | seaman_id | 1725108 | PW001P01_XREF | MANDATORY | 001, 002, 012 | 200; 203, 201 | |
FirstName | seaman_name | SILVIA YANETH | MANDATORY | 001, 004, 006 | 200 | ||
MiddleName | middle_name |
| If not Null or ““ then 004, 006 else leave ““ | 200 | |||
LastName | seaman_surname | BANEGAS CARDENAS | MANDATORY | 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 | MANDATORY | 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 | MANDATORY | 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" | MANDATORY | 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 | |||
primary_email |
| 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 |
| 2335 | vessel ID can be linked | MANDATORY | 001 | 200 |
Activities Data
| Crew Inspector Field | Sample Value | Description/Comments | XREF | Importance | Error / Text | Solution |
---|---|---|---|---|---|---|---|
Interface | CREWINSP | Find the Interface from PW001C112.CODE | PW001C112 | MANDATORY | 001 | 200 | |
ExternalPIN | seaman_id | 114476 | PW001P01_XREF | MANDATORY | 001 | 200 | |
ExternalActivityID | id | 1642608 | MANDATORY | 001 | 201 | ||
ExternalActivityCode | ONB | If all imported activites are ONB, then we can just flag all ONB | MANDATORY | 001,002 | |||
SignOn | on_date | 03.03.2019 | DD.MM.YYYY | MANDATORY | 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 | MANDATORY | 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
| Crew Inspector Field | Sample Value | Description/Comments | XREF | Importance | Error/Text | Solution |
---|---|---|---|---|---|---|---|
Interface | CREWINSP | Find the Interface from PW001C112.CODE | PW001C112 | MANDATORY | 001 | 200 | |
ExternalPIN | seaman_id | 114476 | MANDATORY | 001 | 200 | ||
ExternalDocID | cert_id | 233 | MANDATORY | 001, 019 | 200 | ||
ExternalDocType | cert_stcw_code | A-V/2, A-V | PW001C06 | MANDATORY | 001, 002 | 200 | |
DocumentNo | licence_number | CGECH-3347 | MANDATORY | 001 | 200 | ||
DateFrom | from_date | 31.08.2022 | MANDATORY | 001, 008 | 200 | ||
DateTo | to_date | 31.08.2027 |
| if (Dateto=Null or ““) { Leave Null or ““ If DateTo is Not Null AND ExpiryDate is Null then copy the DateTo to ExpiryDate. | 200 | ||
ExpiryDate | to_date | MANDATORY | |||||
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
| Crew Inspector Field | Sample Value | Description/Comments | XREF | Importance | Error/Text | Solution |
---|---|---|---|---|---|---|---|
Interface | CREWINSP | Find the Interface from PW001C112.CODE | PW001C112 | MANDATORY | 001 | 200 | |
ExternalPIN | seaman_id | 114476 | MANDATORY | 001 | 200 | ||
ExternalDocID | cert_id | 105 | MANDATORY | 001 | 200 | ||
ExternalDocType | cert_stcw_code | PW001C06 | MANDATORY | 001, 002 | 201 | ||
DateFrom | from_date | 22.11.2022 | MANDATORY / OPTIONAL from PW001C23 Table | 001, 008 | 200 | ||
DateTo | to_date | 22.11.2027 | MANDATORY / OPTIONAL from PW001C23 Table | If not Null or ““ then 008, 009 else leave ““ | 200 | ||
DocumentNo | licence_number | 035851 | MANDATORY / 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 | MANDATORY / 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
| Crew Inspector | Sample Value | Description/Comments | XREF | Importance | Error / Text | Solution |
---|---|---|---|---|---|---|---|
Interface | CREWINSP | Find the Interface from PW001C112.CODE | PW001C112 | MANDATORY | 001 | 200 | |
ExternalPIN | seaman_id | 114476 | MANDATORY | 001 | 200 | ||
ExternalDocID | cert_id | 42 | MANDATORY | 001 | 200 | ||
ExternalDocType | cert_stcw_code | Reg IV-2 | PW001C06 | MANDATORY | 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 |
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:
On the left-hand side pane, select the service to which you got connected and navigate to Updatable programs.
In the Updatable programs node, select the plugin to be affected. Right under the selected plugin, select Plugin parameters.
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:
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 |
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:
On the ribbon, click New to make the dialog appear:
Enter a Code (mandatory field), a unique alpha-numeric APM code.
In the Text field, indicate the name of an interface and its alternative name, if needed, in the Alternative field.
In the Sort field, define the order number of a record (where 0 means the first record in the list).
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.
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: