Crew Inspector plugin
Description | The Crew Inspector plugin is designed to import data from the Crew Inspector platform. |
Latest Version | 2023.30.3.1 |
Release Date | Mar 5, 2024 |
Download Path | |
Type | Replicator Plugin |
Change Log:
- 1.1 Change Log:
- 2 Data Flow
- 2.1 Crew Personal Details
- 2.2 Activities Data
- 2.3 Various Documents
- 2.3.1 Competence Data
- 2.3.2 Travel Data
- 2.3.3 Medical Data
- 3 Housekeeping
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 |
| |
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
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.
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 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}.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 | 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 | 0 | 0 - No any debug output (default value) |
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: