Versions Compared

Key

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

Description

Crew Folio interface

Latest Version

2019.60.0.4

Release Date

Download Path

Download

Type

APM Plugin

Description

The Crew Card Maintenance is implemented as an APM plug-in.

Table of Contents
minLevel1
maxLevel7
excludeContents

Compatibility

Compatible with APM 2019.60 or higher*

*Requires cross-reference table; PW_CREWCARD, MXP_CREWFOLIO

Terminologies

Crew Folio

This is the crew

members

member's journal of all his spendings onboard for a particular period. Normally for one payroll period or for a voyage.   This is used on cruise vessels onboard merchant navy vessels like tank/bulk etc this is referring to like the slop chest or bonded stores. Onboard cruise vessel crew members are equipped with a crew card, that is used onboard in the various chops/stores to purchase various goods. These purchases are listed in the Crew Folio.  

POS

The POS is the place in a shop where a product is passed from the seller to the customer. POS is an abbreviation for 'point of sale'.  POS System is the system registration of the purchase, cost product date etc. 

MXP

http://www.marinexchange.com/index.php?id=222 

MarineXchange MXP is the first enterprise software suite for the cruise industry.
It provides powerful tools to better manage cruise-ship operations. Efficiencies are created through wizards, batch processing, ship participation, and e-commerce integration. The administration for all installations (ships, warehouses, hotels, out islands) is done from the office, and changes are merge replicated daily. All modules are integrated with each other and data is available system-wide.

Through interfaces, MXP data flows to other systems like the company website, reservations, financial systems, or data warehouses. MXP provides a “best practices” approach and is fully SOX compliant.


Process Flow

At the end of the voyage, the crew folios are entered into the payroll so

that

that cost and eventual earnings (hours/gratuities) are added and subtracted from a person's payroll. 

MXP identifies a person using the Charge_Id which is added on the crew card when printing and programming the card. During a purchase, the crew

members

member's charge id is registered in the MXP POS System.  The crew folios are linked to the Charge_Id.

The Crew folios can be subtracted using MXP's API.    


Housekeeping

Download the Plugin

ftpftpAPM_Plugin_CrewFolio_2019.60.0.0.exe

Installing the Plugin

Install the plugin installer to the workstation where your APM (Adonis Personal Manager) is installed.

Step 1Step 2Step 3Step 4

Image Removed

Image Removed

Image Removed

Image Removed

How to Install an APM Plugin

Location

Adonis Personal Manager > Tools > Import > Crew Folio

FunctionalityCommunication -


Setup

InterfaceDetailsCONFIGURATION

Image Removed

Image Added

1) Setup the MXP WebAPI URL

, the default location is http://localhost/MXP_Virgin.exe 

(If you don't know the WebAPI URL, please ask your System Administrator)

2) Click Append to add an Entry Code. 

3) Setup Payroll Transaction:

Look

 Look up to Crew Folio

entry code 

Image Removed

Field Assignments:

Entry Code

Payroll transaction

Select the payroll entry code, and add the condition when a payroll transaction with this entry code should be created. 

4) Click OK to save. 

image-20240103-090948.pngImage Added

5) Click on Field Assignments.

Field Assignments

The following information from MXP is available to be assigned to as standard payroll transaction fields: 

Pin, ChargeID, Invoice_Number, ItemID, business_Day, item_description, item_Quantity, debit_amt, credit_amt, total_amt, currency_code, location in addition the following field is available, vessel_numorgid

6) Click on Append to select Payroll Fields.

7) Select Payroll Fields

8) Select Group by
The Group by column is where the response will be grouped.

 


Note: If the group by is not set, the plugin

will 

will create a list for each transaction.

  

 

the

Image Removed

To get the correct placement of the crew folio, the

forth row is the numorgid is the unique id to tell 

vessel_numorgid must be selected to get the vessel's unique ID. 

9) Click Save


Functionality

How to Import Crew Folios From MXP

Image Added

1) Click the Import MXP Crew Folio Records button

Set initial date

2) Set the Initial Date

For the first import,

there were

no

initail

initial date was set

first

yet, you will select a date where to start the search. Normally the initial date should be the same

with

as the start of the voyage or the start of the payroll date. 

3) Set Import all

transaction upto

Image Removed

transactions up to

This is the end of the voyage or end date of payroll.

Select the query's end date.

4) Click Import MXP Crew Folio Records

Image Added

5) Successfully Imported MXP Crew Folio

HOW TO TRANSFER THE MXP CREW FOLIO RECORDS

Image Removed

List

.

You will be notified that the import is successful. 


How to Transfer to Payroll the MXP Crew Folios Records

Image Added

1) From the list of MXP Crew Folio that

are

is not yet

transfered

transferred to payroll, select persons that you want to Transfer to Payroll. 

In the Collapse View, all the POS

transaction

transactions of the person will be displayed. 

To transfer, select/check the box and click

Image Removed

Successfully transfered

2) To continue click the Transfer to Payroll button

Image Removed

Show/Hide Columns


Image Added

3) Successfully transferred to payroll

Image Removed

Now it will be under Transfered to Payroll 

Image RemovedImage Removed

Debug Mode - Technical View

In APM's Debug Mode it is possible to see the response from the MXP WebAPI.

Log File is also possible to view. 

VIEW THE TRANSFERED MXP CREW FOLIO IN THE PAYROLL MODULEImage Removed


Image Added

4) The persons were removed from the list Not Transferred to Payroll


Image Added

5) In the list Is Transferred to Payroll you will view the transactions already transferred to Payroll. These transactions are still based on the Initial Date and Up to Date. If these dates are changed a new set of transactions will be displayed.


View the Transferred MXP Crew Folio in the Payroll Module

Image Added

Location: Payroll Module > Payroll 

We group

Since we Group by location, in the TEXT column, there were two locations detected (Computer Shop and Administration) The total amount for each location will be

total

totaled and displayed as one entry.

  Plugin Parameters