How to: Configure the Trip Trade (Swap) and Open Time Features in CrewPortal
Merlot supports a number of trip-trading features for crew via the CrewPortal application. This article explains how to configure the various merlot.aero components required for the automated processing of trip trades, as well as providing information on how the CrewPortal functions behave.
Types of Trip Trading
Merlot supports three different mechanisms for crew to trade pairings with each other - collaborative trade board, direct trades, and open time trades (also known as open time pick up).
- Trade Board - the trade board allows crewmembers to place an unwanted pairing or a required pairing on a board so that other crew members can collaboratively initiate a trade transaction.
- Direct Trades - direct trades allow crew to target specific crew members or pairings which they wish to trade, and initiate direct messaging and trade requests via CrewPortal.
- Open Time Trades - open time trades allow crew members to see open pairings and select them for trade with an already assigned pairing on their line.
CrewPortal Resource Dictionary
Did you know that CrewPortal function labels and headers can be customized? Do you prefer to see "Swap" instead of "Trip Trade", or "Calendar" instead of "Roster"? No problem, just follow the steps in this /wiki/spaces/DOC/pages/43090290.
Step-by-step Set Up Guide
The first step in enabling trip trading is to determine the trade functions you wish to expose to crew. Typically, merlot customers choose to expose a select number of functions, gradually increasing the number of available functions over time. This is a good strategy for reducing training and support overheads.
The available trade functions are controlled by mix of User Preferences as well as the enabled background processes within the worker role (also called the JobEngine).
In order to enable trade functions, update the relevant user preferences as outlined in the table below. The primary User Preferences for consideration are highlighted in yellow. It is these preferences that control the availability of the functions in the CrewPortal. These control the available functions.
User Preferences Hint
The best way to find the preferences you need is to use the embedded filter options in the headers of the User Preference form to limit the results to CrewPortal. You can then use the Preference column to target specific preference rows if required.
Note on Configuration Caching
| Application Id | Preference Group | Preference | Example Values | Description |
|---|---|---|---|---|
| CrewPortal | Config | formatSwap | MM/dd/yyyy HH:mm | The date format used to display dates within the Trade / Swap forms. This value must conform to system standards. |
| CrewPortal | Config | daysRangeSwap | 45 | An integer value in hours that defines the period into the future from the current date/time that crew members are able to submit and process direct trades |
| CrewPortal | Config | isVisibleSwaps | TRUE | True or False to determine whether the Trade / Swap function is visible within CrewPortal |
| CrewPortal | Config | isSwapBoardVisible | TRUE | True or False to determine whether the Trade Board function is visible and available within CrewPortal |
| CrewPortal | Config | latestSwapBoardBeforeReportTime | 12 | An integer value in hours value that controls the period of time before the next report that trades are allowable / visible |
| CrewPortal | Config | requireApprovalFromOps | FALSE | Currently unsupported. True or False to determine whether a Trade / Swap needs to be approved by Operations before being actioned. |
| CrewPortal | Config | maxSwapsPerRosterPeriod | 999 | A number that limits the total number of trades a crew member can perform during a single roster period. |
| CrewPortal | Config | maxDutySwapsPerRosterPeriod | 999 | A number that limits the total number of trades of all pairing types that involve Duty Time that a crew member can perform during a roster period. |
| CrewPortal | Config | limitTotalFlyingHoursPerRosterPeriod | 100 | A number that limits the total number of flying hours that a crew member can obtain via trades during a roster period. If a trade will take the crew member over this value the trade will be denied. |
| CrewPortal | Config | allowablePairingTypes | FPG,RDO,RES | Comma separated list of the Pairing Work Types that are allowable for trading. Note: Any value in this list can trade with any other value in this list. |
| CrewPortal | Config | turnOffSwaps | FALSE | True or False value used as a crewmember delta used to disable swaps for a given employee (e.g. a crew member is under disciplinary action). |
| CrewPortal | Config | showNewSwapMenu | TRUE | True or False to determine whether the Show New Swap Menu is displayed in the Trade Board. |
| CrewPortal | Config | allowCounterOffer | TRUE | True or False to determine whether the counter offer option will be available as part of a trade. A counter offer allows a replying crewmember to propose alternate swap options to the initiating crew member. |
| CrewPortal | Config | allowOpenTimeSwaps | TRUE | True or False to indicate if Open Time swaps are available. |
| CrewPortal | Config | allowSwapWithBlankDuty | FALSE | True or False to indicate if a crew member is allowed to swap open time with a blank duty (or "hole"). |
Pairing Work Types
This table provides a list of "Pairing Work Types" that can be used in the parameters above.
ADM | Administration | RDO | Regular day off |
RES | Home Reserve/Standby | HOL | Public Holiday |
FPG | Flying Pairing | GRD | Ground Activity |
AVL | Available Day | UVL | Unavailable |
SLV | Sick Leave | TRN | Ground Training |
VAC | Vacation | SIM | Simulator Training |
ARD | Airport Reserve/Standby | SOC | System Operations Personnel |
CFP | Course Flying Pairings (Ghost pairings for flying courses) | DHD | Deadhead |
3. Because merlot's trading functionality is powered by the JobEngine, a number of background processes must be enabled in order for trades to be validated and executed automatically. The following table outlines the jobs which form part of the trade functionality:
| Job/Parameter | Example Value | Description |
|---|---|---|
| Crew Swaps Job | The job that controls the processing and validation of all types of trades. | |
| Frequency | 3 minutes | The frequency at which the job will process, validate and action Swaps / Trades |
| LogReferenceNumber | TRUE | Determines if a reference number is generated for the crew member on the trade response |
| NotificationMethod | Portal | Determines how the crew member is notified of a trade request processing result |
| Open Time Job | The job that controls the population of Open Time into the Trade Board | |
| Frequency | 10 minutes | The frequency at which the job will add / remove Open Time based on open complements |
| Process From | +12 hrs | The period of time in past from current date/time that the job will start to process pairings to determine if they are open (based on Pairing Report Time) |
| Process To | +45 days | The period of time in future from current date/time that the job will finish processing pairings to determine if they are open (based on Pairing Report Time) |
Step-by-step Functional Guides:
Related articles