FFA

Business Background¶

An Air Clearing File is used to manage the customs clearance process for air freight shipments.

The clearing file may have been created from:

• Existing HAWB
• Existing MAWB
• Existing Quotation
• Manual entry from scratch

The retrieve screen should allow users to locate these files easily using air-specific search criteria.

Proposed Menu Path¶

Air → Clearing Services → Air Clearing Files

Screen Title¶

List of Air Clearing Files

Search / Filter Fields¶

The retrieve screen should include the following filters:

Field	Type	Remarks
HAWB Reference	Textbox	Search by House Air Waybill reference
MAWB Reference	Textbox	Search by Master Air Waybill reference
Clearing Reference	Textbox	Search by generated clearing file reference
Quotation Reference	Textbox	Search by quotation reference, if file was created from quotation
Airline	Dropdown/Searchable	Search by airline name or IATA code
Flight Number	Textbox	Search by flight number
BOE Reference	Textbox	Search by Bill of Entry reference
Cargo Type	Dropdown	Import / Export / All
Status	Dropdown	Draft, Awaiting Approval, Confirmed, Closed, Cancelled
Date Range	Date range picker	Mandatory or default to current period, same approach as Ocean

Search Result Grid Columns¶

1. Main Grid (Parent Grid)¶

Each row represents one Air Clearing File

Column	Description
HAWB Ref	House Air Waybill reference
MAWB Ref	Master Air Waybill reference
Clearing Ref	Air clearing file reference
Quotation Ref	Quotation reference, if applicable
Airline	Airline linked to the shipment
Flight No.	Flight number
Cargo Type	Import or Export
Origin Airport	Airport of origin
Destination Airport	Destination airport
Status	Current clearing status
Created Date	File creation date
Action	Open/View button

2. Nested Grid (Child Grid – BOE Details)¶

Displayed when user clicks expand ( > )

Columns:¶

Column	Description
BOE Ref	Bill of Entry reference
Submitted Date	Date of bill Submission
Clearance Date	Customs clearance date
Post Entry	Yes/No
Status	Status

• Expand/Collapse Row

  • Each row must have an expand icon (>)
  • Clicking expands the BOE grid
  • Clicking again collapses it

• BOE Data Retrieval

  When expanding a row:

  • System must fetch all BOEs linked to that clearing file
  • Data must be filtered by:
    • Clearing Reference OR internal ID

• Multiple BOEs per Clearing File

  • One clearing file can display:
    • 0 BOE
    • 1 BOE
    • Multiple BOEs

• No BOE Case

If no BOE exists:

Display message inside nested grid:

No BOE records found.

• Performance Consideration (IMPORTANT FOR DEV)
  • BOE data must be lazy loaded (on expand click)
  • DO NOT load all BOEs on initial page load
• Sorting Behavior
  • Parent grid sorting should NOT affect BOE grid
  • BOE grid sorting can be optional (not mandatory for now)
• Pagination Behavior
  • Pagination applies only to parent grid
  • Nested BOE grid should NOT have pagination initially (unless large data)

Buttons / Actions¶

Search Button¶

When clicked, the system should apply the selected filters and refresh the result grid.

Reset Button¶

When clicked, the system should clear all filters and reload the default list.

Create Air Clearing File Button¶

When clicked, the system should redirect the user to the New Air Clearing File screen.

Open / View Button¶

Each row should have an action button to open the selected clearing file in the Add/Update page.

Functional Requirements¶

1 – Default Listing¶

When the user opens the retrieve screen, the system should display Air Clearing Files based on the default date range.

2 – Search by References¶

The user should be able to search using:

• HAWB Reference
• MAWB Reference
• Clearing Reference
• Quotation Reference
• BOE Reference

Partial search should be supported where possible.

Example: typing HAWB2602 should return all matching HAWB references.

3 – Search by Airline¶

The Airline dropdown/search must allow search by:

• Airline name, e.g. Emirates
• IATA airline code, e.g. EK

This is important because operations users often search by airline code.

4 – Search by Flight Number¶

The system should allow filtering by Flight Number.

Example: EK702.

5 – Search by Cargo Type¶

The user should be able to filter by:

• Import
• Export
• All

6 – Search by Status¶

The user should be able to filter by:

• Draft
• Awaiting Approval
• Confirmed
• Closed
• Cancelled

7 – Date Range Filter

The date range should filter records based on the clearing file created date, unless otherwise agreed.

Default date range should follow the same logic currently used in Ocean Clearing.

8 – Sorting¶

The grid should allow sorting on important columns such as:

• HAWB Ref
• MAWB Ref
• Clearing Ref
• Airline
• Flight No.
• Cargo Type
• Status
• Created Date

9 – Pagination¶

The grid should support pagination using the same component/standard already used in MFreight.

10 – Search by BOE Reference¶

If user searches using BOE Reference:

• System must return:
  • Clearing file(s) containing that BOE
• When displayed:
  • Row should be expandable
  • BOE should be visible in nested grid

11 – Empty Result¶

If no records match the search criteria, the system should display:

No Air Clearing Files found.

Validation Rules¶

Field	Rule
Date Range	Must be valid. From Date cannot be greater than To Date
Airline	Must be selected from valid airline master if used
Cargo Type	Must be Import, Export, or All
Status	Must be selected from valid status list
BOE search	Must return parent clearing file
Expand click	Must not break if no BOE exists

---

Status Display Rules¶

Statuses should be displayed using badges, similar to Ocean Clearing.

Suggested status labels:

Status	Display
Draft	DRAFT
Awaiting Approval	AWAITING APPROVAL
Confirmed	CONFIRMED
Closed	CLOSED
Cancelled	CANCELLED

Acceptance Criteria¶

1 – Open Retrieve Screen¶

Given I am an authorized user,
When I open Air → Clearing Services,
Then the system should display the List of Air Clearing Files screen.

2 – Default Results¶

Given the retrieve screen is opened,
When the page loads,
Then the system should display records based on the default date range.

3 – Search by HAWB¶

Given I enter a HAWB reference,
When I click Search,
Then the grid should display only matching Air Clearing Files.

4 – Search by MAWB¶

Given I enter a MAWB reference,
When I click Search,
Then the grid should display matching clearing files linked to that MAWB.

5 – Search by Airline Code¶

Given airline master contains Emirates with IATA code EK,
When I search airline using EK,
Then Emirates should be available for selection and matching records should be returned.

6 – Search by Cargo Type¶

Given I select Import,
When I click Search,
Then only Air Import clearing files should be displayed.

7 – Search by Status¶

Given I select Confirmed,
When I click Search,
Then only Confirmed Air Clearing Files should be displayed.

8 – Invalid Date Range¶

Given From Date is greater than To Date,
When I click Search,
Then the system should show a validation message:

From Date cannot be greater than To Date.

9 – No Result¶

Given no file matches the selected filters,
When I click Search,
Then the system should display:

No Air Clearing Files found.

10 – Open File¶

Given search results are displayed,
When I click the Open/View action on a row,
Then the system should open the selected Air Clearing File in the Add/Update page.