Versions Compared

Key

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

Description

Replicator Plugin for import of crew data from Otalio to Adonis

Latest Version

2024.10.12.1

Release Date

18

Download Path

Download

Type

Replicator Plugin

Сhange Log: 

Expand

Version

Date

Description

2024.10.2.1

 

APMPI-1172

The Otalio Master plugin imports crew data from Otalio to Adonis and creates the sea-service activities for uploaded crew.

Note: The sea-service activity is created only in case Department and Position XREFs are correctly defined. Otherwise, records are not imported to APM.

APMPI-1173

Added new mandatory parameters to the Otalio Master plugin:

  • DEF_PAYTABLE is a parameter for Payscale Table

  • DEF_PAYCODE is a parameter for Payscale Code

image-20240415-153801.pngImage Added

APMPI-1175

While importing crew members' records to APM, the system assigns crew their PIN numbers by considering the external CrewID (in formats: abc123456, .abs123456, .123456) and retrieving its numeric part. That means the abc123456 external Crew ID corresponds to the 123456 PIN in APM.

Description

The Otalio Master plugin is designed to import crew data as well as data on embarkation and disembarkation from Otalio to Adonis. On importing, the system creates the sea-service activity for uploaded crew.

Info

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 not 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 formatformats: abc123456, .abc123456) and retrieving its numeric part. That means the abc123456 external Crew ID corresponds to the 123456 PIN number in APM.

  • After the activity confirmation, the payroll information (payroll table and code) is fetched from the Contracts datagroup or Personal Details > the Seniority tab (in case the Contracts datagroup is not in use).

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 stored 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

...

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:

...

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

...

Anchor
APM_Configuration
APM_Configuration
APM Configuration

...

Expand
titleLink Lookup Table to 3rd Party Interface
  1. Navigate to the Setup ribbon tab > General Codes > Personnel Details > Departments:

  2. Select the department affected and click Open on the toolbar.

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

      OTM_code_editor_department.jpg

  4. When completed, click OK to apply the changes.

Info

The Department and Position XREFs are mandatory to be defined. Otherwise, a the sea-service activity will not be created for imported crewand crew data will not be imported.