Description
Apollo is a crew management company that implemented their own crew management system which they make available to their customers.
The interface will on regular intervals download employee information from Apollo and upload this information into Adonis.
Compatible
Compatible with APM 2019.50 or higher*
*Requires cross reference table; PW001P01_XREF
Process Flow
Onboard Crew, and crew lined up to go onboard are downloaded from Apollo and inserted into Adonis.
No information is send from Adonis to Apollo.
Apollo- > Adonis
Crew
Employee Bio Data
| Description | Adonis Field | Apollo | Comment |
|---|---|---|---|
| Unique | PIN | employeeId | The employees unique id is stored in the pin XREF table. The XREF table is used to find the pin using Apollo's employee id. |
| Crew member's first name | FirstName | firstName | |
| Crew member's last name | LastName | lastName | |
| Gender | Sex | Gender | |
| Birth Date | BirthDate | birthDate | |
| Place of Birth | PlaceofBirth | birthPlace | |
| Address 1 | Address1 | line1 | |
| Address 2 | Address2 | line2 | |
| Address 3 | Address3 | line3 | |
| Zip | PostCode | zipCode | |
| Address Country | Address_country | country | |
| Original employment start date | EmploymentStartDate | hireDate | |
| Nationality | Nationality | nationalityCountryCode | |
| Rank | positionID | rank | Uses the rank XREF (General Codes) to find the correct rank code. |
| Hair Color | HairColor | hairColor | Uses the color XREF(General Codes) to find the correct color code. |
| Eye Color | EyeColor | eyeColor | Uses the color XREF(General Codes) to find the correct color code. |
| CLIENT | Client | companyCode | Uses the company XREF (organization) to find the correct company numorgid/clientid |
Seaservice information
| Description | Adonis Field | Apollo Field | Comment |
|---|---|---|---|
| Vessel | vessel | shipReferenceCode | Uses the vessel XREF (organization) to find the correct vessel numorgid |
| Position | Numorgid | positionReferenceCode | Uses the position XREF (organization) to find the correct vessel numorgid |
| Sign-On Date | DateFrom | signonDate | |
| Sign-Off Date | EstimatedEndDate | signoffDate | |
| Planned | IF signOnConfirmed=true THEN N ELSE Y | ||
| Historical | IF signOnConfirmed=true THEN T ELSE F | ||
| DateTo | IF signOffConfirmed=true THEN signOffDate ELSE Null | ||
| Code | Code | no input from Apollo | This information does not exist in Apollo. The system find the activity code identify in the XREF the interface field. The xref code is one of the plug-in parameters See houskeeping. |
Competence and Travel Documents
| Description | Adonis field | Apollo Field | Comment |
|---|---|---|---|
| Unique id to identify Employee | PIN | employeeKey | The employees unique id is stored in the pin XREF table. The XREF table is used to find the pin using Apollo's employee id. |
| CODE | documentCode | Uses the competence / travel docuemnts XREF(General Codes) to find the correct document code | |
| DOCUMENTID | documentId | ||
| COMMENTS | documentName | ||
| DATEFROM | issuedDate | ||
| DATETO | expirationDate | ||
| ISSUEDBY | issuedBy |
Houskeeping
Download the Plug-In
Installing the plugin
See : Installing and distributing the Replicator plug-in
Plugin Parameters
A plug-in will request certain parameters like authentication details, server url, names etc. These parameters are different from plug-in to plugin, before scheduling the plug-in the administrator need to set the correct parameters.
- In the right Panel of the replicator manager expand the plug-in and select plugin parameters
In the right-hand screen select the site and add the parameters manually. 
Plugin specific parameters for the Apollo Interface
Below you find the plugin specific parameters, note the parameters are case sensitive.
Parameter | Description |
|---|---|
CLIENTID | Authentication parameter (ADONIS_Crew) |
CLIENTSECRET | Authentication parameter (Contact Apollo) |
COMPANYCODE | Authentication parameter (Contact Apollo) |
DATABASE | Adonis Database |
SERVER_NAME | Database Server |
| XREF_SEASERVICE | XREF Code identifying the seaservice |
| XREF | Interface name. |
| DAYSAHEAD | Number of days the interface should "look ahead" to identify crew members that are planned to go onboard. |
| STARTDATE | Possible to give particular start date from which the system should select crew members. Should only be used to synchronize both systems during the initialization phase. Leave blank after synchronizing both systems. |
| APIURL | URL to the Apollo Solution Adonis Crew API. |
| AUTHURL | URL to the Apollo Solution Auth API. |
Cross reference (XREF) Setup
In Adonis the functionality exist to link all general code and levels in the organization structure to a 3rd part code. Before starting the plugin the Administrator need to add Apollo XREF codes.
In the general codes > Interfaces
Create the a new interface Apollo, Add this to the Plugin parameter XREF.
This is used by the plugin to determine which XREF codes to use.
The following XREF Codes are used:
General Codes: Color, Ranks, Competences, Travel Documents
Organization Structure: Company, Vessel
Monitoring Surveillance
Status last execution.
To retrieve the latest interface execution status, open the replicator monitor
In the left pane select the Apollo interface plugin in the status menu. It is located directly below the Adonis Replicator status. In the right pane you will find the status of the last execution.
Execution Log:
In the directory where the Apollo plug in is installed you find the log file containing the status of the last 4 weeks of execution.
Open the file aplint.log using notepad, and you find the latest entries at the bottom of the log file.
Reset the replication
Run the following SQL
UPDATE PWINTERFACETASK
SET LastImport= NULL
WHERE TASK='APOLLO_TASK' and SiteNr=<site# of active site>
This update statement will force the system to import all information from Apollo.