Description	Integration with Otalio - Ship Property Management System
Latest Version	2024.10.1.1
Release Date	Jan 31, 2024
Download Path	Download
Type	Replicator Plugin

Change Log:

Version	Date	Description

Version	Date	Description
2023.10.2.1	Jun 27, 2023	APMPI-948 - While exporting records containing more than one activity per person in the same reservation, the system fetches only the first record in the sequence. Once the activity status changes to Embarked in the Otalio interface, it then becomes Current in the Otalio replicator plugin.
2023.10.3.1	Jul 5, 2023	APMPI-956 - Fixed problem with sending Xref codes for hair and eyes colors to Otalio.
2023.10.4.1	Jul 18, 2023	APMPI-966 - From now plugin will send null in the telecommunication information if it`s empty in APM APMPI-976 - Adjusted plugin`s functionality when there is no proper answer from Otalio: The plugin will skip sending the crew data if no status of transaction is received; The message in the log will give the information about skipping. APMPI-977 - Fixed error Object reference not set to an instance of an object, when the plugin send telecommunication information, but the addresses are empty,
2023.10.5.1	Jul 19, 2023	APMPI-979 - Added field BOARDING_CARD_EXT=PIN while sending reservations APMPI-982 - Fixed “Object reference not set to an instance of an object” error when crew has P01.Sex=Null. APMPI-984 - Improvements for the process, when Otalio response include indefinite status of transaction: From now the plugin will wait for the proper transaction status, while inserting Profile; Pin will be skipped and message about it will be shown in the log, if the plugin will not receive proper status;
2023.10.6.1	Aug 18, 2023	APMPI-967 - Added Embarkation and Disembarkation reasons to the Otalio synchronization process. Embarkation reason works in both directions; Disembarkation reason can be received from Otalio, but cannot be sent from APM; For the Promotions: - Embarkation reason will be fetched to PromotionFrom activity; - Disembarkation reason will be fetched to PromotionTo activity; APMPI-981 - Fixed the problem when two Otalio plugin instances cannot work on the same machine APMPI-986 - The way of the data processing was totally redeveloped. From now reservations will be sent from the first try. For more details please check release notes for the ticket APMPI-955 APMPI-995 - Entirely redeveloped the way of the data processing Earlier: The plugin was checking the statuses of the previously sent transactions exactly after sending; From now: The plugin will check the statuses of the previously sent transactions during the next launch of the plugin. Due to this, the performance of the plugin was significantly increased. And it also covered the situations when Otalio service did not have enough time to process the data, which could have lead to the interruption of the synchronization process. Pending transactions ids are stored in the PWOTALIOTX and PWOTALIOTX_POS; By default transactions ids will be stored 1440 minutes, but if needed TX_LIVE parameter can be used to increase or decrease default time. For example if value 100 defined for TX_LIVE parameter, then transactions ids will be stored 100 minutes. APMPI-994 - Fixed the case, when non-seaservice activities could have been a part of the synchronization process. APMPI-999 - Added the Cabin allocation numbers, linked to the persons, to the synchronization process. Cabin allocation numbers can be sent from APM to Otalio only.
2024.10.1.1	Jan 31, 2024	APMPI-978 - Implemented the possibility to exchange photos between Otalio and APM. To do this, follow the steps below: Add a photo. Launch the plugin. Check the log file on sending and receiving photo. Note: Exchanging photos in batch is implemented as well. APMPI-988 - Modified the log entries in the Otalio plugin: DATABASE parameter not defined DAYSGAP parameter not defined DAYSGAP parameter has invalid format DEBUGDAYS parameter has invalid format DEBUGLOG parameter has invalid format SERVER_NAME parameter not defined SERVICE_PSW parameter not defined SERVICE_URL parameter not defined SERVICE_USER parameter not defined STATIC_ID parameter not defined TX_LIVE parameter has wrong format XREF_ADDRESS_TYPE parameter not defined XREF_ADDRESS_TYPE has other value than G or E XREF_SEX_N parameter not defined XREF_SEX_U parameter not defined XREF parameter not defined XREF parameter has value which not exist in cross-reference table 018 Error: Database connection failed APMPI-1007 - Implemented the possibility to restrict the number of records stored in the plugin folder. For this, set the DEBUGDAYS parameter and enter the number of days for the records to be stored: The request/response files are now 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 for the current day only. APMPI-1085 - After signing off a crew member in Otalio and sending this data to Adonis, the existing activity is set to Historical. The next activity is created based on the following logic: The next seaservice activity is not set to Current after signoff of the previous one, if there is a timegap between the activities. The next seaservice activity created on another vessel is not set to Current after signing off the previous one. The next seaservice activity on the same vessel is set to Current after signing off the previous one, if there is no timegap between the activities. APMPI-1094 - The Otalio plugin keeps processing crew data after receiving the message: PROFILE_ID does not exist: The plugin stores a proper message in the log after receiving PROFILE_ID which is not available in APM. APMPI-1097 - Fixed the error while processing crew data containing characters. From now on, the Otalio plugin can process any characters being part of the crew data. Besides, the plugin keeps processing crew data even after encountering errors.

Description

Otalio is a Ship Property Management System, (SPMS) which is integrated with various revenue-facing applications such as Point-of-Sales (POS), Spa, Excursions, and Fine Dining. The system handles primarily passengers and to some extent, crew members when it comes to cabin allocation, embarking and disembarking crew.

Functionality

Adonis is responsible for generating new employees, managing demographics, and planning crew rotation. However, the specific tasks related to confirming embarkation and disembarkation are handled by Otalio.

The Adonis interface covers all crew members who are either scheduled to go onboard or are currently onboard (Planned or Current activities). To ensure efficiency, an end user sets a timeframe for planned activities. This means that only individuals scheduled to go on board shortly, within the specified number of days, are included.

Data Flow

This plugin does not support deletion of information, meaning that deleted information is not synchronized. This however is not an issue, the information is mandatory and the new data entered will synchronize both systems.

Personal Details

Adonis	Otalio	Direction	XRef Code

Adonis	Otalio	Direction	XRef Code
Pin	Crew ID	Adonis → Otalio
FirstName	First Name	Adonis ↔︎ Otalio
lastName	Last Name	Adonis ↔︎ Otalio
MiddleName	Middle Name	Adonis ↔︎ Otalio
EyeColor	Eye Color	Adonis ↔︎ Otalio	Yes
HairColor	Hair Color	Adonis ↔︎ Otalio	Yes
Height	Height	Adonis ↔︎ Otalio
Weight	Weight	Adonis ↔︎ Otalio
Gender	Gender	Adonis ↔︎ Otalio
Marital Status	Marital Status	Adonis ↔︎ Otalio	Yes
BirthDate	Date of Birth	Adonis ↔︎ Otalio
Place of Birth		Adonis ↔︎ Otalio
Country of Birth		Adonis ↔︎ Otalio
Nationality	Birth Nation	Adonis ↔︎ Otalio
OtherCitizenship		Adonis ↔︎ Otalio
Address (Country)	Country	Adonis ↔︎ Otalio
Address (Postcode)	ZIP Code	Adonis ↔︎ Otalio
Address Line 1	Street 1	Adonis ↔︎ Otalio
Address Line 2	Street 2	Adonis ↔︎ Otalio
Address Line 3	Street 2 (so far)	Adonis ↔︎ Otalio
Post Place	City	Adonis ↔︎ Otalio
County (State)	State	Adonis ↔︎ Otalio
Home Phone (Teletype = 2)	Phone call	Adonis ↔︎ Otalio
Mobile Phone (Teletype = 3)		Adonis ↔︎ Otalio
Email (Teletype = 6)		Adonis ↔︎ Otalio

Travel Books Information (Passport/Visa)

In Adonis, the end-user can retain historical travel books that have expired. Among these passports, the valid one is determined based on the latest/newest expiry date.

Travel books can be added and maintained by Otalio.

Only travel books linked to cross-reference codes are interfaced with Otalio.

In Otalio, there are distinct fields for the name and birth date/place information for each travel document. These fields are filled automatically by the interface, which facilitates a one-way data transfer from Adonis to Otalio.

Adonis	Direction	XRef Code

Adonis	Direction	XRef Code
Code	Adonis ↔︎ Otalio	Yes
Travel Book nr	Adonis ↔︎ Otalio
Issue Country	Adonis ↔︎ Otalio
Date From	Adonis ↔︎ Otalio
Date To	Adonis ↔︎ Otalio
Last Name	Adonis → Otalio
First Name	Adonis → Otalio
Middle Name	Adonis → Otalio
Place of Birth	Adonis → Otalio
Date of Birth	Adonis → Otalio

Please note, that in Otalio the list of Travel codes is hardcoded. Any newly added code to Adonis should be sent to Otalio.

Sea-service Records (Reservations in Otalio)

Based on the look-ahead parameter, the system finds all persons assigned to a current and planned service for the particular period ahead. However, the actual embarkation and disembarkation procedures are exclusively handled by Otalio.

Adonis	Direction	XRef Code	Seaservice

Adonis	Direction	XRef Code	Seaservice
Activity Code	Adonis → Otalio		Current & Planned
DateFrom	Adonis ↔︎ Otalio		Planned
Embarkation Port (Crew change module)	Adonis → Otalio		Current & Planned
Estimated End Date	Adonis → Otalio		Current & Planned
Disembarkation Port (Crew change module)	Adonis ↔︎ Otalio		Current & Planned
Department	Adonis → Otalio	Yes (from general codes )	Planned
Position	Adonis → Otalio	Yes (from general codes )	Planned
Vessel	Adonis → Otalio	Yes (from Organization)	Planned
Cabin	Adonis → Otalio		Current & Planned

Embarking

During the embarking process, the planned sea service of a person is validated by changing the activity status from Planned to Current in the interface.

Disembarking

When it comes to disembarking, once Otalio confirms the actual sign-off, the interface updates the date field and moves the activity from Current to Historical. The next activity is created based on the following logic:

The next seaservice activity is not set to Current after the signoff of the previous one if there is a time gap between the activities.
The next seaservice activity created on another vessel is not set to Current after signing off the previous one.
The next seaservice activity on the same vessel is set to Current after signing off the previous one, if there is no time gap between the activities.

Promotion

The contrast between activities (Adonis) and reservations (Otalio) lies in Adonis having 1 or more subsequent activities as part of an onboard service, while Otalio only has a single reservation.
Given the intricacy of the sign-on and sign-off procedure, Otalio cannot execute promotions by creating a new subsequent reservation alone.
This contrast results in Promotions being exclusively managed in Adonis, with no communication to Otalio.

The promotion process
Promotion activities are not sent to Otalio. The Otalio reservation remains linked to the initial activity that created it.
Embarking: Only updates the first activity in the subsequent activities, indicating the onboard service. This activity began the reservation.
Note! The promotions must and can be confirmed in Adonis only
Disembarking: If the initial activity isn't the current activity, the system locates the subsequent current activity and sets the date in the designated field. If there are any planned activities at this time that indicate a planned promotion, they will be disregarded.

Embarkation/Disembarkation reasons handling.

Embarkation reason works in both directions.
Disembarkation reason is received from Otalio, but not sent from Adonis.

Housekeeping

This section will walk you through the installation and configuration of the Otalio plugin.

Otalio Replicator Plugin

The section covers the Otalio plugin's download, installation, and configuration procedures.

Download

http://download.adonis.no/files/upgrade/PersonnelManager/Plugins/Replicator/OTL/

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

Plugin Parameters

A plug-in will request specific parameters like authentication details, server URL, names, etc. These parameters are different from plug-in to plug-in. Before scheduling the plug-in, the administrator needs to set the correct parameters.

Expand the plug-in and select plugin parameters in the right panel of the replicator manager.

In the right-hand screen, select the site and add the parameters manually.

Plugin-specific Parameters for Otalio

Name	Value

Name	Value
SERVER_NAME	Address of server hosting the APM database
DATABASE	Database Name
DAYSGAP	Interval in days from today’s date in which the system fetches the Planned activities.
SERVICE_URL	URL to Otalio service
SERVICE_USER	Otalio user
SERVICE_PSW	Password
XREF	Interface name identifying the XREF codes used by this plugin.
DEBUGLOG	Enter a numeric value to define the log to be managed: 0 - No any debug output 1 - Add debug info into log 2 - Store request/response in the debug folder 3 - Add debug info into log and store request/response in the debug folder 7 - Write extended log to data folder of the plugin
STATICID	Use the following: bf495c3dd44511eb850d0b9704da43d3
XREF_ADDRESS_TYPE	<Defaut Value 'G'> identifying Otalio ADDRESS_TYPE
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
DEBUGDAYS	The request/response files are now 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.
TX_LIVE	Interval in minutes identifying how long a transaction is stored in the PWOTALIOTX / PWOTALIOTX_POS tables.
TRUNCDAYS	Enter the number of days after which the otalio.log file will be replaced with a new one. Note: In case the parameter is not defined, the otalio.log file will not be replaced.
DEF_PAYTABLE	parameter for Payscale Table
DEF_PAYCODE	Parameter for Payscale Code

APM Configuration

Lookup tables

Adonis and Otalio are using different lookup values. We use the XREF functionality in APM to ensure that information sent and received from Otalio is interpreted correctly. Before assigning the cross-reference codes, we need to create an interface. Once created, add the interface name to the plugin parameter XREF. See the table above.

See the dataflow tables to find what lookup tables are used. They are identified with Yes in column XREF.

Country and Ports

Both systems use the two-letter code as defined in the ISO 3166 Alpha-2 standard to identify a country.
e.g. NO, SE, US, etc.

For ports, we use the three-character port code, starting with the two-character country code:

E.g. Rotterdam => NLRTM, Newyork = USNYC

Adding the Otalio Cross Reference Codes (xref)

We use the standard XREF functionality to link the Adonis lookup tables ( General codes, organization structure) to the corresponding code in Otalio.

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. Setting a code to Passive is recommended if it is no longer in use.
In the APP Modules field, select the Adonis Personal Portal module(s) where you want to use the code.
Click OK to proceed.

Navigate to the Setup ribbon tab > General Codes > Competence > Competence Codes:
Select the competence 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.

Navigate to the Setup ribbon tab and click the Organization structure button.
In the Organization tree-view structure, select the vessel which you want to link.
Select Properties > XRef on the left-hand pane:
Click the Append button at the bottom of the page. Clicking the button enables the fields to be filled out:
- Interface is a plugin name. Select it from the drop-down list.
- Xref Code is the 3 party system name usually provided by the system itself.
- Comment is any comment you want to add.
Click Save on the toolbar.

Change Request

Add more parameters in the Otalio Master Plugin

Added new mandatory parameters:
DEF_PAYTABLE - parameter for Payscale Table; DEF_PAYCODE - Parameter for Payscale Code;
The plugin will set PW001P03.PAYSCALETABLE=DEF_PAYTABLE for each imported activity;
The plugin will set PW001P03.PAYSCALE=DEF_PAYCODE for each imported activity;
The plugin will set PW001P0P.PAYSCALETABLE=DEF_PAYTABLE for each imported person;
The plugin will set PW001P0P.PAYSCALECODE=DEF_PAYCODE for each imported person;

Questions/ Answers

Questions	Answers	Comment

Questions	Answers	Comment

Plug-ins User Documentation

Otalio Integration