Description
The Otalio Master plugin is designed to import crew data as well data on embarkation and disembarkation from Otalio to Adonis. On importing, the system creates the sea-service activity for uploaded crew.
The sea-service activity is created only in case Department and Position XREFs are correctly defined (for more information, see APM Configuration). Otherwise, records are imported to APM without activities.
Data Processing Rules
Otalio sends a list of crew members onboard a vessel. Adonis, in its turn, compares the existing list of crew members with the one received from Otalio and processes data based on the following rules:
Crew members existing in the Adonis crew list but not found in the Otalio crew list are disembarked. The disembarkation date is set to the current date.
In case a crew member’s department or position got changed, the system closes the current activity=Today() -1d and creates a new sea-service activity linked to the new department and position code.
If a crew member is not available in the Adonis database, the system adds a crew member as well as creates a sea-service activity (datefrom=embarkation.ActualDate, DateTo=Null, TodateEstimated=disembarkation.ScheduledDate).
If a crew member is already available in the Adonis database, only bio data is updated.
While importing crew members' records to APM, the system assigns crew their PIN numbers by considering the external CrewID (usually in the format: abc123456) and retrieving its numeric part. That means the abc123456 external Crew ID corresponds to the 123456 PIN number in APM.
Field Mapping
Otalio | Adonis | Comment |
|---|---|---|
CrewId | PIN | |
ProfileId | Otalio external PIN | |
dateOfBirth | Birth date | |
placeOfBirth | Place of birth | |
firstName | First name | |
lastName | Last name | |
MiddleName | Middle name | |
Gender | Sex | |
Nationality | Nationality | |
boardCardId | Crew card number store in the Alternative Pin field in the Personal Details datagroup. | |
embarkation.actualDate | Sea-service activity start date | |
disembarkation.scheduledDate | Sea-service activity planned end date | |
disembarkation.actualDate | Sea-service activity actual end date | |
operationalPosition.Code | XREF value of a position in the organization | For more information, see APM Configuration. |
operationalDepartment.Code | XREF value of a department in the organization | For more information, see APM Configuration. |
reservationId | Otalio ID number of the sea-service activity |
Housekeeping
The section covers the download, installation, and configuration procedures of the Otalio Master plugin.
http://download.adonis.no/files/upgrade/PersonnelManager/Plugins/Replicator/OTM/
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 parameter 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 Otalio Master plugin:
Name | Value |
|---|---|
SERVER_NAME | Address of the server hosting the APM database. |
DATABASE | Database name used when installing Adonis Personnel Manager. |
DEBUGLOG | 0 - for the debug information in Replicator only. 7 - for the extended log; adds debug information into the log and stores request/response in the debug folder. |
SERVICE_PSW | Service password. |
SERVICE_URL | URL to the Otalio service. |
SERVICE_USER | Otalio user name. |
XREF | Interface name identifying the XREF codes used by this plugin. For more information, see APM Configuration. |
XREF_SEX_U | Additional gender identification matching the APM value - [U] Unknown. |
XREF_SEX_N | Additional gender identification matching the APM value - [N] Non-binary. |
SHIPCODE | Otalio’s code of the current vessel. |
DEBUGDAYS | The request/response files are stored only for the specified number of days and then will be deleted. Note: If the DEBUGDAYS parameter is not defined, files will be stored within the current day only. |
ONB_CODE | Activity code identifying the sea-service activity. See General Codes > Activities to check the code. |
| Two new parameters will be added in the next version of Otalio Master plugin |
DEF_PAYTABLE | parameter for Payscale Table |
DEF_PAYCODE | Parameter for Payscale Code |
APM Configuration
Adonis uses the standard XREF functionality to link the Adonis lookup tables (General codes, Organization structure) to the corresponding code in Otalio.
To export data, it is required to define the Otalio Master plugin code reference. To do this, first, log in to 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.
Navigate to the Setup ribbon tab > General Codes > Personnel Details > Departments:
Select the department affected and click Open on the toolbar.
Switch to the XREF tab and click the Append button. Clicking the command enables the fields to be filled out:
Interface. Select the interface from the drop-down list. If the interface is unavailable, you need to define the interface by following the instructions in How to add an xref interface above.
Xref Code. Enter a cross-reference value of the 3rd party system
Comment. Enter any comment you want to add.
When completed, click OK to apply the changes.
The Department and Position XREFs are mandatory to be defined. Otherwise, a sea-service activity will not be created for imported crew.