Seaware plugin
- Viktoria Karakiko
- yuriy.biryukov
- Artem Finkelshtein
Description | Export crew data to the Seaware platform. |
Latest Version | 2023.10.1.1 |
Release Date | Nov 20, 2023 |
Download Path | |
Type | Replicator Plugin |
Change Log:
Description
The Seaware plugin is designed to export crew data to the Seaware platform.
After planning crew members onboard the vessels, they are then assigned to cabins. All the provided crew-related data is exported from APM to Seaware, and voyage data - from Seaware to Adonis.
Data Flow
Adonis is the master system with regard to maintaining crew data.
Adonis → Seaware
Crew Data
ADONIS FIELD | SEAWAREQL FIELD | COMMENTS |
|---|---|---|
LASTNAME | lastName |
|
LASTNAME | lastName |
|
FIRSTNAME | firstName |
|
BIRTHDATE | birthDate |
|
PLACEOFBIRTH | birthPlace |
|
COUNTRYOFBIRTH | countryOfBirthId |
|
ADDRESS_COUNTRY | countryOfResidence |
|
DATEFROM | passport: ClientPassportInput | PW001C23.OPTIONS LIKE '%T%' |
TDNUMBER | passport: ClientPassportInput |
|
DATETO | passport: ClientPassportInput |
|
ISSUEDBY | passport: ClientPassportInput |
|
TELENO (TELETYPE = 3) | mobilePhoneNumber |
|
TELENO (TELETYPE = 6) |
| |
SEX | gender |
|
Seaware → Adonis
Voyages
ADONIS FIELD | SEAWAREQL FIELD | COMMENTS |
|---|---|---|
CODE | shipId+autoincrement |
|
STARTDATE | dvoyfdt |
|
ENDDATE | dvoytdt |
|
NAME | shipId + portfr/portto + dvoyfdt/dvoytdt |
|
NUMORGID | shipId |
|
DATEFROM | dvoyfdt | Specifies the timeframe in which a ship comes into a port. |
DATETO | dvoyfdt | Specifies the timeframe in which a ship comes into a port. |
DATEFROM | dvoytdt | Specifies the timeframe in which a ship leaves a port. |
DATETO | dvoytdt | Specifies the timeframe in which a ship leaves a port. |
CODETYPE |
| Accepts value B. |
CREATED |
| Stands for time when a record was added. |
CREATEDBY |
| Stands for a plugin code which is SWR. |
CREATETIME |
| Stands for time when a record was added. |
PLACEFROM | portfr | Speficies the port which a ship leaves. |
PLACETO | portfr | Speficies the port which a ship leaves. |
PLACEFROM
| portto | Speficies the port to which a ship is heading. |
PLACETO | portto | Speficies the port to which a ship is heading. |
STATUS
|
| Accepts value 0. |
ETA
| dvoytdt | Specifies the date till which the voyage takes place. |
ETD | dvoytdt + 23:59 | Specifies the date till which the voyage takes place + 1 day. |
Housekeeping
The section covers the download, installation, and configuration procedures of the Seaware plugin.
http://download.adonis.no/files/upgrade/PersonnelManager/Plugins/Replicator/SWR/
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 Seaware plugin:
Name | Value |
|---|---|
DATABASE | Enter the database name used when installing Adonis Personnel Manager. |
DEBUGLOG | 0 |
SERVER_NAME | Specify the server name to which to connect. |
SERVICE_PSW | Define the service password. |
SERVICE_URL | http://internal-staging-graphql-sew-alb-99653069.us-east-1.elb.amazonaws.com/graphql |
SERVICE_USER | Set the service user. |
XREF | Enter the Seaware plugin code defined in Adonis Personnel Manager. For more information, see Seaware Code Setup. |
Seaware Code Setup
To export data, it is required to define the Seaware 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 Seaware 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 Seaware plugin in the Status node on the left-hand pane to see the export results: