BIG Pega COE Team
Business Rules to be added in EPICs
Category: GCX016ER
This report presents the exact business rules dynamically extracted from the legacy system. Rules are formatted in an Agile/BDD Given/When/Then structure, offering a bridge between business requirements and technical implementation constraints. Component rules have been logically grouped into feature sets.
🎯 GCX016ER Scope Detected: Extracted 3573 rules, Optimally Merged into 244 Feature Scenarios.
📁 File: GCX016E.cbl
Select All in File
R-GCX016E-cbl-00001 (+58) File: GCX016E.cbl Business Rule: Overview Rules
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when system needs to process messages from gc350.exp.input queue.
Trigger Criteria:
- Context: The system needs to process messages from GC350.EXP.INPUT queue
- Applied to: MQ Message Retrieval
- Action: Message retrieval is initiated
Logic Flow:
IF The system needs to process messages from GC350.EXP.INPUT queue
AND Message retrieval is initiated
THEN:
- • Messages are retrieved from queue and completion codes are evaluated to determine message availability status
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when messages have been retrieved from the queue with completion codes.
Trigger Criteria:
- Context: Messages have been retrieved from the queue with completion codes
- Applied to: Messages Available?
- Action: Completion code is not OK and reason code is 2033
Logic Flow:
IF Messages have been retrieved from the queue with completion codes
AND Completion code is not OK and reason code is 2033
THEN:
- • Set message not available flag
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when message completion is ok.
Trigger Criteria:
- Context: Message completion is OK
- Applied to: Messages Available?
- Action: Backout count is not zero
Logic Flow:
IF Message completion is OK
AND Backout count is not zero
THEN:
- • Skip message and set skip message flag
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when message completion is ok.
Trigger Criteria:
- Context: Message completion is OK
- Applied to: Messages Available?
- Action: Backout count is zero
Logic Flow:
IF Message completion is OK
AND Backout count is zero
THEN:
- • Set good message found flag for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid messages are available for processing. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Valid messages are available for processing
- Applied to: Message Array Initialization
- Action: Message ID is GCW016
Logic Flow:
IF Valid messages are available for processing
AND Message ID is GCW016
THEN:
- • Process messages directly varying WS-LINE from 1 until max entries or end found
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when message array has been initialized.
Trigger Criteria:
- Context: Message array has been initialized
- Applied to: Message Type?
- Action: Message contains train-related segments (M10 with vessel/train info)
Logic Flow:
IF Message array has been initialized
AND Message contains train-related segments (M10 with vessel/train info)
THEN:
- • Route to train processing path
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when message array has been initialized.
Trigger Criteria:
- Context: Message array has been initialized
- Applied to: Message Type?
- Action: Message contains cargo-related segments (X4, N7)
Logic Flow:
IF Message array has been initialized
AND Message contains cargo-related segments (X4, N7)
THEN:
- • Route to cargo processing path
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when m10 segment contains vessel name information.
Trigger Criteria:
- Context: M10 segment contains vessel name information
- Applied to: Train Identification and Validation
- Action: Vessel name starts with 'TRAIN' or 'DAY'
Logic Flow:
IF M10 segment contains vessel name information
AND Vessel name starts with 'TRAIN' or 'DAY'
THEN:
- • Continue processing without additional validation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when vessel name does not start with 'train' or 'day'.
Trigger Criteria:
- Context: Vessel name does not start with 'TRAIN' or 'DAY'
- Applied to: Train Identification and Validation
- Action: Train lookup is performed against train list
Logic Flow:
IF Vessel name does not start with 'TRAIN' or 'DAY'
AND Train lookup is performed against train list
THEN:
- • If train not found, generate error message to Merlin system
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when v9 segment contains event code hmi.
Trigger Criteria:
- Context: V9 segment contains event code HMI
- Applied to: Train Hold Processing - HMI
- Action: Train hold event is processed
Logic Flow:
IF V9 segment contains event code HMI
AND Train hold event is processed
THEN:
- • Set train held status and log hold message to Merlin system
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when v9 segment contains event code hre.
Trigger Criteria:
- Context: V9 segment contains event code HRE
- Applied to: Train Hold Release Processing - HRE
- Action: Train hold release event is processed
Logic Flow:
IF V9 segment contains event code HRE
AND Train hold release event is processed
THEN:
- • Remove train hold status and log release message to Merlin system
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when v9 segment contains event code pod or aad.
Trigger Criteria:
- Context: V9 segment contains event code POD or AAD
- Applied to: Train Arrival Processing - POD/AAD
- Action: Train arrival event is processed
Logic Flow:
IF V9 segment contains event code POD or AAD
AND Train arrival event is processed
THEN:
- • Process train arrival and update arrival status in system
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when v9 segment contains event code rc.
Trigger Criteria:
- Context: V9 segment contains event code RC
- Applied to: Train Review Complete Processing - RC
- Action: Review complete event is processed
Logic Flow:
IF V9 segment contains event code RC
AND Review complete event is processed
THEN:
- • Set review completed status for the train
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when v9 segment contains event code oca.
Trigger Criteria:
- Context: V9 segment contains event code OCA
- Applied to: Train Not Arrived Processing - OCA
- Action: Train not arrived event is processed
Logic Flow:
IF V9 segment contains event code OCA
AND Train not arrived event is processed
THEN:
- • Handle arrival cancellation for the train
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when v9 segment contains event code coc.
Trigger Criteria:
- Context: V9 segment contains event code COC
- Applied to: Train Arrival Cancellation - COC
- Action: Train arrival cancellation is processed
Logic Flow:
IF V9 segment contains event code COC
AND Train arrival cancellation is processed
THEN:
- • Process arrival cancellation with different logic based on current arrival status
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when v9 segment contains event code lck.
Trigger Criteria:
- Context: V9 segment contains event code LCK
- Applied to: Train Lock Processing - LCK
- Action: Train lock event is processed
Logic Flow:
IF V9 segment contains event code LCK
AND Train lock event is processed
THEN:
- • Set train locked status
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when v9 segment contains event code ulc.
Trigger Criteria:
- Context: V9 segment contains event code ULC
- Applied to: Train Unlock Processing - ULC
- Action: Train unlock event is processed and train is currently locked
Logic Flow:
IF V9 segment contains event code ULC
AND Train unlock event is processed and train is currently locked
THEN:
- • Remove train lock status
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when v9 segment contains event code sei.
Trigger Criteria:
- Context: V9 segment contains event code SEI
- Applied to: Train Seizure Processing - SEI
- Action: Train seizure event is processed
Logic Flow:
IF V9 segment contains event code SEI
AND Train seizure event is processed
THEN:
- • Set train seized status
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when v9 segment contains event code ser.
Trigger Criteria:
- Context: V9 segment contains event code SER
- Applied to: Train Seizure Release Processing - SER
- Action: Train seizure release event is processed
Logic Flow:
IF V9 segment contains event code SER
AND Train seizure release event is processed
THEN:
- • Remove train seize status
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when v9 segment contains event code cae.
Trigger Criteria:
- Context: V9 segment contains event code CAE
- Applied to: Train All Clear Processing - CAE
- Action: Train all clear event is processed
Logic Flow:
IF V9 segment contains event code CAE
AND Train all clear event is processed
THEN:
- • Set all clear status for the train
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when event code is hmi or sei.
Trigger Criteria:
- Context: Event code is HMI or SEI
- Applied to: Equipment Hold Processing by VID Segment
- Action: VID segments are present for equipment-specific processing
Logic Flow:
IF Event code is HMI or SEI
AND VID segments are present for equipment-specific processing
THEN:
- • Process associated VID segments for equipment-specific holds
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when event code is hre or ser.
Trigger Criteria:
- Context: Event code is HRE or SER
- Applied to: Equipment Release Processing by VID Segment
- Action: VID segments are present for equipment-specific processing
Logic Flow:
IF Event code is HRE or SER
AND VID segments are present for equipment-specific processing
THEN:
- • Process associated VID segments for equipment-specific releases
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when x4 segment contains disposition code and processing parameters.
Trigger Criteria:
- Context: X4 segment contains disposition code and processing parameters
- Applied to: Cargo Lookup Method?
- Action: Processing type is by bond number
Logic Flow:
IF X4 segment contains disposition code and processing parameters
AND Processing type is by bond number
THEN:
- • Route to bond-based cargo processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when x4 segment contains disposition code and processing parameters.
Trigger Criteria:
- Context: X4 segment contains disposition code and processing parameters
- Applied to: Cargo Lookup Method?
- Action: Processing type is by car ID and waybill
Logic Flow:
IF X4 segment contains disposition code and processing parameters
AND Processing type is by car ID and waybill
THEN:
- • Route to car/waybill-based cargo processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code requires bond-based processing.
Trigger Criteria:
- Context: Disposition code requires bond-based processing
- Applied to: Cargo Processing by Bond
- Action: Bond number is identified from X4 segment
Logic Flow:
IF Disposition code requires bond-based processing
AND Bond number is identified from X4 segment
THEN:
- • Process all cargos with matching bond number
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code requires car/waybill-based processing.
Trigger Criteria:
- Context: Disposition code requires car/waybill-based processing
- Applied to: Cargo Processing by Car/Waybill
- Action: Car ID and waybill are identified from segments
Logic Flow:
IF Disposition code requires car/waybill-based processing
AND Car ID and waybill are identified from segments
THEN:
- • Process all cargos with matching car ID and waybill
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code requires individual cargo processing.
Trigger Criteria:
- Context: Disposition code requires individual cargo processing
- Applied to: Individual Cargo Processing
- Action: Single cargo is identified from segments
Logic Flow:
IF Disposition code requires individual cargo processing
AND Single cargo is identified from segments
THEN:
- • Process individual US cargo with disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo requires status segment processing.
Trigger Criteria:
- Context: Cargo requires status segment processing
- Applied to: S09 Status Segment Processing
- Action: S09 segments are fetched for cargo
Logic Flow:
IF Cargo requires status segment processing
AND S09 segments are fetched for cargo
THEN:
- • Create or replace S09 segments for cargo records and manage status arrays with sequence numbers
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo is not cprs shipment.
Trigger Criteria:
- Context: Cargo is not CPRS shipment
- Applied to: S09 Status Segment Processing
- Action: N7 segment data contains car information
Logic Flow:
IF Cargo is not CPRS shipment
AND N7 segment data contains car information
THEN:
- • Update car ID from N7 segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo is cprs shipment.
Trigger Criteria:
- Context: Cargo is CPRS shipment
- Applied to: S09 Status Segment Processing
- Action: Car ID processing is performed
Logic Flow:
IF Cargo is CPRS shipment
AND Car ID processing is performed
THEN:
- • Clear car ID information
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo is cprs shipment.
Trigger Criteria:
- Context: Cargo is CPRS shipment
- Applied to: CPRS Bond Processing
- Action: Bond processing is required
Logic Flow:
IF Cargo is CPRS shipment
AND Bond processing is required
THEN:
- • Apply CPRS-specific bond processing rules
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code needs validation.
Trigger Criteria:
- Context: Disposition code needs validation
- Applied to: Disposition Code Table Lookup
- Action: DC table lookup is performed
Logic Flow:
IF Disposition code needs validation
AND DC table lookup is performed
THEN:
- • Retrieve disposition code details from DC table
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status array contains existing disposition codes.
Trigger Criteria:
- Context: Status array contains existing disposition codes
- Applied to: Duplicate Disposition Code Detection
- Action: New disposition code is being added
Logic Flow:
IF Status array contains existing disposition codes
AND New disposition code is being added
THEN:
- • Search existing status array for matching disposition codes and check entry numbers and quantities for exact matches
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when new disposition code has counterpart logic defined.
Trigger Criteria:
- Context: New disposition code has counterpart logic defined
- Applied to: Counterpart Disposition Code Removal
- Action: Counterpart disposition codes exist in status array
Logic Flow:
IF New disposition code has counterpart logic defined
AND Counterpart disposition codes exist in status array
THEN:
- • Remove counterpart disposition codes from status array
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code is 95.
Trigger Criteria:
- Context: Disposition code is 95
- Applied to: Disposition Code 95 Processing
- Action: Entry numbers match existing bond information
Logic Flow:
IF Disposition code is 95
AND Entry numbers match existing bond information
THEN:
- • Clear bond information from cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code requires in-bond processing.
Trigger Criteria:
- Context: Disposition code requires in-bond processing
- Applied to: In-Bond Broker Processing
- Action: Entry number and broker information are provided
Logic Flow:
IF Disposition code requires in-bond processing
AND Entry number and broker information are provided
THEN:
- • Update broker entry numbers with validation and set in-bond information for entry types 61, 62, 63, 69
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code is snp.
Trigger Criteria:
- Context: Disposition code is SNP
- Applied to: SNP Processing
- Action: SNP processing is initiated
Logic Flow:
IF Disposition code is SNP
AND SNP processing is initiated
THEN:
- • Process SNP disposition with specific business logic
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status array has been updated with disposition codes.
Trigger Criteria:
- Context: Status array has been updated with disposition codes
- Applied to: Status Array Verification
- Action: Status array verification is performed
Logic Flow:
IF Status array has been updated with disposition codes
AND Status array verification is performed
THEN:
- • Verify status array integrity and sequence numbers
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status array contains multiple disposition codes.
Trigger Criteria:
- Context: Status array contains multiple disposition codes
- Applied to: Individual Status Analysis
- Action: Individual status analysis is performed
Logic Flow:
IF Status array contains multiple disposition codes
AND Individual status analysis is performed
THEN:
- • Analyze each status code for hold, release, PTT, and other status flags
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all disposition codes have been processed and analyzed.
Trigger Criteria:
- Context: All disposition codes have been processed and analyzed
- Applied to: Complex Cargo Status Evaluation
- Action: Final status determination is required
Logic Flow:
IF All disposition codes have been processed and analyzed
AND Final status determination is required
THEN:
- • Apply status hierarchy: Manual Release → Released, FDA Hold → HOLDFDA, PTT with quantity check → PTT, Hold combinations → Various hold statuses, Release with quantity validation → RELSD or HOLDPCS, Export/Arrival → EXPORT/ARRIVAL, Default → ACK or PROCEED
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when multiple cargos exist with same car id and waybill.
Trigger Criteria:
- Context: Multiple cargos exist with same car ID and waybill
- Applied to: Multi-Cargo Processing by Car/Waybill
- Action: Multi-cargo processing is initiated
Logic Flow:
IF Multiple cargos exist with same car ID and waybill
AND Multi-cargo processing is initiated
THEN:
- • Process all related cargos and verify release status for each CCN
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo status is set to export.
Trigger Criteria:
- Context: Cargo status is set to export
- Applied to: Export Notification Processing
- Action: Export processing is performed
Logic Flow:
IF Cargo status is set to export
AND Export processing is performed
THEN:
- • Set export status, clear destination index, and generate appropriate notifications
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo status is set to arrival.
Trigger Criteria:
- Context: Cargo status is set to arrival
- Applied to: Arrival Notification Processing
- Action: Arrival processing is performed
Logic Flow:
IF Cargo status is set to arrival
AND Arrival processing is performed
THEN:
- • Update arrival flags and dates based on location
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo lookup returns no existing cargo.
Trigger Criteria:
- Context: Cargo lookup returns no existing cargo
- Applied to: New Cargo Record Creation
- Action: New cargo creation is required
Logic Flow:
IF Cargo lookup returns no existing cargo
AND New cargo creation is required
THEN:
- • Create new cargo record with CPRS vs regular shipment handling and automatically spawn GCT0162E for new cargos
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo is identified as foreign shipment.
Trigger Criteria:
- Context: Cargo is identified as foreign shipment
- Applied to: New Foreign Cargo Record Creation
- Action: Foreign cargo creation is required
Logic Flow:
IF Cargo is identified as foreign shipment
AND Foreign cargo creation is required
THEN:
- • Create foreign cargo record with appropriate international processing flags
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when m10 segments contain foreign manifest information.
Trigger Criteria:
- Context: M10 segments contain foreign manifest information
- Applied to: Foreign Manifest Building from M10 Segments
- Action: Foreign manifest building is initiated
Logic Flow:
IF M10 segments contain foreign manifest information
AND Foreign manifest building is initiated
THEN:
- • Build foreign manifest structure from M10 segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when table operations are required for various business processes. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Table operations are required for various business processes
- Applied to: Generic Table I/O Interface
- Action: Generic table interface is called
Logic Flow:
IF Table operations are required for various business processes
AND Generic table interface is called
THEN:
- • Perform table read/write operations with appropriate error handling
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo processing requires merlin notification.
Trigger Criteria:
- Context: Cargo processing requires Merlin notification
- Applied to: Comprehensive Merlin Message Formatting
- Action: Merlin message formatting is initiated
Logic Flow:
IF Cargo processing requires Merlin notification
AND Merlin message formatting is initiated
THEN:
- • Include disposition code messages unless manual/auto release, add car ID, waybill, US CCN, date/time, special comments up to 3 lines, K1 comments up to 4 lines, and quantity impact information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when k1 segment contains cp rail identifiers.
Trigger Criteria:
- Context: K1 segment contains CP Rail identifiers
- Applied to: Comprehensive Merlin Message Formatting
- Action: K1 segment contains 'DIRECTOR OF CUSTOMS, CP RAIL' or 'CANADIAN PACIFIC LIMITED' or 'CANADIAN PACIFIC RAILWAY CO'
Logic Flow:
IF K1 segment contains CP Rail identifiers
AND K1 segment contains 'DIRECTOR OF CUSTOMS, CP RAIL' or 'CANADIAN PACIFIC LIMITED' or 'CANADIAN PACIFIC RAILWAY CO'
THEN:
- • Create broker bond creation message for CP Rail
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo status has been determined and requires external integration.
Trigger Criteria:
- Context: Cargo status has been determined and requires external integration
- Applied to: Cargo Status Integration
- Action: Integration is initiated and equipment type is valid (containers, trailers, chassis, etc.) and status is not PTT/PTT-EX for held/partial held cargos
Logic Flow:
IF Cargo status has been determined and requires external integration
AND Integration is initiated and equipment type is valid (containers, trailers, chassis, etc.) and status is not PTT/PTT-EX for held/partial held cargos
THEN:
- • Map cargo status to integration system status descriptions and process only HOLD, PTT, PTT-EX, or RELEASE statuses
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when process type is 4e and cargo status is release.
Trigger Criteria:
- Context: Process type is 4E and cargo status is release
- Applied to: Cargo Status Integration
- Action: Release status verification is performed
Logic Flow:
IF Process type is 4E and cargo status is release
AND Release status verification is performed
THEN:
- • Verify full release before setting 'RELEASE' status in integration system
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code is freight forwarder type.
Trigger Criteria:
- Context: Disposition code is freight forwarder type
- Applied to: CIH Hold Email Notification
- Action: Email notification is required and freight forwarder has internet capability
Logic Flow:
IF Disposition code is freight forwarder type
AND Email notification is required and freight forwarder has internet capability
THEN:
- • Route email to freight forwarder email address,
otherwise route to default Merlin ID
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when email notification fails to primary recipients.
Trigger Criteria:
- Context: Email notification fails to primary recipients
- Applied to: CIH Hold Email Notification
- Action: Email failure is detected
Logic Flow:
IF Email notification fails to primary recipients
AND Email failure is detected
THEN:
- • Resend email to backup recipients (AEI9999, OM01247)
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when merlin message is ready for distribution.
Trigger Criteria:
- Context: Merlin message is ready for distribution
- Applied to: Merlin Message Distribution
- Action: Message type is error message
Logic Flow:
IF Merlin message is ready for distribution
AND Message type is error message
THEN:
- • Route to 'IN' destination
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when merlin message is informational type.
Trigger Criteria:
- Context: Merlin message is informational type
- Applied to: Merlin Message Distribution
- Action: Info message routing is performed
Logic Flow:
IF Merlin message is informational type
AND Info message routing is performed
THEN:
- • Route to 'IN' plus SD segment Merlin IDs
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when merlin message is release type.
Trigger Criteria:
- Context: Merlin message is release type
- Applied to: Merlin Message Distribution
- Action: Release message routing is performed
Logic Flow:
IF Merlin message is release type
AND Release message routing is performed
THEN:
- • Route to SD segment Merlin IDs only
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when merlin message is unrelease type.
Trigger Criteria:
- Context: Merlin message is unrelease type
- Applied to: Merlin Message Distribution
- Action: Unrelease message routing is performed
Logic Flow:
IF Merlin message is unrelease type
AND Unrelease message routing is performed
THEN:
- • Route to OM01247 plus SD cancel Merlin IDs
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when merlin message is export type.
Trigger Criteria:
- Context: Merlin message is export type
- Applied to: Merlin Message Distribution
- Action: Export message routing is performed
Logic Flow:
IF Merlin message is export type
AND Export message routing is performed
THEN:
- • Route based on equipment type classification
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when primary merlin id is invalid.
Trigger Criteria:
- Context: Primary Merlin ID is invalid
- Applied to: Merlin Message Distribution
- Action: Merlin ID validation fails
Logic Flow:
IF Primary Merlin ID is invalid
AND Merlin ID validation fails
THEN:
- • Reroute to OM01247 with error notification
R-GCX016E-cbl-00060 (+10) File: GCX016E.cbl Business Rule: MQ Message Retrieval
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when message is being processed for customs edi transactions.
Trigger Criteria:
- Context: A message is being processed for customs EDI transactions
- Applied to: Check Message Type for GCW016
- Action: The message ID is GCW016
Logic Flow:
IF A message is being processed for customs EDI transactions
AND The message ID is GCW016
THEN:
- • Skip MQ processing and use internal message structure directly
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when system needs to retrieve customs messages from mq.
Trigger Criteria:
- Context: The system needs to retrieve customs messages from MQ
- Applied to: Establish MQ Connection
- Action: MQ connection is initiated
Logic Flow:
IF The system needs to retrieve customs messages from MQ
AND MQ connection is initiated
THEN:
- • Connect to MQ system and prepare for queue operations
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when mq connection is established.
Trigger Criteria:
- Context: MQ connection is established
- Applied to: Open GC350.EXP.INPUT Queue
- Action: Queue open operation is requested for GC350.EXP.INPUT
Logic Flow:
IF MQ connection is established
AND Queue open operation is requested for GC350.EXP.INPUT
THEN:
- • Open the queue for reading customs export messages
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when attempt to open gc350.exp.input queue has been made.
Trigger Criteria:
- Context: An attempt to open GC350.EXP.INPUT queue has been made
- Applied to: Queue Open Successful?
- Action: Queue open operation completes
Logic Flow:
IF An attempt to open GC350.EXP.INPUT queue has been made
AND Queue open operation completes
THEN:
- • If queue opens successfully, proceed to message loading;
otherwise set message not available
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when gc350.exp.input queue is open and accessible.
Trigger Criteria:
- Context: The GC350.EXP.INPUT queue is open and accessible
- Applied to: Execute MQGET to Retrieve Message
- Action: MQGET operation is executed
Logic Flow:
IF The GC350.EXP.INPUT queue is open and accessible
AND MQGET operation is executed
THEN:
- • Retrieve the next available customs message from the queue
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when mqget operation has been executed on the customs queue.
Trigger Criteria:
- Context: MQGET operation has been executed on the customs queue
- Applied to: Message Available?
- Action: Message completion code is evaluated
Logic Flow:
IF MQGET operation has been executed on the customs queue
AND Message completion code is evaluated
THEN:
- • If completion code is OK, message is available; if reason code 2033, no message available;
otherwise message error occurred
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when customs message is available from the queue.
Trigger Criteria:
- Context: A customs message is available from the queue
- Applied to: Backout Count Valid?
- Action: Message backout count is checked
Logic Flow:
IF A customs message is available from the queue
AND Message backout count is checked
THEN:
- • If backout count is zero, message is good for processing; if backout count is not zero, skip the message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when customs message is available and has valid backout count.
Trigger Criteria:
- Context: A customs message is available and has valid backout count
- Applied to: Set Good Message Flag
- Action: Message validation is complete
Logic Flow:
IF A customs message is available and has valid backout count
AND Message validation is complete
THEN:
- • Set good message flag to indicate message is ready for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when customs message is available but has invalid backout count.
Trigger Criteria:
- Context: A customs message is available but has invalid backout count
- Applied to: Set Skip Message Flag
- Action: Message backout count validation fails
Logic Flow:
IF A customs message is available but has invalid backout count
AND Message backout count validation fails
THEN:
- • Set skip message flag to bypass processing of this message
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when mqget operation has been attempted on customs queue.
Trigger Criteria:
- Context: MQGET operation has been attempted on customs queue
- Applied to: Set Message Not Available Flag
- Action: No message is available or queue open failed or message error occurred
Logic Flow:
IF MQGET operation has been attempted on customs queue
AND No message is available or queue open failed or message error occurred
THEN:
- • Set message not available flag to indicate no messages to process
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when message processing result has been determined (good, skip, or not available).
Trigger Criteria:
- Context: A message processing result has been determined (good, skip, or not available)
- Applied to: Continue Loading?
- Action: Loading continuation is evaluated
Logic Flow:
IF A message processing result has been determined (good, skip, or not available)
AND Loading continuation is evaluated
THEN:
- • If more messages needed and conditions allow, continue loading;
otherwise complete message loading process
R-GCX016E-cbl-00071 (+5) File: GCX016E.cbl Business Rule: Train Identification and Validation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when vessel name is provided in the m10 segment.
Trigger Criteria:
- Context: A vessel name is provided in the M10 segment
- Applied to: Extract Train ID from Vessel Name
- Action: The vessel name starts with 'TRAIN' or 'DAY'
Logic Flow:
IF A vessel name is provided in the M10 segment
AND The vessel name starts with 'TRAIN' or 'DAY'
THEN:
- • The system continues with train processing without additional validation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when vessel name that does not start with 'train' or 'day'.
Trigger Criteria:
- Context: A vessel name that does not start with 'TRAIN' or 'DAY'
- Applied to: Query GCWTL Train List Segments
- Action: The system searches the train list using GCCUTRIO
Logic Flow:
IF A vessel name that does not start with 'TRAIN' or 'DAY'
AND The system searches the train list using GCCUTRIO
THEN:
- • If the train is found in GCWTL segments, processing continues; if not found, an error is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train lookup has been performed.
Trigger Criteria:
- Context: A train lookup has been performed
- Applied to: Generate Train Not Found Error
- Action: The train is not found in the GCWTL train list segments
Logic Flow:
IF A train lookup has been performed
AND The train is not found in the GCWTL train list segments
THEN:
- • The system generates a train not found error message for Merlin notification
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train has been successfully found in the system.
Trigger Criteria:
- Context: A train has been successfully found in the system
- Applied to: Apply CPRS Special Processing
- Action: The train is identified as a CPRS train
Logic Flow:
IF A train has been successfully found in the system
AND The train is identified as a CPRS train
THEN:
- • The system applies CPRS-specific processing rules and continues with train processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train validation has been completed.
Trigger Criteria:
- Context: Train validation has been completed
- Applied to: Continue with Train Processing
- Action: The train is either a valid TRAIN/DAY named vessel or found in the train list
Logic Flow:
IF Train validation has been completed
AND The train is either a valid TRAIN/DAY named vessel or found in the train list
THEN:
- • The system sets the train found flag and continues with subsequent train processing operations
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when vessel name that requires train validation. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A vessel name that requires train validation
- Applied to: Call GCCUTRIO to Lookup Train
- Action: The vessel name does not match TRAIN or DAY naming patterns
Logic Flow:
IF A vessel name that requires train validation
AND The vessel name does not match TRAIN or DAY naming patterns
THEN:
- • The system calls GCCUTRIO service to lookup the train in external train records
R-GCX016E-cbl-00077 (+9) File: GCX016E.cbl Business Rule: Train Hold Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when v9 segment with hmi disposition code is received.
Trigger Criteria:
- Context: A V9 segment with HMI disposition code is received
- Applied to: Validate Train ID from M10 Segment
- Action: The system processes the M10 segment to extract train identification
Logic Flow:
IF A V9 segment with HMI disposition code is received
AND The system processes the M10 segment to extract train identification
THEN:
- • The train ID is validated and made available for subsequent hold processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train id has been extracted from the m10 segment.
Trigger Criteria:
- Context: A train ID has been extracted from the M10 segment
- Applied to: Train Found in System?
- Action: The system searches for the train in the GCWTL train list segments
Logic Flow:
IF A train ID has been extracted from the M10 segment
AND The system searches for the train in the GCWTL train list segments
THEN:
- • The system determines if the train exists and routes processing accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train exists in the gcwtl train list segments.
Trigger Criteria:
- Context: A train exists in the GCWTL train list segments
- Applied to: Retrieve Train Record from GCWTL
- Action: The system needs to process a hold disposition for the train
Logic Flow:
IF A train exists in the GCWTL train list segments
AND The system needs to process a hold disposition for the train
THEN:
- • The complete train record is retrieved from GCWTL for status updates
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid train record has been retrieved from gcwtl.
Trigger Criteria:
- Context: A valid train record has been retrieved from GCWTL
- Applied to: Set Train Hold Status Flag
- Action: An HMI disposition code is being processed
Logic Flow:
IF A valid train record has been retrieved from GCWTL
AND An HMI disposition code is being processed
THEN:
- • The train hold status flag is set to indicate the train is held
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train hold status flag has been set.
Trigger Criteria:
- Context: The train hold status flag has been set
- Applied to: Update Train Status in Database
- Action: The system completes hold processing
Logic Flow:
IF The train hold status flag has been set
AND The system completes hold processing
THEN:
- • The updated train status is written back to the GCWTL database
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train has been successfully placed on hold.
Trigger Criteria:
- Context: A train has been successfully placed on hold
- Applied to: Log Hold Action with Timestamp
- Action: The hold status has been updated in the database
Logic Flow:
IF A train has been successfully placed on hold
AND The hold status has been updated in the database
THEN:
- • A log entry is created with the hold action and current timestamp for audit purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train hold action has been logged.
Trigger Criteria:
- Context: A train hold action has been logged
- Applied to: Generate Merlin Hold Notification Message
- Action: The system needs to notify stakeholders of the hold
Logic Flow:
IF A train hold action has been logged
AND The system needs to notify stakeholders of the hold
THEN:
- • A Merlin hold notification message is generated with train details and hold information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when merlin hold notification message has been generated.
Trigger Criteria:
- Context: A Merlin hold notification message has been generated
- Applied to: Send Hold Notification to Recipients
- Action: The system processes notification distribution
Logic Flow:
IF A Merlin hold notification message has been generated
AND The system processes notification distribution
THEN:
- • The hold notification is sent to all designated recipients through the Merlin message system
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train id from m10 segment does not exist in gcwtl train list.
Trigger Criteria:
- Context: A train ID from M10 segment does not exist in GCWTL train list
- Applied to: Generate Train Not Found Error
- Action: The system attempts to process an HMI hold disposition
Logic Flow:
IF A train ID from M10 segment does not exist in GCWTL train list
AND The system attempts to process an HMI hold disposition
THEN:
- • A train not found error is generated for the invalid train ID
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train not found error has been generated.
Trigger Criteria:
- Context: A train not found error has been generated
- Applied to: Send Error Message to Default Recipient
- Action: The system needs to notify about the processing error
Logic Flow:
IF A train not found error has been generated
AND The system needs to notify about the processing error
THEN:
- • The error message is sent to the default recipient for error handling and resolution
R-GCX016E-cbl-00087 (+9) File: GCX016E.cbl Business Rule: Train Hold Release Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when hre disposition code is received and a vid segment is present in the message.
Trigger Criteria:
- Context: An HRE disposition code is received AND a VID segment is present in the message
- Applied to: Process VID Segment for Individual Equipment
- Action: The system processes the hold release event
Logic Flow:
IF An HRE disposition code is received AND a VID segment is present in the message
AND The system processes the hold release event
THEN:
- • The system processes VID segment for individual equipment hold release instead of train-level processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment-specific hold release is being processed and the equipment has an active hold counter.
Trigger Criteria:
- Context: Equipment-specific hold release is being processed AND the equipment has an active hold counter
- Applied to: Decrement Equipment Hold Counter
- Action: The VID segment is processed for hold release
Logic Flow:
IF Equipment-specific hold release is being processed AND the equipment has an active hold counter
AND The VID segment is processed for hold release
THEN:
- • The equipment hold counter is decremented by one
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment hold counter has been decremented.
Trigger Criteria:
- Context: Equipment hold counter has been decremented
- Applied to: Hold Counter = 0?
- Action: The system checks the equipment hold counter value
Logic Flow:
IF Equipment hold counter has been decremented
AND The system checks the equipment hold counter value
THEN:
- • IF the hold counter equals zero THEN proceed to remove equipment hold flag ELSE proceed to log hold release action
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment hold counter equals zero.
Trigger Criteria:
- Context: Equipment hold counter equals zero
- Applied to: Remove Equipment Hold Flag
- Action: All holds on the equipment have been released
Logic Flow:
IF Equipment hold counter equals zero
AND All holds on the equipment have been released
THEN:
- • The equipment hold status flag is removed from the equipment record
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when hre disposition code is received and no vid segment is present in the message.
Trigger Criteria:
- Context: An HRE disposition code is received AND no VID segment is present in the message
- Applied to: Process Train-Level Hold Release
- Action: The system processes the hold release event
Logic Flow:
IF An HRE disposition code is received AND no VID segment is present in the message
AND The system processes the hold release event
THEN:
- • The system processes train-level hold release for the entire train
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train-level hold release is being processed.
Trigger Criteria:
- Context: Train-level hold release is being processed
- Applied to: Remove Train Hold Status Flag
- Action: The system processes the train hold release
Logic Flow:
IF Train-level hold release is being processed
AND The system processes the train hold release
THEN:
- • The train hold status flag is removed from the train record
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when hold release action has been processed (either equipment-specific or train-level).
Trigger Criteria:
- Context: A hold release action has been processed (either equipment-specific or train-level)
- Applied to: Log Hold Release Action
- Action: The hold release processing is completed
Logic Flow:
IF A hold release action has been processed (either equipment-specific or train-level)
AND The hold release processing is completed
THEN:
- • The hold release action is logged in the system audit trail
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when hold release action has been logged.
Trigger Criteria:
- Context: Hold release action has been logged
- Applied to: Update Train Status in Database
- Action: The system completes hold release processing
Logic Flow:
IF Hold release action has been logged
AND The system completes hold release processing
THEN:
- • The train status is updated in the database with the current hold release information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train status has been updated in the database.
Trigger Criteria:
- Context: Train status has been updated in the database
- Applied to: Generate Merlin Notification Message
- Action: The hold release processing is nearly complete
Logic Flow:
IF Train status has been updated in the database
AND The hold release processing is nearly complete
THEN:
- • A Merlin notification message is generated containing hold release details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when merlin notification message has been generated.
Trigger Criteria:
- Context: A Merlin notification message has been generated
- Applied to: Send Hold Release Notification
- Action: The system is ready to send notifications
Logic Flow:
IF A Merlin notification message has been generated
AND The system is ready to send notifications
THEN:
- • The hold release notification is transmitted to the designated recipients
R-GCX016E-cbl-00097 (+13) File: GCX016E.cbl Business Rule: Train Arrival Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train arrival event (pod/aad disposition code) is being processed.
Trigger Criteria:
- Context: A train arrival event (POD/AAD disposition code) is being processed
- Applied to: Train ID Suffix Check
- Action: The system examines the train ID suffix
Logic Flow:
IF A train arrival event (POD/AAD disposition code) is being processed
AND The system examines the train ID suffix
THEN:
- • If the train ID ends with suffix 'T', classify as export manifest train,
otherwise classify as import manifest train
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train has been classified as export manifest train (suffix 't').
Trigger Criteria:
- Context: A train has been classified as export manifest train (suffix 'T')
- Applied to: Export Manifest Train - Suffix 'T'
- Action: The train arrival processing begins
Logic Flow:
IF A train has been classified as export manifest train (suffix 'T')
AND The train arrival processing begins
THEN:
- • Execute export manifest pre-arrival processing procedures
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train has been classified as import manifest train (no suffix 't').
Trigger Criteria:
- Context: A train has been classified as import manifest train (no suffix 'T')
- Applied to: Import Manifest Train - No Suffix 'T'
- Action: The train arrival processing begins
Logic Flow:
IF A train has been classified as import manifest train (no suffix 'T')
AND The train arrival processing begins
THEN:
- • Execute standard import manifest arrival processing procedures
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when export manifest train is being processed for arrival.
Trigger Criteria:
- Context: An export manifest train is being processed for arrival
- Applied to: Export Manifest Port Validation
- Action: The system validates the port location
Logic Flow:
IF An export manifest train is being processed for arrival
AND The system validates the port location
THEN:
- • If the port is valid for export operations, proceed with export manifest arrival flag setting,
otherwise redirect to import manifest processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when export manifest train has passed port validation.
Trigger Criteria:
- Context: An export manifest train has passed port validation
- Applied to: Set Export Manifest Arrival Flag
- Action: The arrival processing continues
Logic Flow:
IF An export manifest train has passed port validation
AND The arrival processing continues
THEN:
- • Set the export manifest arrival flag to indicate successful export arrival
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train is either an import manifest train or an export train that failed port validation.
Trigger Criteria:
- Context: A train is either an import manifest train or an export train that failed port validation
- Applied to: Set Standard Arrival Flag
- Action: The arrival processing continues
Logic Flow:
IF A train is either an import manifest train or an export train that failed port validation
AND The arrival processing continues
THEN:
- • Set the standard arrival flag to indicate train arrival
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train arrival flag has been set (either export or standard).
Trigger Criteria:
- Context: A train arrival flag has been set (either export or standard)
- Applied to: Set Train Arrival Date from V9 Segment
- Action: The system processes the V9 segment containing arrival information
Logic Flow:
IF A train arrival flag has been set (either export or standard)
AND The system processes the V9 segment containing arrival information
THEN:
- • Extract the arrival date from the V9 segment and assign it as the train's official arrival date
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train arrival date has been successfully assigned.
Trigger Criteria:
- Context: The train arrival date has been successfully assigned
- Applied to: Set Train Arrived Status Flag
- Action: The system updates train status information
Logic Flow:
IF The train arrival date has been successfully assigned
AND The system updates train status information
THEN:
- • Set the train arrived status flag to indicate the train has completed arrival processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train arrived status flag has been set.
Trigger Criteria:
- Context: The train arrived status flag has been set
- Applied to: US Cargo Arrival Processing
- Action: The system continues with cargo processing
Logic Flow:
IF The train arrived status flag has been set
AND The system continues with cargo processing
THEN:
- • Initiate arrival processing for all US cargo manifests associated with this train
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when us cargo arrival processing has been initiated.
Trigger Criteria:
- Context: US cargo arrival processing has been initiated
- Applied to: Send AEI Arrival Messages
- Action: The system processes AEI notification requirements
Logic Flow:
IF US cargo arrival processing has been initiated
AND The system processes AEI notification requirements
THEN:
- • Generate and send AEI arrival messages to notify relevant parties of train arrival
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when aei arrival messages have been sent.
Trigger Criteria:
- Context: AEI arrival messages have been sent
- Applied to: Send Email Notifications
- Action: The system processes notification distribution
Logic Flow:
IF AEI arrival messages have been sent
AND The system processes notification distribution
THEN:
- • Send email notifications to configured recipients about the train arrival event
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when k1 remark message processing for trains has been completed.
Trigger Criteria:
- Context: K1 remark message processing for trains has been completed
- Applied to: Log Train Arrival Action
- Action: The system finalizes arrival processing
Logic Flow:
IF K1 remark message processing for trains has been completed
AND The system finalizes arrival processing
THEN:
- • Create a log entry documenting the train arrival action with relevant details
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train arrival action has been logged.
Trigger Criteria:
- Context: The train arrival action has been logged
- Applied to: Update Train Status in Database
- Action: The system commits status changes
Logic Flow:
IF The train arrival action has been logged
AND The system commits status changes
THEN:
- • Update the train status information in the database to reflect the completed arrival
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train status has been updated in the database.
Trigger Criteria:
- Context: The train status has been updated in the database
- Applied to: Generate Merlin Arrival Notification
- Action: The system generates external notifications
Logic Flow:
IF The train status has been updated in the database
AND The system generates external notifications
THEN:
- • Create and send a Merlin arrival notification message to inform the Merlin system of the train arrival
R-GCX016E-cbl-00111 (+12) File: GCX016E.cbl Business Rule: Train Review Complete Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when v9 segment is received with a disposition code.
Trigger Criteria:
- Context: A V9 segment is received with a disposition code
- Applied to: Validate RC Disposition Code
- Action: The system processes the V9 segment
Logic Flow:
IF A V9 segment is received with a disposition code
AND The system processes the V9 segment
THEN:
- • The disposition code must be 'RC' to proceed with review complete processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train record exists in the system.
Trigger Criteria:
- Context: A train record exists in the system
- Applied to: Is Train Export Manifest?
- Action: The system needs to determine if it's an export manifest train
Logic Flow:
IF A train record exists in the system
AND The system needs to determine if it's an export manifest train
THEN:
- • The system checks the train ID suffix to identify export manifest trains
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train id is available for processing.
Trigger Criteria:
- Context: A train ID is available for processing
- Applied to: Train ID ends with 'T'?
- Action: The system checks the train ID suffix
Logic Flow:
IF A train ID is available for processing
AND The system checks the train ID suffix
THEN:
- • If the train ID ends with 'T', it is classified as an export manifest train,
otherwise it is processed as a regular train
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train has been identified as an export manifest train.
Trigger Criteria:
- Context: A train has been identified as an export manifest train
- Applied to: Mark as Export Manifest Train
- Action: The system processes the train classification
Logic Flow:
IF A train has been identified as an export manifest train
AND The system processes the train classification
THEN:
- • The train is marked with export manifest status for subsequent processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid rc disposition code has been processed for a train.
Trigger Criteria:
- Context: A valid RC disposition code has been processed for a train
- Applied to: Set Review Complete Flag
- Action: The system updates the train status
Logic Flow:
IF A valid RC disposition code has been processed for a train
AND The system updates the train status
THEN:
- • The review complete flag is set to indicate completion of the review process
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when review complete flag has been set for a train.
Trigger Criteria:
- Context: The review complete flag has been set for a train
- Applied to: Update Train Status in GCWTL
- Action: The system updates the train records
Logic Flow:
IF The review complete flag has been set for a train
AND The system updates the train records
THEN:
- • The train status is updated in the GCWTL train list segments with the new review complete status
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train review complete action has been processed.
Trigger Criteria:
- Context: A train review complete action has been processed
- Applied to: Log Review Complete Action
- Action: The system completes the status update
Logic Flow:
IF A train review complete action has been processed
AND The system completes the status update
THEN:
- • The review complete action is logged with appropriate details for audit purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train review complete action has been logged.
Trigger Criteria:
- Context: A train review complete action has been logged
- Applied to: Generate Merlin Notification Message
- Action: The system prepares notifications
Logic Flow:
IF A train review complete action has been logged
AND The system prepares notifications
THEN:
- • A Merlin notification message is generated containing the review complete details
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when review complete notification is being prepared.
Trigger Criteria:
- Context: A review complete notification is being prepared
- Applied to: K1 Remark Message Present?
- Action: The system checks for additional remark information
Logic Flow:
IF A review complete notification is being prepared
AND The system checks for additional remark information
THEN:
- • If K1 remark messages are present, they are processed for inclusion in the notification,
otherwise the notification proceeds without remarks
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when k1 remark messages are present in the transaction.
Trigger Criteria:
- Context: K1 remark messages are present in the transaction
- Applied to: Process K1 Free-Form Text
- Action: The system processes the K1 segments
Logic Flow:
IF K1 remark messages are present in the transaction
AND The system processes the K1 segments
THEN:
- • The free-form text from K1 segments is extracted and formatted for inclusion in notifications
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when k1 free-form text has been processed.
Trigger Criteria:
- Context: K1 free-form text has been processed
- Applied to: Add K1 Comments to Notification
- Action: The system builds the notification message
Logic Flow:
IF K1 free-form text has been processed
AND The system builds the notification message
THEN:
- • The processed K1 comments are added to the notification message content
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when complete review complete notification message has been prepared.
Trigger Criteria:
- Context: A complete review complete notification message has been prepared
- Applied to: Send Review Complete Notification
- Action: The system sends the notification
Logic Flow:
IF A complete review complete notification message has been prepared
AND The system sends the notification
THEN:
- • The notification is transmitted through the Merlin messaging system to appropriate recipients
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when review complete notification has been sent.
Trigger Criteria:
- Context: The review complete notification has been sent
- Applied to: Update Train Processing Status
- Action: The system finalizes the review complete processing
Logic Flow:
IF The review complete notification has been sent
AND The system finalizes the review complete processing
THEN:
- • The train processing status is updated to indicate successful completion of review complete processing
R-GCX016E-cbl-00124 (+13) File: GCX016E.cbl Business Rule: Train Not Arrived Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when v9 segment with oca disposition code is received.
Trigger Criteria:
- Context: A V9 segment with OCA disposition code is received
- Applied to: Validate Train ID from M10 Segment
- Action: The system processes the M10 segment for train identification
Logic Flow:
IF A V9 segment with OCA disposition code is received
AND The system processes the M10 segment for train identification
THEN:
- • The train ID must be extracted and validated from the M10 segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train id has been extracted from the m10 segment.
Trigger Criteria:
- Context: A train ID has been extracted from the M10 segment
- Applied to: Train Found in System?
- Action: The system searches the train list database
Logic Flow:
IF A train ID has been extracted from the M10 segment
AND The system searches the train list database
THEN:
- • If the train is not found in the system, processing should branch to warning generation,
otherwise continue to status checking
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid train id exists in the system.
Trigger Criteria:
- Context: A valid train ID exists in the system
- Applied to: Check Current Train Status
- Action: The system accesses the train status information
Logic Flow:
IF A valid train ID exists in the system
AND The system accesses the train status information
THEN:
- • The current train status must be retrieved for arrival status evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when current train status has been retrieved.
Trigger Criteria:
- Context: The current train status has been retrieved
- Applied to: Train Already Arrived?
- Action: The system evaluates the train's arrival status
Logic Flow:
IF The current train status has been retrieved
AND The system evaluates the train's arrival status
THEN:
- • If the train has already arrived, generate a warning; if not arrived, proceed with OCA disposition processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when either the train is not found in the system or the train has already arrived.
Trigger Criteria:
- Context: Either the train is not found in the system OR the train has already arrived
- Applied to: Generate Train Not Arrived Warning
- Action: An OCA disposition code is processed
Logic Flow:
IF Either the train is not found in the system OR the train has already arrived
AND An OCA disposition code is processed
THEN:
- • A train not arrived warning message must be generated and logged
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train exists in the system and has not yet arrived.
Trigger Criteria:
- Context: A train exists in the system and has not yet arrived
- Applied to: Log OCA Disposition Action
- Action: An OCA disposition code is processed
Logic Flow:
IF A train exists in the system and has not yet arrived
AND An OCA disposition code is processed
THEN:
- • The OCA disposition action must be logged in the system audit trail
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when oca disposition has been successfully logged for a non-arrived train.
Trigger Criteria:
- Context: An OCA disposition has been successfully logged for a non-arrived train
- Applied to: Set Train Re-Arrival Flag
- Action: The system processes the arrival cancellation
Logic Flow:
IF An OCA disposition has been successfully logged for a non-arrived train
AND The system processes the arrival cancellation
THEN:
- • A re-arrival flag must be set to enable future arrival processing for this train
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when re-arrival flag has been set for the train.
Trigger Criteria:
- Context: The re-arrival flag has been set for the train
- Applied to: Update Train Status to Not Arrived
- Action: The system updates the train status database
Logic Flow:
IF The re-arrival flag has been set for the train
AND The system updates the train status database
THEN:
- • The train status must be changed to 'Not Arrived' to reflect the cancelled arrival
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when either a warning condition exists or the train status has been updated to not arrived.
Trigger Criteria:
- Context: Either a warning condition exists OR the train status has been updated to not arrived
- Applied to: Create Merlin Notification Message
- Action: The system prepares notifications
Logic Flow:
IF Either a warning condition exists OR the train status has been updated to not arrived
AND The system prepares notifications
THEN:
- • A Merlin notification message must be created with appropriate train and disposition information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when merlin notification message is being created.
Trigger Criteria:
- Context: A Merlin notification message is being created
- Applied to: Include K1 Remark Messages if Present
- Action: K1 segment remark messages exist in the current transaction
Logic Flow:
IF A Merlin notification message is being created
AND K1 segment remark messages exist in the current transaction
THEN:
- • The K1 remark messages must be included in the Merlin notification message
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when merlin notification message has been created with or without k1 remarks.
Trigger Criteria:
- Context: A Merlin notification message has been created with or without K1 remarks
- Applied to: Send Warning to Operations Team
- Action: The system delivers the notification
Logic Flow:
IF A Merlin notification message has been created with or without K1 remarks
AND The system delivers the notification
THEN:
- • The warning message must be sent to the operations team via the Merlin messaging system
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when warning has been sent to the operations team.
Trigger Criteria:
- Context: The warning has been sent to the operations team
- Applied to: Trigger Re-Arrival Process
- Action: The system completes the OCA processing
Logic Flow:
IF The warning has been sent to the operations team
AND The system completes the OCA processing
THEN:
- • The re-arrival process must be triggered to allow the train to be processed for arrival again in the future
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when re-arrival process has been triggered.
Trigger Criteria:
- Context: The re-arrival process has been triggered
- Applied to: Log Processing Complete
- Action: All OCA processing steps are completed
Logic Flow:
IF The re-arrival process has been triggered
AND All OCA processing steps are completed
THEN:
- • A processing complete log entry must be created to document the successful completion of OCA handling
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when oca processing has been completed and logged.
Trigger Criteria:
- Context: OCA processing has been completed and logged
- Applied to: Continue to Next Message Segment
- Action: The system finishes the current segment processing
Logic Flow:
IF OCA processing has been completed and logged
AND The system finishes the current segment processing
THEN:
- • Processing must continue to the next message segment in the transaction
R-GCX016E-cbl-00138 (+15) File: GCX016E.cbl Business Rule: Train Arrival Cancellation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when v9 segment is received with coc disposition code.
Trigger Criteria:
- Context: A V9 segment is received with COC disposition code
- Applied to: V9 Segment with COC Disposition Code Received
- Action: The system processes the V9 segment
Logic Flow:
IF A V9 segment is received with COC disposition code
AND The system processes the V9 segment
THEN:
- • The system initiates train arrival cancellation processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train id is provided from m10 segment data.
Trigger Criteria:
- Context: A train ID is provided from M10 segment data
- Applied to: Validate Train ID from M10 Segment
- Action: The system validates the train identification
Logic Flow:
IF A train ID is provided from M10 segment data
AND The system validates the train identification
THEN:
- • The system confirms train ID is valid and accessible for cancellation processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train id has been validated from m10 segment.
Trigger Criteria:
- Context: A train ID has been validated from M10 segment
- Applied to: Train Found in System?
- Action: The system searches for the train in the train list
Logic Flow:
IF A train ID has been validated from M10 segment
AND The system searches for the train in the train list
THEN:
- • The system determines if the train exists and can proceed with cancellation or must log an error
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train id cannot be found in the train management system.
Trigger Criteria:
- Context: A train ID cannot be found in the train management system
- Applied to: Log Train Not Found Error
- Action: The system attempts to process train arrival cancellation
Logic Flow:
IF A train ID cannot be found in the train management system
AND The system attempts to process train arrival cancellation
THEN:
- • The system logs a train not found error and terminates the cancellation process
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid train has been found in the system.
Trigger Criteria:
- Context: A valid train has been found in the system
- Applied to: Check Current Train Status
- Action: The system checks the train's current status
Logic Flow:
IF A valid train has been found in the system
AND The system checks the train's current status
THEN:
- • The system retrieves current train status information for cancellation decision making
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when current train status has been retrieved.
Trigger Criteria:
- Context: The current train status has been retrieved
- Applied to: Train Currently Arrived?
- Action: The system evaluates if the train is currently in arrived status
Logic Flow:
IF The current train status has been retrieved
AND The system evaluates if the train is currently in arrived status
THEN:
- • The system determines whether to proceed with arrival cancellation or log a warning for non-arrived trains
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train is currently in arrived status and cancellation is requested.
Trigger Criteria:
- Context: A train is currently in arrived status and cancellation is requested
- Applied to: Cancel Train Arrival Status
- Action: The system processes the arrival cancellation
Logic Flow:
IF A train is currently in arrived status and cancellation is requested
AND The system processes the arrival cancellation
THEN:
- • The system removes the arrival status from the train record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train arrival status has been cancelled.
Trigger Criteria:
- Context: Train arrival status has been cancelled
- Applied to: Update Train Arrival Date to Null
- Action: The system updates train arrival information
Logic Flow:
IF Train arrival status has been cancelled
AND The system updates train arrival information
THEN:
- • The system sets the train arrival date to null
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train arrival date has been nullified.
Trigger Criteria:
- Context: Train arrival date has been nullified
- Applied to: Clear Train Arrival Flags
- Action: The system completes arrival cancellation processing
Logic Flow:
IF Train arrival date has been nullified
AND The system completes arrival cancellation processing
THEN:
- • The system clears all train arrival flags and indicators
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train arrival flags have been cleared.
Trigger Criteria:
- Context: Train arrival flags have been cleared
- Applied to: Log COC Arrival Cancellation Action
- Action: The system completes the cancellation process
Logic Flow:
IF Train arrival flags have been cleared
AND The system completes the cancellation process
THEN:
- • The system logs the COC arrival cancellation action for audit purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when coc arrival cancellation action has been logged.
Trigger Criteria:
- Context: COC arrival cancellation action has been logged
- Applied to: Generate Train Arrival Cancellation Warning
- Action: The system generates operational notifications
Logic Flow:
IF COC arrival cancellation action has been logged
AND The system generates operational notifications
THEN:
- • The system creates a train arrival cancellation warning message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train is not currently in arrived status.
Trigger Criteria:
- Context: A train is not currently in arrived status
- Applied to: Log Warning - Train Not Previously Arrived
- Action: The system processes a COC cancellation request
Logic Flow:
IF A train is not currently in arrived status
AND The system processes a COC cancellation request
THEN:
- • The system logs a warning that the train was not previously arrived
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train arrival cancellation warning has been generated or non-arrived warning has been logged.
Trigger Criteria:
- Context: Train arrival cancellation warning has been generated or non-arrived warning has been logged
- Applied to: Create Merlin Notification Message
- Action: The system prepares business notifications
Logic Flow:
IF Train arrival cancellation warning has been generated or non-arrived warning has been logged
AND The system prepares business notifications
THEN:
- • The system creates a formatted Merlin notification message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when merlin notification message has been created.
Trigger Criteria:
- Context: A Merlin notification message has been created
- Applied to: Send Notification to Business Users
- Action: The system sends business notifications
Logic Flow:
IF A Merlin notification message has been created
AND The system sends business notifications
THEN:
- • The system delivers the notification to appropriate business users
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when notification has been sent to business users.
Trigger Criteria:
- Context: Notification has been sent to business users
- Applied to: Update Train Status in Database
- Action: The system finalizes the cancellation process
Logic Flow:
IF Notification has been sent to business users
AND The system finalizes the cancellation process
THEN:
- • The system updates the train status information in the database
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train status has been updated in the database or error has been logged.
Trigger Criteria:
- Context: Train status has been updated in the database or error has been logged
- Applied to: Process Complete
- Action: The system finishes all cancellation processing steps
Logic Flow:
IF Train status has been updated in the database or error has been logged
AND The system finishes all cancellation processing steps
THEN:
- • The system marks the train arrival cancellation process as complete
R-GCX016E-cbl-00154 (+11) File: GCX016E.cbl Business Rule: Train Lock Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when v9 segment contains event code lck for train lock processing.
Trigger Criteria:
- Context: A V9 segment contains event code LCK for train lock processing
- Applied to: Receive LCK Disposition Code for Train
- Action: The system processes the V9 segment with LCK event code
Logic Flow:
IF A V9 segment contains event code LCK for train lock processing
AND The system processes the V9 segment with LCK event code
THEN:
- • The system initiates train lock processing workflow
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when m10 segment contains vessel/train information.
Trigger Criteria:
- Context: An M10 segment contains vessel/train information
- Applied to: Validate Train ID from M10 Segment
- Action: The system processes the M10 segment for train identification
Logic Flow:
IF An M10 segment contains vessel/train information
AND The system processes the M10 segment for train identification
THEN:
- • The system extracts and validates the train ID for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train id has been extracted from m10 segment and vessel name does not start with 'train' or 'day'.
Trigger Criteria:
- Context: A train ID has been extracted from M10 segment AND vessel name does not start with 'TRAIN' or 'DAY'
- Applied to: Train Found in System?
- Action: The system searches the train list for the specified train ID
Logic Flow:
IF A train ID has been extracted from M10 segment AND vessel name does not start with 'TRAIN' or 'DAY'
AND The system searches the train list for the specified train ID
THEN:
- • The system determines if the train exists in the system OR generates train not found error if train does not exist
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train has been found in the system.
Trigger Criteria:
- Context: A train has been found in the system
- Applied to: Retrieve Current Train Status
- Action: The system needs to process a lock request for the train
Logic Flow:
IF A train has been found in the system
AND The system needs to process a lock request for the train
THEN:
- • The system retrieves the current status information for the train
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when current train status has been retrieved.
Trigger Criteria:
- Context: Current train status has been retrieved
- Applied to: Train Already Locked?
- Action: The system evaluates the train's current lock status
Logic Flow:
IF Current train status has been retrieved
AND The system evaluates the train's current lock status
THEN:
- • The system determines if the train is already locked OR proceeds with lock processing if not already locked
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train is not currently locked.
Trigger Criteria:
- Context: A train is not currently locked
- Applied to: Set Train Lock Status Flag
- Action: The system processes a LCK disposition code for the train
Logic Flow:
IF A train is not currently locked
AND The system processes a LCK disposition code for the train
THEN:
- • The system sets the train locked status flag
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train lock status flag has been set.
Trigger Criteria:
- Context: Train lock status flag has been set
- Applied to: Update Train Record in Database
- Action: The system commits the lock status change
Logic Flow:
IF Train lock status flag has been set
AND The system commits the lock status change
THEN:
- • The system updates the train record in the database with the new lock status
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train record has been updated with lock status.
Trigger Criteria:
- Context: Train record has been updated with lock status
- Applied to: Log Train Lock Action
- Action: The system completes the lock processing
Logic Flow:
IF Train record has been updated with lock status
AND The system completes the lock processing
THEN:
- • The system logs the train lock action with relevant details
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train lock action has been logged.
Trigger Criteria:
- Context: Train lock action has been logged
- Applied to: Generate Merlin Notification Message
- Action: The system processes notification requirements
Logic Flow:
IF Train lock action has been logged
AND The system processes notification requirements
THEN:
- • The system generates a Merlin notification message for the train lock event
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when merlin notification message has been generated.
Trigger Criteria:
- Context: Merlin notification message has been generated
- Applied to: Send Lock Confirmation to Business Users
- Action: The system processes user notification requirements
Logic Flow:
IF Merlin notification message has been generated
AND The system processes user notification requirements
THEN:
- • The system sends lock confirmation to appropriate business users
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train id has been validated and the train does not exist in the train list.
Trigger Criteria:
- Context: A train ID has been validated AND the train does not exist in the train list
- Applied to: Generate Error Message - Train Not Found
- Action: The system attempts to process a lock request for non-existent train
Logic Flow:
IF A train ID has been validated AND the train does not exist in the train list
AND The system attempts to process a lock request for non-existent train
THEN:
- • The system generates an error message indicating train not found
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train's current status shows it is already locked.
Trigger Criteria:
- Context: A train's current status shows it is already locked
- Applied to: Generate Warning - Train Already Locked
- Action: The system processes a LCK disposition code for the already locked train
Logic Flow:
IF A train's current status shows it is already locked
AND The system processes a LCK disposition code for the already locked train
THEN:
- • The system generates a warning message indicating the train is already locked
R-GCX016E-cbl-00166 (+10) File: GCX016E.cbl Business Rule: Train Unlock Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when v9 segment is received with event code ulc.
Trigger Criteria:
- Context: A V9 segment is received with event code ULC
- Applied to: Receive ULC Disposition Code in V9 Segment
- Action: The system processes the V9 segment
Logic Flow:
IF A V9 segment is received with event code ULC
AND The system processes the V9 segment
THEN:
- • The system initiates train unlock processing workflow
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when unlock request is being processed.
Trigger Criteria:
- Context: An unlock request is being processed
- Applied to: Validate Train ID from M10 Segment
- Action: The system needs to identify the target train
Logic Flow:
IF An unlock request is being processed
AND The system needs to identify the target train
THEN:
- • The system retrieves and validates train identification from the M10 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train id has been extracted from the m10 segment.
Trigger Criteria:
- Context: A train ID has been extracted from the M10 segment
- Applied to: Train Found in System?
- Action: The system searches for the train in the train list
Logic Flow:
IF A train ID has been extracted from the M10 segment
AND The system searches for the train in the train list
THEN:
- • If the train is found, processing continues; if not found, an error is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid train has been identified in the system.
Trigger Criteria:
- Context: A valid train has been identified in the system
- Applied to: Retrieve Current Train Status
- Action: The system needs to process an unlock request
Logic Flow:
IF A valid train has been identified in the system
AND The system needs to process an unlock request
THEN:
- • The system retrieves the current lock status of the train
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when current train status has been retrieved.
Trigger Criteria:
- Context: The current train status has been retrieved
- Applied to: Train Currently Locked?
- Action: The system evaluates whether unlock operation should proceed
Logic Flow:
IF The current train status has been retrieved
AND The system evaluates whether unlock operation should proceed
THEN:
- • If train is locked, unlock proceeds; if not locked, a warning is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train is currently in locked status.
Trigger Criteria:
- Context: A train is currently in locked status
- Applied to: Update Train Status to Unlocked
- Action: A valid unlock request is processed
Logic Flow:
IF A train is currently in locked status
AND A valid unlock request is processed
THEN:
- • The system updates the train status to unlocked
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train status has been successfully updated to unlocked.
Trigger Criteria:
- Context: A train status has been successfully updated to unlocked
- Applied to: Log Train Unlock Action
- Action: The unlock operation completes
Logic Flow:
IF A train status has been successfully updated to unlocked
AND The unlock operation completes
THEN:
- • The system logs the unlock action with timestamp and train details
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train unlock action has been logged.
Trigger Criteria:
- Context: A train unlock action has been logged
- Applied to: Generate Merlin Notification Message
- Action: The system needs to notify stakeholders
Logic Flow:
IF A train unlock action has been logged
AND The system needs to notify stakeholders
THEN:
- • The system generates a Merlin notification message with unlock details
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when merlin notification message has been generated.
Trigger Criteria:
- Context: A Merlin notification message has been generated
- Applied to: Send Train Unlock Confirmation
- Action: The system completes unlock processing
Logic Flow:
IF A Merlin notification message has been generated
AND The system completes unlock processing
THEN:
- • The system sends unlock confirmation to the requesting party
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train id has been provided for unlock processing.
Trigger Criteria:
- Context: A train ID has been provided for unlock processing
- Applied to: Generate Error Message - Train Not Found
- Action: The train cannot be found in the system
Logic Flow:
IF A train ID has been provided for unlock processing
AND The train cannot be found in the system
THEN:
- • The system generates an error message indicating train not found
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid train has been identified for unlock processing.
Trigger Criteria:
- Context: A valid train has been identified for unlock processing
- Applied to: Generate Warning - Train Not Locked
- Action: The train is not currently in locked status
Logic Flow:
IF A valid train has been identified for unlock processing
AND The train is not currently in locked status
THEN:
- • The system generates a warning message indicating train is not locked
R-GCX016E-cbl-00177 (+15) File: GCX016E.cbl Business Rule: Train Seizure Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when v9 segment contains event code 'sei' for train seizure.
Trigger Criteria:
- Context: A V9 segment contains event code 'SEI' for train seizure
- Applied to: SEI Disposition Code Received for Train
- Action: The system processes the V9 segment with SEI event code
Logic Flow:
IF A V9 segment contains event code 'SEI' for train seizure
AND The system processes the V9 segment with SEI event code
THEN:
- • The system initiates train seizure processing workflow
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when m10 segment contains vessel/train identification information.
Trigger Criteria:
- Context: An M10 segment contains vessel/train identification information
- Applied to: Validate Train ID from M10 Segment
- Action: The system processes the M10 segment for train seizure
Logic Flow:
IF An M10 segment contains vessel/train identification information
AND The system processes the M10 segment for train seizure
THEN:
- • The system extracts the train ID and prepares it for validation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train id has been extracted from the m10 segment.
Trigger Criteria:
- Context: A train ID has been extracted from the M10 segment
- Applied to: Train Found in System?
- Action: The system searches for the train in the train list
Logic Flow:
IF A train ID has been extracted from the M10 segment
AND The system searches for the train in the train list
THEN:
- • The system determines if the train exists and is valid for seizure processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid train has been found in the system.
Trigger Criteria:
- Context: A valid train has been found in the system
- Applied to: Retrieve Current Train Status
- Action: The system needs to process a seizure request
Logic Flow:
IF A valid train has been found in the system
AND The system needs to process a seizure request
THEN:
- • The system retrieves the current train status including seizure flag
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when current train status has been retrieved.
Trigger Criteria:
- Context: The current train status has been retrieved
- Applied to: Train Already Seized?
- Action: The system checks if the train is already seized
Logic Flow:
IF The current train status has been retrieved
AND The system checks if the train is already seized
THEN:
- • If train seizure flag is 'Y', skip processing;
otherwise proceed with seizure
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train is not currently seized and seizure processing is required.
Trigger Criteria:
- Context: A train is not currently seized and seizure processing is required
- Applied to: Set Train Seizure Flag to 'Y'
- Action: The system processes the seizure request
Logic Flow:
IF A train is not currently seized and seizure processing is required
AND The system processes the seizure request
THEN:
- • The system sets the train seizure flag to 'Y'
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train seizure flag has been set to 'y'.
Trigger Criteria:
- Context: The train seizure flag has been set to 'Y'
- Applied to: Update Train Status in Database
- Action: The system needs to save the status change
Logic Flow:
IF The train seizure flag has been set to 'Y'
AND The system needs to save the status change
THEN:
- • The system updates the train record in the database with the new seizure status
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train has been successfully seized.
Trigger Criteria:
- Context: A train has been successfully seized
- Applied to: Log Seizure Action with Timestamp
- Action: The system completes the seizure status update
Logic Flow:
IF A train has been successfully seized
AND The system completes the seizure status update
THEN:
- • The system logs the seizure action with current date and time
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train seizure has been logged successfully.
Trigger Criteria:
- Context: A train seizure has been logged successfully
- Applied to: Generate Merlin Notification Message
- Action: The system needs to notify stakeholders
Logic Flow:
IF A train seizure has been logged successfully
AND The system needs to notify stakeholders
THEN:
- • The system generates a Merlin notification message with seizure details
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when merlin notification message has been generated for train seizure.
Trigger Criteria:
- Context: A Merlin notification message has been generated for train seizure
- Applied to: Send Seizure Notification to Customs
- Action: The system sends notifications to relevant parties
Logic Flow:
IF A Merlin notification message has been generated for train seizure
AND The system sends notifications to relevant parties
THEN:
- • The system sends the seizure notification to customs authorities
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train has been seized and notifications sent.
Trigger Criteria:
- Context: A train has been seized and notifications sent
- Applied to: Update Train Equipment List Status
- Action: The system processes equipment associated with the train
Logic Flow:
IF A train has been seized and notifications sent
AND The system processes equipment associated with the train
THEN:
- • The system updates the equipment list status to reflect the train seizure
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train equipment list has been updated.
Trigger Criteria:
- Context: The train equipment list has been updated
- Applied to: Mark All Equipment in Train as Seized
- Action: The system processes individual equipment items
Logic Flow:
IF The train equipment list has been updated
AND The system processes individual equipment items
THEN:
- • The system marks each equipment item in the train as seized
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train seizure processing is in progress and k1 segments may be present.
Trigger Criteria:
- Context: Train seizure processing is in progress and K1 segments may be present
- Applied to: Process K1 Remark Messages if Present
- Action: The system checks for K1 remark segments
Logic Flow:
IF Train seizure processing is in progress and K1 segments may be present
AND The system checks for K1 remark segments
THEN:
- • If K1 segments exist, the system processes the remark messages and includes them in seizure documentation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train id has been extracted but the train is not found in the system.
Trigger Criteria:
- Context: A train ID has been extracted but the train is not found in the system
- Applied to: Generate Error Message - Train Not Found
- Action: The system cannot locate the train for seizure processing
Logic Flow:
IF A train ID has been extracted but the train is not found in the system
AND The system cannot locate the train for seizure processing
THEN:
- • The system generates an error message indicating train not found
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train is found in the system but is already seized.
Trigger Criteria:
- Context: A train is found in the system but is already seized
- Applied to: Skip Processing - Already Seized
- Action: The system checks the current seizure status
Logic Flow:
IF A train is found in the system but is already seized
AND The system checks the current seizure status
THEN:
- • The system skips seizure processing and continues to completion
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all seizure processing steps have been completed or skipped appropriately.
Trigger Criteria:
- Context: All seizure processing steps have been completed or skipped appropriately
- Applied to: Complete Train Seizure Processing
- Action: The system reaches the end of seizure processing
Logic Flow:
IF All seizure processing steps have been completed or skipped appropriately
AND The system reaches the end of seizure processing
THEN:
- • The system completes the train seizure processing and returns control to the main workflow
R-GCX016E-cbl-00193 (+17) File: GCX016E.cbl Business Rule: Train Seizure Release Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when v9 segment with event code ser is received for a train.
Trigger Criteria:
- Context: A V9 segment with event code SER is received for a train
- Applied to: Receive SER Disposition Code for Train
- Action: The system processes the SER disposition code
Logic Flow:
IF A V9 segment with event code SER is received for a train
AND The system processes the SER disposition code
THEN:
- • The train seizure release workflow is initiated
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when m10 segment contains train identification information.
Trigger Criteria:
- Context: An M10 segment contains train identification information
- Applied to: Validate Train ID from M10 Segment
- Action: The system processes seizure release for the train
Logic Flow:
IF An M10 segment contains train identification information
AND The system processes seizure release for the train
THEN:
- • The train ID is extracted and validated from the M10 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train id is provided for seizure release processing.
Trigger Criteria:
- Context: A train ID is provided for seizure release processing
- Applied to: Train Found in System?
- Action: The system looks up the train in the train list
Logic Flow:
IF A train ID is provided for seizure release processing
AND The system looks up the train in the train list
THEN:
- • The system determines if the train exists and is valid for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid train exists in the system.
Trigger Criteria:
- Context: A valid train exists in the system
- Applied to: Check Current Train Seizure Status
- Action: The system processes a seizure release request
Logic Flow:
IF A valid train exists in the system
AND The system processes a seizure release request
THEN:
- • The current seizure status of the train is retrieved and evaluated
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train's current seizure status has been retrieved.
Trigger Criteria:
- Context: A train's current seizure status has been retrieved
- Applied to: Train Currently Seized?
- Action: The system evaluates if seizure release is applicable
Logic Flow:
IF A train's current seizure status has been retrieved
AND The system evaluates if seizure release is applicable
THEN:
- • The system determines if the train is currently seized and can be released
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train is currently in seized status.
Trigger Criteria:
- Context: A train is currently in seized status
- Applied to: Release Train from Seizure Status
- Action: A valid seizure release request is processed
Logic Flow:
IF A train is currently in seized status
AND A valid seizure release request is processed
THEN:
- • The train's seizure status is cleared and the train is released
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train has been released from seizure status.
Trigger Criteria:
- Context: A train has been released from seizure status
- Applied to: Update Train Status Flags
- Action: The seizure release processing continues
Logic Flow:
IF A train has been released from seizure status
AND The seizure release processing continues
THEN:
- • All relevant train status flags are updated to reflect the new status
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train seizure release has been successfully processed.
Trigger Criteria:
- Context: A train seizure release has been successfully processed
- Applied to: Log Seizure Release Action
- Action: The system completes the status update
Logic Flow:
IF A train seizure release has been successfully processed
AND The system completes the status update
THEN:
- • The seizure release action is logged with relevant details
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train seizure release has been processed.
Trigger Criteria:
- Context: A train seizure release has been processed
- Applied to: Process Individual Equipment in Train
- Action: The system processes associated equipment
Logic Flow:
IF A train seizure release has been processed
AND The system processes associated equipment
THEN:
- • Each piece of equipment in the train is individually evaluated for seizure release
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when individual equipment is being processed for seizure release.
Trigger Criteria:
- Context: Individual equipment is being processed for seizure release
- Applied to: Equipment Seized?
- Action: The system evaluates each piece of equipment
Logic Flow:
IF Individual equipment is being processed for seizure release
AND The system evaluates each piece of equipment
THEN:
- • The system determines if the equipment is currently in seized status
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when equipment is currently in seized status.
Trigger Criteria:
- Context: Equipment is currently in seized status
- Applied to: Release Equipment from Seizure
- Action: The train seizure release is processed
Logic Flow:
IF Equipment is currently in seized status
AND The train seizure release is processed
THEN:
- • The individual equipment is released from seizure status
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has been released from seizure.
Trigger Criteria:
- Context: Equipment has been released from seizure
- Applied to: Update Equipment Seizure Counter
- Action: The seizure release processing continues
Logic Flow:
IF Equipment has been released from seizure
AND The seizure release processing continues
THEN:
- • The equipment seizure counter is updated to reflect the release
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when current equipment processing is complete.
Trigger Criteria:
- Context: Current equipment processing is complete
- Applied to: Continue to Next Equipment
- Action: More equipment exists in the train
Logic Flow:
IF Current equipment processing is complete
AND More equipment exists in the train
THEN:
- • The system moves to process the next piece of equipment
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all equipment in the train has been processed for seizure release.
Trigger Criteria:
- Context: All equipment in the train has been processed for seizure release
- Applied to: Generate Train Seizure Release Notification
- Action: The seizure release processing is complete
Logic Flow:
IF All equipment in the train has been processed for seizure release
AND The seizure release processing is complete
THEN:
- • A train seizure release notification is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train seizure release notification has been generated.
Trigger Criteria:
- Context: A train seizure release notification has been generated
- Applied to: Send Notification to Business Users
- Action: The notification is ready for distribution
Logic Flow:
IF A train seizure release notification has been generated
AND The notification is ready for distribution
THEN:
- • The notification is sent to appropriate business users
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train id is provided for seizure release.
Trigger Criteria:
- Context: A train ID is provided for seizure release
- Applied to: Generate Train Not Found Error
- Action: The train cannot be found in the system
Logic Flow:
IF A train ID is provided for seizure release
AND The train cannot be found in the system
THEN:
- • A train not found error is generated and processing stops
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train exists but is not currently in seized status.
Trigger Criteria:
- Context: A train exists but is not currently in seized status
- Applied to: Log Warning - Train Not Seized
- Action: A seizure release request is processed
Logic Flow:
IF A train exists but is not currently in seized status
AND A seizure release request is processed
THEN:
- • A warning is logged indicating the train is not seized and processing continues
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all seizure release processing steps have been executed.
Trigger Criteria:
- Context: All seizure release processing steps have been executed
- Applied to: Complete Seizure Release Processing
- Action: The workflow reaches completion
Logic Flow:
IF All seizure release processing steps have been executed
AND The workflow reaches completion
THEN:
- • The seizure release processing is marked as complete
R-GCX016E-cbl-00211 (+11) File: GCX016E.cbl Business Rule: Train All Clear Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cae disposition code is received for a specific train.
Trigger Criteria:
- Context: A CAE disposition code is received for a specific train
- Applied to: Receive CAE Disposition Code for Train
- Action: The system processes the CAE event code
Logic Flow:
IF A CAE disposition code is received for a specific train
AND The system processes the CAE event code
THEN:
- • The train all clear processing is initiated
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cae disposition code is being processed for a train.
Trigger Criteria:
- Context: A CAE disposition code is being processed for a train
- Applied to: Validate Train Exists in System
- Action: The system checks the train list segments
Logic Flow:
IF A CAE disposition code is being processed for a train
AND The system checks the train list segments
THEN:
- • The train existence is validated against the GCWTL train list
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train existence validation has been completed.
Trigger Criteria:
- Context: Train existence validation has been completed
- Applied to: Train Found?
- Action: The system evaluates if the train was found in the train list
Logic Flow:
IF Train existence validation has been completed
AND The system evaluates if the train was found in the train list
THEN:
- • Processing continues to set all clear status if train exists,
otherwise error processing is initiated
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid train has been found in the system.
Trigger Criteria:
- Context: A valid train has been found in the system
- Applied to: Set Train All Clear Status Flag
- Action: The CAE disposition code is processed
Logic Flow:
IF A valid train has been found in the system
AND The CAE disposition code is processed
THEN:
- • The train all clear status flag is set to indicate the train is cleared for export
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train all clear status flag has been set.
Trigger Criteria:
- Context: A train all clear status flag has been set
- Applied to: Clear Any Previous Hold Status
- Action: The system processes the all clear action
Logic Flow:
IF A train all clear status flag has been set
AND The system processes the all clear action
THEN:
- • Any previous hold status flags are cleared to ensure clean all clear state
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train all clear status has been set and previous holds cleared.
Trigger Criteria:
- Context: Train all clear status has been set and previous holds cleared
- Applied to: Update Train Status in Database
- Action: The system commits the status changes
Logic Flow:
IF Train all clear status has been set and previous holds cleared
AND The system commits the status changes
THEN:
- • The train status is updated in the database with the new all clear status
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train status has been successfully updated in the database.
Trigger Criteria:
- Context: Train status has been successfully updated in the database
- Applied to: Log All Clear Action
- Action: The all clear processing is completed
Logic Flow:
IF Train status has been successfully updated in the database
AND The all clear processing is completed
THEN:
- • An audit log entry is created documenting the all clear action with timestamp and train details
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all clear action has been logged successfully.
Trigger Criteria:
- Context: All clear action has been logged successfully
- Applied to: Generate Merlin Notification Message
- Action: The system generates notifications
Logic Flow:
IF All clear action has been logged successfully
AND The system generates notifications
THEN:
- • A Merlin notification message is created containing train details and all clear status information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when merlin notification message has been generated.
Trigger Criteria:
- Context: Merlin notification message has been generated
- Applied to: Send All Clear Confirmation
- Action: The system sends the notification
Logic Flow:
IF Merlin notification message has been generated
AND The system sends the notification
THEN:
- • The all clear confirmation is transmitted to the Merlin system for distribution
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train validation has failed and train was not found.
Trigger Criteria:
- Context: Train validation has failed and train was not found
- Applied to: Generate Train Not Found Error
- Action: The system processes the validation failure
Logic Flow:
IF Train validation has failed and train was not found
AND The system processes the validation failure
THEN:
- • A train not found error message is generated with relevant train identification details
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train not found error has been generated.
Trigger Criteria:
- Context: Train not found error has been generated
- Applied to: Send Error Message to Merlin
- Action: The system transmits the error notification
Logic Flow:
IF Train not found error has been generated
AND The system transmits the error notification
THEN:
- • The error message is sent to Merlin system to notify relevant parties of the processing failure
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when either all clear confirmation has been sent or error message has been transmitted.
Trigger Criteria:
- Context: Either all clear confirmation has been sent or error message has been transmitted
- Applied to: Process Complete
- Action: The processing workflow reaches completion
Logic Flow:
IF Either all clear confirmation has been sent or error message has been transmitted
AND The processing workflow reaches completion
THEN:
- • The CAE all clear processing is marked as complete and control returns to main processing flow
R-GCX016E-cbl-00223 (+13) File: GCX016E.cbl Business Rule: Equipment Hold Release Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when vid segment is received with hre disposition code.
Trigger Criteria:
- Context: A VID segment is received with HRE disposition code
- Applied to: Validate Equipment ID in VID Segment
- Action: The system processes the VID segment equipment ID field
Logic Flow:
IF A VID segment is received with HRE disposition code
AND The system processes the VID segment equipment ID field
THEN:
- • The equipment ID must contain non-blank, valid alphanumeric data to proceed with hold release processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid equipment id from vid segment.
Trigger Criteria:
- Context: A valid equipment ID from VID segment
- Applied to: Look up Equipment in Train Consist
- Action: The system searches the train consist list for the equipment
Logic Flow:
IF A valid equipment ID from VID segment
AND The system searches the train consist list for the equipment
THEN:
- • The equipment must be found in the train consist to proceed with hold release processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment exists in the train consist.
Trigger Criteria:
- Context: Equipment exists in the train consist
- Applied to: Check Current Equipment Hold Status
- Action: The system checks the equipment's current hold status
Logic Flow:
IF Equipment exists in the train consist
AND The system checks the equipment's current hold status
THEN:
- • The equipment must currently have a hold flag set to proceed with hold release
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment is currently held with hold flag set.
Trigger Criteria:
- Context: Equipment is currently held with hold flag set
- Applied to: Remove Equipment Hold Flag
- Action: HRE disposition code is processed for the equipment
Logic Flow:
IF Equipment is currently held with hold flag set
AND HRE disposition code is processed for the equipment
THEN:
- • The system removes the hold flag from the equipment record
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment hold flag has been removed.
Trigger Criteria:
- Context: Equipment hold flag has been removed
- Applied to: Update Equipment Status in Train List
- Action: The system updates the train list
Logic Flow:
IF Equipment hold flag has been removed
AND The system updates the train list
THEN:
- • The equipment status in the train list is updated to reflect the released status
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment hold has been successfully released.
Trigger Criteria:
- Context: Equipment hold has been successfully released
- Applied to: Decrement Train Hold Counter
- Action: The system updates train-level counters
Logic Flow:
IF Equipment hold has been successfully released
AND The system updates train-level counters
THEN:
- • The train hold counter is decremented by one to reflect the equipment release
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment hold has been successfully released.
Trigger Criteria:
- Context: Equipment hold has been successfully released
- Applied to: Log Equipment Hold Release Action
- Action: The system performs logging operations
Logic Flow:
IF Equipment hold has been successfully released
AND The system performs logging operations
THEN:
- • An audit record is created documenting the equipment hold release action with timestamp and equipment details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train hold counter has been decremented.
Trigger Criteria:
- Context: Train hold counter has been decremented
- Applied to: All Equipment Released?
- Action: The system checks if any equipment remains held
Logic Flow:
IF Train hold counter has been decremented
AND The system checks if any equipment remains held
THEN:
- • If train hold counter equals zero, all equipment is considered released;
otherwise equipment remains held
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all equipment in the train has been released from hold.
Trigger Criteria:
- Context: All equipment in the train has been released from hold
- Applied to: Update Train Hold Status to Released
- Action: The system updates the train status
Logic Flow:
IF All equipment in the train has been released from hold
AND The system updates the train status
THEN:
- • The train hold status is set to released
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when equipment hold release has been logged.
Trigger Criteria:
- Context: Equipment hold release has been logged
- Applied to: Generate Equipment Release Notification
- Action: The system generates notifications
Logic Flow:
IF Equipment hold release has been logged
AND The system generates notifications
THEN:
- • Internal notifications are created to inform relevant parties of the equipment release
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment release notification has been generated.
Trigger Criteria:
- Context: Equipment release notification has been generated
- Applied to: Send Merlin Message for Equipment Release
- Action: The system sends external notifications
Logic Flow:
IF Equipment release notification has been generated
AND The system sends external notifications
THEN:
- • A Merlin message is sent containing equipment release details to external systems
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when vid segment contains invalid or blank equipment id.
Trigger Criteria:
- Context: VID segment contains invalid or blank equipment ID
- Applied to: Generate Error - Invalid Equipment ID
- Action: Equipment ID validation fails
Logic Flow:
IF VID segment contains invalid or blank equipment ID
AND Equipment ID validation fails
THEN:
- • An error is generated indicating invalid equipment ID and processing stops
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid equipment id that does not exist in train consist.
Trigger Criteria:
- Context: Valid equipment ID that does not exist in train consist
- Applied to: Generate Error - Equipment Not Found
- Action: Equipment lookup in train consist fails
Logic Flow:
IF Valid equipment ID that does not exist in train consist
AND Equipment lookup in train consist fails
THEN:
- • An error is generated indicating equipment not found in train and processing stops
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment exists in train but is not currently held.
Trigger Criteria:
- Context: Equipment exists in train but is not currently held
- Applied to: Generate Warning - Equipment Not Held
- Action: Hold release is attempted on non-held equipment
Logic Flow:
IF Equipment exists in train but is not currently held
AND Hold release is attempted on non-held equipment
THEN:
- • A warning is generated indicating equipment is not held and processing continues
R-GCX016E-cbl-00237 (+10) File: GCX016E.cbl Business Rule: Equipment Seizure Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when vid segment is received for equipment processing.
Trigger Criteria:
- Context: A VID segment is received for equipment processing
- Applied to: Disposition Code = SEI?
- Action: The system checks the disposition code from the previous X4 segment
Logic Flow:
IF A VID segment is received for equipment processing
AND The system checks the disposition code from the previous X4 segment
THEN:
- • Processing continues only if the disposition code equals SEI,
otherwise the equipment seizure process is skipped
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment id has been extracted from the vid segment.
Trigger Criteria:
- Context: An equipment ID has been extracted from the VID segment
- Applied to: Equipment ID Valid?
- Action: The system validates the equipment ID format
Logic Flow:
IF An equipment ID has been extracted from the VID segment
AND The system validates the equipment ID format
THEN:
- • The equipment ID must be in valid format with proper initial and number components,
otherwise generate invalid equipment ID error
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid equipment id has been provided for seizure.
Trigger Criteria:
- Context: A valid equipment ID has been provided for seizure
- Applied to: Equipment Found in Train?
- Action: The system searches the train consist for the equipment
Logic Flow:
IF A valid equipment ID has been provided for seizure
AND The system searches the train consist for the equipment
THEN:
- • The equipment must exist in the train list,
otherwise generate equipment not found error
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment exists in the train and seizure is requested.
Trigger Criteria:
- Context: Equipment exists in the train and seizure is requested
- Applied to: Equipment Already Seized?
- Action: The system checks the current seizure status of the equipment
Logic Flow:
IF Equipment exists in the train and seizure is requested
AND The system checks the current seizure status of the equipment
THEN:
- • If equipment is already seized, generate equipment already seized error,
otherwise proceed with seizure
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment is found in train and is not currently seized.
Trigger Criteria:
- Context: Equipment is found in train and is not currently seized
- Applied to: Set Equipment Seizure Flag
- Action: The seizure request is processed
Logic Flow:
IF Equipment is found in train and is not currently seized
AND The seizure request is processed
THEN:
- • Set the equipment seizure flag to indicate the equipment is now seized
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment seizure flag has been set.
Trigger Criteria:
- Context: Equipment seizure flag has been set
- Applied to: Update Equipment Status in Train List
- Action: The system updates the train consist information
Logic Flow:
IF Equipment seizure flag has been set
AND The system updates the train consist information
THEN:
- • Update the equipment status in the train list to show seized status
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment status has been updated to seized in the train list.
Trigger Criteria:
- Context: Equipment status has been updated to seized in the train list
- Applied to: Increment Train Seizure Counter
- Action: The system updates train-level seizure tracking
Logic Flow:
IF Equipment status has been updated to seized in the train list
AND The system updates train-level seizure tracking
THEN:
- • Increment the train seizure counter by one to reflect the additional seized equipment
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has been successfully seized and counters updated.
Trigger Criteria:
- Context: Equipment has been successfully seized and counters updated
- Applied to: Log Equipment Seizure Action
- Action: The system logs the seizure action
Logic Flow:
IF Equipment has been successfully seized and counters updated
AND The system logs the seizure action
THEN:
- • Create a log entry with equipment ID, seizure timestamp, and action details for audit purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment seizure has been logged successfully.
Trigger Criteria:
- Context: Equipment seizure has been logged successfully
- Applied to: Generate Seizure Confirmation Message
- Action: The system generates confirmation messaging
Logic Flow:
IF Equipment seizure has been logged successfully
AND The system generates confirmation messaging
THEN:
- • Create a seizure confirmation message with equipment details and seizure status
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when individual equipment has been seized and confirmation message generated.
Trigger Criteria:
- Context: Individual equipment has been seized and confirmation message generated
- Applied to: Update Train Status if All Equipment Seized
- Action: The system evaluates overall train seizure status
Logic Flow:
IF Individual equipment has been seized and confirmation message generated
AND The system evaluates overall train seizure status
THEN:
- • If all equipment in the train is now seized, update the train status to fully seized,
otherwise maintain partial seizure status
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train status has been evaluated and updated as needed.
Trigger Criteria:
- Context: Train status has been evaluated and updated as needed
- Applied to: Send Equipment Seizure Notification
- Action: The system dispatches seizure notifications
Logic Flow:
IF Train status has been evaluated and updated as needed
AND The system dispatches seizure notifications
THEN:
- • Send equipment seizure notification to appropriate recipients including equipment details and seizure confirmation
R-GCX016E-cbl-00248 (+14) File: GCX016E.cbl Business Rule: Equipment Seizure Release Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when ser disposition code is received for equipment seizure release.
Trigger Criteria:
- Context: A SER disposition code is received for equipment seizure release
- Applied to: Receive SER Disposition Code for Equipment
- Action: The system processes the disposition code request
Logic Flow:
IF A SER disposition code is received for equipment seizure release
AND The system processes the disposition code request
THEN:
- • The system initiates equipment seizure release processing workflow
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when vid segment contains equipment identification data.
Trigger Criteria:
- Context: A VID segment contains equipment identification data
- Applied to: Process VID Segment for Equipment ID
- Action: The system processes the VID segment
Logic Flow:
IF A VID segment contains equipment identification data
AND The system processes the VID segment
THEN:
- • The equipment ID is extracted and prepared for seizure release validation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment id is provided for seizure release.
Trigger Criteria:
- Context: An equipment ID is provided for seizure release
- Applied to: Equipment Found in Train?
- Action: The system searches for the equipment in the train equipment list
Logic Flow:
IF An equipment ID is provided for seizure release
AND The system searches for the equipment in the train equipment list
THEN:
- • The system determines if the equipment exists in the train and proceeds accordingly or generates equipment not found error
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment exists in the train consist.
Trigger Criteria:
- Context: Equipment exists in the train consist
- Applied to: Validate Equipment Seizure Status
- Action: The system validates the equipment's current seizure status
Logic Flow:
IF Equipment exists in the train consist
AND The system validates the equipment's current seizure status
THEN:
- • The system determines if the equipment is currently seized and eligible for release
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment seizure status has been validated.
Trigger Criteria:
- Context: Equipment seizure status has been validated
- Applied to: Equipment Currently Seized?
- Action: The system checks if the equipment is currently seized
Logic Flow:
IF Equipment seizure status has been validated
AND The system checks if the equipment is currently seized
THEN:
- • The system proceeds with seizure release if equipment is seized or generates warning if equipment is not seized
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment is currently seized and eligible for release.
Trigger Criteria:
- Context: Equipment is currently seized and eligible for release
- Applied to: Remove Equipment Seizure Flag
- Action: The system processes the seizure release request
Logic Flow:
IF Equipment is currently seized and eligible for release
AND The system processes the seizure release request
THEN:
- • The seizure flag is removed from the equipment record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment seizure flag has been removed.
Trigger Criteria:
- Context: Equipment seizure flag has been removed
- Applied to: Update Equipment Status in Train
- Action: The system updates the train equipment list
Logic Flow:
IF Equipment seizure flag has been removed
AND The system updates the train equipment list
THEN:
- • The equipment status is updated to reflect the seizure release in the train consist
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment status has been updated in the train.
Trigger Criteria:
- Context: Equipment status has been updated in the train
- Applied to: Decrement Train Seizure Counter
- Action: The system processes the seizure release
Logic Flow:
IF Equipment status has been updated in the train
AND The system processes the seizure release
THEN:
- • The train seizure counter is decremented by one
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train seizure counter has been decremented.
Trigger Criteria:
- Context: Train seizure counter has been decremented
- Applied to: All Equipment Released from Seizure?
- Action: The system checks if any equipment remains seized in the train
Logic Flow:
IF Train seizure counter has been decremented
AND The system checks if any equipment remains seized in the train
THEN:
- • The system determines if all equipment is released from seizure and proceeds accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all equipment in the train has been released from seizure.
Trigger Criteria:
- Context: All equipment in the train has been released from seizure
- Applied to: Clear Train Seizure Status
- Action: The system processes the final seizure release
Logic Flow:
IF All equipment in the train has been released from seizure
AND The system processes the final seizure release
THEN:
- • The train seizure status is cleared and the train is no longer considered seized
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment seizure release has been processed.
Trigger Criteria:
- Context: Equipment seizure release has been processed
- Applied to: Log Equipment Seizure Release Action
- Action: The system completes the seizure release action
Logic Flow:
IF Equipment seizure release has been processed
AND The system completes the seizure release action
THEN:
- • The seizure release action is logged with equipment details and timestamp
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment seizure release action has been logged.
Trigger Criteria:
- Context: Equipment seizure release action has been logged
- Applied to: Generate Merlin Notification Message
- Action: The system prepares external notifications
Logic Flow:
IF Equipment seizure release action has been logged
AND The system prepares external notifications
THEN:
- • A Merlin notification message is generated with seizure release details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when merlin notification message has been generated.
Trigger Criteria:
- Context: Merlin notification message has been generated
- Applied to: Send Equipment Release Notification
- Action: The system sends external notifications
Logic Flow:
IF Merlin notification message has been generated
AND The system sends external notifications
THEN:
- • The equipment seizure release notification is transmitted to relevant external systems
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment id is provided for seizure release.
Trigger Criteria:
- Context: Equipment ID is provided for seizure release
- Applied to: Generate Error - Equipment Not Found
- Action: The equipment cannot be found in the train equipment list
Logic Flow:
IF Equipment ID is provided for seizure release
AND The equipment cannot be found in the train equipment list
THEN:
- • An equipment not found error is generated and processing terminates
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment exists in the train but is not currently seized.
Trigger Criteria:
- Context: Equipment exists in the train but is not currently seized
- Applied to: Generate Warning - Equipment Not Seized
- Action: A seizure release request is processed for non-seized equipment
Logic Flow:
IF Equipment exists in the train but is not currently seized
AND A seizure release request is processed for non-seized equipment
THEN:
- • A warning is generated indicating equipment is not seized and processing continues
R-GCX016E-cbl-00263 (+8) File: GCX016E.cbl Business Rule: Export Manifest Train Arrival
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train arrival event is received with pod or aad disposition code and train id has been extracted from m10 vessel name segment.
Trigger Criteria:
- Context: A train arrival event is received with POD or AAD disposition code and train ID has been extracted from M10 vessel name segment
- Applied to: Train ID ends with 'T'?
- Action: The system checks the last character of the train ID
Logic Flow:
IF A train arrival event is received with POD or AAD disposition code and train ID has been extracted from M10 vessel name segment
AND The system checks the last character of the train ID
THEN:
- • If the train ID ends with 'T', identify as export manifest train,
otherwise identify as import manifest train
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train id ends with 't' indicating export manifest train.
Trigger Criteria:
- Context: Train ID ends with 'T' indicating export manifest train
- Applied to: Identify as Export Manifest Train
- Action: The system processes the train identification
Logic Flow:
IF Train ID ends with 'T' indicating export manifest train
AND The system processes the train identification
THEN:
- • Set train type as export manifest and proceed to port validation for export processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train id does not end with 't'.
Trigger Criteria:
- Context: Train ID does not end with 'T'
- Applied to: Identify as Import Manifest Train
- Action: The system processes the train identification
Logic Flow:
IF Train ID does not end with 'T'
AND The system processes the train identification
THEN:
- • Set train type as import manifest and route to standard import processing workflow
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when export manifest train has been identified and arrival port has been extracted from p4 location segment.
Trigger Criteria:
- Context: Export manifest train has been identified and arrival port has been extracted from P4 location segment
- Applied to: Port Designated for Export Manifests?
- Action: The system validates the port designation
Logic Flow:
IF Export manifest train has been identified and arrival port has been extracted from P4 location segment
AND The system validates the port designation
THEN:
- • If port is designated for export manifests, proceed with export processing,
otherwise route to standard import processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when export manifest train has been validated and port is designated for export processing.
Trigger Criteria:
- Context: Export manifest train has been validated and port is designated for export processing
- Applied to: Set Export Manifest Train Status
- Action: The system processes the export manifest train arrival
Logic Flow:
IF Export manifest train has been validated and port is designated for export processing
AND The system processes the export manifest train arrival
THEN:
- • Set train status to export manifest arrived and prepare for subsequent processing steps
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when export manifest train status has been set and v9 segment contains arrival date/time information.
Trigger Criteria:
- Context: Export manifest train status has been set and V9 segment contains arrival date/time information
- Applied to: Update Train Arrival Date from V9 Segment
- Action: The system processes the arrival date update
Logic Flow:
IF Export manifest train status has been set and V9 segment contains arrival date/time information
AND The system processes the arrival date update
THEN:
- • Extract and record the arrival date and time from V9 segment into the train record
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when export manifest train arrival date has been updated successfully.
Trigger Criteria:
- Context: Export manifest train arrival date has been updated successfully
- Applied to: Log Export Manifest Train Arrival
- Action: The system completes the arrival processing
Logic Flow:
IF Export manifest train arrival date has been updated successfully
AND The system completes the arrival processing
THEN:
- • Create audit log entry recording the export manifest train arrival with train ID, port, and arrival timestamp
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when export manifest train arrival has been logged successfully.
Trigger Criteria:
- Context: Export manifest train arrival has been logged successfully
- Applied to: Generate Export Manifest Arrival Notification
- Action: The system generates arrival notifications
Logic Flow:
IF Export manifest train arrival has been logged successfully
AND The system generates arrival notifications
THEN:
- • Create and send export manifest arrival notification containing train details, arrival information, and routing to appropriate recipients
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train is identified as import type or export train port is not designated for export processing.
Trigger Criteria:
- Context: Train is identified as import type OR export train port is not designated for export processing
- Applied to: Route to Standard Import Processing
- Action: The system determines processing route
Logic Flow:
IF Train is identified as import type OR export train port is not designated for export processing
AND The system determines processing route
THEN:
- • Route train to standard import processing workflow and complete processing according to import procedures
R-GCX016E-cbl-00272 (+9) File: GCX016E.cbl Business Rule: Import Manifest Train Arrival
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train arrival event (pod/aad disposition code) is being processed.
Trigger Criteria:
- Context: A train arrival event (POD/AAD disposition code) is being processed
- Applied to: Train ID Suffix Check
- Action: The system checks the train ID suffix
Logic Flow:
IF A train arrival event (POD/AAD disposition code) is being processed
AND The system checks the train ID suffix
THEN:
- • If train ID ends with suffix 'T', route to export manifest processing,
otherwise route to import manifest processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train is being processed for import manifest arrival.
Trigger Criteria:
- Context: A train is being processed for import manifest arrival
- Applied to: Set Train Arrival Status
- Action: The train arrival status needs to be established
Logic Flow:
IF A train is being processed for import manifest arrival
AND The train arrival status needs to be established
THEN:
- • Set the train arrival status flag to indicate the train has arrived for import processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train arrival is being processed and v9 segment contains date/time information.
Trigger Criteria:
- Context: A train arrival is being processed and V9 segment contains date/time information
- Applied to: Update Train Arrival Date from V9 Segment
- Action: The train arrival date needs to be recorded
Logic Flow:
IF A train arrival is being processed and V9 segment contains date/time information
AND The train arrival date needs to be recorded
THEN:
- • Extract and set the train arrival date from the V9 segment timestamp
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train is arriving and may have an existing hold status.
Trigger Criteria:
- Context: A train is arriving and may have an existing hold status
- Applied to: Clear Train Hold Status if Held
- Action: The train arrival is being processed
Logic Flow:
IF A train is arriving and may have an existing hold status
AND The train arrival is being processed
THEN:
- • If the train is currently held, clear the hold status to allow normal processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train has completed arrival processing steps.
Trigger Criteria:
- Context: A train has completed arrival processing steps
- Applied to: Set Train as Arrived in System
- Action: The system needs to record the train's arrived status
Logic Flow:
IF A train has completed arrival processing steps
AND The system needs to record the train's arrived status
THEN:
- • Set the system flag to indicate the train is now arrived and available for cargo operations
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train has arrived and contains us cargo manifests.
Trigger Criteria:
- Context: A train has arrived and contains US cargo manifests
- Applied to: Process US Cargo Arrival Notifications
- Action: Cargo arrival notifications need to be processed
Logic Flow:
IF A train has arrived and contains US cargo manifests
AND Cargo arrival notifications need to be processed
THEN:
- • Process arrival notifications for all US cargos associated with this train
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train has arrived and aei notification is configured.
Trigger Criteria:
- Context: A train has arrived and AEI notification is configured
- Applied to: Send AEI Messages for Train Arrival
- Action: External systems need to be notified of the train arrival
Logic Flow:
IF A train has arrived and AEI notification is configured
AND External systems need to be notified of the train arrival
THEN:
- • Generate and send AEI messages containing train arrival information to configured recipients
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train arrival has been processed.
Trigger Criteria:
- Context: A train arrival has been processed
- Applied to: Update Train Status Flags
- Action: Train status information needs to be updated in the system
Logic Flow:
IF A train arrival has been processed
AND Train status information needs to be updated in the system
THEN:
- • Update all relevant train status flags including arrival status, hold status, and operational flags
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train arrival has been successfully processed.
Trigger Criteria:
- Context: A train arrival has been successfully processed
- Applied to: Log Train Arrival Action
- Action: System audit trail needs to be maintained
Logic Flow:
IF A train arrival has been successfully processed
AND System audit trail needs to be maintained
THEN:
- • Create log entry documenting the train arrival action with timestamp and relevant details
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train arrival has been completely processed.
Trigger Criteria:
- Context: A train arrival has been completely processed
- Applied to: Generate Train Arrival Confirmation
- Action: Confirmation of successful processing is required
Logic Flow:
IF A train arrival has been completely processed
AND Confirmation of successful processing is required
THEN:
- • Generate train arrival confirmation message with processing results and status
R-GCX016E-cbl-00282 (+14) File: GCX016E.cbl Business Rule: Export Manifest Port Validation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train arrival event is received with a train id.
Trigger Criteria:
- Context: A train arrival event is received with a train ID
- Applied to: Train ID has 'T' suffix?
- Action: The system checks if the train ID has a 'T' suffix
Logic Flow:
IF A train arrival event is received with a train ID
AND The system checks if the train ID has a 'T' suffix
THEN:
- • The train is classified as export manifest if suffix is 'T',
otherwise as import manifest - • If train ID has 'T' suffix, identify as export manifest train,
otherwise route to standard import processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when export manifest train arrives at a specific port and the port code is extracted from p4 location segment.
Trigger Criteria:
- Context: An export manifest train arrives at a specific port AND the port code is extracted from P4 location segment
- Applied to: Port Designated for Export Manifests?
- Action: The system looks up the port in the export manifest port configuration table
Logic Flow:
IF An export manifest train arrives at a specific port AND the port code is extracted from P4 location segment
AND The system looks up the port in the export manifest port configuration table
THEN:
- • The port is validated as authorized for export manifests if found in the table,
otherwise validation fails
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when export manifest train arrives at a port and the port is validated as authorized for export manifests.
Trigger Criteria:
- Context: An export manifest train arrives at a port AND the port is validated as authorized for export manifests
- Applied to: Set Export Manifest Port Flag
- Action: The port validation succeeds
Logic Flow:
IF An export manifest train arrives at a port AND the port is validated as authorized for export manifests
AND The port validation succeeds
THEN:
- • The system sets the export manifest port flag and continues with export manifest processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when export manifest train arrives at a port and the port is not found in the export manifest port configuration table.
Trigger Criteria:
- Context: An export manifest train arrives at a port AND the port is not found in the export manifest port configuration table
- Applied to: Generate Port Validation Error
- Action: The port validation fails
Logic Flow:
IF An export manifest train arrives at a port AND the port is not found in the export manifest port configuration table
AND The port validation fails
THEN:
- • The system generates a port validation error and logs the invalid port for export manifest incident
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train arrival event is received and either the train id does not have 't' suffix or the export manifest port validation fails.
Trigger Criteria:
- Context: A train arrival event is received AND either the train ID does not have 'T' suffix OR the export manifest port validation fails
- Applied to: Route to Standard Import Processing
- Action: The train is classified as import manifest or export port validation fails
Logic Flow:
IF A train arrival event is received AND either the train ID does not have 'T' suffix OR the export manifest port validation fails
AND The train is classified as import manifest or export port validation fails
THEN:
- • The system routes the train to standard import processing workflow
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train id has been validated to contain a 't' suffix.
Trigger Criteria:
- Context: A train ID has been validated to contain a 'T' suffix
- Applied to: Identify as Export Manifest Train
- Action: The system processes the train classification
Logic Flow:
IF A train ID has been validated to contain a 'T' suffix
AND The system processes the train classification
THEN:
- • The train is identified and flagged as an export manifest train for export-specific business rule application
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when export manifest train has been identified.
Trigger Criteria:
- Context: An export manifest train has been identified
- Applied to: Extract Arrival Port from P4 Segment
- Action: The system processes the P4 location segment
Logic Flow:
IF An export manifest train has been identified
AND The system processes the P4 location segment
THEN:
- • The arrival port information is extracted from the P4 segment for further validation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when arrival port has been extracted from the p4 segment.
Trigger Criteria:
- Context: An arrival port has been extracted from the P4 segment
- Applied to: Lookup Port Configuration in System Tables
- Action: The system looks up the port configuration in system tables
Logic Flow:
IF An arrival port has been extracted from the P4 segment
AND The system looks up the port configuration in system tables
THEN:
- • Port configuration data is retrieved to determine export manifest processing eligibility
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when port configuration data has been retrieved from system tables.
Trigger Criteria:
- Context: Port configuration data has been retrieved from system tables
- Applied to: Port Designated for Export Manifests?
- Action: The system checks if the port is designated for export manifests
Logic Flow:
IF Port configuration data has been retrieved from system tables
AND The system checks if the port is designated for export manifests
THEN:
- • If port is designated for export manifests, proceed with export processing,
otherwise generate port validation error
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when arrival port has been validated as designated for export manifests.
Trigger Criteria:
- Context: The arrival port has been validated as designated for export manifests
- Applied to: Apply Export Manifest Business Rules
- Action: The system applies export manifest business rules
Logic Flow:
IF The arrival port has been validated as designated for export manifests
AND The system applies export manifest business rules
THEN:
- • Export-specific business rules are applied to the manifest processing workflow
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when export manifest business rules have been applied successfully.
Trigger Criteria:
- Context: Export manifest business rules have been applied successfully
- Applied to: Process as Export Manifest Arrival
- Action: The system processes the export manifest arrival
Logic Flow:
IF Export manifest business rules have been applied successfully
AND The system processes the export manifest arrival
THEN:
- • The train arrival is processed using export manifest specific procedures and status updates
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when arrival port is not designated for export manifests.
Trigger Criteria:
- Context: The arrival port is not designated for export manifests
- Applied to: Generate Port Validation Error
- Action: The system generates a port validation error
Logic Flow:
IF The arrival port is not designated for export manifests
AND The system generates a port validation error
THEN:
- • A port validation error is created indicating the port cannot process export manifests
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train id does not have a 't' suffix.
Trigger Criteria:
- Context: A train ID does not have a 'T' suffix
- Applied to: Route to Standard Import Processing
- Action: The system routes the processing
Logic Flow:
IF A train ID does not have a 'T' suffix
AND The system routes the processing
THEN:
- • The train is routed to standard import processing workflow instead of export processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when port validation processing has been completed (either successful export processing, error generation, or import routing).
Trigger Criteria:
- Context: Port validation processing has been completed (either successful export processing, error generation, or import routing)
- Applied to: Log Port Validation Result
- Action: The system logs the validation result
Logic Flow:
IF Port validation processing has been completed (either successful export processing, error generation, or import routing)
AND The system logs the validation result
THEN:
- • The port validation result and processing outcome are logged for audit trail and system monitoring
R-GCX016E-cbl-00287 (+11) File: GCX016E.cbl Business Rule: AEI Notification Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train arrival event has been detected.
Trigger Criteria:
- Context: A train arrival event has been detected
- Applied to: Train Type?
- Action: The system evaluates the train's manifest type
Logic Flow:
IF A train arrival event has been detected
AND The system evaluates the train's manifest type
THEN:
- • The train is classified as either export manifest train (suffix 'T') or import manifest train for appropriate AEI processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when export manifest train has arrived at a port.
Trigger Criteria:
- Context: An export manifest train has arrived at a port
- Applied to: Port Valid for Export?
- Action: The system validates the port's export processing capabilities
Logic Flow:
IF An export manifest train has arrived at a port
AND The system validates the port's export processing capabilities
THEN:
- • The port is either confirmed as valid for export processing or flagged as invalid, determining the processing path
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when export manifest train has arrived and the port is valid for export processing.
Trigger Criteria:
- Context: An export manifest train has arrived and the port is valid for export processing
- Applied to: Process Export Manifest Arrival
- Action: The system processes the export manifest arrival
Logic Flow:
IF An export manifest train has arrived and the port is valid for export processing
AND The system processes the export manifest arrival
THEN:
- • Export-specific AEI processing is initiated with appropriate export manifest handling procedures
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when either an import manifest train has arrived or an export train has arrived at a port invalid for export processing.
Trigger Criteria:
- Context: Either an import manifest train has arrived or an export train has arrived at a port invalid for export processing
- Applied to: Process Import Manifest Arrival
- Action: The system processes the manifest arrival
Logic Flow:
IF Either an import manifest train has arrived or an export train has arrived at a port invalid for export processing
AND The system processes the manifest arrival
THEN:
- • Import-specific AEI processing is initiated with appropriate import manifest handling procedures
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train arrival has been processed (either export or import).
Trigger Criteria:
- Context: A train arrival has been processed (either export or import)
- Applied to: Identify US Cargo on Train
- Action: The system scans the train's cargo manifest
Logic Flow:
IF A train arrival has been processed (either export or import)
AND The system scans the train's cargo manifest
THEN:
- • All US cargo shipments on the train are identified and flagged for AEI notification processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when us cargo has been identified on an arriving train.
Trigger Criteria:
- Context: US cargo has been identified on an arriving train
- Applied to: Generate AEI Arrival Messages
- Action: The system generates AEI arrival messages
Logic Flow:
IF US cargo has been identified on an arriving train
AND The system generates AEI arrival messages
THEN:
- • Automatic Equipment Identification messages are created containing arrival details for each US cargo shipment
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when aei arrival messages have been generated.
Trigger Criteria:
- Context: AEI arrival messages have been generated
- Applied to: Send Equipment Identification Data
- Action: The system sends equipment identification data
Logic Flow:
IF AEI arrival messages have been generated
AND The system sends equipment identification data
THEN:
- • Equipment identification information is transmitted to designated recipients and systems
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment identification data has been sent.
Trigger Criteria:
- Context: Equipment identification data has been sent
- Applied to: Create Email Notifications
- Action: The system creates email notifications
Logic Flow:
IF Equipment identification data has been sent
AND The system creates email notifications
THEN:
- • Email notifications are generated with AEI arrival details for appropriate distribution
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when email notifications have been created.
Trigger Criteria:
- Context: Email notifications have been created
- Applied to: Distribute AEI Messages
- Action: The system distributes AEI messages
Logic Flow:
IF Email notifications have been created
AND The system distributes AEI messages
THEN:
- • All AEI messages and notifications are sent to their designated recipients and integrated systems
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when aei messages have been distributed.
Trigger Criteria:
- Context: AEI messages have been distributed
- Applied to: Log AEI Processing Actions
- Action: The system logs AEI processing actions
Logic Flow:
IF AEI messages have been distributed
AND The system logs AEI processing actions
THEN:
- • All AEI notification activities are recorded in the system log for audit and tracking purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when aei processing actions have been logged.
Trigger Criteria:
- Context: AEI processing actions have been logged
- Applied to: Update Train Arrival Status
- Action: The system updates train arrival status
Logic Flow:
IF AEI processing actions have been logged
AND The system updates train arrival status
THEN:
- • The train's status is updated to indicate successful completion of AEI notification processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train arrival status has been updated.
Trigger Criteria:
- Context: Train arrival status has been updated
- Applied to: Complete AEI Notification Processing
- Action: The system completes AEI notification processing
Logic Flow:
IF Train arrival status has been updated
AND The system completes AEI notification processing
THEN:
- • All AEI notification processing activities are finalized and the workflow is marked as complete
R-GCX016E-cbl-00299 (+11) File: GCX016E.cbl Business Rule: Cargo Processing by Bond
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when x4 segment contains disposition code information with bond number data.
Trigger Criteria:
- Context: An X4 segment contains disposition code information with bond number data
- Applied to: Extract Bond Number from X4 Segment
- Action: The system processes the X4 segment for bond-based cargo processing
Logic Flow:
IF An X4 segment contains disposition code information with bond number data
AND The system processes the X4 segment for bond-based cargo processing
THEN:
- • The bond number is extracted and stored for subsequent cargo lookup operations
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid customs bond number has been extracted from the x4 segment.
Trigger Criteria:
- Context: A valid customs bond number has been extracted from the X4 segment
- Applied to: Cargo Database Lookup by Bond Number
- Action: The system performs a database lookup using the bond number as search criteria
Logic Flow:
IF A valid customs bond number has been extracted from the X4 segment
AND The system performs a database lookup using the bond number as search criteria
THEN:
- • All cargo records matching the bond number are identified and made available for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when database lookup has been performed using a customs bond number.
Trigger Criteria:
- Context: A database lookup has been performed using a customs bond number
- Applied to: Cargo Records Found?
- Action: The system evaluates the search results
Logic Flow:
IF A database lookup has been performed using a customs bond number
AND The system evaluates the search results
THEN:
- • If cargo records are found, processing continues with the first record; if no records are found, bond processing is terminated
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo records exist for the specified bond number.
Trigger Criteria:
- Context: Cargo records exist for the specified bond number
- Applied to: Retrieve First Cargo Record by Bond
- Action: The system begins processing cargo records for the bond
Logic Flow:
IF Cargo records exist for the specified bond number
AND The system begins processing cargo records for the bond
THEN:
- • The first cargo record is retrieved and prepared for individual cargo processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record has been retrieved for processing.
Trigger Criteria:
- Context: A cargo record has been retrieved for processing
- Applied to: Process Individual Cargo Record
- Action: The system processes the individual cargo record
Logic Flow:
IF A cargo record has been retrieved for processing
AND The system processes the individual cargo record
THEN:
- • The cargo record is prepared for disposition code application and status updates
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record is being processed and a disposition code exists from the x4 segment.
Trigger Criteria:
- Context: A cargo record is being processed and a disposition code exists from the X4 segment
- Applied to: Apply Disposition Code to Cargo
- Action: The system applies the disposition code to the cargo
Logic Flow:
IF A cargo record is being processed and a disposition code exists from the X4 segment
AND The system applies the disposition code to the cargo
THEN:
- • The disposition code is processed according to its type (hold, release, proceed, etc.) and appropriate cargo actions are determined
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code has been applied to a cargo record.
Trigger Criteria:
- Context: A disposition code has been applied to a cargo record
- Applied to: Update Cargo Status
- Action: The system updates the cargo status
Logic Flow:
IF A disposition code has been applied to a cargo record
AND The system updates the cargo status
THEN:
- • The cargo status is modified according to the disposition code requirements and status change records are created
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when one cargo record has been processed for a bond number.
Trigger Criteria:
- Context: One cargo record has been processed for a bond number
- Applied to: Check for Additional Cargo Records
- Action: The system checks for additional cargo records with the same bond
Logic Flow:
IF One cargo record has been processed for a bond number
AND The system checks for additional cargo records with the same bond
THEN:
- • The system identifies whether more cargo records exist for continued processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when system has checked for additional cargo records with the same bond number.
Trigger Criteria:
- Context: The system has checked for additional cargo records with the same bond number
- Applied to: More Cargo with Same Bond?
- Action: The evaluation determines if more records exist
Logic Flow:
IF The system has checked for additional cargo records with the same bond number
AND The evaluation determines if more records exist
THEN:
- • If more records exist, processing continues with the next record; if no more records exist, bond processing summary is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when additional cargo records exist for the same bond number.
Trigger Criteria:
- Context: Additional cargo records exist for the same bond number
- Applied to: Retrieve Next Cargo Record
- Action: The system retrieves the next cargo record
Logic Flow:
IF Additional cargo records exist for the same bond number
AND The system retrieves the next cargo record
THEN:
- • The next cargo record is obtained and prepared for individual cargo processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all cargo records associated with a bond number have been processed.
Trigger Criteria:
- Context: All cargo records associated with a bond number have been processed
- Applied to: Generate Bond Processing Summary
- Action: The system generates a bond processing summary
Logic Flow:
IF All cargo records associated with a bond number have been processed
AND The system generates a bond processing summary
THEN:
- • A summary report is created containing details of all cargo records processed and their final status
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when bond processing summary has been generated.
Trigger Criteria:
- Context: Bond processing summary has been generated
- Applied to: Create Merlin Notification for Bond
- Action: The system creates Merlin notifications for the bond processing
Logic Flow:
IF Bond processing summary has been generated
AND The system creates Merlin notifications for the bond processing
THEN:
- • Appropriate Merlin messages are generated and routed to relevant parties regarding the bond processing results
R-GCX016E-cbl-00311 (+12) File: GCX016E.cbl Business Rule: Cargo Processing by Car/Waybill
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when n7 equipment segment is available for processing.
Trigger Criteria:
- Context: An N7 equipment segment is available for processing
- Applied to: Extract Equipment ID from N7 Segment
- Action: The system processes the N7 segment to extract equipment information
Logic Flow:
IF An N7 equipment segment is available for processing
AND The system processes the N7 segment to extract equipment information
THEN:
- • The equipment initial and equipment number are extracted and combined to form the equipment ID
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when n7 equipment segment contains waybill information.
Trigger Criteria:
- Context: An N7 equipment segment contains waybill information
- Applied to: Extract Waybill Number from N7 Segment
- Action: The system processes the N7 segment for waybill data
Logic Flow:
IF An N7 equipment segment contains waybill information
AND The system processes the N7 segment for waybill data
THEN:
- • The waybill number is extracted from the N7 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment initial and equipment number have been extracted from n7 segment.
Trigger Criteria:
- Context: Equipment initial and equipment number have been extracted from N7 segment
- Applied to: Format Car ID Using Standard Rules
- Action: The system needs to create a standardized car ID
Logic Flow:
IF Equipment initial and equipment number have been extracted from N7 segment
AND The system needs to create a standardized car ID
THEN:
- • The car ID is formatted by combining equipment initial and equipment number according to standard formatting rules
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when formatted car id and waybill number are available.
Trigger Criteria:
- Context: A formatted car ID and waybill number are available
- Applied to: Search Cargo Database by Car/Waybill Index
- Action: The system searches for existing cargo records
Logic Flow:
IF A formatted car ID and waybill number are available
AND The system searches for existing cargo records
THEN:
- • The system queries the cargo database using the car/waybill index to find matching records
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when search has been performed on the cargo database using car id and waybill.
Trigger Criteria:
- Context: A search has been performed on the cargo database using car ID and waybill
- Applied to: Cargo Records Found?
- Action: The system evaluates the search results
Logic Flow:
IF A search has been performed on the cargo database using car ID and waybill
AND The system evaluates the search results
THEN:
- • The system determines if cargo records were found and routes processing accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo records exist for the car id and waybill combination.
Trigger Criteria:
- Context: Cargo records exist for the car ID and waybill combination
- Applied to: Retrieve First Cargo Record
- Action: The system needs to begin processing cargo records
Logic Flow:
IF Cargo records exist for the car ID and waybill combination
AND The system needs to begin processing cargo records
THEN:
- • The first cargo record matching the criteria is retrieved for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record has been retrieved for processing.
Trigger Criteria:
- Context: A cargo record has been retrieved for processing
- Applied to: Process Individual Cargo Record
- Action: The system processes the cargo record
Logic Flow:
IF A cargo record has been retrieved for processing
AND The system processes the cargo record
THEN:
- • The cargo record is processed with applicable disposition codes, status updates, and business rule validations
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when one cargo record has been processed for a car/waybill combination.
Trigger Criteria:
- Context: One cargo record has been processed for a car/waybill combination
- Applied to: More Records Exist?
- Action: The system checks for additional matching records
Logic Flow:
IF One cargo record has been processed for a car/waybill combination
AND The system checks for additional matching records
THEN:
- • The system determines if more cargo records exist with the same car ID and waybill and continues processing if found
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when additional cargo records exist for the same car id and waybill combination.
Trigger Criteria:
- Context: Additional cargo records exist for the same car ID and waybill combination
- Applied to: Retrieve Next Cargo Record
- Action: The system continues processing multiple records
Logic Flow:
IF Additional cargo records exist for the same car ID and waybill combination
AND The system continues processing multiple records
THEN:
- • The next cargo record in the sequence is retrieved for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when subsequent cargo record has been retrieved for the same car/waybill combination.
Trigger Criteria:
- Context: A subsequent cargo record has been retrieved for the same car/waybill combination
- Applied to: Process Next Individual Cargo Record
- Action: The system processes this additional cargo record
Logic Flow:
IF A subsequent cargo record has been retrieved for the same car/waybill combination
AND The system processes this additional cargo record
THEN:
- • The cargo record is processed with the same disposition codes, status updates, and business rule validations as previous records
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when no existing cargo records were found for the car/waybill combination.
Trigger Criteria:
- Context: No existing cargo records were found for the car/waybill combination
- Applied to: CPRS Traffic?
- Action: The system evaluates the traffic type
Logic Flow:
IF No existing cargo records were found for the car/waybill combination
AND The system evaluates the traffic type
THEN:
- • The system determines if this is CPRS traffic and routes to appropriate processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when no existing cargo records exist and the traffic is identified as cprs.
Trigger Criteria:
- Context: No existing cargo records exist and the traffic is identified as CPRS
- Applied to: Create New CPRS Cargo Record
- Action: The system creates a new cargo record
Logic Flow:
IF No existing cargo records exist and the traffic is identified as CPRS
AND The system creates a new cargo record
THEN:
- • A new CPRS cargo record is created with appropriate CPRS-specific attributes and processing rules
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when car/waybill processing has been completed.
Trigger Criteria:
- Context: Car/waybill processing has been completed
- Applied to: Log Car/Waybill Processing Action
- Action: The system finalizes the processing step
Logic Flow:
IF Car/waybill processing has been completed
AND The system finalizes the processing step
THEN:
- • The processing actions and results are logged for audit trail and business tracking purposes
R-GCX016E-cbl-00324 (+10) File: GCX016E.cbl Business Rule: Individual Cargo Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo ccn (container control number) is provided for processing.
Trigger Criteria:
- Context: A cargo CCN (Container Control Number) is provided for processing
- Applied to: Cargo Found in System?
- Action: The system searches for the cargo record in the database
Logic Flow:
IF A cargo CCN (Container Control Number) is provided for processing
AND The system searches for the cargo record in the database
THEN:
- • If the cargo record is found, proceed with processing; if not found, generate an error message indicating cargo not available
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code is received for cargo processing.
Trigger Criteria:
- Context: A disposition code is received for cargo processing
- Applied to: Valid Disposition Code?
- Action: The system validates the disposition code against the DC table
Logic Flow:
IF A disposition code is received for cargo processing
AND The system validates the disposition code against the DC table
THEN:
- • If the disposition code exists in the DC table, continue processing; if not found, generate an error message for invalid disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code is being added to a cargo's status array.
Trigger Criteria:
- Context: A disposition code is being added to a cargo's status array
- Applied to: Duplicate Found?
- Action: The system searches the existing status array for the same disposition code with matching entry number and quantity
Logic Flow:
IF A disposition code is being added to a cargo's status array
AND The system searches the existing status array for the same disposition code with matching entry number and quantity
THEN:
- • If an exact duplicate is found, skip processing and continue; if no duplicate exists, proceed with adding the disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when new disposition code is being added that has defined counterpart codes in the dc table.
Trigger Criteria:
- Context: A new disposition code is being added that has defined counterpart codes in the DC table
- Applied to: Remove Counterpart Codes
- Action: The system processes the counterpart removal logic
Logic Flow:
IF A new disposition code is being added that has defined counterpart codes in the DC table
AND The system processes the counterpart removal logic
THEN:
- • Remove all counterpart disposition codes from the status array before adding the new disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition codes have been processed and the status array is updated.
Trigger Criteria:
- Context: Disposition codes have been processed and the status array is updated
- Applied to: Status Change Required?
- Action: The system evaluates all disposition codes in the status array to determine the final cargo status
Logic Flow:
IF Disposition codes have been processed and the status array is updated
AND The system evaluates all disposition codes in the status array to determine the final cargo status
THEN:
- • If the evaluated status differs from the current cargo status, proceed with status update;
otherwise, complete processing without changes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has release disposition codes in its status array.
Trigger Criteria:
- Context: The cargo has release disposition codes in its status array
- Applied to: Calculate Release Quantities
- Action: The system calculates the total released quantity by summing all release quantities from disposition codes
Logic Flow:
IF The cargo has release disposition codes in its status array
AND The system calculates the total released quantity by summing all release quantities from disposition codes
THEN:
- • Update the cargo's released quantity field with the calculated total and determine if the cargo is fully released, partially released, or held
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has release disposition codes in its status array.
Trigger Criteria:
- Context: The cargo has release disposition codes in its status array
- Applied to: Set Release Flags
- Action: The system validates that the release quantity meets or exceeds the cargo quantity
Logic Flow:
IF The cargo has release disposition codes in its status array
AND The system validates that the release quantity meets or exceeds the cargo quantity
THEN:
- • Set the released flag to true and update the cargo status to RELSD (Released) or HOLDPCS (Hold Pieces) based on partial release conditions
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has hold disposition codes in its status array.
Trigger Criteria:
- Context: The cargo has hold disposition codes in its status array
- Applied to: Set Hold Flags
- Action: The system evaluates hold codes for border holds, destination holds, or FDA holds
Logic Flow:
IF The cargo has hold disposition codes in its status array
AND The system evaluates hold codes for border holds, destination holds, or FDA holds
THEN:
- • Set the corresponding hold flags (held at border, held at destination, held for FDA) and update the cargo status to reflect the hold condition
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has a proceed disposition code and entry type is 61, 62, 63, or 69.
Trigger Criteria:
- Context: The cargo has a proceed disposition code and entry type is 61, 62, 63, or 69
- Applied to: Process In-Bond Entry
- Action: The system processes the proceed status
Logic Flow:
IF The cargo has a proceed disposition code and entry type is 61, 62, 63, or 69
AND The system processes the proceed status
THEN:
- • Update the cargo's in-bond information including broker details, bond numbers, and entry information, and set the cargo status to PROCEED
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has arrival or export disposition codes in its status array.
Trigger Criteria:
- Context: The cargo has arrival or export disposition codes in its status array
- Applied to: Update Arrival/Export Flags
- Action: The system processes arrival or export status changes
Logic Flow:
IF The cargo has arrival or export disposition codes in its status array
AND The system processes arrival or export status changes
THEN:
- • For arrival codes, set arrival flag and update arrival date; for export codes, set export flag and clear destination index; update cargo status to ARRIVAL or EXPORT accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo status has been updated with new disposition codes.
Trigger Criteria:
- Context: A cargo status has been updated with new disposition codes
- Applied to: Generate Status Notifications
- Action: The system determines notification requirements based on the status change and freight forwarder setup
Logic Flow:
IF A cargo status has been updated with new disposition codes
AND The system determines notification requirements based on the status change and freight forwarder setup
THEN:
- • Generate Merlin messages for brokers, send email notifications to freight forwarders if configured, and make IIS calls for equipment tracking as appropriate
R-GCX016E-cbl-00335 (+11) File: GCX016E.cbl Business Rule: Disposition Code 95 Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code 95 is being processed for bond cancellation.
Trigger Criteria:
- Context: A disposition code 95 is being processed for bond cancellation
- Applied to: Validate DC95 in Disposition Code Table
- Action: The system looks up DC95 in the disposition code table
Logic Flow:
IF A disposition code 95 is being processed for bond cancellation
AND The system looks up DC95 in the disposition code table
THEN:
- • The system confirms DC95 is a valid disposition code or generates an error if not found
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code 95 is being processed for bond cancellation.
Trigger Criteria:
- Context: A disposition code 95 is being processed for bond cancellation
- Applied to: Clear M12 Bond Data
- Action: The system clears bond information
Logic Flow:
IF A disposition code 95 is being processed for bond cancellation
AND The system clears bond information
THEN:
- • All M12 bond segment data is removed from the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code 95 is being processed for bond cancellation.
Trigger Criteria:
- Context: A disposition code 95 is being processed for bond cancellation
- Applied to: Clear Broker QP Information
- Action: The system clears bond-related information
Logic Flow:
IF A disposition code 95 is being processed for bond cancellation
AND The system clears bond-related information
THEN:
- • All broker QP (Qualified Person) information is removed from the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code 95 is being processed for bond cancellation.
Trigger Criteria:
- Context: A disposition code 95 is being processed for bond cancellation
- Applied to: Reset In-Bond Entry Status
- Action: The system resets bond information
Logic Flow:
IF A disposition code 95 is being processed for bond cancellation
AND The system resets bond information
THEN:
- • The in-bond entry status is reset to indicate no active bond
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid disposition code 95 is being processed.
Trigger Criteria:
- Context: A valid disposition code 95 is being processed
- Applied to: Clear BOL Type Code
- Action: The system processes the bond cancellation
Logic Flow:
IF A valid disposition code 95 is being processed
AND The system processes the bond cancellation
THEN:
- • The BOL type code is cleared from the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code 95 is being processed.
Trigger Criteria:
- Context: A disposition code 95 is being processed
- Applied to: Clear Bond Number Index & Clear Bond Owner Information
- Action: The system processes bond cancellation
Logic Flow:
IF A disposition code 95 is being processed
AND The system processes bond cancellation
THEN:
- • The bond number index is cleared from the cargo record
- • Bond owner information is cleared from the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code 95 is being processed.
Trigger Criteria:
- Context: A disposition code 95 is being processed
- Applied to: Generate Error Message - Invalid DC95
- Action: The system cannot find DC95 in the disposition code table
Logic Flow:
IF A disposition code 95 is being processed
AND The system cannot find DC95 in the disposition code table
THEN:
- • An error message is generated indicating invalid disposition code 95
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code 95 has been processed and bond information cleared.
Trigger Criteria:
- Context: A disposition code 95 has been processed and bond information cleared
- Applied to: Update Cargo Status Array
- Action: The system updates cargo status
Logic Flow:
IF A disposition code 95 has been processed and bond information cleared
AND The system updates cargo status
THEN:
- • The cargo status array is updated to reflect the bond cancellation with appropriate status codes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code 95 has been processed and bond information cleared.
Trigger Criteria:
- Context: A disposition code 95 has been processed and bond information cleared
- Applied to: Log Bond Cancellation Action
- Action: The system completes bond cancellation processing
Logic Flow:
IF A disposition code 95 has been processed and bond information cleared
AND The system completes bond cancellation processing
THEN:
- • The bond cancellation action is logged with relevant cargo and bond details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code 95 has been processed and bond cancellation completed.
Trigger Criteria:
- Context: A disposition code 95 has been processed and bond cancellation completed
- Applied to: Generate Merlin Notification
- Action: The system generates notifications
Logic Flow:
IF A disposition code 95 has been processed and bond cancellation completed
AND The system generates notifications
THEN:
- • A Merlin notification is generated to inform relevant parties of the bond cancellation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all bond information has been cleared for disposition code 95.
Trigger Criteria:
- Context: All bond information has been cleared for disposition code 95
- Applied to: Update Database with Cleared Bond Info
- Action: The system updates the database
Logic Flow:
IF All bond information has been cleared for disposition code 95
AND The system updates the database
THEN:
- • The cargo database is updated with all cleared bond fields and updated status information
R-GCX016E-cbl-00362 (+9) File: GCX016E.cbl Business Rule: SNP Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when edi message is received for snp processing.
Trigger Criteria:
- Context: An EDI message is received for SNP processing
- Applied to: Entry Type Code Present?
- Action: The system checks for the presence of an entry type code in the message
Logic Flow:
IF An EDI message is received for SNP processing
AND The system checks for the presence of an entry type code in the message
THEN:
- • If entry type code is present, proceed to validation; if not present, skip entry type processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when entry type code is present in the edi message.
Trigger Criteria:
- Context: An entry type code is present in the EDI message
- Applied to: Valid EDI Format?
- Action: The system validates the format of the entry type code
Logic Flow:
IF An entry type code is present in the EDI message
AND The system validates the format of the entry type code
THEN:
- • If format is valid, proceed to conversion; if invalid, generate error message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid edi entry type code needs to be converted to internal format.
Trigger Criteria:
- Context: A valid EDI entry type code needs to be converted to internal format
- Applied to: Code Found in Array?
- Action: The system searches the conversion array for the EDI code
Logic Flow:
IF A valid EDI entry type code needs to be converted to internal format
AND The system searches the conversion array for the EDI code
THEN:
- • If code is found in array, set internal entry type code; if not found, generate error message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when internal entry type code has been successfully set.
Trigger Criteria:
- Context: An internal entry type code has been successfully set
- Applied to: Entry Type = 61, 62, 63, or 69?
- Action: The system checks if the entry type is 61, 62, 63, or 69
Logic Flow:
IF An internal entry type code has been successfully set
AND The system checks if the entry type is 61, 62, 63, or 69
THEN:
- • If entry type matches in-bond codes, set master in-bond flag;
otherwise proceed to border crossing check
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when entry type code is identified as 61, 62, 63, or 69.
Trigger Criteria:
- Context: The entry type code is identified as 61, 62, 63, or 69
- Applied to: Set Master In-Bond Flag
- Action: The system processes the in-bond entry type
Logic Flow:
IF The entry type code is identified as 61, 62, 63, or 69
AND The system processes the in-bond entry type
THEN:
- • Set the master in-bond flag to indicate special in-bond processing is required
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when entry type processing is in progress.
Trigger Criteria:
- Context: Entry type processing is in progress
- Applied to: Border Crossing Scenario?
- Action: The system evaluates if this is a border crossing scenario
Logic Flow:
IF Entry type processing is in progress
AND The system evaluates if this is a border crossing scenario
THEN:
- • If border crossing is detected, apply border crossing logic;
otherwise update cargo record directly
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when border crossing scenario has been identified.
Trigger Criteria:
- Context: A border crossing scenario has been identified
- Applied to: Apply Border Crossing Logic
- Action: The system applies border crossing logic
Logic Flow:
IF A border crossing scenario has been identified
AND The system applies border crossing logic
THEN:
- • Execute special border crossing processing rules and update cargo accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when entry type has been successfully processed and validated.
Trigger Criteria:
- Context: Entry type has been successfully processed and validated
- Applied to: Update Cargo Record with Entry Type
- Action: The system updates the cargo record
Logic Flow:
IF Entry type has been successfully processed and validated
AND The system updates the cargo record
THEN:
- • Store the internal entry type code and any associated flags in the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when entry type conversion has been completed successfully.
Trigger Criteria:
- Context: Entry type conversion has been completed successfully
- Applied to: Log Entry Type Conversion
- Action: The system logs the conversion activity
Logic Flow:
IF Entry type conversion has been completed successfully
AND The system logs the conversion activity
THEN:
- • Create audit log entry showing original EDI code, converted internal code, and processing timestamp
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when entry type validation or conversion has failed.
Trigger Criteria:
- Context: Entry type validation or conversion has failed
- Applied to: Generate Error Message
- Action: The system encounters an invalid format or unknown code
Logic Flow:
IF Entry type validation or conversion has failed
AND The system encounters an invalid format or unknown code
THEN:
- • Generate appropriate error message indicating the nature of the entry type processing failure
R-GCX016E-cbl-00372 (+7) File: GCX016E.cbl Business Rule: Canadian Border Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cross-border cargo record is received for processing.
Trigger Criteria:
- Context: A cross-border cargo record is received for processing
- Applied to: Extract US Port Code from Cargo Data
- Action: The system processes the cargo data
Logic Flow:
IF A cross-border cargo record is received for processing
AND The system processes the cargo data
THEN:
- • The US port code is extracted from the cargo record for border location mapping
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when us port code has been extracted from cargo data.
Trigger Criteria:
- Context: A US port code has been extracted from cargo data
- Applied to: Access Canadian Border Location Mapping Table
- Action: The system needs to determine the corresponding Canadian border location
Logic Flow:
IF A US port code has been extracted from cargo data
AND The system needs to determine the corresponding Canadian border location
THEN:
- • The Canadian border location mapping table is accessed for lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when us port code has been extracted from cargo data.
Trigger Criteria:
- Context: A US port code has been extracted from cargo data
- Applied to: Generate Error for Unmapped Port Code
- Action: The US port code is not found in the Canadian border location mapping table
Logic Flow:
IF A US port code has been extracted from cargo data
AND The US port code is not found in the Canadian border location mapping table
THEN:
- • An error is generated indicating the port code cannot be mapped to a Canadian border location
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when us port code has been extracted from cargo data and the mapping table is accessed.
Trigger Criteria:
- Context: A US port code has been extracted from cargo data and the mapping table is accessed
- Applied to: US Port Code Found in Mapping?
- Action: The system searches for the US port code in the mapping table
Logic Flow:
IF A US port code has been extracted from cargo data and the mapping table is accessed
AND The system searches for the US port code in the mapping table
THEN:
- • The system determines if a corresponding Canadian border location mapping exists
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when us port code exists in the canadian border location mapping table.
Trigger Criteria:
- Context: A US port code exists in the Canadian border location mapping table
- Applied to: Retrieve Corresponding Canadian Border Location Name
- Action: The system finds a valid mapping entry
Logic Flow:
IF A US port code exists in the Canadian border location mapping table
AND The system finds a valid mapping entry
THEN:
- • The corresponding Canadian border location name is retrieved from the mapping table
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when canadian border location name has been successfully retrieved from the mapping table.
Trigger Criteria:
- Context: A Canadian border location name has been successfully retrieved from the mapping table
- Applied to: Update Cargo Record with Canadian Border Location
- Action: The system processes the mapping result
Logic Flow:
IF A Canadian border location name has been successfully retrieved from the mapping table
AND The system processes the mapping result
THEN:
- • The cargo record is updated with the Canadian border location information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record has been updated with canadian border location information.
Trigger Criteria:
- Context: A cargo record has been updated with Canadian border location information
- Applied to: Log Border Location Mapping
- Action: The border location mapping is completed
Logic Flow:
IF A cargo record has been updated with Canadian border location information
AND The border location mapping is completed
THEN:
- • An audit log entry is created documenting the border location mapping operation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when border location mapping has been completed successfully or an error has been generated for unmapped port code.
Trigger Criteria:
- Context: Border location mapping has been completed successfully or an error has been generated for unmapped port code
- Applied to: Continue Cargo Processing with Border Location
- Action: The border location processing step is finished
Logic Flow:
IF Border location mapping has been completed successfully or an error has been generated for unmapped port code
AND The border location processing step is finished
THEN:
- • The system continues with the next step in the cargo processing workflow
R-GCX016E-cbl-00380 (+8) File: GCX016E.cbl Business Rule: FDA Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has an a1 disposition code for fda processing.
Trigger Criteria:
- Context: A cargo has an A1 disposition code for FDA processing
- Applied to: A1 Disposition Code Processing
- Action: The system processes the A1 disposition code
Logic Flow:
IF A cargo has an A1 disposition code for FDA processing
AND The system processes the A1 disposition code
THEN:
- • The system retrieves the N9 reference number segment and formats the FDA reference number with FDA PN prefix
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has an a3 disposition code for fda processing.
Trigger Criteria:
- Context: A cargo has an A3 disposition code for FDA processing
- Applied to: A3 Disposition Code Processing
- Action: The system processes the A3 disposition code
Logic Flow:
IF A cargo has an A3 disposition code for FDA processing
AND The system processes the A3 disposition code
THEN:
- • The system retrieves the N9 reference number segment and formats the FDA reference number with FDA prefix
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when fda disposition code processing is required.
Trigger Criteria:
- Context: FDA disposition code processing is required
- Applied to: Retrieve N9 Reference Number Segment
- Action: The system needs to process FDA reference numbers
Logic Flow:
IF FDA disposition code processing is required
AND The system needs to process FDA reference numbers
THEN:
- • The system retrieves the N9 reference number segment from the cargo database
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when a1 disposition code is being processed and n9 reference number segment is retrieved.
Trigger Criteria:
- Context: An A1 disposition code is being processed and N9 reference number segment is retrieved
- Applied to: Format FDA Reference Number with FDA PN Prefix
- Action: The system formats the FDA reference number
Logic Flow:
IF An A1 disposition code is being processed and N9 reference number segment is retrieved
AND The system formats the FDA reference number
THEN:
- • The system applies FDA PN prefix to the reference number
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when a3 disposition code is being processed and n9 reference number segment is retrieved.
Trigger Criteria:
- Context: An A3 disposition code is being processed and N9 reference number segment is retrieved
- Applied to: Format FDA Reference Number with FDA Prefix
- Action: The system formats the FDA reference number
Logic Flow:
IF An A3 disposition code is being processed and N9 reference number segment is retrieved
AND The system formats the FDA reference number
THEN:
- • The system applies FDA prefix to the reference number
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when fda reference number has been formatted with appropriate prefix.
Trigger Criteria:
- Context: FDA reference number has been formatted with appropriate prefix
- Applied to: Reposition Existing N9 Data
- Action: The system updates the N9 segment
Logic Flow:
IF FDA reference number has been formatted with appropriate prefix
AND The system updates the N9 segment
THEN:
- • The system repositions existing N9 data to maintain proper segment structure
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when n9 data has been repositioned and fda reference number is formatted.
Trigger Criteria:
- Context: N9 data has been repositioned and FDA reference number is formatted
- Applied to: Update N9 Reference Segment
- Action: The system updates the N9 reference segment
Logic Flow:
IF N9 data has been repositioned and FDA reference number is formatted
AND The system updates the N9 reference segment
THEN:
- • The system updates the N9 reference segment with the formatted FDA reference number
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when n9 reference segment has been updated with fda reference number.
Trigger Criteria:
- Context: N9 reference segment has been updated with FDA reference number
- Applied to: Replace N9 Segment in Database
- Action: The system persists the changes
Logic Flow:
IF N9 reference segment has been updated with FDA reference number
AND The system persists the changes
THEN:
- • The system replaces the N9 segment in the cargo database with the updated information
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when fda processing has been completed and n9 segment has been updated in database.
Trigger Criteria:
- Context: FDA processing has been completed and N9 segment has been updated in database
- Applied to: Log FDA Processing Action
- Action: The system completes FDA processing
Logic Flow:
IF FDA processing has been completed and N9 segment has been updated in database
AND The system completes FDA processing
THEN:
- • The system logs the FDA processing action for audit trail
R-GCX016E-cbl-00389 (+19) File: GCX016E.cbl Business Rule: Freight Forwarder Email Notifications
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cih hold has been detected for a cargo.
Trigger Criteria:
- Context: A CIH hold has been detected for a cargo
- Applied to: Search Broker Database for Freight Forwarder Disposition Codes
- Action: The system searches the broker name table for freight forwarder disposition codes
Logic Flow:
IF A CIH hold has been detected for a cargo
AND The system searches the broker name table for freight forwarder disposition codes
THEN:
- • The system identifies whether freight forwarder disposition codes exist for the cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when search has been performed in the broker database for freight forwarder disposition codes.
Trigger Criteria:
- Context: A search has been performed in the broker database for freight forwarder disposition codes
- Applied to: Freight Forwarder Found?
- Action: The system evaluates the search results
Logic Flow:
IF A search has been performed in the broker database for freight forwarder disposition codes
AND The system evaluates the search results
THEN:
- • If a freight forwarder is found, continue processing;
otherwise, complete the process without further action
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when freight forwarder has been found in the broker database.
Trigger Criteria:
- Context: A freight forwarder has been found in the broker database
- Applied to: Retrieve Cargo Segment Data from GCSUSS03/GCSUSS07
- Action: The system needs cargo segment information
Logic Flow:
IF A freight forwarder has been found in the broker database
AND The system needs cargo segment information
THEN:
- • The system retrieves cargo segment data from both GCSUSS03 and GCSUSS07 databases
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo segment data has been retrieved from gcsuss03 and gcsuss07.
Trigger Criteria:
- Context: Cargo segment data has been retrieved from GCSUSS03 and GCSUSS07
- Applied to: Extract Freight Forwarder Information
- Action: The system processes the cargo segment data
Logic Flow:
IF Cargo segment data has been retrieved from GCSUSS03 and GCSUSS07
AND The system processes the cargo segment data
THEN:
- • The system extracts freight forwarder identification and contact information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when freight forwarder information has been extracted from cargo segment data.
Trigger Criteria:
- Context: Freight forwarder information has been extracted from cargo segment data
- Applied to: Lookup Freight Forwarder Name from Broker Tables
- Action: The system searches the broker name tables (GCST2RT)
Logic Flow:
IF Freight forwarder information has been extracted from cargo segment data
AND The system searches the broker name tables (GCST2RT)
THEN:
- • The system retrieves the complete freight forwarder name and details
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when freight forwarder name has been successfully looked up.
Trigger Criteria:
- Context: The freight forwarder name has been successfully looked up
- Applied to: Retrieve Freight Forwarder Email Address
- Action: The system searches the broker email address table (GCSTBRT)
Logic Flow:
IF The freight forwarder name has been successfully looked up
AND The system searches the broker email address table (GCSTBRT)
THEN:
- • The system retrieves the freight forwarder's email address
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when email address lookup has been performed for the freight forwarder.
Trigger Criteria:
- Context: An email address lookup has been performed for the freight forwarder
- Applied to: Valid Email Address?
- Action: The system evaluates the retrieved email address
Logic Flow:
IF An email address lookup has been performed for the freight forwarder
AND The system evaluates the retrieved email address
THEN:
- • If a valid email address exists, continue with email notification;
otherwise, complete the process without sending email
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid email address has been found for the freight forwarder.
Trigger Criteria:
- Context: A valid email address has been found for the freight forwarder
- Applied to: Build Comprehensive Email Content
- Action: The system prepares the email notification
Logic Flow:
IF A valid email address has been found for the freight forwarder
AND The system prepares the email notification
THEN:
- • The system creates a structured email content framework ready for detailed information inclusion
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when email content structure has been built.
Trigger Criteria:
- Context: Email content structure has been built
- Applied to: Include Equipment Details
- Action: The system adds equipment information to the email
Logic Flow:
IF Email content structure has been built
AND The system adds equipment information to the email
THEN:
- • The email includes equipment type, identification numbers, and related equipment details
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when equipment details have been included in the email.
Trigger Criteria:
- Context: Equipment details have been included in the email
- Applied to: Include Waybill Information
- Action: The system adds waybill information to the email
Logic Flow:
IF Equipment details have been included in the email
AND The system adds waybill information to the email
THEN:
- • The email includes waybill numbers and associated shipping documentation details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when waybill information has been included in the email.
Trigger Criteria:
- Context: Waybill information has been included in the email
- Applied to: Include CCN and Content Description
- Action: The system adds CCN and content information to the email
Logic Flow:
IF Waybill information has been included in the email
AND The system adds CCN and content information to the email
THEN:
- • The email includes the Cargo Control Number and detailed description of cargo contents
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when ccn and content description have been included in the email.
Trigger Criteria:
- Context: CCN and content description have been included in the email
- Applied to: Include Origin/Destination Stations
- Action: The system adds location information to the email
Logic Flow:
IF CCN and content description have been included in the email
AND The system adds location information to the email
THEN:
- • The email includes origin station, destination station, and routing information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when origin and destination station information has been included in the email.
Trigger Criteria:
- Context: Origin and destination station information has been included in the email
- Applied to: Include Disposition Information
- Action: The system adds disposition information to the email
Logic Flow:
IF Origin and destination station information has been included in the email
AND The system adds disposition information to the email
THEN:
- • The email includes disposition codes, hold reasons, and any special handling instructions
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when complete email content has been built with all required information.
Trigger Criteria:
- Context: Complete email content has been built with all required information
- Applied to: Send Email Notification
- Action: The system attempts to send the email notification
Logic Flow:
IF Complete email content has been built with all required information
AND The system attempts to send the email notification
THEN:
- • The system transmits the email to the freight forwarder's email address
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when email notification has been sent to the freight forwarder.
Trigger Criteria:
- Context: An email notification has been sent to the freight forwarder
- Applied to: Email Delivery Successful?
- Action: The system receives delivery confirmation or failure notification
Logic Flow:
IF An email notification has been sent to the freight forwarder
AND The system receives delivery confirmation or failure notification
THEN:
- • If delivery is successful, log the success;
otherwise, initiate retry process
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when email delivery has been confirmed as successful.
Trigger Criteria:
- Context: Email delivery has been confirmed as successful
- Applied to: Log Successful Delivery
- Action: The system processes the successful delivery confirmation
Logic Flow:
IF Email delivery has been confirmed as successful
AND The system processes the successful delivery confirmation
THEN:
- • The system creates a log entry recording the successful email delivery with timestamp and recipient information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when email delivery has failed.
Trigger Criteria:
- Context: Email delivery has failed
- Applied to: Retry Email Delivery
- Action: The system has not reached the retry limit
Logic Flow:
IF Email delivery has failed
AND The system has not reached the retry limit
THEN:
- • The system attempts to resend the email notification
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when email delivery has failed and a retry attempt is being considered.
Trigger Criteria:
- Context: Email delivery has failed and a retry attempt is being considered
- Applied to: Retry Limit Reached?
- Action: The system checks the current retry count against the maximum retry limit
Logic Flow:
IF Email delivery has failed and a retry attempt is being considered
AND The system checks the current retry count against the maximum retry limit
THEN:
- • If retry limit is not reached, continue retry attempts;
otherwise, log delivery failure and complete process
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when email delivery has failed and retry limit has been reached.
Trigger Criteria:
- Context: Email delivery has failed and retry limit has been reached
- Applied to: Log Delivery Failure
- Action: The system processes the final delivery failure
Logic Flow:
IF Email delivery has failed and retry limit has been reached
AND The system processes the final delivery failure
THEN:
- • The system creates a log entry recording the email delivery failure with error details and attempted recipient information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when email notification process has reached a terminal state (success, failure, or no freight forwarder found).
Trigger Criteria:
- Context: Email notification process has reached a terminal state (success, failure, or no freight forwarder found)
- Applied to: Process Complete
- Action: The system finalizes the notification process
Logic Flow:
IF Email notification process has reached a terminal state (success, failure, or no freight forwarder found)
AND The system finalizes the notification process
THEN:
- • The system marks the freight forwarder notification process as complete and returns control to the calling process
R-GCX016E-cbl-00409 (+12) File: GCX016E.cbl Business Rule: Cargo Status Array Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record exists in the system.
Trigger Criteria:
- Context: A cargo record exists in the system
- Applied to: Initialize Empty Status Arrays
- Action: No S09 status segments are found in the database for the cargo
Logic Flow:
IF A cargo record exists in the system
AND No S09 status segments are found in the database for the cargo
THEN:
- • The system initializes empty S09A status arrays with zero occurrence counts and clears all status tracking variables
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when s09 status segments exist in the database for a cargo.
Trigger Criteria:
- Context: S09 status segments exist in the database for a cargo
- Applied to: Populate S09A Status Arrays from Database
- Action: The system retrieves the status segments
Logic Flow:
IF S09 status segments exist in the database for a cargo
AND The system retrieves the status segments
THEN:
- • The system populates the S09A status arrays with disposition codes, quantities, entry numbers, and sequence information from each database segment
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when status arrays contain existing disposition code entries.
Trigger Criteria:
- Context: Status arrays contain existing disposition code entries
- Applied to: Track Maximum Sequence Numbers
- Action: Processing status array data
Logic Flow:
IF Status arrays contain existing disposition code entries
AND Processing status array data
THEN:
- • The system identifies and tracks the maximum sequence number for each status array type to determine the next available sequence number for new entries
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when new disposition code is being processed for a cargo.
Trigger Criteria:
- Context: A new disposition code is being processed for a cargo
- Applied to: Duplicate Code Check
- Action: The system searches existing status arrays
Logic Flow:
IF A new disposition code is being processed for a cargo
AND The system searches existing status arrays
THEN:
- • If a disposition code with identical code, entry number, and quantity already exists, the system flags it as a duplicate;
otherwise, it is marked as a new code
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code is confirmed as new and not duplicate.
Trigger Criteria:
- Context: A disposition code is confirmed as new and not duplicate
- Applied to: Add New Status Entry to Array
- Action: Adding the code to the status array
Logic Flow:
IF A disposition code is confirmed as new and not duplicate
AND Adding the code to the status array
THEN:
- • The system creates a new status array entry with the disposition code, quantity, entry number, date/time, and assigns the next sequential number while incrementing the array occurrence count
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code matches an existing entry in the status array.
Trigger Criteria:
- Context: A disposition code matches an existing entry in the status array
- Applied to: Update Existing Status Entry
- Action: Processing the disposition code update
Logic Flow:
IF A disposition code matches an existing entry in the status array
AND Processing the disposition code update
THEN:
- • The system updates the existing status array entry with new quantity, date/time, and other relevant information while maintaining the original sequence number
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code has defined counterpart codes in the system.
Trigger Criteria:
- Context: A disposition code has defined counterpart codes in the system
- Applied to: Remove Counterpart Disposition Codes
- Action: Adding the primary disposition code to the status array
Logic Flow:
IF A disposition code has defined counterpart codes in the system
AND Adding the primary disposition code to the status array
THEN:
- • The system identifies and removes any existing counterpart disposition codes from the status arrays and decrements the occurrence counts accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status array entries have been added, updated, or removed.
Trigger Criteria:
- Context: Status array entries have been added, updated, or removed
- Applied to: Reorganize Array Sequences
- Action: Finalizing status array changes
Logic Flow:
IF Status array entries have been added, updated, or removed
AND Finalizing status array changes
THEN:
- • The system reorganizes the arrays by reassigning sequential numbers starting from 1, compacting the arrays to eliminate empty slots, and updating occurrence counts
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when status arrays have been modified with new or updated disposition codes.
Trigger Criteria:
- Context: Status arrays have been modified with new or updated disposition codes
- Applied to: Calculate Status Array Changes
- Action: Calculating the impact of changes
Logic Flow:
IF Status arrays have been modified with new or updated disposition codes
AND Calculating the impact of changes
THEN:
- • The system determines how the changes affect release quantities, hold status, and overall cargo processing status based on the disposition code types and quantities
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status arrays have been processed and finalized in memory.
Trigger Criteria:
- Context: Status arrays have been processed and finalized in memory
- Applied to: Convert Arrays to Database Format
- Action: Preparing to update the database
Logic Flow:
IF Status arrays have been processed and finalized in memory
AND Preparing to update the database
THEN:
- • The system converts the S09A status arrays into S09 database segment format with proper field mapping, data formatting, and segment structure
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status segments have been converted to database format.
Trigger Criteria:
- Context: Status segments have been converted to database format
- Applied to: Replace Status Segments in Database
- Action: Updating the cargo record in the database
Logic Flow:
IF Status segments have been converted to database format
AND Updating the cargo record in the database
THEN:
- • The system replaces the existing S09 status segments with the updated segments and commits the changes to maintain data integrity
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo is not a cprs shipment and n7 equipment data is available.
Trigger Criteria:
- Context: A cargo is not a CPRS shipment and N7 equipment data is available
- Applied to: Update Car ID Information
- Action: Processing car ID updates
Logic Flow:
IF A cargo is not a CPRS shipment and N7 equipment data is available
AND Processing car ID updates
THEN:
- • The system updates the cargo record with car ID information from the N7 segment, including equipment initial and number, while preserving existing data for CPRS shipments
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status arrays have been modified for a cargo.
Trigger Criteria:
- Context: Status arrays have been modified for a cargo
- Applied to: Track Status Change History
- Action: Completing status array processing
Logic Flow:
IF Status arrays have been modified for a cargo
AND Completing status array processing
THEN:
- • The system creates history records documenting the status changes, including timestamps, disposition codes added or removed, and the resulting cargo status
R-GCX016E-cbl-00422 (+72) File: GCX016E.cbl Business Rule: Multi
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when lead manifest is being processed.
Trigger Criteria:
- Context: A lead manifest is being processed
- Applied to: Check for Follower Manifests?
- Action: The system checks for associated follower manifests
Logic Flow:
IF A lead manifest is being processed
AND The system checks for associated follower manifests
THEN:
- • All linked follower manifests are identified and prepared for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when follower manifest is identified for processing and a lead manifest ccn exists.
Trigger Criteria:
- Context: A follower manifest is identified for processing AND a lead manifest CCN exists
- Applied to: Lead Manifest CCN differs from US CCN Key?
- Action: The lead manifest CCN is compared to the current US CCN key
Logic Flow:
IF A follower manifest is identified for processing AND a lead manifest CCN exists
AND The lead manifest CCN is compared to the current US CCN key
THEN:
- • If the lead manifest CCN differs from the US CCN key, special action processing is initiated,
otherwise standard follower processing continues
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when follower manifest requires processing and the lead manifest ccn differs from us ccn and the message type is gcw016.
Trigger Criteria:
- Context: A follower manifest requires processing AND the lead manifest CCN differs from US CCN AND the message type is GCW016
- Applied to: Prepare 350 Special Action Messages
- Action: The system prepares the follower manifest message
Logic Flow:
IF A follower manifest requires processing AND the lead manifest CCN differs from US CCN AND the message type is GCW016
AND The system prepares the follower manifest message
THEN:
- • A special action code of 350 is set in the message for proper routing and processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when follower manifest message is being prepared and disposition codes exist for the cargo.
Trigger Criteria:
- Context: A follower manifest message is being prepared AND disposition codes exist for the cargo
- Applied to: Include Disposition Codes in Message
- Action: The message content is assembled
Logic Flow:
IF A follower manifest message is being prepared AND disposition codes exist for the cargo
AND The message content is assembled
THEN:
- • All relevant disposition codes are included in the follower manifest message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when follower manifest message is being prepared and quantity information exists.
Trigger Criteria:
- Context: A follower manifest message is being prepared AND quantity information exists
- Applied to: Include Quantities in Message
- Action: The message content is assembled
Logic Flow:
IF A follower manifest message is being prepared AND quantity information exists
AND The message content is assembled
THEN:
- • All relevant quantity information is included in the follower manifest message
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when follower manifest message is being prepared and entry numbers exist.
Trigger Criteria:
- Context: A follower manifest message is being prepared AND entry numbers exist
- Applied to: Include Entry Numbers in Message
- Action: The message content is assembled
Logic Flow:
IF A follower manifest message is being prepared AND entry numbers exist
AND The message content is assembled
THEN:
- • All relevant entry numbers are included in the follower manifest message
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when follower manifest message has been prepared with all required information.
Trigger Criteria:
- Context: A follower manifest message has been prepared with all required information
- Applied to: Spawn GCT0162E Transaction for Follower Processing
- Action: The system is ready to process the follower manifest
Logic Flow:
IF A follower manifest message has been prepared with all required information
AND The system is ready to process the follower manifest
THEN:
- • A GCT0162E transaction is spawned with the prepared message content for follower manifest processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when follower manifest is being processed and a lead manifest exists.
Trigger Criteria:
- Context: A follower manifest is being processed AND a lead manifest exists
- Applied to: Link Follower to Lead Manifest
- Action: The follower manifest processing is completed
Logic Flow:
IF A follower manifest is being processed AND a lead manifest exists
AND The follower manifest processing is completed
THEN:
- • The follower manifest is properly linked to its lead manifest for tracking and reporting purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all follower manifests have been processed and linked to their lead manifest.
Trigger Criteria:
- Context: All follower manifests have been processed and linked to their lead manifest
- Applied to: Update Comprehensive Cargo Tracking
- Action: The multi-manifest processing is completing
Logic Flow:
IF All follower manifests have been processed and linked to their lead manifest
AND The multi-manifest processing is completing
THEN:
- • The comprehensive cargo tracking system is updated with all manifest relationships and cargo status information
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record with car id and waybill number exists in the system.
Trigger Criteria:
- Context: A cargo record with car ID and waybill number exists in the system
- Applied to: Start Multi-Cargo Processing by Car/Waybill
- Action: Multi-cargo processing is triggered for car/waybill combination
Logic Flow:
IF A cargo record with car ID and waybill number exists in the system
AND Multi-cargo processing is triggered for car/waybill combination
THEN:
- • System begins coordinated processing of all related cargo records
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when car id and waybill number are provided for cargo lookup.
Trigger Criteria:
- Context: Car ID and waybill number are provided for cargo lookup
- Applied to: Retrieve First Cargo Record by Car ID and Waybill
- Action: System searches for cargo records with matching car ID and waybill
Logic Flow:
IF Car ID and waybill number are provided for cargo lookup
AND System searches for cargo records with matching car ID and waybill
THEN:
- • First matching cargo record is retrieved for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when search for cargo records by car id and waybill has been performed.
Trigger Criteria:
- Context: A search for cargo records by car ID and waybill has been performed
- Applied to: Cargo Record Found?
- Action: System evaluates the search results
Logic Flow:
IF A search for cargo records by car ID and waybill has been performed
AND System evaluates the search results
THEN:
- • Processing continues if cargo record found,
otherwise processing terminates
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid cargo record exists for processing.
Trigger Criteria:
- Context: A valid cargo record exists for processing
- Applied to: Process Individual Cargo Record
- Action: Individual cargo processing is initiated
Logic Flow:
IF A valid cargo record exists for processing
AND Individual cargo processing is initiated
THEN:
- • Cargo record is processed according to disposition codes and status rules
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record is being processed.
Trigger Criteria:
- Context: A cargo record is being processed
- Applied to: Analyze Cargo Hold Status
- Action: System evaluates cargo hold status
Logic Flow:
IF A cargo record is being processed
AND System evaluates cargo hold status
THEN:
- • Hold status is analyzed to determine next processing steps
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record contains disposition codes.
Trigger Criteria:
- Context: Cargo record contains disposition codes
- Applied to: Manual Release Present?
- Action: System evaluates disposition codes for manual release
Logic Flow:
IF Cargo record contains disposition codes
AND System evaluates disposition codes for manual release
THEN:
- • If manual release present, cargo bypasses hold checks;
otherwise continue hold evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo does not have manual release status.
Trigger Criteria:
- Context: Cargo does not have manual release status
- Applied to: Check Various Hold Types
- Action: System checks for various hold types in cargo status
Logic Flow:
IF Cargo does not have manual release status
AND System checks for various hold types in cargo status
THEN:
- • Hold types are identified and classified for appropriate processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status is being evaluated for holds.
Trigger Criteria:
- Context: Cargo status is being evaluated for holds
- Applied to: Border Hold?
- Action: System checks for border hold indicators
Logic Flow:
IF Cargo status is being evaluated for holds
AND System checks for border hold indicators
THEN:
- • If border hold exists, processing continues to release verification;
otherwise check next hold type
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo does not have border hold and status is being evaluated.
Trigger Criteria:
- Context: Cargo does not have border hold and status is being evaluated
- Applied to: Destination Hold?
- Action: System checks for destination hold indicators
Logic Flow:
IF Cargo does not have border hold and status is being evaluated
AND System checks for destination hold indicators
THEN:
- • If destination hold exists, processing continues to release verification;
otherwise check next hold type
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo does not have border or destination hold and status is being evaluated.
Trigger Criteria:
- Context: Cargo does not have border or destination hold and status is being evaluated
- Applied to: FDA Hold?
- Action: System checks for FDA hold indicators
Logic Flow:
IF Cargo does not have border or destination hold and status is being evaluated
AND System checks for FDA hold indicators
THEN:
- • If FDA hold exists, processing continues to release verification;
otherwise check piece count hold
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo does not have border, destination, or fda hold and status is being evaluated.
Trigger Criteria:
- Context: Cargo does not have border, destination, or FDA hold and status is being evaluated
- Applied to: Piece Count Hold?
- Action: System checks for piece count hold indicators
Logic Flow:
IF Cargo does not have border, destination, or FDA hold and status is being evaluated
AND System checks for piece count hold indicators
THEN:
- • If piece count hold exists, processing continues to release verification;
otherwise retrieve next cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when current cargo record processing is complete and no holds prevent continuation.
Trigger Criteria:
- Context: Current cargo record processing is complete and no holds prevent continuation
- Applied to: Retrieve Next Cargo Record with Same Car/Waybill
- Action: System searches for additional cargo records with same car ID and waybill
Logic Flow:
IF Current cargo record processing is complete and no holds prevent continuation
AND System searches for additional cargo records with same car ID and waybill
THEN:
- • Next matching cargo record is retrieved for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when search for additional cargo records with same car id and waybill has been performed.
Trigger Criteria:
- Context: A search for additional cargo records with same car ID and waybill has been performed
- Applied to: More Records with Same Car/Waybill?
- Action: System evaluates search results for more records
Logic Flow:
IF A search for additional cargo records with same car ID and waybill has been performed
AND System evaluates search results for more records
THEN:
- • If more records exist, continue processing;
otherwise proceed to release verification
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all cargo records with same car id and waybill have been processed.
Trigger Criteria:
- Context: All cargo records with same car ID and waybill have been processed
- Applied to: Verify Release Status Across All Records
- Action: System verifies release status across all related records
Logic Flow:
IF All cargo records with same car ID and waybill have been processed
AND System verifies release status across all related records
THEN:
- • Release status is verified for coordinated notification and database updates
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when release status has been verified across all related cargo records.
Trigger Criteria:
- Context: Release status has been verified across all related cargo records
- Applied to: All Records Released?
- Action: System evaluates if all records are in released status
Logic Flow:
IF Release status has been verified across all related cargo records
AND System evaluates if all records are in released status
THEN:
- • If all records released, generate comprehensive notification;
otherwise generate status change notification
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when all cargo records with same car id and waybill are in released status.
Trigger Criteria:
- Context: All cargo records with same car ID and waybill are in released status
- Applied to: Generate Comprehensive Release Notification
- Action: Comprehensive release notification is triggered
Logic Flow:
IF All cargo records with same car ID and waybill are in released status
AND Comprehensive release notification is triggered
THEN:
- • Complete release notification is generated for all stakeholders
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo status changes have occurred during processing.
Trigger Criteria:
- Context: Cargo status changes have occurred during processing
- Applied to: Create Merlin Notification for Status Changes
- Action: Merlin notification creation is triggered
Logic Flow:
IF Cargo status changes have occurred during processing
AND Merlin notification creation is triggered
THEN:
- • Status change notifications are created and routed to appropriate recipients
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo status changes and notifications have been processed.
Trigger Criteria:
- Context: Cargo status changes and notifications have been processed
- Applied to: Update Cargo Status in Database
- Action: Database update is initiated
Logic Flow:
IF Cargo status changes and notifications have been processed
AND Database update is initiated
THEN:
- • All cargo status changes are committed to the database
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all cargo records have been processed and database updates completed.
Trigger Criteria:
- Context: All cargo records have been processed and database updates completed
- Applied to: End Multi-Cargo Processing
- Action: Multi-cargo processing reaches completion
Logic Flow:
IF All cargo records have been processed and database updates completed
AND Multi-cargo processing reaches completion
THEN:
- • Processing terminates successfully for the car/waybill group
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when lead manifest with an associated ccn and a current us ccn key are available.
Trigger Criteria:
- Context: A lead manifest with an associated CCN and a current US CCN key are available
- Applied to: Lead Manifest CCN differs from US CCN Key?
- Action: The system compares the lead manifest CCN with the US CCN key
Logic Flow:
IF A lead manifest with an associated CCN and a current US CCN key are available
AND The system compares the lead manifest CCN with the US CCN key
THEN:
- • If the lead manifest CCN differs from the US CCN key, proceed with follower manifest processing,
otherwise complete multi-manifest processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when follower manifest has been identified for processing.
Trigger Criteria:
- Context: A follower manifest has been identified for processing
- Applied to: Prepare Follower Manifest Data
- Action: The system prepares follower manifest data
Logic Flow:
IF A follower manifest has been identified for processing
AND The system prepares follower manifest data
THEN:
- • All required manifest data elements including cargo information, quantities, and entry numbers are prepared for message creation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when follower manifest requires processing and the message type is gcw016.
Trigger Criteria:
- Context: A follower manifest requires processing and the message type is GCW016
- Applied to: Create 350 Special Action Message
- Action: The system creates a special action message
Logic Flow:
IF A follower manifest requires processing and the message type is GCW016
AND The system creates a special action message
THEN:
- • A message with special action code 350 is created and general information is copied for the follower manifest
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when follower manifest message is being prepared and disposition codes exist.
Trigger Criteria:
- Context: A follower manifest message is being prepared and disposition codes exist
- Applied to: Include Disposition Codes in Message
- Action: The system includes disposition codes in the message
Logic Flow:
IF A follower manifest message is being prepared and disposition codes exist
AND The system includes disposition codes in the message
THEN:
- • All relevant disposition codes are included in the follower manifest message for downstream processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when follower manifest message is being prepared and cargo quantities are available.
Trigger Criteria:
- Context: A follower manifest message is being prepared and cargo quantities are available
- Applied to: Include Cargo Quantities in Message
- Action: The system includes cargo quantities in the message
Logic Flow:
IF A follower manifest message is being prepared and cargo quantities are available
AND The system includes cargo quantities in the message
THEN:
- • All relevant cargo quantities are included in the follower manifest message
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when follower manifest message is being prepared and entry numbers exist.
Trigger Criteria:
- Context: A follower manifest message is being prepared and entry numbers exist
- Applied to: Include Entry Numbers in Message
- Action: The system includes entry numbers in the message
Logic Flow:
IF A follower manifest message is being prepared and entry numbers exist
AND The system includes entry numbers in the message
THEN:
- • All relevant entry numbers are included in the follower manifest message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when follower manifest message has been prepared with all required data.
Trigger Criteria:
- Context: A follower manifest message has been prepared with all required data
- Applied to: Spawn GCT0162E Transaction for Follower Processing
- Action: The system spawns the GCT0162E transaction
Logic Flow:
IF A follower manifest message has been prepared with all required data
AND The system spawns the GCT0162E transaction
THEN:
- • The GCT0162E transaction is initiated with the prepared follower manifest message for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when follower manifest and its corresponding lead manifest are identified.
Trigger Criteria:
- Context: A follower manifest and its corresponding lead manifest are identified
- Applied to: Link Follower Manifest to Lead Manifest
- Action: The system links the follower manifest to the lead manifest
Logic Flow:
IF A follower manifest and its corresponding lead manifest are identified
AND The system links the follower manifest to the lead manifest
THEN:
- • The relationship between the follower and lead manifest is established for comprehensive tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when follower manifest has been processed and linked to its lead manifest.
Trigger Criteria:
- Context: A follower manifest has been processed and linked to its lead manifest
- Applied to: Update Comprehensive Cargo Tracking
- Action: The system updates comprehensive cargo tracking
Logic Flow:
IF A follower manifest has been processed and linked to its lead manifest
AND The system updates comprehensive cargo tracking
THEN:
- • The cargo tracking system is updated with complete follower manifest information for full visibility
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when follower manifest processing action has been completed.
Trigger Criteria:
- Context: A follower manifest processing action has been completed
- Applied to: Log Follower Manifest Processing Action
- Action: The system logs the processing action
Logic Flow:
IF A follower manifest processing action has been completed
AND The system logs the processing action
THEN:
- • The follower manifest processing action is recorded in the system log for audit and monitoring purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when one follower manifest has been processed and there may be additional follower manifests.
Trigger Criteria:
- Context: One follower manifest has been processed and there may be additional follower manifests
- Applied to: More Follower Manifests?
- Action: The system checks for more follower manifests to process
Logic Flow:
IF One follower manifest has been processed and there may be additional follower manifests
AND The system checks for more follower manifests to process
THEN:
- • If more follower manifests exist, continue processing the next one,
otherwise complete multi-manifest processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when car id and waybill number combination exists from previous n7 segment processing.
Trigger Criteria:
- Context: A car ID and waybill number combination exists from previous N7 segment processing
- Applied to: Retrieve First Cargo Record by Car ID and Waybill
- Action: The system needs to process multiple cargo records with the same car and waybill
Logic Flow:
IF A car ID and waybill number combination exists from previous N7 segment processing
AND The system needs to process multiple cargo records with the same car and waybill
THEN:
- • The system retrieves the first cargo record matching the car ID and waybill combination from the US cargo root segments
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when search has been performed for cargo records by car id and waybill.
Trigger Criteria:
- Context: A search has been performed for cargo records by car ID and waybill
- Applied to: Cargo Record Found?
- Action: The system evaluates the search results
Logic Flow:
IF A search has been performed for cargo records by car ID and waybill
AND The system evaluates the search results
THEN:
- • If a cargo record is found, continue with individual cargo processing,
otherwise end the multi-cargo processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record has been retrieved with matching car id and waybill.
Trigger Criteria:
- Context: A cargo record has been retrieved with matching car ID and waybill
- Applied to: Process Individual Cargo Record
- Action: The system processes the individual cargo record
Logic Flow:
IF A cargo record has been retrieved with matching car ID and waybill
AND The system processes the individual cargo record
THEN:
- • The system applies the current disposition code processing logic to the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when individual cargo record is being processed with current disposition code context.
Trigger Criteria:
- Context: An individual cargo record is being processed with current disposition code context
- Applied to: Update Cargo Status and Disposition Codes
- Action: The system updates the cargo record
Logic Flow:
IF An individual cargo record is being processed with current disposition code context
AND The system updates the cargo record
THEN:
- • The system applies the disposition code to the cargo's status array and updates the cargo status according to disposition code processing rules
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when one cargo record has been processed for a car id and waybill combination.
Trigger Criteria:
- Context: One cargo record has been processed for a car ID and waybill combination
- Applied to: Check for Additional Cargo Records with Same Car/Waybill
- Action: The system checks for additional records
Logic Flow:
IF One cargo record has been processed for a car ID and waybill combination
AND The system checks for additional records
THEN:
- • The system searches the cargo database for other records with the same car ID and waybill combination
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when search has been performed for additional cargo records with the same car id and waybill.
Trigger Criteria:
- Context: A search has been performed for additional cargo records with the same car ID and waybill
- Applied to: More Records with Same Car/Waybill?
- Action: The system evaluates the search results
Logic Flow:
IF A search has been performed for additional cargo records with the same car ID and waybill
AND The system evaluates the search results
THEN:
- • If more records are found, retrieve the next record for processing,
otherwise proceed to release status verification
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when additional cargo records exist with the same car id and waybill combination.
Trigger Criteria:
- Context: Additional cargo records exist with the same car ID and waybill combination
- Applied to: Retrieve Next Cargo Record
- Action: The system retrieves the next record
Logic Flow:
IF Additional cargo records exist with the same car ID and waybill combination
AND The system retrieves the next record
THEN:
- • The system fetches the next cargo record from the US cargo root segments for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all cargo records with the same car id and waybill have been processed.
Trigger Criteria:
- Context: All cargo records with the same car ID and waybill have been processed
- Applied to: Verify Release Status Across All Records
- Action: The system verifies release status across all records
Logic Flow:
IF All cargo records with the same car ID and waybill have been processed
AND The system verifies release status across all records
THEN:
- • The system examines the release status of each processed cargo record to determine overall release state
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when release status has been verified across all cargo records with the same car id and waybill.
Trigger Criteria:
- Context: Release status has been verified across all cargo records with the same car ID and waybill
- Applied to: All Records Have Same Release Status?
- Action: The system evaluates status consistency
Logic Flow:
IF Release status has been verified across all cargo records with the same car ID and waybill
AND The system evaluates status consistency
THEN:
- • If all records have the same release status, generate comprehensive release notification,
otherwise proceed to create Merlin notifications for status changes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all cargo records with the same car id and waybill have consistent release status.
Trigger Criteria:
- Context: All cargo records with the same car ID and waybill have consistent release status
- Applied to: Generate Comprehensive Release Notification
- Action: The system generates release notification
Logic Flow:
IF All cargo records with the same car ID and waybill have consistent release status
AND The system generates release notification
THEN:
- • The system creates a comprehensive release notification covering all related cargo records
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo records have been processed and comprehensive release notification generated.
Trigger Criteria:
- Context: Cargo records have been processed and comprehensive release notification generated
- Applied to: Generate Export Notification if Applicable
- Action: The system evaluates export notification requirements
Logic Flow:
IF Cargo records have been processed and comprehensive release notification generated
AND The system evaluates export notification requirements
THEN:
- • If any cargo records have export status or export-related disposition codes, generate appropriate export notifications
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when export notifications have been processed for applicable cargo records.
Trigger Criteria:
- Context: Export notifications have been processed for applicable cargo records
- Applied to: Generate Arrival Notification if Applicable
- Action: The system evaluates arrival notification requirements
Logic Flow:
IF Export notifications have been processed for applicable cargo records
AND The system evaluates arrival notification requirements
THEN:
- • If any cargo records have arrival status or arrival-related disposition codes, generate appropriate arrival notifications
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo records with the same car id and waybill do not have consistent release status or arrival notifications have been processed.
Trigger Criteria:
- Context: Cargo records with the same car ID and waybill do not have consistent release status OR arrival notifications have been processed
- Applied to: Create Merlin Notification for Status Changes
- Action: The system creates Merlin notifications
Logic Flow:
IF Cargo records with the same car ID and waybill do not have consistent release status OR arrival notifications have been processed
AND The system creates Merlin notifications
THEN:
- • The system generates appropriate Merlin messages for each cargo status change including disposition code details and cargo information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all notifications have been generated for cargo records with the same car id and waybill.
Trigger Criteria:
- Context: All notifications have been generated for cargo records with the same car ID and waybill
- Applied to: Update Final Status for All Related Records
- Action: The system updates final status
Logic Flow:
IF All notifications have been generated for cargo records with the same car ID and waybill
AND The system updates final status
THEN:
- • The system commits all status changes and disposition code updates to all related cargo records in the database
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record requires multi-cargo status verification.
Trigger Criteria:
- Context: A cargo record requires multi-cargo status verification
- Applied to: Start Multi-Cargo Status Verification
- Action: The multi-cargo status verification process is initiated
Logic Flow:
IF A cargo record requires multi-cargo status verification
AND The multi-cargo status verification process is initiated
THEN:
- • The verification process begins and prepares to retrieve related cargo records
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when car id and waybill number are provided for verification.
Trigger Criteria:
- Context: A car ID and waybill number are provided for verification
- Applied to: Retrieve All Cargo Records with Same Car ID and Waybill
- Action: The system searches for related cargo records
Logic Flow:
IF A car ID and waybill number are provided for verification
AND The system searches for related cargo records
THEN:
- • All cargo records with matching car ID and waybill number are retrieved from the cargo database
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when search for cargo records with matching car id and waybill has been performed.
Trigger Criteria:
- Context: A search for cargo records with matching car ID and waybill has been performed
- Applied to: More Records Found?
- Action: The system checks for additional unprocessed records
Logic Flow:
IF A search for cargo records with matching car ID and waybill has been performed
AND The system checks for additional unprocessed records
THEN:
- • If more records exist, continue processing individual records,
otherwise proceed to status comparison
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when individual cargo record is selected for processing.
Trigger Criteria:
- Context: An individual cargo record is selected for processing
- Applied to: Process Individual Cargo Record
- Action: The record processing begins
Logic Flow:
IF An individual cargo record is selected for processing
AND The record processing begins
THEN:
- • The cargo record is prepared for hold status analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record is being processed for status verification.
Trigger Criteria:
- Context: A cargo record is being processed for status verification
- Applied to: Analyze Cargo Hold Status
- Action: The hold status analysis is performed
Logic Flow:
IF A cargo record is being processed for status verification
AND The hold status analysis is performed
THEN:
- • The system evaluates all hold conditions and release status for the cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record is being analyzed for release status.
Trigger Criteria:
- Context: A cargo record is being analyzed for release status
- Applied to: Check Manual Release Status
- Action: The system checks for manual release indicators
Logic Flow:
IF A cargo record is being analyzed for release status
AND The system checks for manual release indicators
THEN:
- • If manual release is found, skip other hold checks and mark as released,
otherwise continue with hold type evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record without manual release is being processed.
Trigger Criteria:
- Context: A cargo record without manual release is being processed
- Applied to: Check Various Hold Types
- Action: Hold type evaluation begins
Logic Flow:
IF A cargo record without manual release is being processed
AND Hold type evaluation begins
THEN:
- • The system proceeds to check border holds, destination holds, FDA holds, and piece count holds
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record is being evaluated for hold conditions.
Trigger Criteria:
- Context: A cargo record is being evaluated for hold conditions
- Applied to: Evaluate Border Hold
- Action: Border hold status is checked
Logic Flow:
IF A cargo record is being evaluated for hold conditions
AND Border hold status is checked
THEN:
- • The system determines if border hold conditions apply to the cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record is being evaluated for hold conditions.
Trigger Criteria:
- Context: A cargo record is being evaluated for hold conditions
- Applied to: Evaluate Destination Hold
- Action: Destination hold status is checked
Logic Flow:
IF A cargo record is being evaluated for hold conditions
AND Destination hold status is checked
THEN:
- • The system determines if destination hold conditions apply to the cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record is being evaluated for hold conditions.
Trigger Criteria:
- Context: A cargo record is being evaluated for hold conditions
- Applied to: Evaluate FDA Hold
- Action: FDA hold status is checked
Logic Flow:
IF A cargo record is being evaluated for hold conditions
AND FDA hold status is checked
THEN:
- • The system determines if FDA hold conditions apply to the cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record is being evaluated for hold conditions.
Trigger Criteria:
- Context: A cargo record is being evaluated for hold conditions
- Applied to: Evaluate Piece Count Hold
- Action: Piece count hold status is checked
Logic Flow:
IF A cargo record is being evaluated for hold conditions
AND Piece count hold status is checked
THEN:
- • The system determines if piece count hold conditions apply based on quantity validation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all hold conditions have been evaluated for a cargo record.
Trigger Criteria:
- Context: All hold conditions have been evaluated for a cargo record
- Applied to: Determine Individual Record Release Status
- Action: The final release status is determined
Logic Flow:
IF All hold conditions have been evaluated for a cargo record
AND The final release status is determined
THEN:
- • The cargo record is classified as either released or held based on the evaluation results
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when individual cargo record's release status has been determined.
Trigger Criteria:
- Context: An individual cargo record's release status has been determined
- Applied to: Store Record Status in Verification Array
- Action: The status is stored in the verification array
Logic Flow:
IF An individual cargo record's release status has been determined
AND The status is stored in the verification array
THEN:
- • The record's release status is added to the array for later comparison with other related records
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all related cargo records have been processed and their statuses stored.
Trigger Criteria:
- Context: All related cargo records have been processed and their statuses stored
- Applied to: Compare All Record Statuses
- Action: Status comparison is performed
Logic Flow:
IF All related cargo records have been processed and their statuses stored
AND Status comparison is performed
THEN:
- • The system compares all record statuses to determine if they are consistent
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all related cargo record statuses have been compared.
Trigger Criteria:
- Context: All related cargo record statuses have been compared
- Applied to: All Records Have Consistent Release Status?
- Action: Consistency verification is performed
Logic Flow:
IF All related cargo record statuses have been compared
AND Consistency verification is performed
THEN:
- • If all records have consistent release status, generate comprehensive release notification,
otherwise create status mismatch warning
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all related cargo records have consistent release status.
Trigger Criteria:
- Context: All related cargo records have consistent release status
- Applied to: Generate Comprehensive Release Notification
- Action: Comprehensive release notification is generated
Logic Flow:
IF All related cargo records have consistent release status
AND Comprehensive release notification is generated
THEN:
- • A notification is created confirming the consistent release status across all related records
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when related cargo records have inconsistent release statuses.
Trigger Criteria:
- Context: Related cargo records have inconsistent release statuses
- Applied to: Create Release Status Mismatch Warning
- Action: Status mismatch warning is created
Logic Flow:
IF Related cargo records have inconsistent release statuses
AND Status mismatch warning is created
THEN:
- • A warning is generated indicating the inconsistency in release statuses among related records
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when multi-cargo status verification has been completed.
Trigger Criteria:
- Context: Multi-cargo status verification has been completed
- Applied to: Update Multi-Cargo Release Flag
- Action: The multi-cargo release flag is updated
Logic Flow:
IF Multi-cargo status verification has been completed
AND The multi-cargo release flag is updated
THEN:
- • The flag is set to reflect the overall release status of all related cargo records
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when multi-cargo status verification has been completed.
Trigger Criteria:
- Context: Multi-cargo status verification has been completed
- Applied to: Log Status Verification Results
- Action: Results logging is performed
Logic Flow:
IF Multi-cargo status verification has been completed
AND Results logging is performed
THEN:
- • The verification results, including any warnings or notifications, are logged for audit purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all multi-cargo status verification activities have been completed.
Trigger Criteria:
- Context: All multi-cargo status verification activities have been completed
- Applied to: End Multi-Cargo Status Verification
- Action: The verification process ends
Logic Flow:
IF All multi-cargo status verification activities have been completed
AND The verification process ends
THEN:
- • The process is completed and control is returned to the calling procedure
R-GCX016E-cbl-00431 (+16) File: GCX016E.cbl Business Rule: US
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record is being processed.
Trigger Criteria:
- Context: A cargo record is being processed
- Applied to: Identify Transit Cargo
- Action: The system evaluates cargo routing and destination information
Logic Flow:
IF A cargo record is being processed
AND The system evaluates cargo routing and destination information
THEN:
- • The cargo is flagged for transit processing if it meets US-Canada-US movement criteria
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has been identified for potential transit processing.
Trigger Criteria:
- Context: A cargo has been identified for potential transit processing
- Applied to: Cargo Moving Through Canada?
- Action: The system checks if the cargo routing involves movement through Canadian territory
Logic Flow:
IF A cargo has been identified for potential transit processing
AND The system checks if the cargo routing involves movement through Canadian territory
THEN:
- • The cargo is processed for Canadian transit if routing goes through Canada,
otherwise standard processing continues
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo requires canadian transit processing.
Trigger Criteria:
- Context: A cargo requires Canadian transit processing
- Applied to: Map US Port to Canadian Border Location
- Action: The system needs to identify the Canadian border location
Logic Flow:
IF A cargo requires Canadian transit processing
AND The system needs to identify the Canadian border location
THEN:
- • The US port is mapped to the corresponding Canadian border crossing location using border location mapping tables
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when canadian border location has been identified for the cargo.
Trigger Criteria:
- Context: A Canadian border location has been identified for the cargo
- Applied to: Search Canadian Cargo Database
- Action: The system searches the Canadian cargo database using cargo identifiers
Logic Flow:
IF A Canadian border location has been identified for the cargo
AND The system searches the Canadian cargo database using cargo identifiers
THEN:
- • The system retrieves matching Canadian cargo records from GCCC-CARGO-ROOT database
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when system has searched the canadian cargo database.
Trigger Criteria:
- Context: The system has searched the Canadian cargo database
- Applied to: Canadian Manifest Found?
- Action: The search results are evaluated for matching manifests
Logic Flow:
IF The system has searched the Canadian cargo database
AND The search results are evaluated for matching manifests
THEN:
- • Processing continues with equipment validation if Canadian manifest found,
otherwise error is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when canadian manifest has been found for the cargo.
Trigger Criteria:
- Context: A Canadian manifest has been found for the cargo
- Applied to: Validate Equipment ID Match
- Action: The system compares equipment IDs between US and Canadian records
Logic Flow:
IF A Canadian manifest has been found for the cargo
AND The system compares equipment IDs between US and Canadian records
THEN:
- • The equipment IDs must match exactly for the records to be linked for transit processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment id validation has been performed.
Trigger Criteria:
- Context: Equipment ID validation has been performed
- Applied to: Equipment ID Matches?
- Action: The system evaluates the match results
Logic Flow:
IF Equipment ID validation has been performed
AND The system evaluates the match results
THEN:
- • Cross-border tracking link is created if equipment IDs match,
otherwise error is generated for no Canadian match
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment ids match between us and canadian cargo records.
Trigger Criteria:
- Context: Equipment IDs match between US and Canadian cargo records
- Applied to: Create Cross-Border Tracking Link
- Action: The system creates cross-border tracking relationships
Logic Flow:
IF Equipment IDs match between US and Canadian cargo records
AND The system creates cross-border tracking relationships
THEN:
- • A tracking link is established connecting the US and Canadian cargo records for transit monitoring
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cross-border tracking link has been created.
Trigger Criteria:
- Context: A cross-border tracking link has been created
- Applied to: Update Transit Status
- Action: The system updates cargo status information
Logic Flow:
IF A cross-border tracking link has been created
AND The system updates cargo status information
THEN:
- • The cargo status is updated to reflect transit processing status and cross-border movement tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when canadian cargo records are being evaluated for transit processing.
Trigger Criteria:
- Context: Canadian cargo records are being evaluated for transit processing
- Applied to: Exclude Deleted Canadian Records
- Action: The system checks the status of Canadian records
Logic Flow:
IF Canadian cargo records are being evaluated for transit processing
AND The system checks the status of Canadian records
THEN:
- • Records marked as deleted are excluded from transit processing consideration
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when canadian cargo records are being evaluated for transit processing.
Trigger Criteria:
- Context: Canadian cargo records are being evaluated for transit processing
- Applied to: Exclude New Bond Created Records
- Action: The system checks for new bond created status
Logic Flow:
IF Canadian cargo records are being evaluated for transit processing
AND The system checks for new bond created status
THEN:
- • Records with new bond created status are excluded from transit processing consideration
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid canadian records have been identified and linked.
Trigger Criteria:
- Context: Valid Canadian records have been identified and linked
- Applied to: Process Transit Routing
- Action: The system processes transit routing information
Logic Flow:
IF Valid Canadian records have been identified and linked
AND The system processes transit routing information
THEN:
- • Transit routing data is processed and updated for cross-border movement tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when transit routing has been processed.
Trigger Criteria:
- Context: Transit routing has been processed
- Applied to: Update US Destination Information
- Action: The system updates destination information
Logic Flow:
IF Transit routing has been processed
AND The system updates destination information
THEN:
- • The final US destination information is updated to reflect the cargo's ultimate destination after Canadian transit
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when us destination information has been updated for transit cargo.
Trigger Criteria:
- Context: US destination information has been updated for transit cargo
- Applied to: Generate Transit Notification
- Action: The system generates processing notifications
Logic Flow:
IF US destination information has been updated for transit cargo
AND The system generates processing notifications
THEN:
- • Transit processing notifications are generated and sent to appropriate parties for cross-border movement tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when transit notifications have been generated.
Trigger Criteria:
- Context: Transit notifications have been generated
- Applied to: Log Transit Processing
- Action: The system logs processing activities
Logic Flow:
IF Transit notifications have been generated
AND The system logs processing activities
THEN:
- • All transit processing activities are logged with timestamps and details for audit trail and tracking purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when no canadian manifest is found or equipment ids do not match.
Trigger Criteria:
- Context: No Canadian manifest is found or equipment IDs do not match
- Applied to: Generate Error - No Canadian Match
- Action: The system cannot establish cross-border tracking
Logic Flow:
IF No Canadian manifest is found or equipment IDs do not match
AND The system cannot establish cross-border tracking
THEN:
- • An error is generated indicating no Canadian match found and standard processing continues
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo does not require canadian transit processing or transit processing has failed.
Trigger Criteria:
- Context: Cargo does not require Canadian transit processing or transit processing has failed
- Applied to: Continue Standard Processing
- Action: The system determines standard processing should continue
Logic Flow:
IF Cargo does not require Canadian transit processing or transit processing has failed
AND The system determines standard processing should continue
THEN:
- • Standard cargo processing procedures are followed without transit-specific handling
R-GCX016E-cbl-00448 (+16) File: GCX016E.cbl Business Rule: Cargo Lookup by Bond Index
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when incoming message contains bond number information in the message structure.
Trigger Criteria:
- Context: An incoming message contains bond number information in the message structure
- Applied to: Extract Bond Number from Message
- Action: The system processes the message to extract the bond number
Logic Flow:
IF An incoming message contains bond number information in the message structure
AND The system processes the message to extract the bond number
THEN:
- • The bond number is extracted from the message and made available for validation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when bond number has been extracted from the message.
Trigger Criteria:
- Context: A bond number has been extracted from the message
- Applied to: Bond Number Valid?
- Action: The system validates the bond number format and content
Logic Flow:
IF A bond number has been extracted from the message
AND The system validates the bond number format and content
THEN:
- • If the bond number is valid, processing continues; if invalid, an error is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid bond number has been extracted and validated.
Trigger Criteria:
- Context: A valid bond number has been extracted and validated
- Applied to: Set Bond Number as Search Key
- Action: The system prepares for cargo database lookup
Logic Flow:
IF A valid bond number has been extracted and validated
AND The system prepares for cargo database lookup
THEN:
- • The bond number is set as the search key for cargo record retrieval
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when bond number search key has been configured. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A bond number search key has been configured
- Applied to: Call GCCUSIO2 Database Access
- Action: The system needs to retrieve cargo records from the database
Logic Flow:
IF A bond number search key has been configured
AND The system needs to retrieve cargo records from the database
THEN:
- • The GCCUSIO2 database access module is called with the bond number search key
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when database access has been initiated with a bond number search key.
Trigger Criteria:
- Context: Database access has been initiated with a bond number search key
- Applied to: Search GCSUSRT Cargo Root Segments
- Action: The system searches the GCSUSRT cargo root segments table
Logic Flow:
IF Database access has been initiated with a bond number search key
AND The system searches the GCSUSRT cargo root segments table
THEN:
- • All cargo records with matching bond numbers are identified for retrieval
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when search has been performed on cargo root segments using bond number.
Trigger Criteria:
- Context: A search has been performed on cargo root segments using bond number
- Applied to: First Cargo Record Found?
- Action: The system evaluates the search results
Logic Flow:
IF A search has been performed on cargo root segments using bond number
AND The system evaluates the search results
THEN:
- • If at least one cargo record is found, processing continues; if no records found, bond not found error is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when at least one cargo record exists with the specified bond number.
Trigger Criteria:
- Context: At least one cargo record exists with the specified bond number
- Applied to: Retrieve First Cargo Record
- Action: The system retrieves cargo records
Logic Flow:
IF At least one cargo record exists with the specified bond number
AND The system retrieves cargo records
THEN:
- • The first matching cargo record is retrieved and made available for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when first cargo record has been successfully retrieved.
Trigger Criteria:
- Context: The first cargo record has been successfully retrieved
- Applied to: Set Cargo Found Flag
- Action: The system updates processing status
Logic Flow:
IF The first cargo record has been successfully retrieved
AND The system updates processing status
THEN:
- • The cargo found flag is set to indicate successful cargo location
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when first cargo record has been retrieved and cargo found flag is set.
Trigger Criteria:
- Context: The first cargo record has been retrieved and cargo found flag is set
- Applied to: Check for Additional Records
- Action: The system checks for additional records with the same bond number
Logic Flow:
IF The first cargo record has been retrieved and cargo found flag is set
AND The system checks for additional records with the same bond number
THEN:
- • The system determines if more cargo records exist with the same bond number
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when additional record check has been performed.
Trigger Criteria:
- Context: Additional record check has been performed
- Applied to: More Records with Same Bond?
- Action: The system evaluates if more records exist with the same bond number
Logic Flow:
IF Additional record check has been performed
AND The system evaluates if more records exist with the same bond number
THEN:
- • If more records exist, they are retrieved; if no more records, processing continues with current records
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when additional cargo records exist with the same bond number.
Trigger Criteria:
- Context: Additional cargo records exist with the same bond number
- Applied to: Retrieve Next Cargo Record
- Action: The system retrieves the next cargo record
Logic Flow:
IF Additional cargo records exist with the same bond number
AND The system retrieves the next cargo record
THEN:
- • The next matching cargo record is retrieved and prepared for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record has been retrieved (first or subsequent).
Trigger Criteria:
- Context: A cargo record has been retrieved (first or subsequent)
- Applied to: Add to Cargo Processing List
- Action: The system manages the cargo processing list
Logic Flow:
IF A cargo record has been retrieved (first or subsequent)
AND The system manages the cargo processing list
THEN:
- • The cargo record is added to the processing list for subsequent operations
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all cargo records with the bond number have been retrieved and added to processing list.
Trigger Criteria:
- Context: All cargo records with the bond number have been retrieved and added to processing list
- Applied to: Set Bond Index for Processing
- Action: The system prepares for cargo processing operations
Logic Flow:
IF All cargo records with the bond number have been retrieved and added to processing list
AND The system prepares for cargo processing operations
THEN:
- • The bond index is configured for processing all associated cargo records
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when bond index has been configured and all cargo records are in the processing list.
Trigger Criteria:
- Context: Bond index has been configured and all cargo records are in the processing list
- Applied to: Return Cargo Records for Processing
- Action: The cargo lookup operation completes successfully
Logic Flow:
IF Bond index has been configured and all cargo records are in the processing list
AND The cargo lookup operation completes successfully
THEN:
- • All cargo records associated with the bond number are returned for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when bond number search has been performed and no cargo records were found.
Trigger Criteria:
- Context: A bond number search has been performed and no cargo records were found
- Applied to: Generate Bond Not Found Error
- Action: The system processes the empty search result
Logic Flow:
IF A bond number search has been performed and no cargo records were found
AND The system processes the empty search result
THEN:
- • A bond not found error is generated for the specified bond number
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when bond not found error has been generated.
Trigger Criteria:
- Context: A bond not found error has been generated
- Applied to: Log Bond Lookup Failure
- Action: The system handles the error condition
Logic Flow:
IF A bond not found error has been generated
AND The system handles the error condition
THEN:
- • The bond lookup failure is logged with relevant details for audit purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when bond lookup failure has been logged.
Trigger Criteria:
- Context: Bond lookup failure has been logged
- Applied to: Continue with Next Message
- Action: The system completes error handling for the current message
Logic Flow:
IF Bond lookup failure has been logged
AND The system completes error handling for the current message
THEN:
- • Processing continues with the next available message in the queue
R-GCX016E-cbl-00465 (+16) File: GCX016E.cbl Business Rule: Cargo Lookup by Car ID Index
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when car equipment initial and number are provided from n7 segment.
Trigger Criteria:
- Context: A car equipment initial and number are provided from N7 segment
- Applied to: Format Car ID using Standard Rules
- Action: The system needs to create a car ID key for cargo lookup
Logic Flow:
IF A car equipment initial and number are provided from N7 segment
AND The system needs to create a car ID key for cargo lookup
THEN:
- • The car ID is formatted by concatenating equipment initial and number with proper spacing and validation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when formatted car id key exists.
Trigger Criteria:
- Context: A formatted car ID key exists
- Applied to: Search Cargo Database by Car ID
- Action: The system searches for cargo records in the database
Logic Flow:
IF A formatted car ID key exists
AND The system searches for cargo records in the database
THEN:
- • The system queries both US cargo root segments and car ID index tables to find matching records
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when database search has been performed for a car id.
Trigger Criteria:
- Context: A database search has been performed for a car ID
- Applied to: Cargo Record Found?
- Action: The system evaluates the search results
Logic Flow:
IF A database search has been performed for a car ID
AND The system evaluates the search results
THEN:
- • If a cargo record is found, retrieve the existing record;
otherwise proceed to CPRS traffic check
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record exists in the database for the car id.
Trigger Criteria:
- Context: A cargo record exists in the database for the car ID
- Applied to: Retrieve Existing Cargo Record
- Action: The system needs to process the cargo
Logic Flow:
IF A cargo record exists in the database for the car ID
AND The system needs to process the cargo
THEN:
- • The existing cargo record is retrieved and made available for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when no cargo record was found in the initial database search.
Trigger Criteria:
- Context: No cargo record was found in the initial database search
- Applied to: Is CPRS Traffic?
- Action: The system evaluates the traffic type
Logic Flow:
IF No cargo record was found in the initial database search
AND The system evaluates the traffic type
THEN:
- • If the cargo is identified as CPRS traffic, apply CPRS special processing;
otherwise generate error message for missing cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo is identified as cprs traffic and no initial record was found.
Trigger Criteria:
- Context: Cargo is identified as CPRS traffic and no initial record was found
- Applied to: Apply CPRS Special Processing
- Action: CPRS special processing is triggered
Logic Flow:
IF Cargo is identified as CPRS traffic and no initial record was found
AND CPRS special processing is triggered
THEN:
- • The system handles SCAC unknown scenarios and performs US-CCN key renumbering for CPRS-specific lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cprs traffic is being processed.
Trigger Criteria:
- Context: CPRS traffic is being processed
- Applied to: Handle SCAC Unknown Scenarios
- Action: The SCAC code is unknown or not available
Logic Flow:
IF CPRS traffic is being processed
AND The SCAC code is unknown or not available
THEN:
- • The system applies default SCAC handling rules and prepares for key renumbering
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cprs traffic requires special key handling.
Trigger Criteria:
- Context: CPRS traffic requires special key handling
- Applied to: Perform US-CCN Key Renumbering
- Action: US-CCN key renumbering is performed
Logic Flow:
IF CPRS traffic requires special key handling
AND US-CCN key renumbering is performed
THEN:
- • The system creates an updated lookup key using CPRS-specific numbering rules
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when renumbered us-ccn key has been created for cprs traffic.
Trigger Criteria:
- Context: A renumbered US-CCN key has been created for CPRS traffic
- Applied to: Search Again with Updated Key
- Action: The system searches the database again
Logic Flow:
IF A renumbered US-CCN key has been created for CPRS traffic
AND The system searches the database again
THEN:
- • The system queries the cargo database using the updated CPRS key
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cprs special processing and secondary search have been completed.
Trigger Criteria:
- Context: CPRS special processing and secondary search have been completed
- Applied to: Record Found After CPRS Processing?
- Action: The system evaluates the search results
Logic Flow:
IF CPRS special processing and secondary search have been completed
AND The system evaluates the search results
THEN:
- • If a record is found, retrieve the existing cargo record;
otherwise create a new CPRS cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when no cargo record exists after cprs processing and secondary search.
Trigger Criteria:
- Context: No cargo record exists after CPRS processing and secondary search
- Applied to: Create New CPRS Cargo Record
- Action: A new CPRS cargo record needs to be created
Logic Flow:
IF No cargo record exists after CPRS processing and secondary search
AND A new CPRS cargo record needs to be created
THEN:
- • The system initiates creation of a new cargo record with CPRS-specific attributes
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when new cprs cargo record is being created.
Trigger Criteria:
- Context: A new CPRS cargo record is being created
- Applied to: Initialize New Record with Car ID
- Action: The record initialization process begins
Logic Flow:
IF A new CPRS cargo record is being created
AND The record initialization process begins
THEN:
- • The new record is populated with the car ID and basic identification information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when new cprs cargo record is being initialized.
Trigger Criteria:
- Context: A new CPRS cargo record is being initialized
- Applied to: Set CPRS-Specific Flags
- Action: CPRS-specific attributes need to be set
Logic Flow:
IF A new CPRS cargo record is being initialized
AND CPRS-specific attributes need to be set
THEN:
- • The system applies CPRS-specific flags, processing indicators, and business rule markers
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when new cprs cargo record has been fully initialized.
Trigger Criteria:
- Context: A new CPRS cargo record has been fully initialized
- Applied to: Insert New Record into Database
- Action: The record is ready for database storage
Logic Flow:
IF A new CPRS cargo record has been fully initialized
AND The record is ready for database storage
THEN:
- • The system inserts the new record into the US cargo root segments database
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when new cprs cargo record has been successfully inserted into the database.
Trigger Criteria:
- Context: A new CPRS cargo record has been successfully inserted into the database
- Applied to: Log CPRS Cargo Creation
- Action: Audit logging is required
Logic Flow:
IF A new CPRS cargo record has been successfully inserted into the database
AND Audit logging is required
THEN:
- • The system creates log entries documenting the CPRS cargo creation event
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record has been found or created successfully.
Trigger Criteria:
- Context: A cargo record has been found or created successfully
- Applied to: Return Cargo Record for Processing
- Action: The lookup process is complete
Logic Flow:
IF A cargo record has been found or created successfully
AND The lookup process is complete
THEN:
- • The system returns the cargo record to the calling process for further business operations
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when no cargo record exists and the traffic is not cprs type.
Trigger Criteria:
- Context: No cargo record exists and the traffic is not CPRS type
- Applied to: Generate Error Message for Missing Cargo
- Action: The cargo lookup process fails
Logic Flow:
IF No cargo record exists and the traffic is not CPRS type
AND The cargo lookup process fails
THEN:
- • The system generates an error message indicating the cargo could not be located for the given car ID
R-GCX016E-cbl-00482 (+15) File: GCX016E.cbl Business Rule: Cargo Lookup by Car/Waybill Combination
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when equipment initial and equipment number are provided from n7 segment.
Trigger Criteria:
- Context: Equipment initial and equipment number are provided from N7 segment
- Applied to: Format Car ID using Standard Rules
- Action: System needs to format car ID for cargo lookup
Logic Flow:
IF Equipment initial and equipment number are provided from N7 segment
AND System needs to format car ID for cargo lookup
THEN:
- • System concatenates equipment initial and equipment number to create standardized car ID format
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when formatted car id and waybill number are available.
Trigger Criteria:
- Context: Formatted car ID and waybill number are available
- Applied to: Build Car/Waybill Search Key
- Action: System prepares to search for cargo records
Logic Flow:
IF Formatted car ID and waybill number are available
AND System prepares to search for cargo records
THEN:
- • System builds composite search key using car ID and waybill number combination
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when car/waybill search key is constructed.
Trigger Criteria:
- Context: Car/waybill search key is constructed
- Applied to: Search GCSUSRT Database by Car/Waybill Index
- Action: System searches GCSUSRT database using car/waybill index
Logic Flow:
IF Car/waybill search key is constructed
AND System searches GCSUSRT database using car/waybill index
THEN:
- • System retrieves cargo records matching the car/waybill combination
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when database search for car/waybill combination is completed.
Trigger Criteria:
- Context: Database search for car/waybill combination is completed
- Applied to: First Cargo Record Found?
- Action: System checks search results
Logic Flow:
IF Database search for car/waybill combination is completed
AND System checks search results
THEN:
- • System determines if first cargo record exists and proceeds with retrieval or handles not found scenario
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when first cargo record exists for car/waybill combination.
Trigger Criteria:
- Context: First cargo record exists for car/waybill combination
- Applied to: Retrieve First Cargo Record
- Action: System retrieves the first matching cargo record
Logic Flow:
IF First cargo record exists for car/waybill combination
AND System retrieves the first matching cargo record
THEN:
- • System loads cargo record data for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when first cargo record is successfully retrieved.
Trigger Criteria:
- Context: First cargo record is successfully retrieved
- Applied to: Store Cargo Information
- Action: System processes the cargo record data
Logic Flow:
IF First cargo record is successfully retrieved
AND System processes the cargo record data
THEN:
- • System stores cargo information in working storage for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when first cargo record is processed and stored.
Trigger Criteria:
- Context: First cargo record is processed and stored
- Applied to: Search for Additional Records with Same Car/Waybill
- Action: System searches for additional records with same car/waybill
Logic Flow:
IF First cargo record is processed and stored
AND System searches for additional records with same car/waybill
THEN:
- • System identifies all remaining cargo records with matching car/waybill combination
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when search for additional cargo records is completed.
Trigger Criteria:
- Context: Search for additional cargo records is completed
- Applied to: More Records Found?
- Action: System evaluates search results for more records
Logic Flow:
IF Search for additional cargo records is completed
AND System evaluates search results for more records
THEN:
- • System determines if additional records exist and continues retrieval or proceeds to next processing step
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when additional cargo records exist for car/waybill combination.
Trigger Criteria:
- Context: Additional cargo records exist for car/waybill combination
- Applied to: Retrieve Next Cargo Record
- Action: System retrieves next matching cargo record
Logic Flow:
IF Additional cargo records exist for car/waybill combination
AND System retrieves next matching cargo record
THEN:
- • System loads additional cargo record data for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when additional cargo record is successfully retrieved.
Trigger Criteria:
- Context: Additional cargo record is successfully retrieved
- Applied to: Add to Cargo Collection
- Action: System processes the additional cargo record
Logic Flow:
IF Additional cargo record is successfully retrieved
AND System processes the additional cargo record
THEN:
- • System adds cargo record to the collection and continues search for more records
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all cargo records for car/waybill combination are collected.
Trigger Criteria:
- Context: All cargo records for car/waybill combination are collected
- Applied to: CPRS Traffic?
- Action: System checks cargo characteristics for CPRS traffic indicators
Logic Flow:
IF All cargo records for car/waybill combination are collected
AND System checks cargo characteristics for CPRS traffic indicators
THEN:
- • System determines if CPRS special handling rules should be applied
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo is identified as cprs traffic.
Trigger Criteria:
- Context: Cargo is identified as CPRS traffic
- Applied to: Apply CPRS Handling Rules
- Action: System applies CPRS handling rules
Logic Flow:
IF Cargo is identified as CPRS traffic
AND System applies CPRS handling rules
THEN:
- • System clears car ID information and applies CPRS-specific processing logic
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when car id is formatted and cprs processing is completed if applicable.
Trigger Criteria:
- Context: Car ID is formatted and CPRS processing is completed if applicable
- Applied to: Validate Car ID Format
- Action: System validates car ID format
Logic Flow:
IF Car ID is formatted and CPRS processing is completed if applicable
AND System validates car ID format
THEN:
- • System ensures car ID meets format requirements and is ready for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all cargo records are retrieved, validated, and processed.
Trigger Criteria:
- Context: All cargo records are retrieved, validated, and processed
- Applied to: Return All Matching Cargo Records
- Action: System completes cargo lookup operation
Logic Flow:
IF All cargo records are retrieved, validated, and processed
AND System completes cargo lookup operation
THEN:
- • System returns complete collection of matching cargo records for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when no cargo records exist for the specified car/waybill combination.
Trigger Criteria:
- Context: No cargo records exist for the specified car/waybill combination
- Applied to: Handle Cargo Not Found Scenario
- Action: System handles cargo not found scenario
Logic Flow:
IF No cargo records exist for the specified car/waybill combination
AND System handles cargo not found scenario
THEN:
- • System logs the not found condition and continues processing without cargo records
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo lookup operation is completed with or without results.
Trigger Criteria:
- Context: Cargo lookup operation is completed with or without results
- Applied to: Log Search Results
- Action: System logs search results
Logic Flow:
IF Cargo lookup operation is completed with or without results
AND System logs search results
THEN:
- • System records search outcome including number of records found or not found status
R-GCX016E-cbl-00498 (+18) File: GCX016E.cbl Business Rule: Cargo 350 Message Logging
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code is received for cargo processing.
Trigger Criteria:
- Context: A disposition code is received for cargo processing
- Applied to: Disposition Code Type?
- Action: The system evaluates the disposition code type
Logic Flow:
IF A disposition code is received for cargo processing
AND The system evaluates the disposition code type
THEN:
- • The system must categorize it as Hold, Release, Arrival, Export, Seizure, Status Information, or Cancellation action type
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is classified as a hold action type.
Trigger Criteria:
- Context: A disposition code is classified as a hold action type
- Applied to: Log Hold Action
- Action: The system processes the hold disposition code
Logic Flow:
IF A disposition code is classified as a hold action type
AND The system processes the hold disposition code
THEN:
- • The system must log the hold action with disposition code details and action description
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code is classified as a release action type.
Trigger Criteria:
- Context: A disposition code is classified as a release action type
- Applied to: Log Release Action
- Action: The system processes the release disposition code
Logic Flow:
IF A disposition code is classified as a release action type
AND The system processes the release disposition code
THEN:
- • The system must log the release action with disposition code details and action description
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code is classified as an arrival action type.
Trigger Criteria:
- Context: A disposition code is classified as an arrival action type
- Applied to: Log Arrival Action
- Action: The system processes the arrival disposition code
Logic Flow:
IF A disposition code is classified as an arrival action type
AND The system processes the arrival disposition code
THEN:
- • The system must log the arrival action with disposition code details and action description
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code is classified as an export action type.
Trigger Criteria:
- Context: A disposition code is classified as an export action type
- Applied to: Log Export Action
- Action: The system processes the export disposition code
Logic Flow:
IF A disposition code is classified as an export action type
AND The system processes the export disposition code
THEN:
- • The system must log the export action with disposition code details and action description
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code is classified as a seizure action type.
Trigger Criteria:
- Context: A disposition code is classified as a seizure action type
- Applied to: Log Seizure Action
- Action: The system processes the seizure disposition code
Logic Flow:
IF A disposition code is classified as a seizure action type
AND The system processes the seizure disposition code
THEN:
- • The system must log the seizure action with disposition code details and action description
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is classified as status information type.
Trigger Criteria:
- Context: A disposition code is classified as status information type
- Applied to: Log Status Information
- Action: The system processes the status information disposition code
Logic Flow:
IF A disposition code is classified as status information type
AND The system processes the status information disposition code
THEN:
- • The system must log the status information with disposition code details and action description
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code is classified as a cancellation action type.
Trigger Criteria:
- Context: A disposition code is classified as a cancellation action type
- Applied to: Log Cancellation Action
- Action: The system processes the cancellation disposition code
Logic Flow:
IF A disposition code is classified as a cancellation action type
AND The system processes the cancellation disposition code
THEN:
- • The system must log the cancellation action with disposition code details and action description
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code action has been categorized and logged.
Trigger Criteria:
- Context: A disposition code action has been categorized and logged
- Applied to: Prepare Log Message
- Action: The system prepares the log message structure
Logic Flow:
IF A disposition code action has been categorized and logged
AND The system prepares the log message structure
THEN:
- • The system must create a standardized message format ready for timestamp, equipment, disposition, and user information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when log message structure has been prepared for cargo disposition action.
Trigger Criteria:
- Context: A log message structure has been prepared for cargo disposition action
- Applied to: Add Timestamp Information
- Action: The system adds timestamp information to the log message
Logic Flow:
IF A log message structure has been prepared for cargo disposition action
AND The system adds timestamp information to the log message
THEN:
- • The system must include the current processing timestamp in the log message
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when log message has timestamp information added.
Trigger Criteria:
- Context: A log message has timestamp information added
- Applied to: Add Equipment Details
- Action: The system adds equipment details to the log message
Logic Flow:
IF A log message has timestamp information added
AND The system adds equipment details to the log message
THEN:
- • The system must include equipment ID, waybill number, and US-CCN in the log message
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when log message has equipment details added.
Trigger Criteria:
- Context: A log message has equipment details added
- Applied to: Add Disposition Code Details
- Action: The system adds disposition code details to the log message
Logic Flow:
IF A log message has equipment details added
AND The system adds disposition code details to the log message
THEN:
- • The system must include the disposition code and corresponding action description in the log message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when log message has disposition code details added.
Trigger Criteria:
- Context: A log message has disposition code details added
- Applied to: Add User Information
- Action: The system adds user information to the log message
Logic Flow:
IF A log message has disposition code details added
AND The system adds user information to the log message
THEN:
- • The system must include the user ID who initiated the disposition code action in the log message
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when complete log message with all required information has been prepared.
Trigger Criteria:
- Context: A complete log message with all required information has been prepared
- Applied to: Spawn GCT1051E Transaction
- Action: The system spawns GCT1051E transaction for logging
Logic Flow:
IF A complete log message with all required information has been prepared
AND The system spawns GCT1051E transaction for logging
THEN:
- • The system must invoke GCT1051E transaction with the complete log message for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when gct1051e transaction has been spawned with the log message.
Trigger Criteria:
- Context: GCT1051E transaction has been spawned with the log message
- Applied to: Write to Audit Trail
- Action: The system writes to the audit trail
Logic Flow:
IF GCT1051E transaction has been spawned with the log message
AND The system writes to the audit trail
THEN:
- • The system must permanently store the cargo disposition log message in the audit trail database
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when audit trail write operation has been attempted.
Trigger Criteria:
- Context: The audit trail write operation has been attempted
- Applied to: Logging Successful?
- Action: The system validates logging success
Logic Flow:
IF The audit trail write operation has been attempted
AND The system validates logging success
THEN:
- • The system must determine if the logging was successful or if an error occurred during the process
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo disposition logging has been validated as successful.
Trigger Criteria:
- Context: The cargo disposition logging has been validated as successful
- Applied to: Continue Processing
- Action: The system continues processing
Logic Flow:
IF The cargo disposition logging has been validated as successful
AND The system continues processing
THEN:
- • The system must proceed with the next step in the cargo processing workflow
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo disposition logging has been validated as unsuccessful.
Trigger Criteria:
- Context: The cargo disposition logging has been validated as unsuccessful
- Applied to: Handle Logging Error
- Action: The system handles the logging error
Logic Flow:
IF The cargo disposition logging has been validated as unsuccessful
AND The system handles the logging error
THEN:
- • The system must implement appropriate error handling procedures and may generate error notifications
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo disposition logging process has either completed successfully or error handling has been performed.
Trigger Criteria:
- Context: The cargo disposition logging process has either completed successfully or error handling has been performed
- Applied to: End Logging Process
- Action: The system ends the logging process
Logic Flow:
IF The cargo disposition logging process has either completed successfully or error handling has been performed
AND The system ends the logging process
THEN:
- • The system must properly terminate the logging process and clean up any resources used
R-GCX016E-cbl-00517 (+12) File: GCX016E.cbl Business Rule: K1 Remark Message Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when k1 segment is received for processing.
Trigger Criteria:
- Context: A K1 segment is received for processing
- Applied to: Message Type?
- Action: The system evaluates the message context to determine processing type
Logic Flow:
IF A K1 segment is received for processing
AND The system evaluates the message context to determine processing type
THEN:
- • The K1 segment is classified as either train message or cargo message for appropriate processing workflow
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when k1 segment contains free-form text data.
Trigger Criteria:
- Context: A K1 segment contains free-form text data
- Applied to: Extract Free-Form Text
- Action: The system processes the K1 segment
Logic Flow:
IF A K1 segment contains free-form text data
AND The system processes the K1 segment
THEN:
- • The free-form text content is extracted and prepared for validation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when free-form text has been extracted from k1 segment.
Trigger Criteria:
- Context: Free-form text has been extracted from K1 segment
- Applied to: Text Valid?
- Action: The system validates the text content
Logic Flow:
IF Free-form text has been extracted from K1 segment
AND The system validates the text content
THEN:
- • The text is either accepted as valid for further processing or rejected if it fails validation criteria
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid k1 message is classified as train-related.
Trigger Criteria:
- Context: A valid K1 message is classified as train-related
- Applied to: Store K1 Message for Train
- Action: The system processes the validated K1 content
Logic Flow:
IF A valid K1 message is classified as train-related
AND The system processes the validated K1 content
THEN:
- • The K1 message is stored in train message repository for inclusion in train notifications
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid k1 message is classified as cargo-related.
Trigger Criteria:
- Context: A valid K1 message is classified as cargo-related
- Applied to: Store K1 Message for Cargo
- Action: The system processes the validated K1 content
Logic Flow:
IF A valid K1 message is classified as cargo-related
AND The system processes the validated K1 content
THEN:
- • The K1 message is stored in cargo message repository for inclusion in cargo notifications
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when k1 message has been stored for either train or cargo processing.
Trigger Criteria:
- Context: A K1 message has been stored for either train or cargo processing
- Applied to: Log K1 Message Action
- Action: The system completes K1 message storage
Logic Flow:
IF A K1 message has been stored for either train or cargo processing
AND The system completes K1 message storage
THEN:
- • The K1 message processing action is logged with appropriate details for audit purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when k1 message has been logged and processed.
Trigger Criteria:
- Context: A K1 message has been logged and processed
- Applied to: Associate with Disposition Code
- Action: The system identifies related disposition codes
Logic Flow:
IF A K1 message has been logged and processed
AND The system identifies related disposition codes
THEN:
- • The K1 message is associated with the appropriate disposition code for combined processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when k1 message is associated with a disposition code.
Trigger Criteria:
- Context: A K1 message is associated with a disposition code
- Applied to: Special K1 Type?
- Action: The system evaluates K1 content for special processing requirements
Logic Flow:
IF A K1 message is associated with a disposition code
AND The system evaluates K1 content for special processing requirements
THEN:
- • The K1 message is classified as either requiring special bond creation processing or standard remark processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when k1 message contains canadian pacific railway identifiers such as 'director of customs, cp rail', 'canadian pacific limited', or 'canadian pacific railway co'.
Trigger Criteria:
- Context: A K1 message contains Canadian Pacific Railway identifiers such as 'DIRECTOR OF CUSTOMS, CP RAIL', 'CANADIAN PACIFIC LIMITED', or 'CANADIAN PACIFIC RAILWAY CO'
- Applied to: Canadian Pacific Railway Bond Creation
- Action: The system processes the special K1 type
Logic Flow:
IF A K1 message contains Canadian Pacific Railway identifiers such as 'DIRECTOR OF CUSTOMS, CP RAIL', 'CANADIAN PACIFIC LIMITED', or 'CANADIAN PACIFIC RAILWAY CO'
AND The system processes the special K1 type
THEN:
- • A broker bond creation message is generated for Canadian Pacific Railway processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when k1 message does not require special bond creation processing.
Trigger Criteria:
- Context: A K1 message does not require special bond creation processing
- Applied to: Standard K1 Remark
- Action: The system processes the K1 message type
Logic Flow:
IF A K1 message does not require special bond creation processing
AND The system processes the K1 message type
THEN:
- • The K1 message is processed as a standard remark for inclusion in notifications
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when k1 message has been processed as either special bond creation or standard remark.
Trigger Criteria:
- Context: A K1 message has been processed as either special bond creation or standard remark
- Applied to: Add to Merlin Message
- Action: The system prepares Merlin notifications
Logic Flow:
IF A K1 message has been processed as either special bond creation or standard remark
AND The system prepares Merlin notifications
THEN:
- • The K1 message content is added to appropriate Merlin messages for distribution
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when k1 messages are included in cargo and train notifications.
Trigger Criteria:
- Context: K1 messages are included in cargo and train notifications
- Applied to: Format K1 Comments
- Action: The system formats the notification content
Logic Flow:
IF K1 messages are included in cargo and train notifications
AND The system formats the notification content
THEN:
- • K1 comments are formatted with up to 4 lines of K1 segment comments as available and properly structured for recipient systems
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when k1 comments have been formatted for notifications.
Trigger Criteria:
- Context: K1 comments have been formatted for notifications
- Applied to: Integrate with Status Updates
- Action: The system processes status updates for cargo or train operations
Logic Flow:
IF K1 comments have been formatted for notifications
AND The system processes status updates for cargo or train operations
THEN:
- • The formatted K1 comments are integrated with status updates to provide complete information context
R-GCX016E-cbl-00530 (+11) File: GCX016E.cbl Business Rule: CPRS Cargo Not Found Error Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cprs cargo lookup request is initiated.
Trigger Criteria:
- Context: A CPRS cargo lookup request is initiated
- Applied to: Cargo Found in System?
- Action: The system searches for the cargo in the database
Logic Flow:
IF A CPRS cargo lookup request is initiated
AND The system searches for the cargo in the database
THEN:
- • The system determines if the cargo exists and routes to appropriate processing path
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo is not found in the system.
Trigger Criteria:
- Context: Cargo is not found in the system
- Applied to: Check CPRS Traffic Flag
- Action: The system checks the CPRS traffic designation flag
Logic Flow:
IF Cargo is not found in the system
AND The system checks the CPRS traffic designation flag
THEN:
- • The system identifies whether this is CPRS traffic requiring special error handling
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cprs traffic flag has been checked for cargo not found in system.
Trigger Criteria:
- Context: The CPRS traffic flag has been checked for cargo not found in system
- Applied to: Is CPRS Traffic?
- Action: The system evaluates if the cargo is designated as CPRS traffic
Logic Flow:
IF The CPRS traffic flag has been checked for cargo not found in system
AND The system evaluates if the cargo is designated as CPRS traffic
THEN:
- • If CPRS traffic, generate specific error message;
otherwise continue with normal processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo is not found in system and is designated as cprs traffic.
Trigger Criteria:
- Context: Cargo is not found in system and is designated as CPRS traffic
- Applied to: Generate CPRS Cargo Not Found Error
- Action: The system initiates error message generation
Logic Flow:
IF Cargo is not found in system and is designated as CPRS traffic
AND The system initiates error message generation
THEN:
- • A CPRS-specific cargo not found error message is created
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cprs cargo not found error is being generated.
Trigger Criteria:
- Context: A CPRS cargo not found error is being generated
- Applied to: Format Error Message with Car ID
- Action: The system formats the error message
Logic Flow:
IF A CPRS cargo not found error is being generated
AND The system formats the error message
THEN:
- • The car ID information is included in the error message format
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when error message is being formatted with car id.
Trigger Criteria:
- Context: The error message is being formatted with car ID
- Applied to: Include Equipment Details in Error
- Action: Equipment details are available for the cargo
Logic Flow:
IF The error message is being formatted with car ID
AND Equipment details are available for the cargo
THEN:
- • Equipment information is included in the error message
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when error message includes equipment details.
Trigger Criteria:
- Context: The error message includes equipment details
- Applied to: Add Waybill Information to Error
- Action: Waybill information is available
Logic Flow:
IF The error message includes equipment details
AND Waybill information is available
THEN:
- • Waybill information is added to the error message
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when error message content is complete with all required information.
Trigger Criteria:
- Context: The error message content is complete with all required information
- Applied to: Set Error Message Type
- Action: The system sets the message type
Logic Flow:
IF The error message content is complete with all required information
AND The system sets the message type
THEN:
- • The error message is classified with the appropriate type for CPRS cargo not found scenarios
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cprs error message is formatted and typed.
Trigger Criteria:
- Context: The CPRS error message is formatted and typed
- Applied to: Send Error to Merlin System
- Action: The system sends the error to Merlin
Logic Flow:
IF The CPRS error message is formatted and typed
AND The system sends the error to Merlin
THEN:
- • The error message is transmitted to the Merlin system for distribution
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when error message has been sent to merlin system.
Trigger Criteria:
- Context: The error message has been sent to Merlin system
- Applied to: Log CPRS Error for Audit
- Action: The system performs audit logging
Logic Flow:
IF The error message has been sent to Merlin system
AND The system performs audit logging
THEN:
- • The CPRS error is recorded in audit logs with appropriate details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cprs error has been processed and logged.
Trigger Criteria:
- Context: CPRS error has been processed and logged
- Applied to: Continue Processing Other Cargo
- Action: The system continues with remaining processing
Logic Flow:
IF CPRS error has been processed and logged
AND The system continues with remaining processing
THEN:
- • Normal cargo processing workflow resumes for other cargo items
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo is found in the system.
Trigger Criteria:
- Context: Cargo is found in the system
- Applied to: Normal Cargo Processing
- Action: The system initiates cargo processing
Logic Flow:
IF Cargo is found in the system
AND The system initiates cargo processing
THEN:
- • Cargo follows the normal processing workflow without error handling
R-GCX016E-cbl-00542 (+11) File: GCX016E.cbl Business Rule: Train Not Arrived Warning
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when oca disposition code is received for a train and m10 segment contains train identification information.
Trigger Criteria:
- Context: An OCA disposition code is received for a train AND M10 segment contains train identification information
- Applied to: Validate Train ID from M10 Segment
- Action: The system processes the M10 segment to extract and validate train ID
Logic Flow:
IF An OCA disposition code is received for a train AND M10 segment contains train identification information
AND The system processes the M10 segment to extract and validate train ID
THEN:
- • The train ID is validated against available train data for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when validated train id from m10 segment processing.
Trigger Criteria:
- Context: A validated train ID from M10 segment processing
- Applied to: Train Found in USCS System?
- Action: The system searches for the train in USCS train list segments
Logic Flow:
IF A validated train ID from M10 segment processing
AND The system searches for the train in USCS train list segments
THEN:
- • If train is found, proceed to arrival status check OR if train is not found, generate train not arrived warning
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train exists in the uscs system.
Trigger Criteria:
- Context: A train exists in the USCS system
- Applied to: Check Train Arrival Status
- Action: The system checks the train's current arrival status information
Logic Flow:
IF A train exists in the USCS system
AND The system checks the train's current arrival status information
THEN:
- • The arrival status is retrieved and made available for arrival validation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train arrival status information is available.
Trigger Criteria:
- Context: Train arrival status information is available
- Applied to: Train Already Arrived?
- Action: The system evaluates if the train status indicates it has already arrived
Logic Flow:
IF Train arrival status information is available
AND The system evaluates if the train status indicates it has already arrived
THEN:
- • If train has already arrived, end OCA processing OR if train has not arrived, generate train not arrived warning
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train is not found in uscs system or train exists but has not arrived.
Trigger Criteria:
- Context: Train is not found in USCS system OR train exists but has not arrived
- Applied to: Generate Train Not Arrived Warning
- Action: The system processes OCA disposition code for the train
Logic Flow:
IF Train is not found in USCS system OR train exists but has not arrived
AND The system processes OCA disposition code for the train
THEN:
- • A train not arrived warning is generated for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train not arrived warning has been generated.
Trigger Criteria:
- Context: A train not arrived warning has been generated
- Applied to: Log Warning Message with Train Details
- Action: The system logs the warning message
Logic Flow:
IF A train not arrived warning has been generated
AND The system logs the warning message
THEN:
- • Warning message is recorded with complete train details including train ID and relevant context information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when warning message with train details has been logged.
Trigger Criteria:
- Context: Warning message with train details has been logged
- Applied to: Create Merlin Warning Notification
- Action: The system creates Merlin notification for the warning
Logic Flow:
IF Warning message with train details has been logged
AND The system creates Merlin notification for the warning
THEN:
- • Merlin warning notification is created and prepared for delivery to operations team
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when merlin warning notification is being created.
Trigger Criteria:
- Context: Merlin warning notification is being created
- Applied to: Include Train ID and Location Information
- Action: The system includes train and location information in the notification
Logic Flow:
IF Merlin warning notification is being created
AND The system includes train and location information in the notification
THEN:
- • Train ID and location information are included in the warning notification for complete operational context
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when warning notification includes train id and location information.
Trigger Criteria:
- Context: Warning notification includes train ID and location information
- Applied to: Set Re-arrival Process Flag
- Action: The system sets re-arrival process flag for the train
Logic Flow:
IF Warning notification includes train ID and location information
AND The system sets re-arrival process flag for the train
THEN:
- • Re-arrival process flag is set to ensure proper handling when train actually arrives
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when warning notification is complete with train details and re-arrival flag is set.
Trigger Criteria:
- Context: Warning notification is complete with train details and re-arrival flag is set
- Applied to: Send Warning to Operations Team
- Action: The system sends the warning to operations team
Logic Flow:
IF Warning notification is complete with train details and re-arrival flag is set
AND The system sends the warning to operations team
THEN:
- • Warning notification is successfully delivered to operations team for immediate attention
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when warning has been sent to operations team.
Trigger Criteria:
- Context: Warning has been sent to operations team
- Applied to: Update Train Status for Re-processing
- Action: The system updates train status for re-processing
Logic Flow:
IF Warning has been sent to operations team
AND The system updates train status for re-processing
THEN:
- • Train status is updated to indicate warning condition and readiness for re-processing upon actual arrival
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train has already arrived or train status has been updated for re-processing after warning.
Trigger Criteria:
- Context: Train has already arrived OR train status has been updated for re-processing after warning
- Applied to: End OCA Processing
- Action: The system completes OCA processing
Logic Flow:
IF Train has already arrived OR train status has been updated for re-processing after warning
AND The system completes OCA processing
THEN:
- • OCA disposition code processing is completed and system is ready for next transaction
R-GCX016E-cbl-00554 (+13) File: GCX016E.cbl Business Rule: Train Arrival Cancellation Warning
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when message segment contains a disposition code.
Trigger Criteria:
- Context: A message segment contains a disposition code
- Applied to: Receive COC Disposition Code
- Action: The disposition code is 'COC'
Logic Flow:
IF A message segment contains a disposition code
AND The disposition code is 'COC'
THEN:
- • The system initiates train arrival cancellation processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when m10 segment contains vessel/train information.
Trigger Criteria:
- Context: An M10 segment contains vessel/train information
- Applied to: Validate Train ID from M10 Segment
- Action: Processing a COC disposition code
Logic Flow:
IF An M10 segment contains vessel/train information
AND Processing a COC disposition code
THEN:
- • The system extracts the train ID from the M10 segment for validation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train id has been extracted from the m10 segment.
Trigger Criteria:
- Context: A train ID has been extracted from the M10 segment
- Applied to: Train Found in System?
- Action: The system searches for the train in the train list
Logic Flow:
IF A train ID has been extracted from the M10 segment
AND The system searches for the train in the train list
THEN:
- • The system determines if the train exists or not found
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train id has been extracted from the m10 segment.
Trigger Criteria:
- Context: A train ID has been extracted from the M10 segment
- Applied to: Generate Train Not Found Error
- Action: The train is not found in the train list
Logic Flow:
IF A train ID has been extracted from the M10 segment
AND The train is not found in the train list
THEN:
- • The system generates a train not found error message
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid train has been found in the system.
Trigger Criteria:
- Context: A valid train has been found in the system
- Applied to: Log Train Arrival Cancellation Action
- Action: Processing a COC disposition code for train arrival cancellation
Logic Flow:
IF A valid train has been found in the system
AND Processing a COC disposition code for train arrival cancellation
THEN:
- • The system logs the cancellation action with train details and timestamp
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train arrival cancellation has been logged.
Trigger Criteria:
- Context: A train arrival cancellation has been logged
- Applied to: Update Train Status to Cancel Arrival
- Action: The train status needs to be updated
Logic Flow:
IF A train arrival cancellation has been logged
AND The train status needs to be updated
THEN:
- • The system sets the train status to cancel arrival state
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train has an existing arrival date.
Trigger Criteria:
- Context: A train has an existing arrival date
- Applied to: Clear Train Arrival Date
- Action: The train arrival is being cancelled
Logic Flow:
IF A train has an existing arrival date
AND The train arrival is being cancelled
THEN:
- • The system clears the train arrival date field
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train has arrival flags set.
Trigger Criteria:
- Context: A train has arrival flags set
- Applied to: Reset Train Arrival Flags
- Action: The train arrival is being cancelled
Logic Flow:
IF A train has arrival flags set
AND The train arrival is being cancelled
THEN:
- • The system resets all train arrival flags to their initial state
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train arrival has been successfully cancelled.
Trigger Criteria:
- Context: A train arrival has been successfully cancelled
- Applied to: Generate CBP Cancellation Warning Message
- Action: CBP notification is required
Logic Flow:
IF A train arrival has been successfully cancelled
AND CBP notification is required
THEN:
- • The system generates a CBP cancellation warning message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cbp cancellation warning message needs to be created.
Trigger Criteria:
- Context: A CBP cancellation warning message needs to be created
- Applied to: Format Warning with Train Details
- Action: Formatting the message content
Logic Flow:
IF A CBP cancellation warning message needs to be created
AND Formatting the message content
THEN:
- • The system includes train ID, cancellation timestamp, and relevant train details in the message
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when k1 segment contains cancellation reason comments.
Trigger Criteria:
- Context: A K1 segment contains cancellation reason comments
- Applied to: Include Cancellation Reason from K1 Segment
- Action: Formatting the CBP warning message
Logic Flow:
IF A K1 segment contains cancellation reason comments
AND Formatting the CBP warning message
THEN:
- • The system includes the cancellation reason from the K1 segment in the warning message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when formatted cbp cancellation warning message is ready.
Trigger Criteria:
- Context: A formatted CBP cancellation warning message is ready
- Applied to: Send Warning to Merlin Message System
- Action: The message needs to be transmitted
Logic Flow:
IF A formatted CBP cancellation warning message is ready
AND The message needs to be transmitted
THEN:
- • The system sends the warning message to the Merlin message system
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train arrival cancellation has been processed and message sent.
Trigger Criteria:
- Context: A train arrival cancellation has been processed and message sent
- Applied to: Log Cancellation Event for Audit Trail
- Action: Creating audit trail records
Logic Flow:
IF A train arrival cancellation has been processed and message sent
AND Creating audit trail records
THEN:
- • The system logs the complete cancellation event with all relevant details for audit purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train not found error has been generated.
Trigger Criteria:
- Context: A train not found error has been generated
- Applied to: Send Error Message to Operations
- Action: Operations notification is required
Logic Flow:
IF A train not found error has been generated
AND Operations notification is required
THEN:
- • The system sends the error message to operations personnel for resolution
R-GCX016E-cbl-00568 (+9) File: GCX016E.cbl Business Rule: Cargo Search by Car ID
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when raw car identification needs to be processed for cargo search.
Trigger Criteria:
- Context: A raw car identification needs to be processed for cargo search
- Applied to: Format Car ID using Standard Rules
- Action: The system applies standard car ID formatting rules
Logic Flow:
IF A raw car identification needs to be processed for cargo search
AND The system applies standard car ID formatting rules
THEN:
- • The car ID is formatted according to business standards for consistent cargo matching
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when formatted car id and partial ccn are available for cargo search.
Trigger Criteria:
- Context: A formatted car ID and partial CCN are available for cargo search
- Applied to: Search with Partial CCN and Car ID
- Action: The system searches the US cargo root segments using both partial CCN and car ID as search criteria
Logic Flow:
IF A formatted car ID and partial CCN are available for cargo search
AND The system searches the US cargo root segments using both partial CCN and car ID as search criteria
THEN:
- • The system returns cargo records that match both the partial CCN and car ID combination
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when search has been performed using partial ccn and car id.
Trigger Criteria:
- Context: A search has been performed using partial CCN and car ID
- Applied to: Cargo Found with Partial CCN?
- Action: The system evaluates the search results
Logic Flow:
IF A search has been performed using partial CCN and car ID
AND The system evaluates the search results
THEN:
- • If cargo records are found, proceed to return found cargo; if no records found, initiate secondary search phase
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when primary search with partial ccn and car id found no matching cargo records.
Trigger Criteria:
- Context: Primary search with partial CCN and car ID found no matching cargo records
- Applied to: Search with Car ID Only
- Action: The system searches the US cargo root segments using only car ID as search criteria
Logic Flow:
IF Primary search with partial CCN and car ID found no matching cargo records
AND The system searches the US cargo root segments using only car ID as search criteria
THEN:
- • The system returns all cargo records that match the car ID regardless of CCN
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when secondary search has been performed using only car id.
Trigger Criteria:
- Context: A secondary search has been performed using only car ID
- Applied to: Cargo Found with Car ID Only?
- Action: The system evaluates the search results
Logic Flow:
IF A secondary search has been performed using only car ID
AND The system evaluates the search results
THEN:
- • If cargo records are found, proceed to handle SCAC scenarios; if no records found, handle cargo not found scenario
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo records were found using car id only search and scac information may be unknown.
Trigger Criteria:
- Context: Cargo records were found using car ID only search and SCAC information may be unknown
- Applied to: Handle SCAC Unknown Scenarios
- Action: The system processes the found cargo records
Logic Flow:
IF Cargo records were found using car ID only search and SCAC information may be unknown
AND The system processes the found cargo records
THEN:
- • The system handles SCAC unknown scenarios and prepares cargo for CCN key renumbering
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo records require ccn key renumbering due to scac unknown scenarios.
Trigger Criteria:
- Context: Cargo records require CCN key renumbering due to SCAC unknown scenarios
- Applied to: Perform US-CCN Key Renumbering
- Action: The system performs US-CCN key renumbering process
Logic Flow:
IF Cargo records require CCN key renumbering due to SCAC unknown scenarios
AND The system performs US-CCN key renumbering process
THEN:
- • The cargo records are updated with proper CCN keys for accurate cargo tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo records have been successfully found and processed through either primary or secondary search.
Trigger Criteria:
- Context: Cargo records have been successfully found and processed through either primary or secondary search
- Applied to: Return Found Cargo Record
- Action: The system completes cargo record processing
Logic Flow:
IF Cargo records have been successfully found and processed through either primary or secondary search
AND The system completes cargo record processing
THEN:
- • The found cargo record is returned to the requesting process for further business operations
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when both primary and secondary cargo searches have failed to locate any matching cargo records.
Trigger Criteria:
- Context: Both primary and secondary cargo searches have failed to locate any matching cargo records
- Applied to: Handle Cargo Not Found Scenario
- Action: The system processes the cargo not found scenario
Logic Flow:
IF Both primary and secondary cargo searches have failed to locate any matching cargo records
AND The system processes the cargo not found scenario
THEN:
- • The system initiates appropriate error handling procedures for missing cargo situations
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo search has failed and the cargo may be related to cprs operations.
Trigger Criteria:
- Context: Cargo search has failed and the cargo may be related to CPRS operations
- Applied to: Generate CPRS Error Message if Applicable
- Action: The system determines CPRS error message generation is applicable
Logic Flow:
IF Cargo search has failed and the cargo may be related to CPRS operations
AND The system determines CPRS error message generation is applicable
THEN:
- • A CPRS-specific error message is generated to inform users of the cargo search failure
R-GCX016E-cbl-00578 (+11) File: GCX016E.cbl Business Rule: S09 Status Segment Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo processing request is initiated.
Trigger Criteria:
- Context: A cargo processing request is initiated
- Applied to: Cargo Record Found?
- Action: The system checks for the existence of the cargo record
Logic Flow:
IF A cargo processing request is initiated
AND The system checks for the existence of the cargo record
THEN:
- • If cargo record exists, proceed to fetch status segments; if not, initialize empty status arrays
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid cargo record exists.
Trigger Criteria:
- Context: A valid cargo record exists
- Applied to: Fetch S09 Status Segments from Database
- Action: The system fetches S09 status segments from the database
Logic Flow:
IF A valid cargo record exists
AND The system fetches S09 status segments from the database
THEN:
- • All status segments associated with the cargo are retrieved for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status segment fetch operation has completed.
Trigger Criteria:
- Context: Status segment fetch operation has completed
- Applied to: Status Segments Exist?
- Action: The system checks if any status segments were found
Logic Flow:
IF Status segment fetch operation has completed
AND The system checks if any status segments were found
THEN:
- • If segments exist, populate status arrays from database; if not, initialize empty arrays
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when no status segments exist for the cargo or cargo record not found.
Trigger Criteria:
- Context: No status segments exist for the cargo OR cargo record not found
- Applied to: Initialize Empty Status Arrays
- Action: The system initializes status processing
Logic Flow:
IF No status segments exist for the cargo OR cargo record not found
AND The system initializes status processing
THEN:
- • Empty status arrays are created to prepare for new status information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status segments exist in the database for the cargo.
Trigger Criteria:
- Context: Status segments exist in the database for the cargo
- Applied to: Populate Status Arrays from Database Segments
- Action: The system populates status arrays
Logic Flow:
IF Status segments exist in the database for the cargo
AND The system populates status arrays
THEN:
- • All existing status information is loaded into memory arrays for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when status arrays are populated from database segments.
Trigger Criteria:
- Context: Status arrays are populated from database segments
- Applied to: Track Maximum Sequence Numbers
- Action: The system processes sequence numbers
Logic Flow:
IF Status arrays are populated from database segments
AND The system processes sequence numbers
THEN:
- • The maximum sequence number is tracked for future segment creation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status arrays are initialized (either empty or populated from database).
Trigger Criteria:
- Context: Status arrays are initialized (either empty or populated from database)
- Applied to: Process Status Array Updates
- Action: The system processes status updates from disposition codes or events
Logic Flow:
IF Status arrays are initialized (either empty or populated from database)
AND The system processes status updates from disposition codes or events
THEN:
- • Status arrays are modified according to business rules for holds, releases, and other status changes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when status array updates have been processed.
Trigger Criteria:
- Context: Status array updates have been processed
- Applied to: Status Array Modified?
- Action: The system checks for modifications
Logic Flow:
IF Status array updates have been processed
AND The system checks for modifications
THEN:
- • If arrays were modified, convert to database format and update; if not, end processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when status arrays have been modified during processing.
Trigger Criteria:
- Context: Status arrays have been modified during processing
- Applied to: Convert Status Arrays to Database Format
- Action: The system converts arrays to database format
Logic Flow:
IF Status arrays have been modified during processing
AND The system converts arrays to database format
THEN:
- • Status information is formatted into S09 segments ready for database storage
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status arrays have been converted to database format and cargo is not cprs type.
Trigger Criteria:
- Context: Status arrays have been converted to database format AND cargo is not CPRS type
- Applied to: Update Car ID Information for Non-CPRS Cargo
- Action: The system updates car ID information
Logic Flow:
IF Status arrays have been converted to database format AND cargo is not CPRS type
AND The system updates car ID information
THEN:
- • Car identification data is updated in the cargo record based on N7 segment information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status segments have been formatted for database storage and car id has been updated.
Trigger Criteria:
- Context: Status segments have been formatted for database storage AND car ID has been updated
- Applied to: Replace Status Segments in Database
- Action: The system replaces status segments in the database
Logic Flow:
IF Status segments have been formatted for database storage AND car ID has been updated
AND The system replaces status segments in the database
THEN:
- • All modified status information is persisted to the GCSUSS09 database
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when status segments have been replaced in the database.
Trigger Criteria:
- Context: Status segments have been replaced in the database
- Applied to: Confirm Status Segment Updates
- Action: The system confirms the update operation
Logic Flow:
IF Status segments have been replaced in the database
AND The system confirms the update operation
THEN:
- • Status segment processing is confirmed as complete and successful
R-GCX016E-cbl-00590 (+6) File: GCX016E.cbl Business Rule: Disposition Code Table Lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code is received from an x4 segment.
Trigger Criteria:
- Context: A disposition code is received from an X4 segment
- Applied to: Search DC Table for Disposition Code
- Action: The system searches the DC table for the disposition code
Logic Flow:
IF A disposition code is received from an X4 segment
AND The system searches the DC table for the disposition code
THEN:
- • The system retrieves disposition code information if found or flags as invalid if not found
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code has been found in the dc table.
Trigger Criteria:
- Context: A disposition code has been found in the DC table
- Applied to: Set Valid Disposition Code Flag
- Action: The disposition code information is successfully retrieved
Logic Flow:
IF A disposition code has been found in the DC table
AND The disposition code information is successfully retrieved
THEN:
- • The system sets the valid disposition code flag to allow continued processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code is not found in the dc table.
Trigger Criteria:
- Context: A disposition code is not found in the DC table
- Applied to: Generate Merlin Error Message
- Action: The table lookup returns no matching record
Logic Flow:
IF A disposition code is not found in the DC table
AND The table lookup returns no matching record
THEN:
- • The system generates a Merlin error message and sets invalid disposition code flag
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid disposition code is found in the dc table.
Trigger Criteria:
- Context: A valid disposition code is found in the DC table
- Applied to: Validate Code Processing Rules
- Action: The system validates the code processing rules
Logic Flow:
IF A valid disposition code is found in the DC table
AND The system validates the code processing rules
THEN:
- • The system confirms the code can be processed according to established business rules
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when invalid disposition code flag has been set.
Trigger Criteria:
- Context: An invalid disposition code flag has been set
- Applied to: Log Unknown Disposition Code
- Action: The system processes the invalid code
Logic Flow:
IF An invalid disposition code flag has been set
AND The system processes the invalid code
THEN:
- • The system logs the unknown disposition code for audit and monitoring purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code has been validated and flagged as valid.
Trigger Criteria:
- Context: A disposition code has been validated and flagged as valid
- Applied to: Continue Processing with Valid Code
- Action: All processing rules have been satisfied
Logic Flow:
IF A disposition code has been validated and flagged as valid
AND All processing rules have been satisfied
THEN:
- • The system continues with normal cargo processing using the validated disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code has been flagged as invalid.
Trigger Criteria:
- Context: A disposition code has been flagged as invalid
- Applied to: Skip Processing for Invalid Code
- Action: The invalid code flag is set
Logic Flow:
IF A disposition code has been flagged as invalid
AND The invalid code flag is set
THEN:
- • The system skips further processing for that cargo to prevent errors
R-GCX016E-cbl-00597 (+6) File: GCX016E.cbl Business Rule: Duplicate Disposition Code Detection
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo status array (s09a) needs to be checked for existing disposition codes.
Trigger Criteria:
- Context: A cargo status array (S09A) needs to be checked for existing disposition codes
- Applied to: Status Array Empty?
- Action: The system accesses the status array to determine if it contains any entries
Logic Flow:
IF A cargo status array (S09A) needs to be checked for existing disposition codes
AND The system accesses the status array to determine if it contains any entries
THEN:
- • If the status array is empty, set no duplicates found flag and skip duplicate detection process
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when new disposition code and an existing status array entry.
Trigger Criteria:
- Context: A new disposition code and an existing status array entry
- Applied to: Disposition Code Match?
- Action: The system compares the disposition code values
Logic Flow:
IF A new disposition code and an existing status array entry
AND The system compares the disposition code values
THEN:
- • If the disposition codes match exactly, proceed to sequence number validation,
otherwise continue to next array entry
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when two disposition codes that match and their respective sequence numbers.
Trigger Criteria:
- Context: Two disposition codes that match and their respective sequence numbers
- Applied to: Same Sequence Number?
- Action: The system compares the sequence numbers of the matching disposition codes
Logic Flow:
IF Two disposition codes that match and their respective sequence numbers
AND The system compares the sequence numbers of the matching disposition codes
THEN:
- • If sequence numbers are identical, mark as exact duplicate found,
otherwise check date/time stamps for partial match
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when two matching disposition codes with different sequence numbers and their date/time stamps.
Trigger Criteria:
- Context: Two matching disposition codes with different sequence numbers and their date/time stamps
- Applied to: Same Date/Time?
- Action: The system compares the date and time stamp values
Logic Flow:
IF Two matching disposition codes with different sequence numbers and their date/time stamps
AND The system compares the date and time stamp values
THEN:
- • If date/time stamps are identical, mark as duplicate with different time,
otherwise continue search process
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when completed search through status array with duplicate detection flags.
Trigger Criteria:
- Context: Completed search through status array with duplicate detection flags
- Applied to: Duplicate Found?
- Action: The system evaluates whether any duplicate conditions were identified during the search
Logic Flow:
IF Completed search through status array with duplicate detection flags
AND The system evaluates whether any duplicate conditions were identified during the search
THEN:
- • If any duplicate was found (exact or temporal), set duplicate detection flag and prepare duplicate handling,
otherwise return no duplicate status
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status array with multiple entries and current search position.
Trigger Criteria:
- Context: A status array with multiple entries and current search position
- Applied to: More Array Entries?
- Action: The system checks if there are remaining entries to process in the array
Logic Flow:
IF A status array with multiple entries and current search position
AND The system checks if there are remaining entries to process in the array
THEN:
- • If more entries exist, get next status entry for comparison,
otherwise proceed to duplicate evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when confirmed duplicate disposition code with its details.
Trigger Criteria:
- Context: A confirmed duplicate disposition code with its details
- Applied to: Log Duplicate Information
- Action: The system needs to record the duplicate detection event
Logic Flow:
IF A confirmed duplicate disposition code with its details
AND The system needs to record the duplicate detection event
THEN:
- • Log the duplicate disposition code information including sequence numbers, date/time stamps, and duplicate type for audit trail
R-GCX016E-cbl-00604 (+7) File: GCX016E.cbl Business Rule: Counterpart Disposition Code Removal
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has existing hold disposition codes in its status array and a new release disposition code is being processed.
Trigger Criteria:
- Context: A cargo has existing hold disposition codes in its status array AND a new release disposition code is being processed
- Applied to: Remove Hold Codes when Release Code Added
- Action: The system processes the release disposition code AND identifies conflicting hold codes in the status array
Logic Flow:
IF A cargo has existing hold disposition codes in its status array AND a new release disposition code is being processed
AND The system processes the release disposition code AND identifies conflicting hold codes in the status array
THEN:
- • The system removes all conflicting hold disposition codes from the status array AND maintains the release code as the active status
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has existing release disposition codes in its status array and a new hold disposition code is being processed.
Trigger Criteria:
- Context: A cargo has existing release disposition codes in its status array AND a new hold disposition code is being processed
- Applied to: Remove Release Codes when Hold Code Added
- Action: The system processes the hold disposition code AND identifies conflicting release codes in the status array
Logic Flow:
IF A cargo has existing release disposition codes in its status array AND a new hold disposition code is being processed
AND The system processes the hold disposition code AND identifies conflicting release codes in the status array
THEN:
- • The system removes all conflicting release disposition codes from the status array AND maintains the hold code as the active status
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo has existing status information codes in its status array and new status information codes are being processed.
Trigger Criteria:
- Context: A cargo has existing status information codes in its status array AND new status information codes are being processed
- Applied to: Remove Superseded Status Information Codes
- Action: The system identifies that existing status information codes are superseded by the new codes
Logic Flow:
IF A cargo has existing status information codes in its status array AND new status information codes are being processed
AND The system identifies that existing status information codes are superseded by the new codes
THEN:
- • The system removes the outdated status information codes from the status array AND retains only the current status information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo has disposition codes in its status array and some codes have been marked as cancelled or superseded.
Trigger Criteria:
- Context: A cargo has disposition codes in its status array AND some codes have been marked as cancelled or superseded
- Applied to: Remove Cancelled Disposition Codes
- Action: The system processes disposition code updates AND identifies cancelled or superseded codes
Logic Flow:
IF A cargo has disposition codes in its status array AND some codes have been marked as cancelled or superseded
AND The system processes disposition code updates AND identifies cancelled or superseded codes
THEN:
- • The system removes all cancelled and superseded disposition codes from the status array AND maintains only active disposition codes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition codes have been removed from the cargo status array.
Trigger Criteria:
- Context: Disposition codes have been removed from the cargo status array
- Applied to: Update Status Array Sequence Numbers
- Action: The removal process is complete AND gaps exist in the sequence numbering
Logic Flow:
IF Disposition codes have been removed from the cargo status array
AND The removal process is complete AND gaps exist in the sequence numbering
THEN:
- • The system renumbers all remaining disposition codes in sequential order AND maintains proper array indexing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition codes have been removed from the status array and gaps exist in the array structure.
Trigger Criteria:
- Context: Disposition codes have been removed from the status array AND gaps exist in the array structure
- Applied to: Reorganize Status Array Structure
- Action: The code removal process is complete
Logic Flow:
IF Disposition codes have been removed from the status array AND gaps exist in the array structure
AND The code removal process is complete
THEN:
- • The system compacts the status array by moving remaining codes to fill gaps AND maintains proper array structure without empty slots
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when counterpart disposition codes are being removed from a cargo status array.
Trigger Criteria:
- Context: Counterpart disposition codes are being removed from a cargo status array
- Applied to: Log Counterpart Code Removal Action
- Action: The removal action is executed
Logic Flow:
IF Counterpart disposition codes are being removed from a cargo status array
AND The removal action is executed
THEN:
- • The system logs the removal action with details of which codes were removed AND the reason for removal AND the timestamp of the action
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when counterpart disposition codes have been removed from the status array.
Trigger Criteria:
- Context: Counterpart disposition codes have been removed from the status array
- Applied to: Validate Status Array Integrity
- Action: The removal and reorganization process is complete
Logic Flow:
IF Counterpart disposition codes have been removed from the status array
AND The removal and reorganization process is complete
THEN:
- • The system validates that no conflicting codes remain AND all sequence numbers are properly ordered AND the array structure is consistent
R-GCX016E-cbl-00612 (+13) File: GCX016E.cbl Business Rule: Manual Release Request Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when manual release request is received with a disposition code.
Trigger Criteria:
- Context: A manual release request is received with a disposition code
- Applied to: Validate Disposition Code in DC Table
- Action: The system looks up the disposition code in the DC table
Logic Flow:
IF A manual release request is received with a disposition code
AND The system looks up the disposition code in the DC table
THEN:
- • The system confirms the code exists and is valid for manual release processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code has been validated in the dc table.
Trigger Criteria:
- Context: A disposition code has been validated in the DC table
- Applied to: Valid Manual Release Code?
- Action: The system checks if the code type allows manual release operations
Logic Flow:
IF A disposition code has been validated in the DC table
AND The system checks if the code type allows manual release operations
THEN:
- • Processing continues if authorized,
otherwise an error is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid manual release code is being processed.
Trigger Criteria:
- Context: A valid manual release code is being processed
- Applied to: Duplicate Code Found?
- Action: The system searches existing status arrays for the same disposition code
Logic Flow:
IF A valid manual release code is being processed
AND The system searches existing status arrays for the same disposition code
THEN:
- • Processing is skipped if duplicate found,
otherwise continues with adding the code
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when manual release code is being added to cargo status.
Trigger Criteria:
- Context: A manual release code is being added to cargo status
- Applied to: Remove Counterpart Hold Codes
- Action: The system identifies existing hold codes that conflict with the release
Logic Flow:
IF A manual release code is being added to cargo status
AND The system identifies existing hold codes that conflict with the release
THEN:
- • All counterpart hold codes are removed from the status array before adding the release code
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when counterpart hold codes have been removed and no duplicates exist.
Trigger Criteria:
- Context: Counterpart hold codes have been removed and no duplicates exist
- Applied to: Add Manual Release Code to Status Array
- Action: The system processes the manual release code
Logic Flow:
IF Counterpart hold codes have been removed and no duplicates exist
AND The system processes the manual release code
THEN:
- • The manual release code is added to the cargo's status array with appropriate sequence number
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when manual release code has been added to the status array.
Trigger Criteria:
- Context: A manual release code has been added to the status array
- Applied to: Update Release Quantities
- Action: The system processes quantity information from the release request
Logic Flow:
IF A manual release code has been added to the status array
AND The system processes quantity information from the release request
THEN:
- • The cargo's released quantity is updated to reflect the manual release amount
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when release quantities have been updated for manual release.
Trigger Criteria:
- Context: Release quantities have been updated for manual release
- Applied to: Log Manual Release Action
- Action: The system completes the manual release processing
Logic Flow:
IF Release quantities have been updated for manual release
AND The system completes the manual release processing
THEN:
- • An audit record is created documenting the manual release action with timestamp and user information
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when manual release has been logged and quantities updated.
Trigger Criteria:
- Context: Manual release has been logged and quantities updated
- Applied to: Evaluate Final Cargo Status
- Action: The system evaluates all disposition codes in the status array
Logic Flow:
IF Manual release has been logged and quantities updated
AND The system evaluates all disposition codes in the status array
THEN:
- • The final cargo status is determined based on the hierarchy of all active disposition codes
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when final cargo status has been evaluated.
Trigger Criteria:
- Context: Final cargo status has been evaluated
- Applied to: Cargo Fully Released?
- Action: The system compares released quantities against total cargo quantities
Logic Flow:
IF Final cargo status has been evaluated
AND The system compares released quantities against total cargo quantities
THEN:
- • Cargo is marked as fully released if all quantities are released,
otherwise marked as partially released
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo has been determined to be fully released.
Trigger Criteria:
- Context: Cargo has been determined to be fully released
- Applied to: Generate Release Notification
- Action: The system processes the full release status
Logic Flow:
IF Cargo has been determined to be fully released
AND The system processes the full release status
THEN:
- • A release notification is generated for appropriate parties including brokers and freight forwarders
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when release notification has been generated or cargo is partially released.
Trigger Criteria:
- Context: Release notification has been generated or cargo is partially released
- Applied to: Update Cargo Status Flags
- Action: The system updates the cargo record
Logic Flow:
IF Release notification has been generated or cargo is partially released
AND The system updates the cargo record
THEN:
- • All relevant status flags are updated to reflect the current release state of the cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when manual release request contains an invalid disposition code.
Trigger Criteria:
- Context: A manual release request contains an invalid disposition code
- Applied to: Generate Error Message
- Action: The disposition code validation fails
Logic Flow:
IF A manual release request contains an invalid disposition code
AND The disposition code validation fails
THEN:
- • An error message is generated indicating the invalid code and processing is terminated
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when manual release code already exists in the cargo's status array.
Trigger Criteria:
- Context: A manual release code already exists in the cargo's status array
- Applied to: Skip Processing
- Action: The system detects the duplicate during processing
Logic Flow:
IF A manual release code already exists in the cargo's status array
AND The system detects the duplicate during processing
THEN:
- • Processing is skipped for this code and continues with next item without error
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo status flags have been updated or error/skip condition occurred.
Trigger Criteria:
- Context: Cargo status flags have been updated or error/skip condition occurred
- Applied to: Send Merlin Notification
- Action: The system completes manual release processing
Logic Flow:
IF Cargo status flags have been updated or error/skip condition occurred
AND The system completes manual release processing
THEN:
- • Appropriate notifications are sent through Merlin system to relevant parties based on the processing outcome
R-GCX016E-cbl-00626 (+13) File: GCX016E.cbl Business Rule: Disposition Code Removal Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code removal request is received.
Trigger Criteria:
- Context: A disposition code removal request is received
- Applied to: Validate Removal Request Parameters
- Action: The system validates the removal request parameters
Logic Flow:
IF A disposition code removal request is received
AND The system validates the removal request parameters
THEN:
- • The request must contain valid disposition code, entry number, and quantity information to proceed with removal processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when validated disposition code removal request and cargo status array.
Trigger Criteria:
- Context: A validated disposition code removal request and cargo status array
- Applied to: Disposition Code Exists in Status Array?
- Action: The system searches for the target disposition code in the status array
Logic Flow:
IF A validated disposition code removal request and cargo status array
AND The system searches for the target disposition code in the status array
THEN:
- • If the disposition code exists in the array, proceed with removal process,
otherwise generate error message for code not found
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code that exists in the cargo status array.
Trigger Criteria:
- Context: A disposition code that exists in the cargo status array
- Applied to: Locate Disposition Code Position
- Action: The system searches through the status array entries
Logic Flow:
IF A disposition code that exists in the cargo status array
AND The system searches through the status array entries
THEN:
- • The system must locate the exact array position and sequence number of the target disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when located disposition code in the status array and current cargo status.
Trigger Criteria:
- Context: A located disposition code in the status array and current cargo status
- Applied to: Removal Allowed?
- Action: The system evaluates removal authorization rules
Logic Flow:
IF A located disposition code in the status array and current cargo status
AND The system evaluates removal authorization rules
THEN:
- • If the code can be removed without violating business constraints, authorize removal,
otherwise deny and generate error
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when authorized disposition code removal request with located array position.
Trigger Criteria:
- Context: An authorized disposition code removal request with located array position
- Applied to: Remove Code from Status Array
- Action: The system executes the removal operation
Logic Flow:
IF An authorized disposition code removal request with located array position
AND The system executes the removal operation
THEN:
- • The disposition code must be completely removed from the status array while preserving array integrity
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status array with a removed disposition code creating a gap in sequence.
Trigger Criteria:
- Context: A status array with a removed disposition code creating a gap in sequence
- Applied to: Reorganize Status Array Sequence
- Action: The system reorganizes the array structure
Logic Flow:
IF A status array with a removed disposition code creating a gap in sequence
AND The system reorganizes the array structure
THEN:
- • All remaining disposition codes must be resequenced to eliminate gaps and maintain proper chronological order
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when reorganized status array with one less disposition code.
Trigger Criteria:
- Context: A reorganized status array with one less disposition code
- Applied to: Update Array Counter
- Action: The system updates array management counters
Logic Flow:
IF A reorganized status array with one less disposition code
AND The system updates array management counters
THEN:
- • The status array counter must be decremented by one to accurately reflect the current number of active disposition codes
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when successfully removed disposition code from cargo status array.
Trigger Criteria:
- Context: A successfully removed disposition code from cargo status array
- Applied to: Log Removal Action
- Action: The system logs the removal action
Logic Flow:
IF A successfully removed disposition code from cargo status array
AND The system logs the removal action
THEN:
- • An audit entry must be created containing cargo identifier, removed disposition code, removal timestamp, and user information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when successfully completed disposition code removal with updated status array.
Trigger Criteria:
- Context: A successfully completed disposition code removal with updated status array
- Applied to: Generate Removal Confirmation
- Action: The system generates removal confirmation
Logic Flow:
IF A successfully completed disposition code removal with updated status array
AND The system generates removal confirmation
THEN:
- • A confirmation message must be created containing cargo details, removed disposition code, and updated status information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo with updated status array after disposition code removal.
Trigger Criteria:
- Context: A cargo with updated status array after disposition code removal
- Applied to: Update Cargo Status
- Action: The system updates the cargo record
Logic Flow:
IF A cargo with updated status array after disposition code removal
AND The system updates the cargo record
THEN:
- • The cargo record must be updated with the new status array and any derived status changes resulting from the removal
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record with updated status array after disposition code removal.
Trigger Criteria:
- Context: A cargo record with updated status array after disposition code removal
- Applied to: Trigger Status Re-evaluation
- Action: The system triggers status re-evaluation process
Logic Flow:
IF A cargo record with updated status array after disposition code removal
AND The system triggers status re-evaluation process
THEN:
- • The cargo's overall status must be recalculated based on remaining disposition codes using standard status determination rules
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo with updated status after disposition code removal and re-evaluation.
Trigger Criteria:
- Context: A cargo with updated status after disposition code removal and re-evaluation
- Applied to: Send Status Change Notification
- Action: The system sends status change notifications
Logic Flow:
IF A cargo with updated status after disposition code removal and re-evaluation
AND The system sends status change notifications
THEN:
- • Notifications must be sent to brokers, freight forwarders, and other stakeholders based on cargo notification rules and new status
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code removal request that cannot be processed due to validation failure or authorization denial.
Trigger Criteria:
- Context: A disposition code removal request that cannot be processed due to validation failure or authorization denial
- Applied to: Generate Error Message
- Action: The system generates an error message
Logic Flow:
IF A disposition code removal request that cannot be processed due to validation failure or authorization denial
AND The system generates an error message
THEN:
- • An error message must be created explaining why the removal failed and what corrective action is needed
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when failed disposition code removal request with generated error message.
Trigger Criteria:
- Context: A failed disposition code removal request with generated error message
- Applied to: Log Removal Failure
- Action: The system logs the removal failure
Logic Flow:
IF A failed disposition code removal request with generated error message
AND The system logs the removal failure
THEN:
- • A failure audit entry must be created containing cargo identifier, attempted disposition code, failure reason, and timestamp
R-GCX016E-cbl-00640 (+7) File: GCX016E.cbl Business Rule: Status Information Code Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status information disposition code is received for processing and the cargo has existing s09a status array segments.
Trigger Criteria:
- Context: A status information disposition code is received for processing AND the cargo has existing S09A status array segments
- Applied to: Search Existing S09A Status Arrays
- Action: The system searches through all existing status array entries for the same disposition code
Logic Flow:
IF A status information disposition code is received for processing AND the cargo has existing S09A status array segments
AND The system searches through all existing status array entries for the same disposition code
THEN:
- • The system identifies whether the status information code already exists in the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status information disposition code is being processed and the same disposition code already exists in the cargo's status array.
Trigger Criteria:
- Context: A status information disposition code is being processed AND the same disposition code already exists in the cargo's status array
- Applied to: Skip Processing - Code Already Exists
- Action: The system detects the duplicate status information code
Logic Flow:
IF A status information disposition code is being processed AND the same disposition code already exists in the cargo's status array
AND The system detects the duplicate status information code
THEN:
- • The system skips adding the disposition code AND continues to the next disposition code for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when new status information disposition code needs to be added to the cargo's status array and the status array has a maximum capacity limit.
Trigger Criteria:
- Context: A new status information disposition code needs to be added to the cargo's status array AND the status array has a maximum capacity limit
- Applied to: Validate Available Space in Status Array
- Action: The system checks the current number of entries against the maximum allowed entries
Logic Flow:
IF A new status information disposition code needs to be added to the cargo's status array AND the status array has a maximum capacity limit
AND The system checks the current number of entries against the maximum allowed entries
THEN:
- • The system determines whether there is available space for the new status information code
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status information disposition code needs to be added and the cargo's status array has reached maximum capacity.
Trigger Criteria:
- Context: A status information disposition code needs to be added AND the cargo's status array has reached maximum capacity
- Applied to: Generate Array Full Warning
- Action: The system attempts to insert the new status information code
Logic Flow:
IF A status information disposition code needs to be added AND the cargo's status array has reached maximum capacity
AND The system attempts to insert the new status information code
THEN:
- • The system generates an array full warning AND continues processing the next disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status information disposition code is not found in the existing status array and there is available space in the status array.
Trigger Criteria:
- Context: A status information disposition code is not found in the existing status array AND there is available space in the status array
- Applied to: Insert New Status Information Code
- Action: The system processes the status information disposition code
Logic Flow:
IF A status information disposition code is not found in the existing status array AND there is available space in the status array
AND The system processes the status information disposition code
THEN:
- • The system inserts the new status information code into the next available position in the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when new status information disposition code has been successfully inserted into the status array.
Trigger Criteria:
- Context: A new status information disposition code has been successfully inserted into the status array
- Applied to: Update Status Array Sequence Counter
- Action: The insertion is completed
Logic Flow:
IF A new status information disposition code has been successfully inserted into the status array
AND The insertion is completed
THEN:
- • The system increments the status array sequence counter to reflect the new entry count
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status information disposition code has been successfully added to the cargo's status array.
Trigger Criteria:
- Context: A status information disposition code has been successfully added to the cargo's status array
- Applied to: Set Status Information Flag
- Action: The status information code insertion is completed
Logic Flow:
IF A status information disposition code has been successfully added to the cargo's status array
AND The status information code insertion is completed
THEN:
- • The system sets the status information flag to indicate the presence of status information codes
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status information disposition code has been successfully added to the cargo's status array and the status information flag has been set.
Trigger Criteria:
- Context: A status information disposition code has been successfully added to the cargo's status array AND the status information flag has been set
- Applied to: Log Status Information Code Addition
- Action: The status information processing is completed
Logic Flow:
IF A status information disposition code has been successfully added to the cargo's status array AND the status information flag has been set
AND The status information processing is completed
THEN:
- • The system logs the status information code addition for audit trail purposes
R-GCX016E-cbl-00648 (+19) File: GCX016E.cbl Business Rule: Hold and Release Code Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code is received for cargo processing.
Trigger Criteria:
- Context: A disposition code is received for cargo processing
- Applied to: Disposition Code Type?
- Action: The system evaluates the disposition code type
Logic Flow:
IF A disposition code is received for cargo processing
AND The system evaluates the disposition code type
THEN:
- • The code is classified as either a hold code or release code based on the disposition code table definition
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when hold or release disposition code needs to be added to cargo status array.
Trigger Criteria:
- Context: A hold or release disposition code needs to be added to cargo status array
- Applied to: Code Already Exists?
- Action: The system searches the existing status array for the same disposition code with matching entry number and quantity
Logic Flow:
IF A hold or release disposition code needs to be added to cargo status array
AND The system searches the existing status array for the same disposition code with matching entry number and quantity
THEN:
- • If an exact match is found, the duplicate processing is skipped,
otherwise the code is processed
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when hold disposition code is validated and not a duplicate.
Trigger Criteria:
- Context: A hold disposition code is validated and not a duplicate
- Applied to: Add Hold Code to Status Array
- Action: The system processes the hold code addition
Logic Flow:
IF A hold disposition code is validated and not a duplicate
AND The system processes the hold code addition
THEN:
- • The hold code is added to the status array with sequence number, entry number, quantity, location, and date/time information
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when release disposition code is validated and not a duplicate.
Trigger Criteria:
- Context: A release disposition code is validated and not a duplicate
- Applied to: Add Release Code to Status Array
- Action: The system processes the release code addition
Logic Flow:
IF A release disposition code is validated and not a duplicate
AND The system processes the release code addition
THEN:
- • The release code is added to the status array with sequence number, entry number, release quantity, location, and date/time information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when new hold or release code is being added to the status array.
Trigger Criteria:
- Context: A new hold or release code is being added to the status array
- Applied to: Remove Counterpart Codes
- Action: The system identifies counterpart codes that conflict with the new code
Logic Flow:
IF A new hold or release code is being added to the status array
AND The system identifies counterpart codes that conflict with the new code
THEN:
- • All conflicting counterpart codes are removed from the status array before adding the new code
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when hold disposition code has been successfully added to the status array.
Trigger Criteria:
- Context: A hold disposition code has been successfully added to the status array
- Applied to: Set Cargo Hold Status
- Action: The system processes hold code implications
Logic Flow:
IF A hold disposition code has been successfully added to the status array
AND The system processes hold code implications
THEN:
- • The cargo hold status is set with appropriate hold type (border hold, destination hold, FDA hold) based on the disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo hold status has been set for a disposition code.
Trigger Criteria:
- Context: Cargo hold status has been set for a disposition code
- Applied to: Update Hold Flags
- Action: The system updates hold-related information
Logic Flow:
IF Cargo hold status has been set for a disposition code
AND The system updates hold-related information
THEN:
- • Hold flags are updated including held at border flag, held at destination flag, held for FDA flag, and hold location information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when release disposition code is being processed.
Trigger Criteria:
- Context: A release disposition code is being processed
- Applied to: Calculate Release Quantities
- Action: The system calculates release quantities
Logic Flow:
IF A release disposition code is being processed
AND The system calculates release quantities
THEN:
- • Release quantities are calculated based on the disposition code quantity, existing released quantities, and total cargo quantities with validation that release does not exceed available quantities
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when release disposition code is being processed.
Trigger Criteria:
- Context: A release disposition code is being processed
- Applied to: Remove Conflicting Hold Codes
- Action: The system identifies conflicting hold codes in the status array
Logic Flow:
IF A release disposition code is being processed
AND The system identifies conflicting hold codes in the status array
THEN:
- • All hold codes that conflict with the release are removed from the status array before processing the release
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when release disposition code has been processed and quantities calculated.
Trigger Criteria:
- Context: A release disposition code has been processed and quantities calculated
- Applied to: Set Cargo Release Status
- Action: The system sets cargo release status
Logic Flow:
IF A release disposition code has been processed and quantities calculated
AND The system sets cargo release status
THEN:
- • The cargo release status is updated with release type, release quantities, and release location based on the disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo release status has been set for a disposition code.
Trigger Criteria:
- Context: Cargo release status has been set for a disposition code
- Applied to: Update Release Flags
- Action: The system updates release-related information
Logic Flow:
IF Cargo release status has been set for a disposition code
AND The system updates release-related information
THEN:
- • Release flags are updated including released flag, PTT flag, PTT exam flag, and release quantity information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when release disposition code is being evaluated.
Trigger Criteria:
- Context: A release disposition code is being evaluated
- Applied to: Manual Release?
- Action: The system checks if the code represents a manual release
Logic Flow:
IF A release disposition code is being evaluated
AND The system checks if the code represents a manual release
THEN:
- • The code is identified as manual release if it originates from transaction GCT1071E or has manual release indicators
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when manual release disposition code is identified.
Trigger Criteria:
- Context: A manual release disposition code is identified
- Applied to: Process Manual Release Request
- Action: The system processes the manual release request
Logic Flow:
IF A manual release disposition code is identified
AND The system processes the manual release request
THEN:
- • The manual release is processed with special validation, broker verification, and immediate release status setting
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when manual release request has been processed.
Trigger Criteria:
- Context: A manual release request has been processed
- Applied to: Log Manual Release Action
- Action: The system logs the manual release action
Logic Flow:
IF A manual release request has been processed
AND The system logs the manual release action
THEN:
- • The manual release action is logged with user information, timestamp, release details, and audit trail information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when release disposition code is being evaluated and is not a manual release.
Trigger Criteria:
- Context: A release disposition code is being evaluated and is not a manual release
- Applied to: Auto Release?
- Action: The system checks if the code represents an automatic release
Logic Flow:
IF A release disposition code is being evaluated and is not a manual release
AND The system checks if the code represents an automatic release
THEN:
- • The code is identified as automatic release if it has ARL (Auto Release) indicators or meets automatic release criteria
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when automatic release disposition code is identified.
Trigger Criteria:
- Context: An automatic release disposition code is identified
- Applied to: Process Automatic Release
- Action: The system processes the automatic release
Logic Flow:
IF An automatic release disposition code is identified
AND The system processes the automatic release
THEN:
- • The automatic release is processed with system validation, automatic broker assignment, and immediate release status setting
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when automatic release is being processed.
Trigger Criteria:
- Context: An automatic release is being processed
- Applied to: Validate Release Conditions
- Action: The system validates release conditions
Logic Flow:
IF An automatic release is being processed
AND The system validates release conditions
THEN:
- • All release conditions are validated including cargo status, hold status, quantity availability, and regulatory compliance before allowing the release
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when hold or release codes have been added or removed from the status array.
Trigger Criteria:
- Context: Hold or release codes have been added or removed from the status array
- Applied to: Update Status Array Sequence
- Action: The system updates status array sequencing
Logic Flow:
IF Hold or release codes have been added or removed from the status array
AND The system updates status array sequencing
THEN:
- • All status array entries are renumbered with proper sequence numbers and the array count is updated
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when hold disposition code has been processed and cargo status updated.
Trigger Criteria:
- Context: A hold disposition code has been processed and cargo status updated
- Applied to: Generate Hold Notification
- Action: The system generates hold notifications
Logic Flow:
IF A hold disposition code has been processed and cargo status updated
AND The system generates hold notifications
THEN:
- • Hold notifications are sent to brokers, freight forwarders, and other relevant parties with hold details, reason, and required actions
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when release disposition code has been processed and cargo status updated.
Trigger Criteria:
- Context: A release disposition code has been processed and cargo status updated
- Applied to: Generate Release Notification
- Action: The system generates release notifications
Logic Flow:
IF A release disposition code has been processed and cargo status updated
AND The system generates release notifications
THEN:
- • Release notifications are sent to brokers, freight forwarders, and other relevant parties with release details, quantities, and pickup authorization
R-GCX016E-cbl-00668 (+16) File: GCX016E.cbl Business Rule: CPRS Bond Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record is being processed for bond assignment.
Trigger Criteria:
- Context: A cargo record is being processed for bond assignment
- Applied to: CPRS Cargo Identified?
- Action: The system checks the cargo type or carrier information
Logic Flow:
IF A cargo record is being processed for bond assignment
AND The system checks the cargo type or carrier information
THEN:
- • The cargo is identified as CPRS cargo if it meets CPRS criteria,
otherwise it is processed as regular cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cprs cargo has been identified for bond processing.
Trigger Criteria:
- Context: A CPRS cargo has been identified for bond processing
- Applied to: Retrieve CPRS Bond Information
- Action: The system accesses the US cargo root record
Logic Flow:
IF A CPRS cargo has been identified for bond processing
AND The system accesses the US cargo root record
THEN:
- • Current bond number, broker information, and bond status are retrieved from the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cprs bond information has been retrieved.
Trigger Criteria:
- Context: CPRS bond information has been retrieved
- Applied to: Validate Bond Assignment
- Action: The system validates the bond assignment against cargo entry type and requirements
Logic Flow:
IF CPRS bond information has been retrieved
AND The system validates the bond assignment against cargo entry type and requirements
THEN:
- • The bond assignment is confirmed as valid or flagged for correction
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when bond assignment validation has been completed.
Trigger Criteria:
- Context: Bond assignment validation has been completed
- Applied to: Bond Already Assigned?
- Action: The system checks if a bond number already exists for the cargo
Logic Flow:
IF Bond assignment validation has been completed
AND The system checks if a bond number already exists for the cargo
THEN:
- • If bond number exists and is valid, proceed to update existing bond,
otherwise create new bond assignment
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cprs cargo does not have an existing valid bond assignment.
Trigger Criteria:
- Context: CPRS cargo does not have an existing valid bond assignment
- Applied to: Create New Bond Assignment
- Action: The system creates a new bond assignment
Logic Flow:
IF CPRS cargo does not have an existing valid bond assignment
AND The system creates a new bond assignment
THEN:
- • A new bond number is assigned to the cargo and bond creation is logged
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cprs cargo has an existing valid bond assignment.
Trigger Criteria:
- Context: CPRS cargo has an existing valid bond assignment
- Applied to: Update Existing Bond
- Action: The system updates the bond information
Logic Flow:
IF CPRS cargo has an existing valid bond assignment
AND The system updates the bond information
THEN:
- • Existing bond record is updated with current cargo processing information and status
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when bond assignment has been created or updated.
Trigger Criteria:
- Context: Bond assignment has been created or updated
- Applied to: Process Broker Bond Information
- Action: The system processes broker bond information
Logic Flow:
IF Bond assignment has been created or updated
AND The system processes broker bond information
THEN:
- • Broker details are validated and associated with the bond assignment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when broker bond information processing has started.
Trigger Criteria:
- Context: Broker bond information processing has started
- Applied to: Broker Information Available?
- Action: The system checks for available broker information in the broker table
Logic Flow:
IF Broker bond information processing has started
AND The system checks for available broker information in the broker table
THEN:
- • If broker information exists, assign broker to bond,
otherwise set default broker information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when broker information is available for the bond.
Trigger Criteria:
- Context: Broker information is available for the bond
- Applied to: Assign Broker to Bond
- Action: The system assigns the broker to the bond
Logic Flow:
IF Broker information is available for the bond
AND The system assigns the broker to the bond
THEN:
- • Broker ID, name, and contact information are associated with the bond record
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when broker information is not available for the bond.
Trigger Criteria:
- Context: Broker information is not available for the bond
- Applied to: Set Default Broker Information
- Action: The system sets default broker information
Logic Flow:
IF Broker information is not available for the bond
AND The system sets default broker information
THEN:
- • Default broker ID and standard broker information are assigned to the bond
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when broker has been assigned to the bond or default broker information has been set.
Trigger Criteria:
- Context: Broker has been assigned to the bond or default broker information has been set
- Applied to: Update Bond Owner Information
- Action: The system updates bond owner information
Logic Flow:
IF Broker has been assigned to the bond or default broker information has been set
AND The system updates bond owner information
THEN:
- • Bond owner details are updated with current broker information and ownership status
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when bond owner information has been updated.
Trigger Criteria:
- Context: Bond owner information has been updated
- Applied to: Clear Previous Bond Data
- Action: The system clears previous bond data
Logic Flow:
IF Bond owner information has been updated
AND The system clears previous bond data
THEN:
- • Any conflicting or outdated bond information is removed from the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when previous bond data has been cleared.
Trigger Criteria:
- Context: Previous bond data has been cleared
- Applied to: Set CPRS Bond Flags
- Action: The system sets CPRS bond flags
Logic Flow:
IF Previous bond data has been cleared
AND The system sets CPRS bond flags
THEN:
- • CPRS-specific flags are set to indicate bond type, processing status, and special handling requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cprs bond flags have been set.
Trigger Criteria:
- Context: CPRS bond flags have been set
- Applied to: Log Bond Assignment Action
- Action: The system logs the bond assignment action
Logic Flow:
IF CPRS bond flags have been set
AND The system logs the bond assignment action
THEN:
- • Bond assignment details, timestamp, and processing information are recorded in the status segments
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when bond assignment action has been logged.
Trigger Criteria:
- Context: Bond assignment action has been logged
- Applied to: Generate Bond Creation Notification
- Action: The system generates bond creation notification
Logic Flow:
IF Bond assignment action has been logged
AND The system generates bond creation notification
THEN:
- • Notification message is prepared with bond details, cargo information, and routing instructions
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when bond creation notification has been generated.
Trigger Criteria:
- Context: Bond creation notification has been generated
- Applied to: Send K1 Message for Bond Creation
- Action: The system sends K1 message for bond creation
Logic Flow:
IF Bond creation notification has been generated
AND The system sends K1 message for bond creation
THEN:
- • K1 message with bond creation details is transmitted to the appropriate recipients
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when k1 message for bond creation has been sent.
Trigger Criteria:
- Context: K1 message for bond creation has been sent
- Applied to: Update Cargo Record with Bond Info
- Action: The system updates the cargo record with bond information
Logic Flow:
IF K1 message for bond creation has been sent
AND The system updates the cargo record with bond information
THEN:
- • Cargo record is updated with complete bond assignment details, broker information, and processing status
R-GCX016E-cbl-00685 (+12) File: GCX016E.cbl Business Rule: Cargo Arrival Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo disposition code is being processed.
Trigger Criteria:
- Context: A cargo disposition code is being processed
- Applied to: Arrival Disposition Code Received?
- Action: The system checks if the disposition code indicates an arrival event
Logic Flow:
IF A cargo disposition code is being processed
AND The system checks if the disposition code indicates an arrival event
THEN:
- • The system proceeds with arrival processing if arrival disposition code is present,
otherwise skips arrival processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when arrival disposition code has been received.
Trigger Criteria:
- Context: An arrival disposition code has been received
- Applied to: Valid Border/Destination Location?
- Action: The system validates the arrival location against valid border and destination locations
Logic Flow:
IF An arrival disposition code has been received
AND The system validates the arrival location against valid border and destination locations
THEN:
- • The system continues arrival processing if location is valid,
otherwise generates location error message and skips processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid arrival location has been confirmed.
Trigger Criteria:
- Context: A valid arrival location has been confirmed
- Applied to: Set Cargo Arrival Flag
- Action: The system processes the arrival event
Logic Flow:
IF A valid arrival location has been confirmed
AND The system processes the arrival event
THEN:
- • The cargo arrival flag is set to indicate arrival status
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo arrival flag has been set.
Trigger Criteria:
- Context: Cargo arrival flag has been set
- Applied to: Clear Bond Start Date
- Action: The system processes bond-related information for the arrived cargo
Logic Flow:
IF Cargo arrival flag has been set
AND The system processes bond-related information for the arrived cargo
THEN:
- • The bond start date is cleared to reset bond timing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when bond start date has been cleared for arrived cargo.
Trigger Criteria:
- Context: Bond start date has been cleared for arrived cargo
- Applied to: Set Arrival Index
- Action: The system assigns location tracking information
Logic Flow:
IF Bond start date has been cleared for arrived cargo
AND The system assigns location tracking information
THEN:
- • An arrival index is set to identify the specific arrival location
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when arrival index has been set for the cargo.
Trigger Criteria:
- Context: Arrival index has been set for the cargo
- Applied to: Calculate Cargo Age
- Action: The system calculates cargo timing information
Logic Flow:
IF Arrival index has been set for the cargo
AND The system calculates cargo timing information
THEN:
- • Cargo age is calculated based on arrival date and relevant timing factors
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo age has been calculated.
Trigger Criteria:
- Context: Cargo age has been calculated
- Applied to: Update Cargo Status to Arrived
- Action: The system updates cargo status information
Logic Flow:
IF Cargo age has been calculated
AND The system updates cargo status information
THEN:
- • The cargo status is updated to 'Arrived' to reflect current state
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo status has been updated to arrived.
Trigger Criteria:
- Context: Cargo status has been updated to arrived
- Applied to: Generate Arrival Notification
- Action: The system processes notification requirements
Logic Flow:
IF Cargo status has been updated to arrived
AND The system processes notification requirements
THEN:
- • An arrival notification is generated for internal tracking and reporting
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when arrival notification has been generated.
Trigger Criteria:
- Context: Arrival notification has been generated
- Applied to: Send AEI Notification Message
- Action: The system processes external notification requirements
Logic Flow:
IF Arrival notification has been generated
AND The system processes external notification requirements
THEN:
- • An AEI notification message is sent to external systems for equipment tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when aei notification message has been sent.
Trigger Criteria:
- Context: AEI notification message has been sent
- Applied to: Log Arrival Action
- Action: The system processes audit and logging requirements
Logic Flow:
IF AEI notification message has been sent
AND The system processes audit and logging requirements
THEN:
- • The arrival action is logged for audit trail and historical tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when arrival action has been logged.
Trigger Criteria:
- Context: Arrival action has been logged
- Applied to: Update Destination Index
- Action: The system updates location tracking information
Logic Flow:
IF Arrival action has been logged
AND The system updates location tracking information
THEN:
- • The destination index is updated to reflect the current cargo location
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when destination index has been updated.
Trigger Criteria:
- Context: Destination index has been updated
- Applied to: Trigger GCCIIS Status Update
- Action: The system processes external system synchronization requirements
Logic Flow:
IF Destination index has been updated
AND The system processes external system synchronization requirements
THEN:
- • A GCCIIS status update is triggered to synchronize cargo information with external systems
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when arrival location validation has failed.
Trigger Criteria:
- Context: An arrival location validation has failed
- Applied to: Generate Location Error Message
- Action: The system detects an invalid border or destination location
Logic Flow:
IF An arrival location validation has failed
AND The system detects an invalid border or destination location
THEN:
- • A location error message is generated to notify of the invalid location
R-GCX016E-cbl-00698 (+17) File: GCX016E.cbl Business Rule: Cargo Export Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code has been received for cargo processing.
Trigger Criteria:
- Context: A disposition code has been received for cargo processing
- Applied to: Export Disposition Code Received?
- Action: The system evaluates the disposition code type
Logic Flow:
IF A disposition code has been received for cargo processing
AND The system evaluates the disposition code type
THEN:
- • The system identifies if it is an export disposition code and proceeds with export processing or skips to completion
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when export disposition code has been received with location information.
Trigger Criteria:
- Context: An export disposition code has been received with location information
- Applied to: Validate Export Location
- Action: The system validates the export location against valid export ports
Logic Flow:
IF An export disposition code has been received with location information
AND The system validates the export location against valid export ports
THEN:
- • The system confirms the location is valid for export processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when export location has been specified in the disposition code.
Trigger Criteria:
- Context: An export location has been specified in the disposition code
- Applied to: Valid Export Port?
- Action: The system checks the location against the valid export port table
Logic Flow:
IF An export location has been specified in the disposition code
AND The system checks the location against the valid export port table
THEN:
- • The system either confirms the port is valid and continues processing or generates an error for invalid ports
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid export port has been confirmed for the cargo.
Trigger Criteria:
- Context: A valid export port has been confirmed for the cargo
- Applied to: Set Export Status Flag
- Action: The system processes the export disposition code
Logic Flow:
IF A valid export port has been confirmed for the cargo
AND The system processes the export disposition code
THEN:
- • The system sets the export status flag to active in the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when export status flag has been set for the cargo.
Trigger Criteria:
- Context: The export status flag has been set for the cargo
- Applied to: Clear Destination Index
- Action: The system processes the export status change
Logic Flow:
IF The export status flag has been set for the cargo
AND The system processes the export status change
THEN:
- • The system clears the destination index field to remove domestic destination references
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when destination index has been cleared for the export cargo.
Trigger Criteria:
- Context: The destination index has been cleared for the export cargo
- Applied to: Update Export Date/Time
- Action: The system finalizes the export status change
Logic Flow:
IF The destination index has been cleared for the export cargo
AND The system finalizes the export status change
THEN:
- • The system updates the export date and time fields with the current timestamp
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when export date and time have been updated for the cargo.
Trigger Criteria:
- Context: The export date and time have been updated for the cargo
- Applied to: Check Previous Export Status
- Action: The system checks the cargo's previous processing history
Logic Flow:
IF The export date and time have been updated for the cargo
AND The system checks the cargo's previous processing history
THEN:
- • The system retrieves the current export status to determine if duplicate processing should be prevented
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when system has checked the cargo's previous export status.
Trigger Criteria:
- Context: The system has checked the cargo's previous export status
- Applied to: Already Exported?
- Action: The system evaluates if the cargo already has an active export status
Logic Flow:
IF The system has checked the cargo's previous export status
AND The system evaluates if the cargo already has an active export status
THEN:
- • The system either skips duplicate processing or continues with new export notification
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has already been processed for export.
Trigger Criteria:
- Context: The cargo has already been processed for export
- Applied to: Skip Duplicate Export
- Action: The system detects duplicate export processing
Logic Flow:
IF The cargo has already been processed for export
AND The system detects duplicate export processing
THEN:
- • The system skips the export notification and completes processing without generating duplicate messages
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has not been previously exported.
Trigger Criteria:
- Context: The cargo has not been previously exported
- Applied to: Generate Export Notification
- Action: The system processes the export status change
Logic Flow:
IF The cargo has not been previously exported
AND The system processes the export status change
THEN:
- • The system generates a new export notification message for distribution
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when export notification needs to be generated.
Trigger Criteria:
- Context: An export notification needs to be generated
- Applied to: Format Export Message
- Action: The system creates the export message
Logic Flow:
IF An export notification needs to be generated
AND The system creates the export message
THEN:
- • The system formats the message with proper export notification headers and structure
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when export message format has been established.
Trigger Criteria:
- Context: The export message format has been established
- Applied to: Include Cargo Details
- Action: The system populates the message content
Logic Flow:
IF The export message format has been established
AND The system populates the message content
THEN:
- • The system includes cargo identification, quantities, and relevant cargo details in the export message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo details have been included in the export message.
Trigger Criteria:
- Context: Cargo details have been included in the export message
- Applied to: Add Location Information
- Action: The system completes the message content
Logic Flow:
IF Cargo details have been included in the export message
AND The system completes the message content
THEN:
- • The system adds the export port code, location name, and relevant geographic information to the message
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when export notification message has been fully formatted with cargo and location details.
Trigger Criteria:
- Context: The export notification message has been fully formatted with cargo and location details
- Applied to: Send Export Notification
- Action: The system is ready to distribute the notification
Logic Flow:
IF The export notification message has been fully formatted with cargo and location details
AND The system is ready to distribute the notification
THEN:
- • The system sends the export notification to designated recipients and systems
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when export notification has been successfully sent.
Trigger Criteria:
- Context: The export notification has been successfully sent
- Applied to: Update Cargo Record
- Action: The system finalizes the export processing
Logic Flow:
IF The export notification has been successfully sent
AND The system finalizes the export processing
THEN:
- • The system updates the cargo record in the database with the export status, date, time, and location information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record has been updated with export information.
Trigger Criteria:
- Context: The cargo record has been updated with export information
- Applied to: Log Export Action
- Action: The system completes the export processing workflow
Logic Flow:
IF The cargo record has been updated with export information
AND The system completes the export processing workflow
THEN:
- • The system creates a log entry documenting the export action, timestamp, and processing details
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all export processing steps have been completed successfully or skipped appropriately.
Trigger Criteria:
- Context: All export processing steps have been completed successfully or skipped appropriately
- Applied to: Export Processing Complete
- Action: The system reaches the end of export processing logic
Logic Flow:
IF All export processing steps have been completed successfully or skipped appropriately
AND The system reaches the end of export processing logic
THEN:
- • The system marks the export processing as complete and returns control to the main processing flow
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when invalid export port has been detected or other validation has failed.
Trigger Criteria:
- Context: An invalid export port has been detected or other validation has failed
- Applied to: Generate Error Message
- Action: The system cannot proceed with export processing
Logic Flow:
IF An invalid export port has been detected or other validation has failed
AND The system cannot proceed with export processing
THEN:
- • The system generates an appropriate error message describing the export processing failure
R-GCX016E-cbl-00716 (+13) File: GCX016E.cbl Business Rule: Cancel Arrival Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record exists in the system.
Trigger Criteria:
- Context: A cargo record exists in the system
- Applied to: Cargo Has Arrival Status?
- Action: Cancel arrival processing is triggered for the cargo
Logic Flow:
IF A cargo record exists in the system
AND Cancel arrival processing is triggered for the cargo
THEN:
- • System checks if cargo has arrival status and only proceeds with cancellation if arrival status exists,
otherwise skips cancellation processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has been validated to have arrival status.
Trigger Criteria:
- Context: Cargo has been validated to have arrival status
- Applied to: Reset Arrival Flag to False
- Action: Arrival cancellation is authorized and processed
Logic Flow:
IF Cargo has been validated to have arrival status
AND Arrival cancellation is authorized and processed
THEN:
- • System sets the cargo arrival flag to false to indicate cargo is no longer in arrived status
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo arrival flag has been reset to false.
Trigger Criteria:
- Context: Cargo arrival flag has been reset to false
- Applied to: Clear Arrival Date Information
- Action: Arrival cancellation processing continues
Logic Flow:
IF Cargo arrival flag has been reset to false
AND Arrival cancellation processing continues
THEN:
- • System clears all arrival date and time fields from the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when arrival date information has been cleared from cargo record.
Trigger Criteria:
- Context: Arrival date information has been cleared from cargo record
- Applied to: Update Cargo Status Arrays
- Action: Status array processing is performed
Logic Flow:
IF Arrival date information has been cleared from cargo record
AND Status array processing is performed
THEN:
- • System updates cargo status arrays to remove arrival-related status entries and recalculate current status
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo status arrays have been updated for cancellation.
Trigger Criteria:
- Context: Cargo status arrays have been updated for cancellation
- Applied to: Remove Arrival Disposition Codes
- Action: Disposition code processing is performed
Logic Flow:
IF Cargo status arrays have been updated for cancellation
AND Disposition code processing is performed
THEN:
- • System removes all arrival-related disposition codes from cargo status array
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when arrival disposition codes have been removed from cargo.
Trigger Criteria:
- Context: Arrival disposition codes have been removed from cargo
- Applied to: Restore Previous Bond Information
- Action: Bond information restoration is processed
Logic Flow:
IF Arrival disposition codes have been removed from cargo
AND Bond information restoration is processed
THEN:
- • System restores the cargo's previous bond number and related bond information that existed before arrival processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when previous bond information has been restored to cargo.
Trigger Criteria:
- Context: Previous bond information has been restored to cargo
- Applied to: Recalculate Cargo Age
- Action: Cargo age calculation is performed
Logic Flow:
IF Previous bond information has been restored to cargo
AND Cargo age calculation is performed
THEN:
- • System recalculates cargo age using original entry date and current date, excluding the cancelled arrival period
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo age has been recalculated after cancellation.
Trigger Criteria:
- Context: Cargo age has been recalculated after cancellation
- Applied to: Clear Destination Index
- Action: Destination processing is performed
Logic Flow:
IF Cargo age has been recalculated after cancellation
AND Destination processing is performed
THEN:
- • System clears the destination index field to remove destination-specific routing information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when destination index has been cleared for the cargo.
Trigger Criteria:
- Context: Destination index has been cleared for the cargo
- Applied to: Multiple Cargo Records with Same Car/Waybill?
- Action: System checks for related cargo records
Logic Flow:
IF Destination index has been cleared for the cargo
AND System checks for related cargo records
THEN:
- • System identifies if multiple cargo records exist with the same car ID and waybill number and processes them as a batch if found,
otherwise processes single cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when multiple cargo records with same car id and waybill have been identified.
Trigger Criteria:
- Context: Multiple cargo records with same car ID and waybill have been identified
- Applied to: Process All Related Cargo Records
- Action: Batch processing is initiated
Logic Flow:
IF Multiple cargo records with same car ID and waybill have been identified
AND Batch processing is initiated
THEN:
- • System applies the same arrival cancellation processing to all related cargo records with matching car ID and waybill number
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all related cargo records have been processed for arrival cancellation.
Trigger Criteria:
- Context: All related cargo records have been processed for arrival cancellation
- Applied to: Verify All Records Updated
- Action: Verification process is executed
Logic Flow:
IF All related cargo records have been processed for arrival cancellation
AND Verification process is executed
THEN:
- • System confirms that all cargo records with matching car ID and waybill have been successfully updated with cancellation changes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all cargo records have been verified as updated or single cargo processing is complete.
Trigger Criteria:
- Context: All cargo records have been verified as updated OR single cargo processing is complete
- Applied to: Generate Arrival Cancellation Notification
- Action: Notification generation is triggered
Logic Flow:
IF All cargo records have been verified as updated OR single cargo processing is complete
AND Notification generation is triggered
THEN:
- • System creates arrival cancellation notification message with cargo details and cancellation information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when arrival cancellation notification has been generated.
Trigger Criteria:
- Context: Arrival cancellation notification has been generated
- Applied to: Update Audit Trail
- Action: Audit trail processing is performed
Logic Flow:
IF Arrival cancellation notification has been generated
AND Audit trail processing is performed
THEN:
- • System records arrival cancellation transaction in audit trail with timestamp, user information, and affected cargo details
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when audit trail has been updated with cancellation transaction.
Trigger Criteria:
- Context: Audit trail has been updated with cancellation transaction
- Applied to: Send Merlin Notification Message
- Action: Merlin message transmission is initiated
Logic Flow:
IF Audit trail has been updated with cancellation transaction
AND Merlin message transmission is initiated
THEN:
- • System sends arrival cancellation notification message through Merlin system to appropriate recipients
R-GCX016E-cbl-00730 (+11) File: GCX016E.cbl Business Rule: Cancel Export Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cancel export disposition code is received for a cargo.
Trigger Criteria:
- Context: A cancel export disposition code is received for a cargo
- Applied to: Validate Cancel Export Request
- Action: The system processes the cancel export request
Logic Flow:
IF A cancel export disposition code is received for a cargo
AND The system processes the cancel export request
THEN:
- • The system validates the request parameters and ensures the cargo exists and is accessible
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cancel export request is being processed for a cargo.
Trigger Criteria:
- Context: A cancel export request is being processed for a cargo
- Applied to: Export Status Currently Active?
- Action: The system checks the current cargo status
Logic Flow:
IF A cancel export request is being processed for a cargo
AND The system checks the current cargo status
THEN:
- • The system determines if export status is currently active and proceeds only if export status exists
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has active export status that needs to be cancelled.
Trigger Criteria:
- Context: A cargo has active export status that needs to be cancelled
- Applied to: Retrieve Current Export Information
- Action: The system needs to process the export cancellation
Logic Flow:
IF A cargo has active export status that needs to be cancelled
AND The system needs to process the export cancellation
THEN:
- • The system retrieves current export date, destination information, and export status flags from the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo export cancellation is being processed and current export information has been retrieved.
Trigger Criteria:
- Context: A cargo export cancellation is being processed and current export information has been retrieved
- Applied to: Clear Export Status Flag
- Action: The system clears the export status
Logic Flow:
IF A cargo export cancellation is being processed and current export information has been retrieved
AND The system clears the export status
THEN:
- • The export status flag is set to inactive or cleared in the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo export status is being cancelled and export status flag has been cleared.
Trigger Criteria:
- Context: A cargo export status is being cancelled and export status flag has been cleared
- Applied to: Reset Export Date Fields
- Action: The system resets export date information
Logic Flow:
IF A cargo export status is being cancelled and export status flag has been cleared
AND The system resets export date information
THEN:
- • Export date fields are cleared or reset to null values in the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo export is being cancelled and export date fields have been reset.
Trigger Criteria:
- Context: A cargo export is being cancelled and export date fields have been reset
- Applied to: Clear Destination Index
- Action: The system clears destination information
Logic Flow:
IF A cargo export is being cancelled and export date fields have been reset
AND The system clears destination information
THEN:
- • The destination index is cleared or reset in the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo export has been cancelled and destination index has been cleared.
Trigger Criteria:
- Context: A cargo export has been cancelled and destination index has been cleared
- Applied to: Restore Previous Cargo Status
- Action: The system restores the previous cargo status
Logic Flow:
IF A cargo export has been cancelled and destination index has been cleared
AND The system restores the previous cargo status
THEN:
- • The cargo status is reverted to the status it had before export processing, typically 'ACK' or previous processing status
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo export has been cancelled and previous status has been restored.
Trigger Criteria:
- Context: A cargo export has been cancelled and previous status has been restored
- Applied to: Update Cargo Status Arrays
- Action: The system updates status tracking arrays
Logic Flow:
IF A cargo export has been cancelled and previous status has been restored
AND The system updates status tracking arrays
THEN:
- • The S09 status arrays are updated to remove export-related status entries and add cancellation status information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo export has been cancelled and status arrays have been updated.
Trigger Criteria:
- Context: A cargo export has been cancelled and status arrays have been updated
- Applied to: Generate Cancel Export Notification
- Action: The system generates export cancellation notification
Logic Flow:
IF A cargo export has been cancelled and status arrays have been updated
AND The system generates export cancellation notification
THEN:
- • A notification message is created containing cargo details, cancellation information, and relevant business data for stakeholders
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when export cancellation notification has been generated.
Trigger Criteria:
- Context: An export cancellation notification has been generated
- Applied to: Log Cancel Export Action
- Action: The system logs the cancellation action
Logic Flow:
IF An export cancellation notification has been generated
AND The system logs the cancellation action
THEN:
- • The export cancellation action is recorded with timestamp, user information, cargo details, and cancellation reason for audit trail
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when export cancellation has been logged and notification prepared.
Trigger Criteria:
- Context: An export cancellation has been logged and notification prepared
- Applied to: Send Notification to Business Users
- Action: The system sends notifications to business users
Logic Flow:
IF An export cancellation has been logged and notification prepared
AND The system sends notifications to business users
THEN:
- • Export cancellation notifications are sent to brokers, freight forwarders, and other relevant parties via Merlin messaging system or email
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all export cancellation processing has been completed and notifications sent.
Trigger Criteria:
- Context: All export cancellation processing has been completed and notifications sent
- Applied to: Update Cargo Record in Database
- Action: The system updates the cargo record in the database
Logic Flow:
IF All export cancellation processing has been completed and notifications sent
AND The system updates the cargo record in the database
THEN:
- • The cargo record is updated in the database with all export cancellation changes, including cleared export status, reset dates, restored previous status, and updated status arrays
R-GCX016E-cbl-00742 (+19) File: GCX016E.cbl Business Rule: Release Quantity Management
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record exists in the system.
Trigger Criteria:
- Context: A cargo record exists in the system
- Applied to: Retrieve Current Cargo Release Quantity
- Action: The release quantity management process is initiated
Logic Flow:
IF A cargo record exists in the system
AND The release quantity management process is initiated
THEN:
- • The current release quantity is retrieved from the cargo record and stored for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status array (s09a) contains disposition codes.
Trigger Criteria:
- Context: A cargo status array (S09A) contains disposition codes
- Applied to: Get Disposition Code from Status Array
- Action: Processing release quantity calculations
Logic Flow:
IF A cargo status array (S09A) contains disposition codes
AND Processing release quantity calculations
THEN:
- • The disposition code is extracted from the status array for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code has been extracted from the status array.
Trigger Criteria:
- Context: A disposition code has been extracted from the status array
- Applied to: Lookup Disposition Code in DC Table
- Action: The system needs to determine the disposition code's action type
Logic Flow:
IF A disposition code has been extracted from the status array
AND The system needs to determine the disposition code's action type
THEN:
- • The disposition code is looked up in the DC table to retrieve its configuration
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code lookup has been performed in the dc table.
Trigger Criteria:
- Context: A disposition code lookup has been performed in the DC table
- Applied to: Disposition Code Found?
- Action: The system checks if the disposition code was found
Logic Flow:
IF A disposition code lookup has been performed in the DC table
AND The system checks if the disposition code was found
THEN:
- • If the disposition code is not found, an error message is generated for unknown disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid disposition code exists in the dc table.
Trigger Criteria:
- Context: A valid disposition code exists in the DC table
- Applied to: Get Disposition Code Action Type
- Action: The system processes the disposition code
Logic Flow:
IF A valid disposition code exists in the DC table
AND The system processes the disposition code
THEN:
- • The action type is retrieved from the DC table configuration
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code action type has been determined.
Trigger Criteria:
- Context: A disposition code action type has been determined
- Applied to: Action Type?
- Action: The system processes the quantity impact
Logic Flow:
IF A disposition code action type has been determined
AND The system processes the quantity impact
THEN:
- • If action type is 'Add', quantity is added to release quantity; if action type is 'Subtract', quantity is subtracted from release quantity; if action type is 'Status Info Only', no quantity change is made
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code has action type 'add'.
Trigger Criteria:
- Context: A disposition code has action type 'Add'
- Applied to: Add to Release Quantity
- Action: The quantity impact is processed
Logic Flow:
IF A disposition code has action type 'Add'
AND The quantity impact is processed
THEN:
- • The disposition code quantity is added to the current release quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code has action type 'subtract'.
Trigger Criteria:
- Context: A disposition code has action type 'Subtract'
- Applied to: Subtract from Release Quantity
- Action: The quantity impact is processed
Logic Flow:
IF A disposition code has action type 'Subtract'
AND The quantity impact is processed
THEN:
- • The disposition code quantity is subtracted from the current release quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code has action type 'status info only'.
Trigger Criteria:
- Context: A disposition code has action type 'Status Info Only'
- Applied to: No Quantity Change
- Action: The quantity impact is processed
Logic Flow:
IF A disposition code has action type 'Status Info Only'
AND The quantity impact is processed
THEN:
- • No change is made to the current release quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when release quantity has been calculated based on disposition code action.
Trigger Criteria:
- Context: Release quantity has been calculated based on disposition code action
- Applied to: Validate Release Quantity Against Total Quantity
- Action: The system validates the calculated release quantity
Logic Flow:
IF Release quantity has been calculated based on disposition code action
AND The system validates the calculated release quantity
THEN:
- • The release quantity is compared against the total cargo quantity for validation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when calculated release quantity exists.
Trigger Criteria:
- Context: A calculated release quantity exists
- Applied to: Release Quantity > Total Quantity?
- Action: The release quantity is validated against total cargo quantity
Logic Flow:
IF A calculated release quantity exists
AND The release quantity is validated against total cargo quantity
THEN:
- • If release quantity exceeds total quantity, the release quantity is set equal to total quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when calculated release quantity exists.
Trigger Criteria:
- Context: A calculated release quantity exists
- Applied to: Release Quantity < 0?
- Action: The release quantity is validated for minimum bounds
Logic Flow:
IF A calculated release quantity exists
AND The release quantity is validated for minimum bounds
THEN:
- • If release quantity is less than zero, the release quantity is set to zero
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when calculated release quantity exceeds the total cargo quantity.
Trigger Criteria:
- Context: The calculated release quantity exceeds the total cargo quantity
- Applied to: Set Release Quantity = Total Quantity
- Action: The system applies quantity validation rules
Logic Flow:
IF The calculated release quantity exceeds the total cargo quantity
AND The system applies quantity validation rules
THEN:
- • The release quantity is set equal to the total cargo quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when calculated release quantity is less than zero.
Trigger Criteria:
- Context: The calculated release quantity is less than zero
- Applied to: Set Release Quantity = 0
- Action: The system applies minimum quantity validation
Logic Flow:
IF The calculated release quantity is less than zero
AND The system applies minimum quantity validation
THEN:
- • The release quantity is set to zero
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when validated release quantity has been calculated.
Trigger Criteria:
- Context: A validated release quantity has been calculated
- Applied to: Update Cargo Record with New Release Quantity
- Action: The quantity processing is complete
Logic Flow:
IF A validated release quantity has been calculated
AND The quantity processing is complete
THEN:
- • The cargo record is updated with the new release quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record has been updated with new release quantity.
Trigger Criteria:
- Context: The cargo record has been updated with new release quantity
- Applied to: Calculate Quantity Impact for Merlin Message
- Action: Preparing Merlin notification messages
Logic Flow:
IF The cargo record has been updated with new release quantity
AND Preparing Merlin notification messages
THEN:
- • The quantity impact (difference between old and new release quantity) is calculated for message content
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when quantity impact has been calculated.
Trigger Criteria:
- Context: Quantity impact has been calculated
- Applied to: Format Before/After Quantity Comparison
- Action: Formatting information for notifications
Logic Flow:
IF Quantity impact has been calculated
AND Formatting information for notifications
THEN:
- • Before and after quantity values are formatted for comparison display
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when quantity comparison has been formatted.
Trigger Criteria:
- Context: Quantity comparison has been formatted
- Applied to: Log Quantity Change in Audit Trail
- Action: Recording the transaction
Logic Flow:
IF Quantity comparison has been formatted
AND Recording the transaction
THEN:
- • The quantity change is logged in the audit trail with before/after values and disposition code information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when quantity change has been logged in audit trail.
Trigger Criteria:
- Context: Quantity change has been logged in audit trail
- Applied to: Generate Merlin Notification with Quantity Impact
- Action: Generating notifications
Logic Flow:
IF Quantity change has been logged in audit trail
AND Generating notifications
THEN:
- • A Merlin notification message is generated including the quantity impact details
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code lookup in the dc table has failed.
Trigger Criteria:
- Context: A disposition code lookup in the DC table has failed
- Applied to: Generate Error Message for Unknown Disposition Code
- Action: The disposition code is not found
Logic Flow:
IF A disposition code lookup in the DC table has failed
AND The disposition code is not found
THEN:
- • An error message is generated indicating unknown disposition code
R-GCX016E-cbl-00762 (+25) File: GCX016E.cbl Business Rule: Hold Cargo Notification
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record exists with status information.
Trigger Criteria:
- Context: A cargo record exists with status information
- Applied to: Hold Status Detected in Cargo
- Action: The system evaluates cargo status and finds hold conditions are present
Logic Flow:
IF A cargo record exists with status information
AND The system evaluates cargo status and finds hold conditions are present
THEN:
- • The hold notification process is triggered and hold information gathering begins
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when hold status has been detected for a cargo.
Trigger Criteria:
- Context: Hold status has been detected for a cargo
- Applied to: Gather Hold Information
- Action: The system begins gathering hold information from GCSUSS09 status segments
Logic Flow:
IF Hold status has been detected for a cargo
AND The system begins gathering hold information from GCSUSS09 status segments
THEN:
- • All relevant hold data including hold type, priority, and status validation is collected
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when hold information is being gathered for a cargo.
Trigger Criteria:
- Context: Hold information is being gathered for a cargo
- Applied to: Check Hold Type
- Action: The system examines the hold status codes and disposition information
Logic Flow:
IF Hold information is being gathered for a cargo
AND The system examines the hold status codes and disposition information
THEN:
- • The hold type is classified as border hold, destination hold, FDA hold, or other specific hold category
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when hold type has been identified for cargo.
Trigger Criteria:
- Context: A hold type has been identified for cargo
- Applied to: Validate Hold Status
- Action: The system validates the hold status against current business rules
Logic Flow:
IF A hold type has been identified for cargo
AND The system validates the hold status against current business rules
THEN:
- • The hold status is confirmed as valid and active, or flagged for correction
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when hold status has been validated for cargo.
Trigger Criteria:
- Context: Hold status has been validated for cargo
- Applied to: Determine Hold Priority
- Action: The system evaluates hold type and associated business rules
Logic Flow:
IF Hold status has been validated for cargo
AND The system evaluates hold type and associated business rules
THEN:
- • Hold priority is determined based on hold type hierarchy and urgency requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when hold information has been gathered for cargo.
Trigger Criteria:
- Context: Hold information has been gathered for cargo
- Applied to: Collect Disposition Code Details
- Action: The system accesses GCSTBRT table segments for disposition code details
Logic Flow:
IF Hold information has been gathered for cargo
AND The system accesses GCSTBRT table segments for disposition code details
THEN:
- • Complete disposition code information including descriptions and hold reasons is collected
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code details are being collected.
Trigger Criteria:
- Context: Disposition code details are being collected
- Applied to: Lookup Disposition Code Description
- Action: The system looks up disposition codes in the DC table
Logic Flow:
IF Disposition code details are being collected
AND The system looks up disposition codes in the DC table
THEN:
- • Descriptive text for each disposition code is retrieved and made available for notification
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code descriptions have been retrieved.
Trigger Criteria:
- Context: Disposition code descriptions have been retrieved
- Applied to: Get Hold Reason Details
- Action: The system analyzes disposition codes for hold-specific information
Logic Flow:
IF Disposition code descriptions have been retrieved
AND The system analyzes disposition codes for hold-specific information
THEN:
- • Detailed hold reasons and explanatory information are extracted for notification purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code details have been collected.
Trigger Criteria:
- Context: Disposition code details have been collected
- Applied to: Retrieve Location Information
- Action: The system accesses station data tables for location information
Logic Flow:
IF Disposition code details have been collected
AND The system accesses station data tables for location information
THEN:
- • Origin station, destination station, and border information are retrieved for the notification
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all hold information and location data have been retrieved.
Trigger Criteria:
- Context: All hold information and location data have been retrieved
- Applied to: Format Hold Notification Message
- Action: The system begins formatting the notification message
Logic Flow:
IF All hold information and location data have been retrieved
AND The system begins formatting the notification message
THEN:
- • A structured message template is prepared with placeholders for equipment, cargo, and location details
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when hold notification message formatting has begun.
Trigger Criteria:
- Context: Hold notification message formatting has begun
- Applied to: Include Equipment Details
- Action: The system accesses GCSUSRT cargo root for equipment details
Logic Flow:
IF Hold notification message formatting has begun
AND The system accesses GCSUSRT cargo root for equipment details
THEN:
- • Car ID, waybill number, and equipment type information are included in the notification
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment details are being included in the notification.
Trigger Criteria:
- Context: Equipment details are being included in the notification
- Applied to: Format Car ID
- Action: The system processes car identification data
Logic Flow:
IF Equipment details are being included in the notification
AND The system processes car identification data
THEN:
- • Car ID is formatted according to standard notation and included in the message
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when car id has been formatted for the notification.
Trigger Criteria:
- Context: Car ID has been formatted for the notification
- Applied to: Include Waybill Number
- Action: The system processes waybill information
Logic Flow:
IF Car ID has been formatted for the notification
AND The system processes waybill information
THEN:
- • Waybill number is included in the notification message for cargo identification
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment details have been included in the notification.
Trigger Criteria:
- Context: Equipment details have been included in the notification
- Applied to: Add Cargo Identification
- Action: The system processes cargo identification data
Logic Flow:
IF Equipment details have been included in the notification
AND The system processes cargo identification data
THEN:
- • US-CCN, cargo description, and quantity information are added to the notification
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo identification is being added to the notification.
Trigger Criteria:
- Context: Cargo identification is being added to the notification
- Applied to: Format US-CCN
- Action: The system processes US-CCN information
Logic Flow:
IF Cargo identification is being added to the notification
AND The system processes US-CCN information
THEN:
- • US-CCN is formatted according to standard format and included in the message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo identification has been added to the notification.
Trigger Criteria:
- Context: Cargo identification has been added to the notification
- Applied to: Include Hold Reason Code
- Action: The system processes hold reason information
Logic Flow:
IF Cargo identification has been added to the notification
AND The system processes hold reason information
THEN:
- • Hold reason codes and associated explanations are included in the notification message
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when hold reason codes have been included in the notification.
Trigger Criteria:
- Context: Hold reason codes have been included in the notification
- Applied to: Add Location and Station Data
- Action: The system processes location data from station tables
Logic Flow:
IF Hold reason codes have been included in the notification
AND The system processes location data from station tables
THEN:
- • Origin station, destination station, and border information are formatted and added to the message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when location and station data is being added to the notification.
Trigger Criteria:
- Context: Location and station data is being added to the notification
- Applied to: Format Origin Station
- Action: The system processes origin station information
Logic Flow:
IF Location and station data is being added to the notification
AND The system processes origin station information
THEN:
- • Origin station name and code are formatted and included in the notification
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when origin station has been formatted for the notification.
Trigger Criteria:
- Context: Origin station has been formatted for the notification
- Applied to: Format Destination Station
- Action: The system processes destination station information
Logic Flow:
IF Origin station has been formatted for the notification
AND The system processes destination station information
THEN:
- • Destination station name and code are formatted and included in the notification
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when location and station data has been added to the notification.
Trigger Criteria:
- Context: Location and station data has been added to the notification
- Applied to: Format Date and Time Information
- Action: The system processes date and time information
Logic Flow:
IF Location and station data has been added to the notification
AND The system processes date and time information
THEN:
- • Hold date, time, and related temporal information are formatted according to standard format
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when all message components including date and time have been formatted.
Trigger Criteria:
- Context: All message components including date and time have been formatted
- Applied to: Create Comprehensive Hold Message
- Action: The system combines all elements into a final message
Logic Flow:
IF All message components including date and time have been formatted
AND The system combines all elements into a final message
THEN:
- • A comprehensive hold notification message is created with all required information properly structured
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all individual message components have been prepared.
Trigger Criteria:
- Context: All individual message components have been prepared
- Applied to: Combine All Elements
- Action: The system combines equipment, cargo, location, and hold information
Logic Flow:
IF All individual message components have been prepared
AND The system combines equipment, cargo, location, and hold information
THEN:
- • All elements are properly integrated into a single comprehensive message structure
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all message elements have been combined.
Trigger Criteria:
- Context: All message elements have been combined
- Applied to: Apply Message Template
- Action: The system applies the standard hold notification template
Logic Flow:
IF All message elements have been combined
AND The system applies the standard hold notification template
THEN:
- • The message conforms to established format standards and includes all required sections
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when message template has been applied to the notification.
Trigger Criteria:
- Context: Message template has been applied to the notification
- Applied to: Validate Message Format
- Action: The system validates the message format and content
Logic Flow:
IF Message template has been applied to the notification
AND The system validates the message format and content
THEN:
- • The message is confirmed to meet all format requirements and contains all mandatory information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when hold notification message has been created and validated.
Trigger Criteria:
- Context: Hold notification message has been created and validated
- Applied to: Route to Merlin Message System
- Action: The system routes the message to the Merlin message system
Logic Flow:
IF Hold notification message has been created and validated
AND The system routes the message to the Merlin message system
THEN:
- • The message is successfully queued in the Merlin system for distribution
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when hold notification has been routed to the merlin message system.
Trigger Criteria:
- Context: Hold notification has been routed to the Merlin message system
- Applied to: Distribute Hold Notification
- Action: The system processes the message for distribution
Logic Flow:
IF Hold notification has been routed to the Merlin message system
AND The system processes the message for distribution
THEN:
- • The hold notification is distributed to all appropriate recipients based on routing rules
R-GCX016E-cbl-00788 (+23) File: GCX016E.cbl Business Rule: Status Array Verification
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo status array verification process is starting.
Trigger Criteria:
- Context: A cargo status array verification process is starting
- Applied to: Initialize Status Analysis Variables
- Action: The system begins status analysis
Logic Flow:
IF A cargo status array verification process is starting
AND The system begins status analysis
THEN:
- • All hold status flags, release status flags, proceed status flags, and information status flags are set to initial values
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has s09a status array entries.
Trigger Criteria:
- Context: A cargo has S09A status array entries
- Applied to: Loop Through S09A Status Array Entries
- Action: The system processes the status array
Logic Flow:
IF A cargo has S09A status array entries
AND The system processes the status array
THEN:
- • Each status entry in the array is examined sequentially until all entries are processed
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when system is processing s09a status array entries.
Trigger Criteria:
- Context: The system is processing S09A status array entries
- Applied to: More Status Entries?
- Action: The current entry position is evaluated
Logic Flow:
IF The system is processing S09A status array entries
AND The current entry position is evaluated
THEN:
- • If more entries exist, continue processing;
otherwise proceed to status evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when status entry exists in the s09a array.
Trigger Criteria:
- Context: A status entry exists in the S09A array
- Applied to: Analyze Individual Status Entry
- Action: The entry is being processed
Logic Flow:
IF A status entry exists in the S09A array
AND The entry is being processed
THEN:
- • The disposition code, quantity, entry number, and other status data are extracted for analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status entry with a disposition code is being analyzed.
Trigger Criteria:
- Context: A status entry with a disposition code is being analyzed
- Applied to: Status Type?
- Action: The disposition code type is evaluated
Logic Flow:
IF A status entry with a disposition code is being analyzed
AND The disposition code type is evaluated
THEN:
- • The entry is classified as Hold, Release, Proceed, or Information type based on the disposition code characteristics
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status entry contains a hold-type disposition code.
Trigger Criteria:
- Context: A status entry contains a hold-type disposition code
- Applied to: Process Hold Disposition Code
- Action: The hold disposition code is processed
Logic Flow:
IF A status entry contains a hold-type disposition code
AND The hold disposition code is processed
THEN:
- • Hold-specific data including location, reason, and quantity are extracted and processed
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status entry contains a release-type disposition code.
Trigger Criteria:
- Context: A status entry contains a release-type disposition code
- Applied to: Process Release Disposition Code
- Action: The release disposition code is processed
Logic Flow:
IF A status entry contains a release-type disposition code
AND The release disposition code is processed
THEN:
- • Release-specific data including quantity, entry number, and release authority are extracted and processed
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status entry contains a proceed-type disposition code.
Trigger Criteria:
- Context: A status entry contains a proceed-type disposition code
- Applied to: Process Proceed Disposition Code
- Action: The proceed disposition code is processed
Logic Flow:
IF A status entry contains a proceed-type disposition code
AND The proceed disposition code is processed
THEN:
- • Proceed-specific data including destination, timing, and conditions are extracted and processed
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status entry contains an information-type disposition code.
Trigger Criteria:
- Context: A status entry contains an information-type disposition code
- Applied to: Process Status Information Code
- Action: The information disposition code is processed
Logic Flow:
IF A status entry contains an information-type disposition code
AND The information disposition code is processed
THEN:
- • Informational data is extracted and recorded without affecting cargo processing status
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when hold disposition code has been processed.
Trigger Criteria:
- Context: A hold disposition code has been processed
- Applied to: Update Hold Status Flags
- Action: Hold status flags are updated
Logic Flow:
IF A hold disposition code has been processed
AND Hold status flags are updated
THEN:
- • Appropriate hold flags are set including border hold, destination hold, FDA hold, or general hold based on the disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when release disposition code has been processed.
Trigger Criteria:
- Context: A release disposition code has been processed
- Applied to: Update Release Status Flags
- Action: Release status flags are updated
Logic Flow:
IF A release disposition code has been processed
AND Release status flags are updated
THEN:
- • Appropriate release flags are set including manual release, auto release, or PTT release based on the disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when proceed disposition code has been processed.
Trigger Criteria:
- Context: A proceed disposition code has been processed
- Applied to: Update Proceed Status Flags
- Action: Proceed status flags are updated
Logic Flow:
IF A proceed disposition code has been processed
AND Proceed status flags are updated
THEN:
- • Proceed flags are set to indicate cargo can proceed to destination or next processing step
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when information disposition code has been processed.
Trigger Criteria:
- Context: An information disposition code has been processed
- Applied to: Update Information Status Flags
- Action: Information status flags are updated
Logic Flow:
IF An information disposition code has been processed
AND Information status flags are updated
THEN:
- • Information flags are set to record status details without affecting processing decisions
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all status entries have been processed and flags updated.
Trigger Criteria:
- Context: All status entries have been processed and flags updated
- Applied to: Evaluate Combined Status Conditions
- Action: Combined status evaluation occurs
Logic Flow:
IF All status entries have been processed and flags updated
AND Combined status evaluation occurs
THEN:
- • The system evaluates the combination of hold, release, proceed, and information flags to determine final status
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status array processing is complete.
Trigger Criteria:
- Context: Status array processing is complete
- Applied to: Has Hold Codes?
- Action: Hold code presence is evaluated
Logic Flow:
IF Status array processing is complete
AND Hold code presence is evaluated
THEN:
- • If any hold flags are set, the cargo has hold conditions;
otherwise proceed to check other status types
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when hold code evaluation is complete.
Trigger Criteria:
- Context: Hold code evaluation is complete
- Applied to: Has Release Codes?
- Action: Release code presence is evaluated
Logic Flow:
IF Hold code evaluation is complete
AND Release code presence is evaluated
THEN:
- • If release flags are set and override hold conditions, set released status;
otherwise maintain hold status
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when release code evaluation is complete and no overriding release found.
Trigger Criteria:
- Context: Release code evaluation is complete and no overriding release found
- Applied to: Has Proceed Codes?
- Action: Proceed code presence is evaluated
Logic Flow:
IF Release code evaluation is complete and no overriding release found
AND Proceed code presence is evaluated
THEN:
- • If proceed flags are set, set proceed status;
otherwise set information-only status
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when hold codes exist and no overriding release codes are present.
Trigger Criteria:
- Context: Hold codes exist and no overriding release codes are present
- Applied to: HELD
- Action: Final status is determined
Logic Flow:
IF Hold codes exist and no overriding release codes are present
AND Final status is determined
THEN:
- • The cargo status is set to HELD with appropriate hold reason and location
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when release codes exist that override any hold conditions.
Trigger Criteria:
- Context: Release codes exist that override any hold conditions
- Applied to: RELEASED
- Action: Final status is determined
Logic Flow:
IF Release codes exist that override any hold conditions
AND Final status is determined
THEN:
- • The cargo status is set to RELEASED with appropriate release quantity and authority
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when proceed codes exist and no hold or overriding release codes are present.
Trigger Criteria:
- Context: Proceed codes exist and no hold or overriding release codes are present
- Applied to: PROCEED
- Action: Final status is determined
Logic Flow:
IF Proceed codes exist and no hold or overriding release codes are present
AND Final status is determined
THEN:
- • The cargo status is set to PROCEED allowing movement to next processing step
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when only information codes exist with no hold, release, or proceed codes.
Trigger Criteria:
- Context: Only information codes exist with no hold, release, or proceed codes
- Applied to: INFORMATION ONLY
- Action: Final status is determined
Logic Flow:
IF Only information codes exist with no hold, release, or proceed codes
AND Final status is determined
THEN:
- • The cargo status is set to INFORMATION ONLY indicating no action required
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when final status has been determined.
Trigger Criteria:
- Context: Final status has been determined
- Applied to: Calculate Release Quantities
- Action: Release quantity calculation occurs
Logic Flow:
IF Final status has been determined
AND Release quantity calculation occurs
THEN:
- • All release quantities from disposition codes are summed to determine total released amount
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status evaluation and quantity calculations are complete.
Trigger Criteria:
- Context: Status evaluation and quantity calculations are complete
- Applied to: Determine Final Cargo Status
- Action: Final cargo status is determined
Logic Flow:
IF Status evaluation and quantity calculations are complete
AND Final cargo status is determined
THEN:
- • The definitive cargo status is established considering all disposition codes, quantities, and business rules
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when final cargo status has been determined.
Trigger Criteria:
- Context: Final cargo status has been determined
- Applied to: Update Cargo Status Flags
- Action: Cargo status flags are updated
Logic Flow:
IF Final cargo status has been determined
AND Cargo status flags are updated
THEN:
- • The cargo record is updated with the new status, quantities, and any status-related data
R-GCX016E-cbl-00812 (+21) File: GCX016E.cbl Business Rule: Individual Status Analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo status analysis process is starting.
Trigger Criteria:
- Context: A cargo status analysis process is starting
- Applied to: Initialize Status Flags
- Action: The system begins individual status analysis
Logic Flow:
IF A cargo status analysis process is starting
AND The system begins individual status analysis
THEN:
- • All status flags (hold, release, proceed, status info, manual release) are set to false or initial values
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo status array contains multiple disposition code entries.
Trigger Criteria:
- Context: A cargo status array contains multiple disposition code entries
- Applied to: Get Next Status Array Entry
- Action: The system processes status entries sequentially
Logic Flow:
IF A cargo status array contains multiple disposition code entries
AND The system processes status entries sequentially
THEN:
- • The next unprocessed status array entry is retrieved for evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo status array is being processed sequentially.
Trigger Criteria:
- Context: A cargo status array is being processed sequentially
- Applied to: More Entries?
- Action: The system checks for remaining entries after processing current entry
Logic Flow:
IF A cargo status array is being processed sequentially
AND The system checks for remaining entries after processing current entry
THEN:
- • If more entries exist, continue processing;
otherwise proceed to final status determination
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when status array entry contains a disposition code.
Trigger Criteria:
- Context: A status array entry contains a disposition code
- Applied to: Analyze Disposition Code
- Action: The system analyzes the disposition code
Logic Flow:
IF A status array entry contains a disposition code
AND The system analyzes the disposition code
THEN:
- • The disposition code is categorized as Hold, Release, Proceed, or Status Info type
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code has been analyzed and categorized.
Trigger Criteria:
- Context: A disposition code has been analyzed and categorized
- Applied to: Code Type?
- Action: The system determines the code type (Hold, Release, Proceed, or Status Info)
Logic Flow:
IF A disposition code has been analyzed and categorized
AND The system determines the code type (Hold, Release, Proceed, or Status Info)
THEN:
- • The appropriate processing path is selected based on the code type
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is categorized as a hold type.
Trigger Criteria:
- Context: A disposition code is categorized as a Hold type
- Applied to: Set Hold Flag
- Action: The system processes the hold disposition code
Logic Flow:
IF A disposition code is categorized as a Hold type
AND The system processes the hold disposition code
THEN:
- • The hold status flag is set to true for subsequent hold condition evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code is categorized as a release type.
Trigger Criteria:
- Context: A disposition code is categorized as a Release type
- Applied to: Set Release Flag
- Action: The system processes the release disposition code
Logic Flow:
IF A disposition code is categorized as a Release type
AND The system processes the release disposition code
THEN:
- • The release status flag is set to true for subsequent release condition evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code is categorized as a proceed type.
Trigger Criteria:
- Context: A disposition code is categorized as a Proceed type
- Applied to: Set Proceed Flag
- Action: The system processes the proceed disposition code
Logic Flow:
IF A disposition code is categorized as a Proceed type
AND The system processes the proceed disposition code
THEN:
- • The proceed status flag is set to true for subsequent proceed condition evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is categorized as status info type.
Trigger Criteria:
- Context: A disposition code is categorized as Status Info type
- Applied to: Set Status Info Flag
- Action: The system processes the informational disposition code
Logic Flow:
IF A disposition code is categorized as Status Info type
AND The system processes the informational disposition code
THEN:
- • The status info flag is set and processing continues to next entry without further evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when hold status flag has been set from disposition code analysis.
Trigger Criteria:
- Context: A hold status flag has been set from disposition code analysis
- Applied to: Evaluate Hold Conditions
- Action: The system evaluates hold-specific business conditions (location, quantity, regulatory requirements)
Logic Flow:
IF A hold status flag has been set from disposition code analysis
AND The system evaluates hold-specific business conditions (location, quantity, regulatory requirements)
THEN:
- • Hold conditions are assessed to determine if cargo hold business flag should be activated
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when hold conditions have been evaluated for a cargo.
Trigger Criteria:
- Context: Hold conditions have been evaluated for a cargo
- Applied to: Hold Status Found?
- Action: The system checks if hold status should be applied
Logic Flow:
IF Hold conditions have been evaluated for a cargo
AND The system checks if hold status should be applied
THEN:
- • If hold conditions are met, set cargo hold business flag;
otherwise proceed to release evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when hold conditions have been evaluated and determined to be applicable.
Trigger Criteria:
- Context: Hold conditions have been evaluated and determined to be applicable
- Applied to: Set Cargo Hold Business Flag
- Action: The system confirms hold status should be applied to cargo
Logic Flow:
IF Hold conditions have been evaluated and determined to be applicable
AND The system confirms hold status should be applied to cargo
THEN:
- • The cargo hold business flag is set to indicate cargo is in hold status
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when release status flag has been set or hold evaluation is complete.
Trigger Criteria:
- Context: A release status flag has been set or hold evaluation is complete
- Applied to: Evaluate Release Conditions
- Action: The system evaluates release-specific business conditions (quantity validation, regulatory clearance)
Logic Flow:
IF A release status flag has been set or hold evaluation is complete
AND The system evaluates release-specific business conditions (quantity validation, regulatory clearance)
THEN:
- • Release conditions are assessed to determine if cargo release business flag should be activated
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when release conditions have been evaluated for a cargo.
Trigger Criteria:
- Context: Release conditions have been evaluated for a cargo
- Applied to: Release Status Found?
- Action: The system checks if release status should be applied
Logic Flow:
IF Release conditions have been evaluated for a cargo
AND The system checks if release status should be applied
THEN:
- • If release conditions are met, set cargo release business flag;
otherwise proceed to proceed evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when release conditions have been evaluated and determined to be applicable.
Trigger Criteria:
- Context: Release conditions have been evaluated and determined to be applicable
- Applied to: Set Cargo Release Business Flag
- Action: The system confirms release status should be applied to cargo
Logic Flow:
IF Release conditions have been evaluated and determined to be applicable
AND The system confirms release status should be applied to cargo
THEN:
- • The cargo release business flag is set to indicate cargo is released
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when proceed status flag has been set or release evaluation is complete.
Trigger Criteria:
- Context: A proceed status flag has been set or release evaluation is complete
- Applied to: Evaluate Proceed Conditions
- Action: The system evaluates proceed-specific business conditions (in-bond requirements, entry type validation)
Logic Flow:
IF A proceed status flag has been set or release evaluation is complete
AND The system evaluates proceed-specific business conditions (in-bond requirements, entry type validation)
THEN:
- • Proceed conditions are assessed to determine if in-bond proceed business flag should be activated
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when proceed conditions have been evaluated for a cargo.
Trigger Criteria:
- Context: Proceed conditions have been evaluated for a cargo
- Applied to: Proceed Status Found?
- Action: The system checks if proceed status should be applied
Logic Flow:
IF Proceed conditions have been evaluated for a cargo
AND The system checks if proceed status should be applied
THEN:
- • If proceed conditions are met, set in-bond proceed business flag;
otherwise proceed to manual release evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when proceed conditions have been evaluated and determined to be applicable.
Trigger Criteria:
- Context: Proceed conditions have been evaluated and determined to be applicable
- Applied to: Set In-Bond Proceed Business Flag
- Action: The system confirms proceed status should be applied to cargo
Logic Flow:
IF Proceed conditions have been evaluated and determined to be applicable
AND The system confirms proceed status should be applied to cargo
THEN:
- • The in-bond proceed business flag is set to indicate cargo can proceed in-bond
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when proceed evaluation is complete or proceed status flag has been set.
Trigger Criteria:
- Context: Proceed evaluation is complete or proceed status flag has been set
- Applied to: Evaluate Manual Release
- Action: The system checks for manual release disposition codes in the status array
Logic Flow:
IF Proceed evaluation is complete or proceed status flag has been set
AND The system checks for manual release disposition codes in the status array
THEN:
- • Manual release conditions are evaluated to determine if manual release business flag should be set
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when manual release conditions have been evaluated for a cargo.
Trigger Criteria:
- Context: Manual release conditions have been evaluated for a cargo
- Applied to: Manual Release Found?
- Action: The system checks if manual release status should be applied
Logic Flow:
IF Manual release conditions have been evaluated for a cargo
AND The system checks if manual release status should be applied
THEN:
- • If manual release conditions are met, set manual release business flag;
otherwise continue to next entry
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when manual release conditions have been evaluated and determined to be applicable.
Trigger Criteria:
- Context: Manual release conditions have been evaluated and determined to be applicable
- Applied to: Set Manual Release Business Flag
- Action: The system confirms manual release status should be applied to cargo
Logic Flow:
IF Manual release conditions have been evaluated and determined to be applicable
AND The system confirms manual release status should be applied to cargo
THEN:
- • The manual release business flag is set to indicate cargo has been manually released
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all status array entries have been processed and individual flags have been set.
Trigger Criteria:
- Context: All status array entries have been processed and individual flags have been set
- Applied to: Set Final Status Flags
- Action: The system completes individual status analysis
Logic Flow:
IF All status array entries have been processed and individual flags have been set
AND The system completes individual status analysis
THEN:
- • Final cargo status flags are determined based on the combination of hold, release, proceed, and manual release flags
R-GCX016E-cbl-00834 (+19) File: GCX016E.cbl Business Rule: Complex Cargo Status Evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has s09a status arrays containing disposition codes with associated flags and quantities.
Trigger Criteria:
- Context: A cargo has S09A status arrays containing disposition codes with associated flags and quantities
- Applied to: Analyze Complete S09A Status Arrays
- Action: The system processes the status arrays to evaluate cargo conditions
Logic Flow:
IF A cargo has S09A status arrays containing disposition codes with associated flags and quantities
AND The system processes the status arrays to evaluate cargo conditions
THEN:
- • The system identifies hold status types, release conditions, proceed dispositions, arrival/export flags, and manual processing indicators for subsequent status determination
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has disposition codes in its status array.
Trigger Criteria:
- Context: A cargo has disposition codes in its status array
- Applied to: Border Hold Status
- Action: The system finds disposition codes that indicate border hold conditions
Logic Flow:
IF A cargo has disposition codes in its status array
AND The system finds disposition codes that indicate border hold conditions
THEN:
- • The system sets the border hold flag to indicate cargo is held at border location
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has disposition codes in its status array.
Trigger Criteria:
- Context: A cargo has disposition codes in its status array
- Applied to: Destination Hold Status
- Action: The system finds disposition codes that indicate destination hold conditions
Logic Flow:
IF A cargo has disposition codes in its status array
AND The system finds disposition codes that indicate destination hold conditions
THEN:
- • The system sets the destination hold flag to indicate cargo is held at destination location
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has disposition codes in its status array.
Trigger Criteria:
- Context: A cargo has disposition codes in its status array
- Applied to: FDA Hold Status
- Action: The system finds disposition codes that indicate FDA hold requirements
Logic Flow:
IF A cargo has disposition codes in its status array
AND The system finds disposition codes that indicate FDA hold requirements
THEN:
- • The system sets the FDA hold flag to indicate cargo requires FDA clearance
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has disposition codes with associated release quantities in its status array.
Trigger Criteria:
- Context: A cargo has disposition codes with associated release quantities in its status array
- Applied to: Piece Count Hold Status
- Action: The system compares released quantities against total cargo quantities
Logic Flow:
IF A cargo has disposition codes with associated release quantities in its status array
AND The system compares released quantities against total cargo quantities
THEN:
- • The system sets piece count hold flag if cargo has partial releases or quantity discrepancies
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo has disposition codes in its status array with manual processing indicators.
Trigger Criteria:
- Context: A cargo has disposition codes in its status array with manual processing indicators
- Applied to: Manual Release Processing
- Action: The system finds manual release disposition codes or manual processing flags
Logic Flow:
IF A cargo has disposition codes in its status array with manual processing indicators
AND The system finds manual release disposition codes or manual processing flags
THEN:
- • The system prioritizes manual release status and sets appropriate processing flags for manual intervention
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has disposition codes in its status array with automatic processing indicators.
Trigger Criteria:
- Context: A cargo has disposition codes in its status array with automatic processing indicators
- Applied to: Automatic Release Processing
- Action: The system finds automatic release disposition codes without hold conditions
Logic Flow:
IF A cargo has disposition codes in its status array with automatic processing indicators
AND The system finds automatic release disposition codes without hold conditions
THEN:
- • The system sets automatic release processing flags and prepares cargo for automated release workflow
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has proceed disposition codes in its status array.
Trigger Criteria:
- Context: A cargo has proceed disposition codes in its status array
- Applied to: Proceed Disposition Processing
- Action: The system processes proceed dispositions with associated location and timing information
Logic Flow:
IF A cargo has proceed disposition codes in its status array
AND The system processes proceed dispositions with associated location and timing information
THEN:
- • The system sets proceed status flags and updates cargo movement authorization while maintaining compliance tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has arrival disposition codes in its status array with location and date information.
Trigger Criteria:
- Context: A cargo has arrival disposition codes in its status array with location and date information
- Applied to: Arrival Status Management
- Action: The system processes arrival events and validates arrival conditions
Logic Flow:
IF A cargo has arrival disposition codes in its status array with location and date information
AND The system processes arrival events and validates arrival conditions
THEN:
- • The system updates arrival status flags, records arrival location and date, and triggers arrival-related processing workflows
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has export disposition codes in its status array with export requirements.
Trigger Criteria:
- Context: A cargo has export disposition codes in its status array with export requirements
- Applied to: Export Status Management
- Action: The system processes export events and validates export conditions
Logic Flow:
IF A cargo has export disposition codes in its status array with export requirements
AND The system processes export events and validates export conditions
THEN:
- • The system updates export status flags, clears destination requirements, and ensures export compliance processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo is associated with canadian manifests and has cross-border movement requirements.
Trigger Criteria:
- Context: A cargo is associated with Canadian manifests and has cross-border movement requirements
- Applied to: Canadian Manifest Processing
- Action: The system processes Canadian manifest disposition codes and cross-border conditions
Logic Flow:
IF A cargo is associated with Canadian manifests and has cross-border movement requirements
AND The system processes Canadian manifest disposition codes and cross-border conditions
THEN:
- • The system applies Canadian regulatory requirements, updates cross-border tracking, and ensures compliance with bilateral trade agreements
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has both hold and release disposition codes in its status array.
Trigger Criteria:
- Context: A cargo has both hold and release disposition codes in its status array
- Applied to: Hold vs Release Priority
- Action: The system evaluates conflicting disposition codes with different priorities and timestamps
Logic Flow:
IF A cargo has both hold and release disposition codes in its status array
AND The system evaluates conflicting disposition codes with different priorities and timestamps
THEN:
- • The system applies business priority rules where holds generally override releases unless specific release conditions supersede hold requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has both proceed and hold disposition codes in its status array.
Trigger Criteria:
- Context: A cargo has both proceed and hold disposition codes in its status array
- Applied to: Proceed vs Hold Priority
- Action: The system evaluates conflicting disposition codes with different business priorities
Logic Flow:
IF A cargo has both proceed and hold disposition codes in its status array
AND The system evaluates conflicting disposition codes with different business priorities
THEN:
- • The system applies priority rules where active holds override proceed dispositions unless proceed has regulatory precedence or proper release authorization
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo has informational disposition codes in its status array.
Trigger Criteria:
- Context: A cargo has informational disposition codes in its status array
- Applied to: Status Information Codes
- Action: The system processes status information codes that do not affect cargo movement
Logic Flow:
IF A cargo has informational disposition codes in its status array
AND The system processes status information codes that do not affect cargo movement
THEN:
- • The system records informational status updates for tracking and reporting purposes without altering cargo processing workflow or hold/release states
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo has multiple hold conditions identified from disposition code analysis.
Trigger Criteria:
- Context: A cargo has multiple hold conditions identified from disposition code analysis
- Applied to: Set Final Hold Status
- Action: The system applies hold priority rules considering FDA holds, border holds, destination holds, and piece count holds
Logic Flow:
IF A cargo has multiple hold conditions identified from disposition code analysis
AND The system applies hold priority rules considering FDA holds, border holds, destination holds, and piece count holds
THEN:
- • The system sets the highest priority hold status (FDA > Border > Destination > Piece Count) and updates cargo status accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has release disposition codes and no overriding hold conditions.
Trigger Criteria:
- Context: A cargo has release disposition codes and no overriding hold conditions
- Applied to: Set Final Release Status
- Action: The system validates release quantities match cargo quantities and all release requirements are satisfied
Logic Flow:
IF A cargo has release disposition codes and no overriding hold conditions
AND The system validates release quantities match cargo quantities and all release requirements are satisfied
THEN:
- • The system sets released status, updates release quantities, and enables cargo for movement processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo has proceed disposition codes and meets movement authorization requirements.
Trigger Criteria:
- Context: A cargo has proceed disposition codes and meets movement authorization requirements
- Applied to: Set Final Proceed Status
- Action: The system validates proceed conditions and ensures no conflicting holds prevent movement
Logic Flow:
IF A cargo has proceed disposition codes and meets movement authorization requirements
AND The system validates proceed conditions and ensures no conflicting holds prevent movement
THEN:
- • The system sets proceed status, authorizes cargo movement, and maintains compliance tracking for in-transit cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo has arrival disposition codes with validated destination and arrival date information.
Trigger Criteria:
- Context: A cargo has arrival disposition codes with validated destination and arrival date information
- Applied to: Set Final Arrival Status
- Action: The system confirms cargo arrival at destination location and completes arrival validation
Logic Flow:
IF A cargo has arrival disposition codes with validated destination and arrival date information
AND The system confirms cargo arrival at destination location and completes arrival validation
THEN:
- • The system sets arrival status, records final arrival date and location, and triggers destination processing workflows
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has export disposition codes and meets all export regulatory requirements.
Trigger Criteria:
- Context: A cargo has export disposition codes and meets all export regulatory requirements
- Applied to: Set Final Export Status
- Action: The system validates export documentation and compliance with international trade regulations
Logic Flow:
IF A cargo has export disposition codes and meets all export regulatory requirements
AND The system validates export documentation and compliance with international trade regulations
THEN:
- • The system sets export status, clears domestic processing requirements, and enables international shipment processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when system has determined final cargo status through disposition code evaluation.
Trigger Criteria:
- Context: The system has determined final cargo status through disposition code evaluation
- Applied to: Update Cargo Status Flags
- Action: The system updates cargo records with new status flags and processing indicators
Logic Flow:
IF The system has determined final cargo status through disposition code evaluation
AND The system updates cargo records with new status flags and processing indicators
THEN:
- • The system commits status changes to cargo database, updates status timestamps, and triggers downstream processing notifications
R-GCX016E-cbl-00854 (+10) File: GCX016E.cbl Business Rule: Canadian Manifest Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when us cargo record exists with equipment information.
Trigger Criteria:
- Context: A US cargo record exists with equipment information
- Applied to: Extract Equipment ID from US Cargo
- Action: Canadian manifest processing is initiated
Logic Flow:
IF A US cargo record exists with equipment information
AND Canadian manifest processing is initiated
THEN:
- • Equipment ID is extracted and formatted for Canadian cargo database search
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment id has been extracted from us cargo.
Trigger Criteria:
- Context: Equipment ID has been extracted from US cargo
- Applied to: Search Canadian Cargo Database
- Action: Canadian cargo database search is performed
Logic Flow:
IF Equipment ID has been extracted from US cargo
AND Canadian cargo database search is performed
THEN:
- • System searches GCCC-CARGO-ROOT database for matching Canadian cargo records by equipment ID
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when canadian cargo database search has been performed.
Trigger Criteria:
- Context: Canadian cargo database search has been performed
- Applied to: Canadian Cargo Found?
- Action: Search results are evaluated
Logic Flow:
IF Canadian cargo database search has been performed
AND Search results are evaluated
THEN:
- • System determines if Canadian cargo record exists and routes processing accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when canadian cargo database search has been performed.
Trigger Criteria:
- Context: Canadian cargo database search has been performed
- Applied to: No Canadian Match Found
- Action: No matching Canadian cargo is found
Logic Flow:
IF Canadian cargo database search has been performed
AND No matching Canadian cargo is found
THEN:
- • System processes the no match condition and continues with standard processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when canadian cargo record has been found.
Trigger Criteria:
- Context: Canadian cargo record has been found
- Applied to: Validate Canadian Cargo Status
- Action: Cargo status is evaluated
Logic Flow:
IF Canadian cargo record has been found
AND Cargo status is evaluated
THEN:
- • System reads and validates the Canadian cargo status from GCCC database
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when canadian cargo status has been retrieved.
Trigger Criteria:
- Context: Canadian cargo status has been retrieved
- Applied to: Status Valid?
- Action: Status validity is checked
Logic Flow:
IF Canadian cargo status has been retrieved
AND Status validity is checked
THEN:
- • System excludes cargos with deleted status or new bond created status and allows valid statuses to proceed
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when canadian cargo has valid status for processing.
Trigger Criteria:
- Context: Canadian cargo has valid status for processing
- Applied to: Create Cross-Border Audit Trail
- Action: Cross-border audit trail creation is initiated
Logic Flow:
IF Canadian cargo has valid status for processing
AND Cross-border audit trail creation is initiated
THEN:
- • System creates audit record linking US and Canadian manifest information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid canadian cargo has been found and audit trail created.
Trigger Criteria:
- Context: Valid Canadian cargo has been found and audit trail created
- Applied to: Match Equipment IDs Between Systems
- Action: Equipment ID matching is performed
Logic Flow:
IF Valid Canadian cargo has been found and audit trail created
AND Equipment ID matching is performed
THEN:
- • System matches car ID number index between US and Canadian cargo records
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment ids have been successfully matched between systems.
Trigger Criteria:
- Context: Equipment IDs have been successfully matched between systems
- Applied to: Update Cargo Processing Status
- Action: Status update is performed
Logic Flow:
IF Equipment IDs have been successfully matched between systems
AND Status update is performed
THEN:
- • System updates cargo processing status to indicate Canadian manifest match completion
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when canadian manifest matching has been completed successfully.
Trigger Criteria:
- Context: Canadian manifest matching has been completed successfully
- Applied to: Log Canadian Manifest Match
- Action: Logging is performed
Logic Flow:
IF Canadian manifest matching has been completed successfully
AND Logging is performed
THEN:
- • System logs the successful Canadian manifest match with relevant details
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when either no canadian cargo was found or canadian cargo has invalid status.
Trigger Criteria:
- Context: Either no Canadian cargo was found or Canadian cargo has invalid status
- Applied to: Log No Match Status
- Action: No match logging is performed
Logic Flow:
IF Either no Canadian cargo was found or Canadian cargo has invalid status
AND No match logging is performed
THEN:
- • System logs the no match status with appropriate reason code
R-GCX016E-cbl-00865 (+19) File: GCX016E.cbl Business Rule: Cargo Status Preservation and Restoration
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record exists with current status information.
Trigger Criteria:
- Context: A cargo record exists with current status information
- Applied to: Save Current Cargo Status
- Action: The system initiates cargo status processing
Logic Flow:
IF A cargo record exists with current status information
AND The system initiates cargo status processing
THEN:
- • The current cargo status is saved to a backup location for potential restoration
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record exists with current status information.
Trigger Criteria:
- Context: A cargo record exists with current status information
- Applied to: Save Current Cargo Status
- Action: The system begins cargo status processing
Logic Flow:
IF A cargo record exists with current status information
AND The system begins cargo status processing
THEN:
- • The current cargo status is saved to backup storage for potential restoration
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status information exists in the system.
Trigger Criteria:
- Context: Cargo status information exists in the system
- Applied to: Store Previous Status Information
- Action: Status preservation process is executed
Logic Flow:
IF Cargo status information exists in the system
AND Status preservation process is executed
THEN:
- • Previous status information including codes, quantities, and dates is stored in designated storage areas
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status is being modified.
Trigger Criteria:
- Context: Cargo status is being modified
- Applied to: Create Audit Trail Entry
- Action: An audit trail entry is required
Logic Flow:
IF Cargo status is being modified
AND An audit trail entry is required
THEN:
- • A complete audit record is created with timestamp, user information, and status change details
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo status updates are pending.
Trigger Criteria:
- Context: Cargo status updates are pending
- Applied to: Process Status Updates
- Action: Status processing is initiated
Logic Flow:
IF Cargo status updates are pending
AND Status processing is initiated
THEN:
- • All status updates are processed according to disposition code rules and status hierarchy
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status updates have been processed.
Trigger Criteria:
- Context: Cargo status updates have been processed
- Applied to: Update Successful?
- Action: The system evaluates update completion
Logic Flow:
IF Cargo status updates have been processed
AND The system evaluates update completion
THEN:
- • The system determines if updates were successful based on validation criteria and error conditions
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo status updates have been validated as successful.
Trigger Criteria:
- Context: Cargo status updates have been validated as successful
- Applied to: Commit New Status
- Action: The commit process is executed
Logic Flow:
IF Cargo status updates have been validated as successful
AND The commit process is executed
THEN:
- • The new cargo status is permanently saved and becomes the current active status
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo status updates have failed validation.
Trigger Criteria:
- Context: Cargo status updates have failed validation
- Applied to: Restore Previous Status
- Action: Status restoration is required
Logic Flow:
IF Cargo status updates have failed validation
AND Status restoration is required
THEN:
- • The cargo status is restored to its previous state using saved backup information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo status restoration has occurred.
Trigger Criteria:
- Context: A cargo status restoration has occurred
- Applied to: Log Restoration Action
- Action: Logging is performed
Logic Flow:
IF A cargo status restoration has occurred
AND Logging is performed
THEN:
- • The restoration action is logged with details about the reason and previous status information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo status has been successfully updated.
Trigger Criteria:
- Context: Cargo status has been successfully updated
- Applied to: Enable Status Comparison
- Action: Status comparison is requested
Logic Flow:
IF Cargo status has been successfully updated
AND Status comparison is requested
THEN:
- • The system provides capability to compare current status with previous status information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo status preservation process is active.
Trigger Criteria:
- Context: Cargo status preservation process is active
- Applied to: Maintain Data Integrity
- Action: Data integrity checks are performed
Logic Flow:
IF Cargo status preservation process is active
AND Data integrity checks are performed
THEN:
- • All cargo data remains consistent and valid throughout the preservation process
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when current cargo status has been backed up.
Trigger Criteria:
- Context: Current cargo status has been backed up
- Applied to: Store Previous Status Information
- Action: The system prepares for status updates
Logic Flow:
IF Current cargo status has been backed up
AND The system prepares for status updates
THEN:
- • Previous status information including dates and codes is stored in audit storage
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status updates have been attempted.
Trigger Criteria:
- Context: Cargo status updates have been attempted
- Applied to: Status Update Successful?
- Action: The system evaluates the update results
Logic Flow:
IF Cargo status updates have been attempted
AND The system evaluates the update results
THEN:
- • The system determines if updates were successful based on completion codes and data validation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo status updates completed successfully.
Trigger Criteria:
- Context: Cargo status updates completed successfully
- Applied to: Maintain Updated Status
- Action: The system confirms successful update validation
Logic Flow:
IF Cargo status updates completed successfully
AND The system confirms successful update validation
THEN:
- • The updated cargo status is maintained and processing continues normally
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo status updates are in progress.
Trigger Criteria:
- Context: Cargo status updates are in progress
- Applied to: Error Detected During Update
- Action: An error or failure occurs during the update process
Logic Flow:
IF Cargo status updates are in progress
AND An error or failure occurs during the update process
THEN:
- • The system detects the error condition and initiates error handling procedures
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when error has been detected during cargo status updates and previous status backup exists.
Trigger Criteria:
- Context: An error has been detected during cargo status updates and previous status backup exists
- Applied to: Restore Previous Cargo Status
- Action: The system initiates error recovery procedures
Logic Flow:
IF An error has been detected during cargo status updates and previous status backup exists
AND The system initiates error recovery procedures
THEN:
- • The cargo status is restored to its previous state from backup storage
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when previous cargo status has been restored from backup.
Trigger Criteria:
- Context: Previous cargo status has been restored from backup
- Applied to: Rollback Status Changes
- Action: The system performs rollback operations
Logic Flow:
IF Previous cargo status has been restored from backup
AND The system performs rollback operations
THEN:
- • All status changes made during the failed update are reversed and data consistency is maintained
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status rollback operations have been completed.
Trigger Criteria:
- Context: Status rollback operations have been completed
- Applied to: Log Status Restoration Event
- Action: The system finalizes the restoration process
Logic Flow:
IF Status rollback operations have been completed
AND The system finalizes the restoration process
THEN:
- • A status restoration event is logged with timestamp, cargo identifier, and restoration details
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status processing has completed either successfully or through error recovery.
Trigger Criteria:
- Context: Status processing has completed either successfully or through error recovery
- Applied to: Maintain Data Integrity
- Action: The system validates final data state
Logic Flow:
IF Status processing has completed either successfully or through error recovery
AND The system validates final data state
THEN:
- • Data integrity is confirmed and cargo information remains consistent across all related records
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when status restoration has been completed due to update errors.
Trigger Criteria:
- Context: Status restoration has been completed due to update errors
- Applied to: Generate Error Notification
- Action: The system generates error notifications
Logic Flow:
IF Status restoration has been completed due to update errors
AND The system generates error notifications
THEN:
- • Error notifications are created with cargo details, error description, and recovery actions taken
R-GCX016E-cbl-00875 (+14) File: GCX016E.cbl Business Rule: Cancel Release Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo disposition code indicates release cancellation.
Trigger Criteria:
- Context: A cargo disposition code indicates release cancellation
- Applied to: Cancel Release Processing Triggered
- Action: The system processes the cancellation disposition code
Logic Flow:
IF A cargo disposition code indicates release cancellation
AND The system processes the cancellation disposition code
THEN:
- • Cancel release processing workflow is initiated
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record exists with status information in s09a arrays.
Trigger Criteria:
- Context: A cargo record exists with status information in S09A arrays
- Applied to: Analyze Current Cargo Status
- Action: Cancel release processing begins
Logic Flow:
IF A cargo record exists with status information in S09A arrays
AND Cancel release processing begins
THEN:
- • The system reads and analyzes current cargo status from status arrays
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when current cargo status is available and previous status exists in audit records.
Trigger Criteria:
- Context: Current cargo status is available and previous status exists in audit records
- Applied to: Compare Previous Release Status
- Action: Status comparison is performed
Logic Flow:
IF Current cargo status is available and previous status exists in audit records
AND Status comparison is performed
THEN:
- • The system identifies differences between current and previous release status
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo status history is available for comparison.
Trigger Criteria:
- Context: Cargo status history is available for comparison
- Applied to: Was Cargo Previously Released?
- Action: The system checks previous release status
Logic Flow:
IF Cargo status history is available for comparison
AND The system checks previous release status
THEN:
- • If cargo was previously released, proceed with cancellation processing,
otherwise skip processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo was previously in released status.
Trigger Criteria:
- Context: Cargo was previously in released status
- Applied to: Detect Release Cancellation
- Action: Current status indicates release cancellation
Logic Flow:
IF Cargo was previously in released status
AND Current status indicates release cancellation
THEN:
- • The system detects and confirms release cancellation event
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when release cancellation has been detected.
Trigger Criteria:
- Context: Release cancellation has been detected
- Applied to: Preserve Previous Status for Audit
- Action: Processing the cancellation event
Logic Flow:
IF Release cancellation has been detected
AND Processing the cancellation event
THEN:
- • The system preserves previous status information in audit records
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when release cancellation has been confirmed and previous status preserved.
Trigger Criteria:
- Context: Release cancellation has been confirmed and previous status preserved
- Applied to: Generate Cancel Release Notification
- Action: Notification generation is triggered
Logic Flow:
IF Release cancellation has been confirmed and previous status preserved
AND Notification generation is triggered
THEN:
- • The system creates a cancel release notification message
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cancel release notification needs to be generated.
Trigger Criteria:
- Context: Cancel release notification needs to be generated
- Applied to: Format Notification Message
- Action: Message formatting process begins
Logic Flow:
IF Cancel release notification needs to be generated
AND Message formatting process begins
THEN:
- • The system formats notification message with proper structure and headers
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when notification message is being formatted.
Trigger Criteria:
- Context: Notification message is being formatted
- Applied to: Include Cargo Details in Message
- Action: Cargo details are added to the message
Logic Flow:
IF Notification message is being formatted
AND Cargo details are added to the message
THEN:
- • The system includes cargo CCN, car ID, waybill number, and quantity information in the notification
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when notification message contains cargo details.
Trigger Criteria:
- Context: Notification message contains cargo details
- Applied to: Add Disposition Code Information
- Action: Disposition code information is added
Logic Flow:
IF Notification message contains cargo details
AND Disposition code information is added
THEN:
- • The system includes disposition code, entry number, and related processing information in the message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cancel release notification message is formatted with cargo and disposition details.
Trigger Criteria:
- Context: Cancel release notification message is formatted with cargo and disposition details
- Applied to: Set Notification Type as UNRLSE
- Action: Message type classification is performed
Logic Flow:
IF Cancel release notification message is formatted with cargo and disposition details
AND Message type classification is performed
THEN:
- • The system sets notification type as UNRLSE for cancel release processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cancel release notification is formatted and classified as unrlse type.
Trigger Criteria:
- Context: Cancel release notification is formatted and classified as UNRLSE type
- Applied to: Route to Merlin Message Distribution
- Action: Message routing is initiated
Logic Flow:
IF Cancel release notification is formatted and classified as UNRLSE type
AND Message routing is initiated
THEN:
- • The system routes notification to Merlin message distribution system
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cancel release notification is routed through merlin distribution.
Trigger Criteria:
- Context: Cancel release notification is routed through Merlin distribution
- Applied to: Send to Business Recipients
- Action: Recipient delivery is processed
Logic Flow:
IF Cancel release notification is routed through Merlin distribution
AND Recipient delivery is processed
THEN:
- • The system sends notification to OM01247 and SD segment cancel Merlin IDs
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cancel release notification has been sent to business recipients.
Trigger Criteria:
- Context: Cancel release notification has been sent to business recipients
- Applied to: Log Cancel Release Action
- Action: Action logging is performed
Logic Flow:
IF Cancel release notification has been sent to business recipients
AND Action logging is performed
THEN:
- • The system logs cancel release action with timestamp and recipient information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cancel release processing is complete and action is logged.
Trigger Criteria:
- Context: Cancel release processing is complete and action is logged
- Applied to: Update Cargo Status Arrays
- Action: Status array update is performed
Logic Flow:
IF Cancel release processing is complete and action is logged
AND Status array update is performed
THEN:
- • The system updates S09A status arrays to reflect cancel release status and removes previous release indicators
R-GCX016E-cbl-00890 (+15) File: GCX016E.cbl Business Rule: Destination Index Management
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo is being processed for arrival at its destination.
Trigger Criteria:
- Context: A cargo is being processed for arrival at its destination
- Applied to: Clear Bond Start Dates
- Action: The arrival processing is initiated
Logic Flow:
IF A cargo is being processed for arrival at its destination
AND The arrival processing is initiated
THEN:
- • All bond start dates are cleared from the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo is arriving at a destination location.
Trigger Criteria:
- Context: A cargo is arriving at a destination location
- Applied to: Set Arrival Index
- Action: The arrival index needs to be established
Logic Flow:
IF A cargo is arriving at a destination location
AND The arrival index needs to be established
THEN:
- • The destination index is set to the current arrival location
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has an established arrival date.
Trigger Criteria:
- Context: A cargo has an established arrival date
- Applied to: Calculate Cargo Age from Arrival Date
- Action: Cargo age calculation is required
Logic Flow:
IF A cargo has an established arrival date
AND Cargo age calculation is required
THEN:
- • The system calculates the number of days between arrival date and current date
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo has successfully arrived at its destination.
Trigger Criteria:
- Context: A cargo has successfully arrived at its destination
- Applied to: Update Arrival Status Flags
- Action: Arrival processing is being completed
Logic Flow:
IF A cargo has successfully arrived at its destination
AND Arrival processing is being completed
THEN:
- • All relevant arrival status flags are updated to indicate completed arrival
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo arrival process is being finalized.
Trigger Criteria:
- Context: A cargo arrival process is being finalized
- Applied to: Record Arrival Timestamp
- Action: The arrival timestamp needs to be recorded
Logic Flow:
IF A cargo arrival process is being finalized
AND The arrival timestamp needs to be recorded
THEN:
- • The current date and time is stored as the official arrival timestamp
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo is being processed for export.
Trigger Criteria:
- Context: A cargo is being processed for export
- Applied to: Clear Destination Index
- Action: Export processing is initiated
Logic Flow:
IF A cargo is being processed for export
AND Export processing is initiated
THEN:
- • The destination index is cleared from the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo is undergoing export processing.
Trigger Criteria:
- Context: A cargo is undergoing export processing
- Applied to: Reset Export Processing Flags
- Action: Export flags need to be reset
Logic Flow:
IF A cargo is undergoing export processing
AND Export flags need to be reset
THEN:
- • All export processing flags are reset to their initial state
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo is being exported.
Trigger Criteria:
- Context: A cargo is being exported
- Applied to: Update Export Status
- Action: Export status update is required
Logic Flow:
IF A cargo is being exported
AND Export status update is required
THEN:
- • The cargo status is updated to indicate export processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo export process is being reset or completed.
Trigger Criteria:
- Context: A cargo export process is being reset or completed
- Applied to: Clear Export-Related Dates
- Action: Export-related dates need to be cleared
Logic Flow:
IF A cargo export process is being reset or completed
AND Export-related dates need to be cleared
THEN:
- • All export-related date fields are cleared from the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo requires bond information restoration.
Trigger Criteria:
- Context: A cargo requires bond information restoration
- Applied to: Restore Bond Information
- Action: Bond restoration process is initiated
Logic Flow:
IF A cargo requires bond information restoration
AND Bond restoration process is initiated
THEN:
- • All previously saved bond information is restored to the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when bond information has been restored for a cargo.
Trigger Criteria:
- Context: Bond information has been restored for a cargo
- Applied to: Recalculate Cargo Age
- Action: Cargo age recalculation is required
Logic Flow:
IF Bond information has been restored for a cargo
AND Cargo age recalculation is required
THEN:
- • The system recalculates cargo age using the restored bond start dates
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when bond information has been restored for a cargo.
Trigger Criteria:
- Context: Bond information has been restored for a cargo
- Applied to: Update Bond Status Flags
- Action: Bond status flags need updating
Logic Flow:
IF Bond information has been restored for a cargo
AND Bond status flags need updating
THEN:
- • All bond status flags are updated to reflect the restored bond state
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo is undergoing bond restoration.
Trigger Criteria:
- Context: A cargo is undergoing bond restoration
- Applied to: Reset Bond Start Dates
- Action: Bond start dates need to be reset
Logic Flow:
IF A cargo is undergoing bond restoration
AND Bond start dates need to be reset
THEN:
- • All bond start dates are reset to their previously saved values
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo requires complete bond state restoration.
Trigger Criteria:
- Context: A cargo requires complete bond state restoration
- Applied to: Restore Previous Bond State
- Action: Previous bond state restoration is initiated
Logic Flow:
IF A cargo requires complete bond state restoration
AND Previous bond state restoration is initiated
THEN:
- • The cargo is restored to its complete previous bonded state with all associated attributes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when destination index management processing has been completed.
Trigger Criteria:
- Context: Destination index management processing has been completed
- Applied to: Update Cargo Record
- Action: Cargo record update is required
Logic Flow:
IF Destination index management processing has been completed
AND Cargo record update is required
THEN:
- • All index management changes are saved to the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when destination index management has been completed.
Trigger Criteria:
- Context: Destination index management has been completed
- Applied to: Trigger Status Updates
- Action: Dependent status updates are required
Logic Flow:
IF Destination index management has been completed
AND Dependent status updates are required
THEN:
- • All related status update processes are triggered
R-GCX016E-cbl-00906 (+15) File: GCX016E.cbl Business Rule: Cargo Record Replacement
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo needs status update processing.
Trigger Criteria:
- Context: A cargo needs status update processing
- Applied to: Retrieve Current Cargo Record
- Action: The system initiates cargo record replacement process
Logic Flow:
IF A cargo needs status update processing
AND The system initiates cargo record replacement process
THEN:
- • The current cargo record is retrieved from the US Cargo Root Segments database
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record has been retrieved and disposition codes have been processed.
Trigger Criteria:
- Context: Cargo record has been retrieved and disposition codes have been processed
- Applied to: Update Cargo Status Changes
- Action: Status changes need to be applied to the cargo record
Logic Flow:
IF Cargo record has been retrieved and disposition codes have been processed
AND Status changes need to be applied to the cargo record
THEN:
- • The cargo status fields are updated with new status information including hold flags, release quantities, and arrival dates
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when n7 equipment segment data is available with car initial and number.
Trigger Criteria:
- Context: N7 equipment segment data is available with car initial and number
- Applied to: Format Car ID Information
- Action: Car ID information needs to be formatted for cargo record
Logic Flow:
IF N7 equipment segment data is available with car initial and number
AND Car ID information needs to be formatted for cargo record
THEN:
- • The car initial and number are combined and formatted into a standardized car ID format
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record is being processed for car id updates.
Trigger Criteria:
- Context: A cargo record is being processed for car ID updates
- Applied to: CPRS Cargo?
- Action: The system checks if the cargo is CPRS type
Logic Flow:
IF A cargo record is being processed for car ID updates
AND The system checks if the cargo is CPRS type
THEN:
- • If cargo is CPRS type, car ID updates are skipped; if non-CPRS, car ID is updated with equipment information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo is determined to be non-cprs type and car id information is formatted.
Trigger Criteria:
- Context: Cargo is determined to be non-CPRS type and car ID information is formatted
- Applied to: Update Car ID for Non-CPRS
- Action: Car ID update is required for the cargo record
Logic Flow:
IF Cargo is determined to be non-CPRS type and car ID information is formatted
AND Car ID update is required for the cargo record
THEN:
- • The cargo record car ID fields are updated with the formatted car identification information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo is determined to be cprs type.
Trigger Criteria:
- Context: Cargo is determined to be CPRS type
- Applied to: Skip Car ID Update for CPRS
- Action: Car ID update processing is initiated
Logic Flow:
IF Cargo is determined to be CPRS type
AND Car ID update processing is initiated
THEN:
- • The car ID update is bypassed and existing car ID information remains unchanged
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record has been updated with new status and car id information.
Trigger Criteria:
- Context: Cargo record has been updated with new status and car ID information
- Applied to: Replace Cargo Record in Database
- Action: Database update is required to persist changes
Logic Flow:
IF Cargo record has been updated with new status and car ID information
AND Database update is required to persist changes
THEN:
- • The existing cargo record in US Cargo Root Segments database is replaced with the updated record
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record has been updated in the database.
Trigger Criteria:
- Context: Cargo record has been updated in the database
- Applied to: Validate Equipment Type
- Action: GCCIIS integration is being considered
Logic Flow:
IF Cargo record has been updated in the database
AND GCCIIS integration is being considered
THEN:
- • The system checks if the equipment type is valid for GCCIIS processing (containers, trailers, chassis, etc.)
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment type validation has been performed.
Trigger Criteria:
- Context: Equipment type validation has been performed
- Applied to: Valid Equipment Type?
- Action: Decision is needed for GCCIIS integration
Logic Flow:
IF Equipment type validation has been performed
AND Decision is needed for GCCIIS integration
THEN:
- • If equipment type is valid, proceed with status mapping; if invalid, skip GCCIIS update
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment type is valid for gcciis and cargo has internal status.
Trigger Criteria:
- Context: Equipment type is valid for GCCIIS and cargo has internal status
- Applied to: Map Internal Status to GCCIIS Status
- Action: Status mapping is required for GCCIIS integration
Logic Flow:
IF Equipment type is valid for GCCIIS and cargo has internal status
AND Status mapping is required for GCCIIS integration
THEN:
- • Internal status codes (HOLD, RELEASE, PTT, PTT-EX) are mapped to corresponding GCCIIS status descriptions
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status has been mapped for gcciis and cargo has release quantity information.
Trigger Criteria:
- Context: Status has been mapped for GCCIIS and cargo has release quantity information
- Applied to: Release Quantity Check
- Action: Release status determination is needed for GCCIIS
Logic Flow:
IF Status has been mapped for GCCIIS and cargo has release quantity information
AND Release status determination is needed for GCCIIS
THEN:
- • If released quantity equals total quantity, send full release; if released quantity is less than total, send hold status
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when release quantity equals total quantity and status is mapped.
Trigger Criteria:
- Context: Release quantity equals total quantity and status is mapped
- Applied to: Send Full Release to GCCIIS
- Action: GCCIIS notification is required for full release
Logic Flow:
IF Release quantity equals total quantity and status is mapped
AND GCCIIS notification is required for full release
THEN:
- • A full release status is sent to GCCIIS equipment tracking system with cargo and equipment details
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when released quantity is less than total quantity or cargo is held.
Trigger Criteria:
- Context: Released quantity is less than total quantity or cargo is held
- Applied to: Send Hold Status to GCCIIS
- Action: GCCIIS notification is required for hold status
Logic Flow:
IF Released quantity is less than total quantity or cargo is held
AND GCCIIS notification is required for hold status
THEN:
- • A hold status is sent to GCCIIS equipment tracking system with cargo and equipment details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment type is invalid for gcciis or status conditions exclude gcciis processing.
Trigger Criteria:
- Context: Equipment type is invalid for GCCIIS or status conditions exclude GCCIIS processing
- Applied to: Skip GCCIIS Update
- Action: GCCIIS integration decision is made
Logic Flow:
IF Equipment type is invalid for GCCIIS or status conditions exclude GCCIIS processing
AND GCCIIS integration decision is made
THEN:
- • GCCIIS update is skipped and processing continues without equipment tracking system notification
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo status updates and gcciis notifications have been processed.
Trigger Criteria:
- Context: Cargo status updates and GCCIIS notifications have been processed
- Applied to: Log Status Update Action
- Action: Action logging is required for audit trail
Logic Flow:
IF Cargo status updates and GCCIIS notifications have been processed
AND Action logging is required for audit trail
THEN:
- • The status update actions are logged with cargo details, status changes, and processing results
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when primary cargo record has been updated and logged.
Trigger Criteria:
- Context: Primary cargo record has been updated and logged
- Applied to: Update Multi-Cargo Records with Same Car/Waybill
- Action: Multiple cargos exist with the same car ID and waybill combination
Logic Flow:
IF Primary cargo record has been updated and logged
AND Multiple cargos exist with the same car ID and waybill combination
THEN:
- • All related cargo records with matching car ID and waybill are updated with consistent status information
R-GCX016E-cbl-00941 (+17) File: GCX016E.cbl Business Rule: Individual Cargo Analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record exists in the system.
Trigger Criteria:
- Context: A cargo record exists in the system
- Applied to: Check Cargo Deletion Status
- Action: The system checks the cargo deletion status flag
Logic Flow:
IF A cargo record exists in the system
AND The system checks the cargo deletion status flag
THEN:
- • The cargo is identified as either deleted or active based on the deletion status indicator
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record has been verified as deleted.
Trigger Criteria:
- Context: A cargo record has been verified as deleted
- Applied to: Mark as Deleted Cargo
- Action: The deletion status check confirms the cargo is deleted
Logic Flow:
IF A cargo record has been verified as deleted
AND The deletion status check confirms the cargo is deleted
THEN:
- • The cargo is marked with deleted status and processing terminates for this cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when active cargo record exists in the system.
Trigger Criteria:
- Context: An active cargo record exists in the system
- Applied to: Check Manual Release Status
- Action: The system analyzes the cargo's release status indicators
Logic Flow:
IF An active cargo record exists in the system
AND The system analyzes the cargo's release status indicators
THEN:
- • The cargo is classified as either having manual release or no manual release based on release status flags
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record shows manual release indicators.
Trigger Criteria:
- Context: A cargo record shows manual release indicators
- Applied to: Identify Manual Release
- Action: Manual release status is confirmed through status analysis
Logic Flow:
IF A cargo record shows manual release indicators
AND Manual release status is confirmed through status analysis
THEN:
- • The cargo is flagged as manually released for subsequent processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record exists with potential hold conditions.
Trigger Criteria:
- Context: A cargo record exists with potential hold conditions
- Applied to: Analyze Hold Status Types
- Action: The system evaluates all hold status indicators
Logic Flow:
IF A cargo record exists with potential hold conditions
AND The system evaluates all hold status indicators
THEN:
- • The system identifies and categorizes each type of hold (border, destination, FDA, piece count, custom) applied to the cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record requires hold status analysis.
Trigger Criteria:
- Context: A cargo record requires hold status analysis
- Applied to: Border Hold Analysis
- Action: The system examines border hold indicators and related status codes
Logic Flow:
IF A cargo record requires hold status analysis
AND The system examines border hold indicators and related status codes
THEN:
- • The cargo is classified as either having border hold conditions or being clear of border holds
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record requires hold status analysis.
Trigger Criteria:
- Context: A cargo record requires hold status analysis
- Applied to: Destination Hold Analysis
- Action: The system examines destination hold indicators and location-specific restrictions
Logic Flow:
IF A cargo record requires hold status analysis
AND The system examines destination hold indicators and location-specific restrictions
THEN:
- • The cargo is classified as either having destination hold conditions or being clear for destination processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record requires hold status analysis.
Trigger Criteria:
- Context: A cargo record requires hold status analysis
- Applied to: FDA Hold Analysis
- Action: The system examines FDA hold indicators and regulatory compliance status
Logic Flow:
IF A cargo record requires hold status analysis
AND The system examines FDA hold indicators and regulatory compliance status
THEN:
- • The cargo is classified as either having FDA hold conditions or being compliant for FDA processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record requires hold status analysis.
Trigger Criteria:
- Context: A cargo record requires hold status analysis
- Applied to: Piece Count Hold Analysis
- Action: The system examines piece count hold indicators and quantity validation results
Logic Flow:
IF A cargo record requires hold status analysis
AND The system examines piece count hold indicators and quantity validation results
THEN:
- • The cargo is classified as either having piece count hold conditions or having accurate piece counts
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record requires hold status analysis.
Trigger Criteria:
- Context: A cargo record requires hold status analysis
- Applied to: Custom Hold Analysis
- Action: The system examines custom hold indicators and customs processing status
Logic Flow:
IF A cargo record requires hold status analysis
AND The system examines custom hold indicators and customs processing status
THEN:
- • The cargo is classified as either having custom hold conditions or being clear for customs processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record has been analyzed for all hold types.
Trigger Criteria:
- Context: A cargo record has been analyzed for all hold types
- Applied to: Evaluate Release Eligibility
- Action: The system evaluates the combined impact of all hold conditions and release requirements
Logic Flow:
IF A cargo record has been analyzed for all hold types
AND The system evaluates the combined impact of all hold conditions and release requirements
THEN:
- • The cargo is determined to be either eligible for release or requiring continued hold status
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record has been determined eligible for release.
Trigger Criteria:
- Context: A cargo record has been determined eligible for release
- Applied to: Set Release Eligible Flag
- Action: All hold conditions have been cleared and release requirements are met
Logic Flow:
IF A cargo record has been determined eligible for release
AND All hold conditions have been cleared and release requirements are met
THEN:
- • The system sets the release eligible flag and prepares the cargo for release processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record has been determined to require continued hold status.
Trigger Criteria:
- Context: A cargo record has been determined to require continued hold status
- Applied to: Set Hold Required Flag
- Action: One or more hold conditions remain unresolved or new hold requirements are identified
Logic Flow:
IF A cargo record has been determined to require continued hold status
AND One or more hold conditions remain unresolved or new hold requirements are identified
THEN:
- • The system sets the hold required flag and maintains the cargo in hold status
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record has been processed for individual analysis.
Trigger Criteria:
- Context: A cargo record has been processed for individual analysis
- Applied to: Check Multiple Records with Same Car/Waybill
- Action: The system searches for other cargo records with matching car ID and waybill number
Logic Flow:
IF A cargo record has been processed for individual analysis
AND The system searches for other cargo records with matching car ID and waybill number
THEN:
- • The system determines if the cargo is part of a single record or multiple records with the same car/waybill combination
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when multiple cargo records exist with the same car id and waybill number.
Trigger Criteria:
- Context: Multiple cargo records exist with the same car ID and waybill number
- Applied to: Analyze All Related Records
- Action: The system processes each related cargo record for status and hold conditions
Logic Flow:
IF Multiple cargo records exist with the same car ID and waybill number
AND The system processes each related cargo record for status and hold conditions
THEN:
- • All related cargo records are analyzed collectively to determine the overall shipment status
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when individual cargo analysis is complete or all related records have been analyzed.
Trigger Criteria:
- Context: Individual cargo analysis is complete or all related records have been analyzed
- Applied to: Determine Overall Status
- Action: The system evaluates all status indicators, hold conditions, and release eligibility
Logic Flow:
IF Individual cargo analysis is complete or all related records have been analyzed
AND The system evaluates all status indicators, hold conditions, and release eligibility
THEN:
- • The system determines the overall status for the cargo or shipment based on the most restrictive conditions
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when overall status has been determined for the cargo or shipment.
Trigger Criteria:
- Context: The overall status has been determined for the cargo or shipment
- Applied to: Generate Status Summary
- Action: The system compiles all analysis results including hold types, release eligibility, and final status
Logic Flow:
IF The overall status has been determined for the cargo or shipment
AND The system compiles all analysis results including hold types, release eligibility, and final status
THEN:
- • A complete status summary is generated containing all relevant cargo analysis information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status summary has been generated for the cargo analysis.
Trigger Criteria:
- Context: A status summary has been generated for the cargo analysis
- Applied to: Update Cargo Analysis Results
- Action: The system processes the final analysis results
Logic Flow:
IF A status summary has been generated for the cargo analysis
AND The system processes the final analysis results
THEN:
- • The cargo records are updated with the new status information, hold flags, and release eligibility indicators
R-GCX016E-cbl-00959 (+12) File: GCX016E.cbl Business Rule: Release Notification Preparation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo release notification process is initiated.
Trigger Criteria:
- Context: A cargo release notification process is initiated
- Applied to: Verify Cargo Release Status
- Action: The system checks the cargo release status
Logic Flow:
IF A cargo release notification process is initiated
AND The system checks the cargo release status
THEN:
- • The system confirms cargo records are available and accessible for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when multiple cargo records exist with the same car id and waybill number.
Trigger Criteria:
- Context: Multiple cargo records exist with the same car ID and waybill number
- Applied to: All Records with Same Car/Waybill Released?
- Action: The system evaluates release status for notification preparation
Logic Flow:
IF Multiple cargo records exist with the same car ID and waybill number
AND The system evaluates release status for notification preparation
THEN:
- • All related cargo records must be in released status to continue with release notification,
otherwise the process terminates
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo records are confirmed as released.
Trigger Criteria:
- Context: Cargo records are confirmed as released
- Applied to: Calculate Release Quantities
- Action: The system prepares release notification details
Logic Flow:
IF Cargo records are confirmed as released
AND The system prepares release notification details
THEN:
- • The system calculates and formats the total released quantities for inclusion in the notification message
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment information exists in n7 segments.
Trigger Criteria:
- Context: Equipment information exists in N7 segments
- Applied to: Format Equipment Information
- Action: The system prepares release notification content
Logic Flow:
IF Equipment information exists in N7 segments
AND The system prepares release notification content
THEN:
- • The system formats car ID, equipment initial, and equipment number into standardized format for the notification message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code information exists in x4 segments.
Trigger Criteria:
- Context: Disposition code information exists in X4 segments
- Applied to: Format Disposition Code Details
- Action: The system prepares release notification content
Logic Flow:
IF Disposition code information exists in X4 segments
AND The system prepares release notification content
THEN:
- • The system formats disposition codes, entry numbers, and related cargo details for inclusion in the notification message
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when current system date and time are available.
Trigger Criteria:
- Context: Current system date and time are available
- Applied to: Format Date/Time Information
- Action: The system prepares release notification content
Logic Flow:
IF Current system date and time are available
AND The system prepares release notification content
THEN:
- • The system formats date and time in the required format for inclusion in the notification message
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when release quantities have been calculated.
Trigger Criteria:
- Context: Release quantities have been calculated
- Applied to: Include Release Quantity Impact
- Action: The system prepares the notification message content
Logic Flow:
IF Release quantities have been calculated
AND The system prepares the notification message content
THEN:
- • The system includes details about quantity changes and impact of the release action in the message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when quantity impact information has been prepared.
Trigger Criteria:
- Context: Quantity impact information has been prepared
- Applied to: Add Before/After Quantity Comparison
- Action: The system finalizes notification message content
Logic Flow:
IF Quantity impact information has been prepared
AND The system finalizes notification message content
THEN:
- • The system includes before and after quantity comparison data to show the effect of the release
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when k1 comment segments exist for the cargo.
Trigger Criteria:
- Context: K1 comment segments exist for the cargo
- Applied to: Include K1 Comment Messages
- Action: The system prepares comprehensive notification content
Logic Flow:
IF K1 comment segments exist for the cargo
AND The system prepares comprehensive notification content
THEN:
- • The system includes up to 4 lines of K1 segment comments in the notification message if available
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when special processing comments are available for the cargo.
Trigger Criteria:
- Context: Special processing comments are available for the cargo
- Applied to: Add Special Processing Comments
- Action: The system prepares detailed notification content
Logic Flow:
IF Special processing comments are available for the cargo
AND The system prepares detailed notification content
THEN:
- • The system includes up to 3 lines of special processing comments in the notification message if present
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all message components have been prepared including equipment info, disposition codes, quantities, and comments.
Trigger Criteria:
- Context: All message components have been prepared including equipment info, disposition codes, quantities, and comments
- Applied to: Format Comprehensive Release Message
- Action: The system creates the final notification message
Logic Flow:
IF All message components have been prepared including equipment info, disposition codes, quantities, and comments
AND The system creates the final notification message
THEN:
- • The system formats all components into a comprehensive release message with proper structure and formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when comprehensive release message has been formatted.
Trigger Criteria:
- Context: A comprehensive release message has been formatted
- Applied to: Set Message Type as RELEASE
- Action: The system finalizes message properties
Logic Flow:
IF A comprehensive release message has been formatted
AND The system finalizes message properties
THEN:
- • The system sets the message type indicator to RELEASE for proper routing and processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when complete release message with proper type assignment exists.
Trigger Criteria:
- Context: A complete release message with proper type assignment exists
- Applied to: Prepare Message for Distribution
- Action: The system prepares for message distribution
Logic Flow:
IF A complete release message with proper type assignment exists
AND The system prepares for message distribution
THEN:
- • The system readies the message for delivery through appropriate notification channels including Merlin routing and email systems
R-GCX016E-cbl-00972 (+16) File: GCX016E.cbl Business Rule: Export Notification Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record with current status and disposition codes.
Trigger Criteria:
- Context: A cargo record with current status and disposition codes
- Applied to: Cargo Export Status?
- Action: The system evaluates if export notification processing is required
Logic Flow:
IF A cargo record with current status and disposition codes
AND The system evaluates if export notification processing is required
THEN:
- • The system determines if cargo has export status and requires export notification processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo marked for export processing with associated port and routing information.
Trigger Criteria:
- Context: A cargo marked for export processing with associated port and routing information
- Applied to: Export Port Validated?
- Action: The system validates export conditions and port information
Logic Flow:
IF A cargo marked for export processing with associated port and routing information
AND The system validates export conditions and port information
THEN:
- • The system confirms if export port is valid and cargo meets export processing requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record with valid export conditions and existing destination index.
Trigger Criteria:
- Context: A cargo record with valid export conditions and existing destination index
- Applied to: Clear Destination Index
- Action: The cargo is being processed for export
Logic Flow:
IF A cargo record with valid export conditions and existing destination index
AND The cargo is being processed for export
THEN:
- • The system clears the destination index to remove domestic routing information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record that has passed export validation with cleared destination index.
Trigger Criteria:
- Context: A cargo record that has passed export validation with cleared destination index
- Applied to: Set Export Status Flag
- Action: The system processes the cargo for export
Logic Flow:
IF A cargo record that has passed export validation with cleared destination index
AND The system processes the cargo for export
THEN:
- • The system sets the export status flag to indicate export processing status
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo with export status flag set and current system date/time available.
Trigger Criteria:
- Context: A cargo with export status flag set and current system date/time available
- Applied to: Calculate Export Date/Time
- Action: The system calculates export timing information
Logic Flow:
IF A cargo with export status flag set and current system date/time available
AND The system calculates export timing information
THEN:
- • The system assigns appropriate export date and time to the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo with export status, date/time, and validated export conditions.
Trigger Criteria:
- Context: A cargo with export status, date/time, and validated export conditions
- Applied to: Prepare Export Notification Message
- Action: The system prepares export notification message
Logic Flow:
IF A cargo with export status, date/time, and validated export conditions
AND The system prepares export notification message
THEN:
- • The system creates message structure with header information for export notification
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when export notification message structure and cargo with associated equipment information.
Trigger Criteria:
- Context: An export notification message structure and cargo with associated equipment information
- Applied to: Format Equipment Information
- Action: The system formats equipment details for the export message
Logic Flow:
IF An export notification message structure and cargo with associated equipment information
AND The system formats equipment details for the export message
THEN:
- • The system includes formatted car ID, equipment type, and equipment details in the export notification
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when export notification message with equipment information and cargo record with complete details.
Trigger Criteria:
- Context: An export notification message with equipment information and cargo record with complete details
- Applied to: Format Cargo Details
- Action: The system formats cargo details for the export message
Logic Flow:
IF An export notification message with equipment information and cargo record with complete details
AND The system formats cargo details for the export message
THEN:
- • The system includes formatted CCN, waybill, origin, destination, and commodity information in the export notification
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when export notification message with cargo details and disposition code information from x4 segment.
Trigger Criteria:
- Context: An export notification message with cargo details and disposition code information from X4 segment
- Applied to: Format Disposition Code Information
- Action: The system formats disposition code information for the export message
Logic Flow:
IF An export notification message with cargo details and disposition code information from X4 segment
AND The system formats disposition code information for the export message
THEN:
- • The system includes formatted disposition code, entry numbers, and related processing information in the export notification
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when export notification message with disposition code information and cargo with release quantity data.
Trigger Criteria:
- Context: An export notification message with disposition code information and cargo with release quantity data
- Applied to: Add Release Quantity Information
- Action: The system adds release quantity information to the export message
Logic Flow:
IF An export notification message with disposition code information and cargo with release quantity data
AND The system adds release quantity information to the export message
THEN:
- • The system includes release quantities and quantity impact details in the export notification
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when complete export notification with all formatted information including equipment, cargo, disposition, and quantity details.
Trigger Criteria:
- Context: A complete export notification with all formatted information including equipment, cargo, disposition, and quantity details
- Applied to: Create Merlin Export Message
- Action: The system creates the Merlin export message
Logic Flow:
IF A complete export notification with all formatted information including equipment, cargo, disposition, and quantity details
AND The system creates the Merlin export message
THEN:
- • The system generates a complete Merlin export message with proper formatting and routing information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when complete merlin export message and equipment type information.
Trigger Criteria:
- Context: A complete Merlin export message and equipment type information
- Applied to: Route to Export Message Recipients
- Action: The system determines export message recipients
Logic Flow:
IF A complete Merlin export message and equipment type information
AND The system determines export message recipients
THEN:
- • The system routes the export notification to appropriate recipients based on equipment type and routing rules
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when routed export notification message with identified recipients.
Trigger Criteria:
- Context: A routed export notification message with identified recipients
- Applied to: Send Export Notification
- Action: The system sends the export notification
Logic Flow:
IF A routed export notification message with identified recipients
AND The system sends the export notification
THEN:
- • The system delivers the export notification message to all identified recipients
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when export notification that has been sent to recipients.
Trigger Criteria:
- Context: An export notification that has been sent to recipients
- Applied to: Delivery Successful?
- Action: The system checks delivery status
Logic Flow:
IF An export notification that has been sent to recipients
AND The system checks delivery status
THEN:
- • The system determines if the export notification was successfully delivered to all recipients
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when export notification that was successfully delivered to all recipients.
Trigger Criteria:
- Context: An export notification that was successfully delivered to all recipients
- Applied to: Log Export Notification Sent
- Action: The system logs the successful delivery
Logic Flow:
IF An export notification that was successfully delivered to all recipients
AND The system logs the successful delivery
THEN:
- • The system records export notification delivery success with timestamp and recipient information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when export notification that failed delivery to one or more recipients.
Trigger Criteria:
- Context: An export notification that failed delivery to one or more recipients
- Applied to: Handle Delivery Failure
- Action: The system handles the delivery failure
Logic Flow:
IF An export notification that failed delivery to one or more recipients
AND The system handles the delivery failure
THEN:
- • The system initiates failure handling procedures and prepares for alternative delivery methods
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when export notification with delivery failure and default recipient configuration.
Trigger Criteria:
- Context: An export notification with delivery failure and default recipient configuration
- Applied to: Reroute to Default Recipients
- Action: The system reroutes to default recipients
Logic Flow:
IF An export notification with delivery failure and default recipient configuration
AND The system reroutes to default recipients
THEN:
- • The system sends the export notification to default recipients (OM01247 and backup recipients) as fallback delivery
R-GCX016E-cbl-00989 (+21) File: GCX016E.cbl Business Rule: Arrival Notification Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has a disposition code in the message.
Trigger Criteria:
- Context: A cargo has a disposition code in the message
- Applied to: Arrival Disposition Code?
- Action: The system processes the disposition code
Logic Flow:
IF A cargo has a disposition code in the message
AND The system processes the disposition code
THEN:
- • The system identifies if it is POD (Proof of Delivery), AAD (Actual Arrival Date), or other arrival-related codes and proceeds with arrival processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has an arrival disposition code and location information.
Trigger Criteria:
- Context: A cargo has an arrival disposition code and location information
- Applied to: Validate Arrival Location
- Action: The system validates the arrival location
Logic Flow:
IF A cargo has an arrival disposition code and location information
AND The system validates the arrival location
THEN:
- • The system confirms the location is valid for arrival processing and matches cargo routing requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo has a validated arrival disposition code.
Trigger Criteria:
- Context: A cargo has a validated arrival disposition code
- Applied to: Set Arrival Status Flags
- Action: The system processes the arrival event
Logic Flow:
IF A cargo has a validated arrival disposition code
AND The system processes the arrival event
THEN:
- • The system sets arrival status flags including arrival date, arrival location, and arrival type indicators
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has arrived at its destination and has active bond start dates.
Trigger Criteria:
- Context: A cargo has arrived at its destination and has active bond start dates
- Applied to: Clear Bond Start Dates
- Action: The system processes the arrival event
Logic Flow:
IF A cargo has arrived at its destination and has active bond start dates
AND The system processes the arrival event
THEN:
- • The system clears the bond start dates to stop bond timing calculations
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has successfully arrived at a validated location.
Trigger Criteria:
- Context: A cargo has successfully arrived at a validated location
- Applied to: Set Arrival Index
- Action: The system processes the arrival event
Logic Flow:
IF A cargo has successfully arrived at a validated location
AND The system processes the arrival event
THEN:
- • The system sets the arrival index to reference the arrival location for future processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has arrival date and time information.
Trigger Criteria:
- Context: A cargo has arrival date and time information
- Applied to: Calculate Cargo Age
- Action: The system processes the arrival event
Logic Flow:
IF A cargo has arrival date and time information
AND The system processes the arrival event
THEN:
- • The system calculates the cargo age from entry date to arrival date for reporting and compliance purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo arrival is being processed.
Trigger Criteria:
- Context: A cargo arrival is being processed
- Applied to: Check Multi-Cargo Records
- Action: The system checks for related cargo records
Logic Flow:
IF A cargo arrival is being processed
AND The system checks for related cargo records
THEN:
- • The system identifies if there are multiple cargo records with the same car ID and waybill that require coordinated processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when multiple cargo records exist in the system.
Trigger Criteria:
- Context: Multiple cargo records exist in the system
- Applied to: Same Car/Waybill Records?
- Action: The system compares car ID and waybill information
Logic Flow:
IF Multiple cargo records exist in the system
AND The system compares car ID and waybill information
THEN:
- • The system identifies records with matching car ID and waybill numbers that require coordinated arrival processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when multiple cargo records share the same car id and waybill.
Trigger Criteria:
- Context: Multiple cargo records share the same car ID and waybill
- Applied to: Process All Related Records
- Action: An arrival event is processed for one record
Logic Flow:
IF Multiple cargo records share the same car ID and waybill
AND An arrival event is processed for one record
THEN:
- • The system processes arrival status for all related records with the same car ID and waybill
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when multiple related cargo records have been processed for arrival.
Trigger Criteria:
- Context: Multiple related cargo records have been processed for arrival
- Applied to: Verify Arrival Status Across Records
- Action: The system verifies arrival status consistency
Logic Flow:
IF Multiple related cargo records have been processed for arrival
AND The system verifies arrival status consistency
THEN:
- • The system ensures all related records have consistent arrival status and flags any discrepancies
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has successfully arrived and all validations are complete.
Trigger Criteria:
- Context: A cargo has successfully arrived and all validations are complete
- Applied to: Create Arrival Notification Message
- Action: The system creates arrival notification
Logic Flow:
IF A cargo has successfully arrived and all validations are complete
AND The system creates arrival notification
THEN:
- • The system generates a structured arrival notification message with all relevant cargo and arrival details
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when arrival notification message is being created.
Trigger Criteria:
- Context: An arrival notification message is being created
- Applied to: Format Arrival Details
- Action: The system formats arrival details
Logic Flow:
IF An arrival notification message is being created
AND The system formats arrival details
THEN:
- • The system formats cargo identification, arrival date/time, and status information into the standard notification format
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when arrival notification is being formatted.
Trigger Criteria:
- Context: An arrival notification is being formatted
- Applied to: Include Equipment Information
- Action: The system includes equipment information
Logic Flow:
IF An arrival notification is being formatted
AND The system includes equipment information
THEN:
- • The system adds car ID, equipment type, and equipment identification details to the notification message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when arrival notification is being formatted.
Trigger Criteria:
- Context: An arrival notification is being formatted
- Applied to: Include Location Information
- Action: The system includes location information
Logic Flow:
IF An arrival notification is being formatted
AND The system includes location information
THEN:
- • The system adds arrival location, destination details, and routing information to the notification message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when arrival notification is being formatted.
Trigger Criteria:
- Context: An arrival notification is being formatted
- Applied to: Include Date/Time Information
- Action: The system includes date/time information
Logic Flow:
IF An arrival notification is being formatted
AND The system includes date/time information
THEN:
- • The system adds arrival date, arrival time, and processing timestamp to the notification message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when arrival notification is being formatted.
Trigger Criteria:
- Context: An arrival notification is being formatted
- Applied to: Add Disposition Code Details
- Action: The system adds disposition code details
Logic Flow:
IF An arrival notification is being formatted
AND The system adds disposition code details
THEN:
- • The system includes the disposition code, code description, and any associated quantities or references in the notification message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when arrival notification message is complete and formatted.
Trigger Criteria:
- Context: An arrival notification message is complete and formatted
- Applied to: Route to Merlin Distribution
- Action: The system routes the message for distribution
Logic Flow:
IF An arrival notification message is complete and formatted
AND The system routes the message for distribution
THEN:
- • The system sends the notification to the Merlin messaging system for distribution to appropriate recipients
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when arrival notification is ready for distribution.
Trigger Criteria:
- Context: An arrival notification is ready for distribution
- Applied to: Message Type?
- Action: The system determines message type
Logic Flow:
IF An arrival notification is ready for distribution
AND The system determines message type
THEN:
- • The system classifies the message as ARRCANL (arrival cancellation) or other arrival type for proper routing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when arrival notification is classified as arrcanl message type.
Trigger Criteria:
- Context: An arrival notification is classified as ARRCANL message type
- Applied to: Send to ARRCANL Basket
- Action: The system routes the message
Logic Flow:
IF An arrival notification is classified as ARRCANL message type
AND The system routes the message
THEN:
- • The system sends the message to the ARRCANL basket for specialized arrival cancellation processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when arrival notification is not classified as arrcanl message type.
Trigger Criteria:
- Context: An arrival notification is not classified as ARRCANL message type
- Applied to: Send to Default Recipient
- Action: The system routes the message
Logic Flow:
IF An arrival notification is not classified as ARRCANL message type
AND The system routes the message
THEN:
- • The system sends the message to default recipients configured for standard arrival notifications
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when arrival notification has been successfully distributed.
Trigger Criteria:
- Context: An arrival notification has been successfully distributed
- Applied to: Log Arrival Action
- Action: The system logs the arrival action
Logic Flow:
IF An arrival notification has been successfully distributed
AND The system logs the arrival action
THEN:
- • The system creates a log entry recording the arrival event, processing details, and distribution results
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when arrival action has been logged.
Trigger Criteria:
- Context: An arrival action has been logged
- Applied to: Update Audit Trail
- Action: The system updates the audit trail
Logic Flow:
IF An arrival action has been logged
AND The system updates the audit trail
THEN:
- • The system records the arrival processing in the audit trail with timestamp, user information, and processing results
R-GCX016E-cbl-01011 (+13) File: GCX016E.cbl Business Rule: New Cargo Record Creation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cprs traffic is not found in the system.
Trigger Criteria:
- Context: CPRS traffic is not found in the system
- Applied to: Check if Foreign Bill?
- Action: the system checks cargo characteristics to determine if it is a foreign bill
Logic Flow:
IF CPRS traffic is not found in the system
AND the system checks cargo characteristics to determine if it is a foreign bill
THEN:
- • the system should identify foreign bill status and route to appropriate processing path
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when foreign bill has been identified for cprs traffic.
Trigger Criteria:
- Context: a foreign bill has been identified for CPRS traffic
- Applied to: Initialize New Cargo Record
- Action: the system needs to create a new cargo record
Logic Flow:
IF a foreign bill has been identified for CPRS traffic
AND the system needs to create a new cargo record
THEN:
- • the system should initialize a new cargo record structure with default values
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when new cargo record has been initialized and x4 segment data is available.
Trigger Criteria:
- Context: a new cargo record has been initialized and X4 segment data is available
- Applied to: Set Cargo Record Fields from X4 Segment
- Action: the system processes X4 segment information
Logic Flow:
IF a new cargo record has been initialized and X4 segment data is available
AND the system processes X4 segment information
THEN:
- • the system should populate cargo record fields including disposition code, entry number, quantity, and related cargo details from the X4 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record fields have been set from x4 segment and n7 segment data is available.
Trigger Criteria:
- Context: cargo record fields have been set from X4 segment and N7 segment data is available
- Applied to: Set Equipment Information from N7 Segment
- Action: the system processes N7 equipment information
Logic Flow:
IF cargo record fields have been set from X4 segment and N7 segment data is available
AND the system processes N7 equipment information
THEN:
- • the system should assign equipment initial, equipment number, and formatted car ID to the cargo record from N7 segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment information has been set and m10 segment data is available.
Trigger Criteria:
- Context: equipment information has been set and M10 segment data is available
- Applied to: Build Foreign Manifest from M10 Segment
- Action: the system processes M10 manifest information
Logic Flow:
IF equipment information has been set and M10 segment data is available
AND the system processes M10 manifest information
THEN:
- • the system should build foreign manifest details including vessel information, transport mode, and manifest identifiers from M10 segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when foreign manifest has been built from m10 segment.
Trigger Criteria:
- Context: foreign manifest has been built from M10 segment
- Applied to: Set SCAC Code
- Action: the system determines carrier information
Logic Flow:
IF foreign manifest has been built from M10 segment
AND the system determines carrier information
THEN:
- • the system should assign the appropriate SCAC code to identify the carrier for the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when scac code has been assigned and transport characteristics are available.
Trigger Criteria:
- Context: SCAC code has been assigned and transport characteristics are available
- Applied to: Set Transport Type
- Action: the system evaluates transport mode and vessel type
Logic Flow:
IF SCAC code has been assigned and transport characteristics are available
AND the system evaluates transport mode and vessel type
THEN:
- • the system should classify and assign the appropriate transport type (rail, truck, vessel, etc.) to the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when transport type has been set and routing information is available.
Trigger Criteria:
- Context: transport type has been set and routing information is available
- Applied to: Set Country Code
- Action: the system determines country information from cargo routing
Logic Flow:
IF transport type has been set and routing information is available
AND the system determines country information from cargo routing
THEN:
- • the system should assign the appropriate country code for origin or destination to the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when country code has been assigned and vessel information is available.
Trigger Criteria:
- Context: country code has been assigned and vessel information is available
- Applied to: Set Vessel Details
- Action: the system processes vessel-specific data
Logic Flow:
IF country code has been assigned and vessel information is available
AND the system processes vessel-specific data
THEN:
- • the system should configure vessel details including vessel name, voyage number, and related transport information in the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when vessel details have been set and equipment initial and number are available.
Trigger Criteria:
- Context: vessel details have been set and equipment initial and number are available
- Applied to: Format Car ID
- Action: the system formats car identification
Logic Flow:
IF vessel details have been set and equipment initial and number are available
AND the system formats car identification
THEN:
- • the system should format car ID by combining equipment initial and equipment number according to standard formatting rules
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when car id has been formatted and all cargo record fields are populated.
Trigger Criteria:
- Context: car ID has been formatted and all cargo record fields are populated
- Applied to: Validate Cargo Record Data
- Action: the system validates cargo record data
Logic Flow:
IF car ID has been formatted and all cargo record fields are populated
AND the system validates cargo record data
THEN:
- • the system should verify that all required fields are present, data formats are correct, and business rules are satisfied before allowing database insertion
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record data has been validated successfully.
Trigger Criteria:
- Context: cargo record data has been validated successfully
- Applied to: Insert New Cargo Record into Database
- Action: the system performs database insertion
Logic Flow:
IF cargo record data has been validated successfully
AND the system performs database insertion
THEN:
- • the system should insert the new cargo record into the GCSUSRT (US Cargo Root) database table
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when new cargo record has been successfully inserted into database.
Trigger Criteria:
- Context: new cargo record has been successfully inserted into database
- Applied to: Log Cargo Creation Action
- Action: the system logs the creation activity
Logic Flow:
IF new cargo record has been successfully inserted into database
AND the system logs the creation activity
THEN:
- • the system should record cargo creation action with timestamp, user information, and cargo details for audit trail purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo creation action has been logged successfully.
Trigger Criteria:
- Context: cargo creation action has been logged successfully
- Applied to: Update CPRS Processing Flag
- Action: the system updates processing status
Logic Flow:
IF cargo creation action has been logged successfully
AND the system updates processing status
THEN:
- • the system should set CPRS processing flag to indicate that cargo record creation has been completed successfully
R-GCX016E-cbl-01025 (+17) File: GCX016E.cbl Business Rule: Foreign Manifest Building
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when m10 input segment is received containing carrier information.
Trigger Criteria:
- Context: An M10 input segment is received containing carrier information
- Applied to: Extract SCAC Code from M10
- Action: The system processes the M10 segment for SCAC code extraction
Logic Flow:
IF An M10 input segment is received containing carrier information
AND The system processes the M10 segment for SCAC code extraction
THEN:
- • The SCAC code is extracted from the designated field position in the M10 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when m10 input segment is received containing transportation mode information.
Trigger Criteria:
- Context: An M10 input segment is received containing transportation mode information
- Applied to: Extract Transport Type from M10
- Action: The system processes the M10 segment for transport type extraction
Logic Flow:
IF An M10 input segment is received containing transportation mode information
AND The system processes the M10 segment for transport type extraction
THEN:
- • The transport type is extracted from the designated field position in the M10 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when m10 input segment is received containing country information.
Trigger Criteria:
- Context: An M10 input segment is received containing country information
- Applied to: Extract Country Code from M10
- Action: The system processes the M10 segment for country code extraction
Logic Flow:
IF An M10 input segment is received containing country information
AND The system processes the M10 segment for country code extraction
THEN:
- • The country code is extracted from the designated field position in the M10 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when m10 input segment is received containing vessel information.
Trigger Criteria:
- Context: An M10 input segment is received containing vessel information
- Applied to: Extract Vessel Details from M10
- Action: The system processes the M10 segment for vessel details extraction
Logic Flow:
IF An M10 input segment is received containing vessel information
AND The system processes the M10 segment for vessel details extraction
THEN:
- • The vessel name and related details are extracted from the designated field positions in the M10 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when scac code has been extracted from the m10 segment.
Trigger Criteria:
- Context: A SCAC code has been extracted from the M10 segment
- Applied to: SCAC Code Valid?
- Action: The system validates the SCAC code against business rules
Logic Flow:
IF A SCAC code has been extracted from the M10 segment
AND The system validates the SCAC code against business rules
THEN:
- • The SCAC code is determined to be valid if it is not spaces and meets format requirements,
otherwise it is invalid
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when extracted scac code has failed validation.
Trigger Criteria:
- Context: The extracted SCAC code has failed validation
- Applied to: Set Default SCAC if Invalid
- Action: The system needs to assign a SCAC code for processing
Logic Flow:
IF The extracted SCAC code has failed validation
AND The system needs to assign a SCAC code for processing
THEN:
- • A default SCAC code is assigned to ensure processing can continue
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when transport type has been extracted from the m10 segment.
Trigger Criteria:
- Context: A transport type has been extracted from the M10 segment
- Applied to: Transport Type Valid?
- Action: The system validates the transport type against acceptable values
Logic Flow:
IF A transport type has been extracted from the M10 segment
AND The system validates the transport type against acceptable values
THEN:
- • The transport type is determined to be valid if it matches recognized transportation modes,
otherwise it is invalid
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when extracted transport type has failed validation.
Trigger Criteria:
- Context: The extracted transport type has failed validation
- Applied to: Set Default Transport Type
- Action: The system needs to assign a transport type for processing
Logic Flow:
IF The extracted transport type has failed validation
AND The system needs to assign a transport type for processing
THEN:
- • A default transport type is assigned to ensure processing can continue
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when country code has been extracted from the m10 segment.
Trigger Criteria:
- Context: A country code has been extracted from the M10 segment
- Applied to: Country Code Valid?
- Action: The system validates the country code against acceptable country codes
Logic Flow:
IF A country code has been extracted from the M10 segment
AND The system validates the country code against acceptable country codes
THEN:
- • The country code is determined to be valid if it matches recognized country identifiers,
otherwise it is invalid
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when extracted country code has failed validation.
Trigger Criteria:
- Context: The extracted country code has failed validation
- Applied to: Set Default Country Code
- Action: The system needs to assign a country code for processing
Logic Flow:
IF The extracted country code has failed validation
AND The system needs to assign a country code for processing
THEN:
- • A default country code is assigned to ensure processing can continue
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all required data elements have been extracted and validated from the input.
Trigger Criteria:
- Context: All required data elements have been extracted and validated from the input
- Applied to: Construct M10 Manifest Segment
- Action: The system constructs the M10 manifest segment
Logic Flow:
IF All required data elements have been extracted and validated from the input
AND The system constructs the M10 manifest segment
THEN:
- • A properly formatted M10 segment is created with all required fields populated
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when vessel details have been extracted from the input segment.
Trigger Criteria:
- Context: Vessel details have been extracted from the input segment
- Applied to: Populate Vessel Name Field
- Action: The system populates the vessel name field in the M10 segment
Logic Flow:
IF Vessel details have been extracted from the input segment
AND The system populates the vessel name field in the M10 segment
THEN:
- • The vessel name field is set with the extracted vessel name value
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid or default transport type has been determined.
Trigger Criteria:
- Context: A valid or default transport type has been determined
- Applied to: Populate Transport Mode Field
- Action: The system populates the transport mode field in the M10 segment
Logic Flow:
IF A valid or default transport type has been determined
AND The system populates the transport mode field in the M10 segment
THEN:
- • The transport mode field is set with the validated transport type value
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid or default country code has been determined.
Trigger Criteria:
- Context: A valid or default country code has been determined
- Applied to: Populate Country of Origin Field
- Action: The system populates the country of origin field in the M10 segment
Logic Flow:
IF A valid or default country code has been determined
AND The system populates the country of origin field in the M10 segment
THEN:
- • The country of origin field is set with the validated country code value
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid or default scac code has been determined.
Trigger Criteria:
- Context: A valid or default SCAC code has been determined
- Applied to: Populate SCAC Field
- Action: The system populates the SCAC field in the M10 segment
Logic Flow:
IF A valid or default SCAC code has been determined
AND The system populates the SCAC field in the M10 segment
THEN:
- • The SCAC field is set with the validated SCAC code value
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when m10 manifest segment has been constructed with populated fields.
Trigger Criteria:
- Context: An M10 manifest segment has been constructed with populated fields
- Applied to: M10 Segment Complete?
- Action: The system validates the completeness of the M10 segment
Logic Flow:
IF An M10 manifest segment has been constructed with populated fields
AND The system validates the completeness of the M10 segment
THEN:
- • The M10 segment is determined to be complete if all mandatory fields are populated,
otherwise it is incomplete
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when m10 segment has failed completeness validation.
Trigger Criteria:
- Context: The M10 segment has failed completeness validation
- Applied to: Log Incomplete Manifest Warning
- Action: The system processes the incomplete segment
Logic Flow:
IF The M10 segment has failed completeness validation
AND The system processes the incomplete segment
THEN:
- • A warning message is logged indicating the manifest is incomplete but processing continues
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when m10 manifest segment has been constructed and validated.
Trigger Criteria:
- Context: An M10 manifest segment has been constructed and validated
- Applied to: Store M10 Manifest Segment
- Action: The system stores the M10 segment
Logic Flow:
IF An M10 manifest segment has been constructed and validated
AND The system stores the M10 segment
THEN:
- • The M10 segment is stored in the appropriate data structure for subsequent processing steps
R-GCX016E-cbl-01043 (+18) File: GCX016E.cbl Business Rule: New Cargo Insertion
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when new cargo insertion process is initiated.
Trigger Criteria:
- Context: A new cargo insertion process is initiated
- Applied to: Initialize New Cargo Record
- Action: The system begins creating a new cargo record
Logic Flow:
IF A new cargo insertion process is initiated
AND The system begins creating a new cargo record
THEN:
- • A new cargo record structure is initialized with default values and prepared for data population
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when x4 segment contains disposition code, entry number, and quantity information.
Trigger Criteria:
- Context: An X4 segment contains disposition code, entry number, and quantity information
- Applied to: Set Cargo Record with X4 Segment Data
- Action: The system processes the X4 segment for new cargo creation
Logic Flow:
IF An X4 segment contains disposition code, entry number, and quantity information
AND The system processes the X4 segment for new cargo creation
THEN:
- • The cargo record is populated with disposition code, entry number, quantity, and related X4 segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when n7 segment contains equipment initial, equipment number, and other equipment details.
Trigger Criteria:
- Context: An N7 segment contains equipment initial, equipment number, and other equipment details
- Applied to: Set Cargo Record with N7 Segment Data
- Action: The system processes the N7 segment for new cargo creation
Logic Flow:
IF An N7 segment contains equipment initial, equipment number, and other equipment details
AND The system processes the N7 segment for new cargo creation
THEN:
- • The cargo record is populated with equipment initial, equipment number, and other N7 segment equipment data
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment initial and equipment number are available from n7 segment.
Trigger Criteria:
- Context: Equipment initial and equipment number are available from N7 segment
- Applied to: Format Car ID for Database
- Action: The system needs to create a car ID for database storage
Logic Flow:
IF Equipment initial and equipment number are available from N7 segment
AND The system needs to create a car ID for database storage
THEN:
- • The car ID is formatted by combining equipment initial and equipment number in the required database format
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo is identified as cprs type.
Trigger Criteria:
- Context: A cargo is identified as CPRS type
- Applied to: Apply CPRS Special Formatting
- Action: The system processes CPRS cargo for database insertion
Logic Flow:
IF A cargo is identified as CPRS type
AND The system processes CPRS cargo for database insertion
THEN:
- • Special CPRS formatting is applied including clearing the car ID field and applying CPRS-specific data formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record is being processed for insertion.
Trigger Criteria:
- Context: A cargo record is being processed for insertion
- Applied to: CPRS Cargo?
- Action: The system evaluates cargo type classification
Logic Flow:
IF A cargo record is being processed for insertion
AND The system evaluates cargo type classification
THEN:
- • The cargo is classified as either CPRS or non-CPRS based on predefined cargo type criteria
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when m10 segments contain vessel name, voyage number, and transportation details.
Trigger Criteria:
- Context: M10 segments contain vessel name, voyage number, and transportation details
- Applied to: Build Foreign Manifest Information from M10 Segments
- Action: The system builds foreign manifest information for new cargo
Logic Flow:
IF M10 segments contain vessel name, voyage number, and transportation details
AND The system builds foreign manifest information for new cargo
THEN:
- • Foreign manifest information is constructed using vessel details, voyage information, and transportation data from M10 segments
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when carrier information is available from manifest or segment data.
Trigger Criteria:
- Context: Carrier information is available from manifest or segment data
- Applied to: Set SCAC Code
- Action: The system processes carrier identification for new cargo
Logic Flow:
IF Carrier information is available from manifest or segment data
AND The system processes carrier identification for new cargo
THEN:
- • The appropriate SCAC code is assigned to identify the transportation carrier
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when transportation mode information is available from manifest segments.
Trigger Criteria:
- Context: Transportation mode information is available from manifest segments
- Applied to: Set Transport Type
- Action: The system classifies the transportation type for new cargo
Logic Flow:
IF Transportation mode information is available from manifest segments
AND The system classifies the transportation type for new cargo
THEN:
- • The transport type is set based on the transportation mode indicated in the manifest data
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when country information is available from manifest or routing data.
Trigger Criteria:
- Context: Country information is available from manifest or routing data
- Applied to: Set Country Code
- Action: The system processes country classification for new cargo
Logic Flow:
IF Country information is available from manifest or routing data
AND The system processes country classification for new cargo
THEN:
- • The appropriate country code is assigned based on origin, destination, or routing country information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when vessel information is available from m10 segments or manifest data.
Trigger Criteria:
- Context: Vessel information is available from M10 segments or manifest data
- Applied to: Set Vessel Details
- Action: The system processes vessel details for new cargo
Logic Flow:
IF Vessel information is available from M10 segments or manifest data
AND The system processes vessel details for new cargo
THEN:
- • Vessel name, voyage number, and related vessel transportation details are populated in the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record has been populated with segment data.
Trigger Criteria:
- Context: A cargo record has been populated with segment data
- Applied to: Validate Cargo Record Completeness
- Action: The system validates the cargo record before database insertion
Logic Flow:
IF A cargo record has been populated with segment data
AND The system validates the cargo record before database insertion
THEN:
- • All required fields are verified as populated and meeting business validation requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when validated cargo record is ready for database insertion. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A validated cargo record is ready for database insertion
- Applied to: Call GCCUSIO Database Insert
- Action: The system calls the database insert function
Logic Flow:
IF A validated cargo record is ready for database insertion
AND The system calls the database insert function
THEN:
- • The GCCUSIO database insert operation is executed to create the new cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when database insert operation has been executed.
Trigger Criteria:
- Context: A database insert operation has been executed
- Applied to: Insert Successful?
- Action: The system evaluates the insert operation result
Logic Flow:
IF A database insert operation has been executed
AND The system evaluates the insert operation result
THEN:
- • The insert operation is classified as either successful or failed based on the database response
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record has been successfully inserted into the database.
Trigger Criteria:
- Context: A cargo record has been successfully inserted into the database
- Applied to: Log Successful Cargo Creation
- Action: The system processes the successful insert result
Logic Flow:
IF A cargo record has been successfully inserted into the database
AND The system processes the successful insert result
THEN:
- • A log entry is created documenting the successful cargo creation with relevant cargo identifiers
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record has been successfully created.
Trigger Criteria:
- Context: A cargo record has been successfully created
- Applied to: Update Cargo Counters
- Action: The system updates processing statistics
Logic Flow:
IF A cargo record has been successfully created
AND The system updates processing statistics
THEN:
- • Cargo processing counters are incremented to reflect the successful cargo creation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record has been successfully created and logged.
Trigger Criteria:
- Context: A cargo record has been successfully created and logged
- Applied to: Generate Success Notification
- Action: The system generates success notifications
Logic Flow:
IF A cargo record has been successfully created and logged
AND The system generates success notifications
THEN:
- • Appropriate notification messages are created and sent to relevant parties or systems
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when database insert operation has failed.
Trigger Criteria:
- Context: A database insert operation has failed
- Applied to: Log Insert Error
- Action: The system processes the failed insert result
Logic Flow:
IF A database insert operation has failed
AND The system processes the failed insert result
THEN:
- • An error log entry is created documenting the insert failure with error details and cargo information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record insert operation has failed and been logged.
Trigger Criteria:
- Context: A cargo record insert operation has failed and been logged
- Applied to: Generate Error Message
- Action: The system generates error notifications
Logic Flow:
IF A cargo record insert operation has failed and been logged
AND The system generates error notifications
THEN:
- • Appropriate error messages are created and sent to relevant parties or systems with failure details
R-GCX016E-cbl-01062 (+12) File: GCX016E.cbl Business Rule: Station Data Lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when station data lookup request is initiated.
Trigger Criteria:
- Context: A station data lookup request is initiated
- Applied to: Station Type Required?
- Action: The system evaluates the station type requirement
Logic Flow:
IF A station data lookup request is initiated
AND The system evaluates the station type requirement
THEN:
- • The system routes to either destination station retrieval or key station retrieval based on the station type needed
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when destination station lookup is required.
Trigger Criteria:
- Context: A destination station lookup is required
- Applied to: Retrieve Destination Station Data
- Action: The system processes the destination station request
Logic Flow:
IF A destination station lookup is required
AND The system processes the destination station request
THEN:
- • The system initiates retrieval of destination station data from the DS table
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when key station lookup is required.
Trigger Criteria:
- Context: A key station lookup is required
- Applied to: Retrieve Key Station Data
- Action: The system processes the key station request
Logic Flow:
IF A key station lookup is required
AND The system processes the key station request
THEN:
- • The system initiates retrieval of key station data from the KS table
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when station data retrieval is required from either ds or ks table. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Station data retrieval is required from either DS or KS table
- Applied to: Call Generic Table I/O Interface
- Action: The system needs to access table data
Logic Flow:
IF Station data retrieval is required from either DS or KS table
AND The system needs to access table data
THEN:
- • The system calls the generic table I/O interface to facilitate data access
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when destination station data is required.
Trigger Criteria:
- Context: Destination station data is required
- Applied to: Access DS Table via GCCTBIO
- Action: The system executes table access through GCCTBIO
Logic Flow:
IF Destination station data is required
AND The system executes table access through GCCTBIO
THEN:
- • The system retrieves data from the DS table containing destination station information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when key station data is required.
Trigger Criteria:
- Context: Key station data is required
- Applied to: Access KS Table via GCCTBIO
- Action: The system executes table access through GCCTBIO
Logic Flow:
IF Key station data is required
AND The system executes table access through GCCTBIO
THEN:
- • The system retrieves data from the KS table containing key station information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when station lookup has been performed on either ds or ks table.
Trigger Criteria:
- Context: A station lookup has been performed on either DS or KS table
- Applied to: Station Found?
- Action: The system evaluates the lookup results
Logic Flow:
IF A station lookup has been performed on either DS or KS table
AND The system evaluates the lookup results
THEN:
- • The system determines if the station was found and routes processing accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when station record has been found in the table.
Trigger Criteria:
- Context: A station record has been found in the table
- Applied to: Extract Station Information
- Action: The system processes the retrieved station data
Logic Flow:
IF A station record has been found in the table
AND The system processes the retrieved station data
THEN:
- • The system extracts the relevant station information fields for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when station information has been extracted from the table.
Trigger Criteria:
- Context: Station information has been extracted from the table
- Applied to: Validate Location Identifiers
- Action: The system validates the location identifiers
Logic Flow:
IF Station information has been extracted from the table
AND The system validates the location identifiers
THEN:
- • The system ensures location identifiers meet required format and business rules
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when station information has been validated successfully.
Trigger Criteria:
- Context: Station information has been validated successfully
- Applied to: Set Station Data Fields
- Action: The system processes the validated station data
Logic Flow:
IF Station information has been validated successfully
AND The system processes the validated station data
THEN:
- • The system sets the appropriate station data fields with the retrieved information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when station lookup has been performed.
Trigger Criteria:
- Context: A station lookup has been performed
- Applied to: Handle Station Not Found
- Action: The requested station is not found in the table
Logic Flow:
IF A station lookup has been performed
AND The requested station is not found in the table
THEN:
- • The system initiates error handling procedures for the missing station
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when station data processing has been completed (either successfully or with error handling).
Trigger Criteria:
- Context: Station data processing has been completed (either successfully or with error handling)
- Applied to: Return Station Information
- Action: The system finalizes the station lookup process
Logic Flow:
IF Station data processing has been completed (either successfully or with error handling)
AND The system finalizes the station lookup process
THEN:
- • The system returns the station information or error status to the requesting process
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when station lookup error has occurred.
Trigger Criteria:
- Context: A station lookup error has occurred
- Applied to: Log Station Lookup Error
- Action: The system processes the error condition
Logic Flow:
IF A station lookup error has occurred
AND The system processes the error condition
THEN:
- • The system logs the station lookup error for audit and troubleshooting purposes
R-GCX016E-cbl-01075 (+12) File: GCX016E.cbl Business Rule: Destination Station Lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when x4 segment is being processed for cargo disposition.
Trigger Criteria:
- Context: An X4 segment is being processed for cargo disposition
- Applied to: Extract Location Identifier from X4 Segment
- Action: The system needs to identify the destination station
Logic Flow:
IF An X4 segment is being processed for cargo disposition
AND The system needs to identify the destination station
THEN:
- • The location identifier is extracted from the X4 segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when location identifier has been extracted from the x4 segment.
Trigger Criteria:
- Context: A location identifier has been extracted from the X4 segment
- Applied to: Location Identifier Present?
- Action: The system checks for the presence of the location identifier
Logic Flow:
IF A location identifier has been extracted from the X4 segment
AND The system checks for the presence of the location identifier
THEN:
- • If location identifier is present, proceed with station lookup,
otherwise generate station not found error
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid location identifier exists for station lookup.
Trigger Criteria:
- Context: A valid location identifier exists for station lookup
- Applied to: Set DS Table Type for Lookup
- Action: The system prepares to access the destination station table
Logic Flow:
IF A valid location identifier exists for station lookup
AND The system prepares to access the destination station table
THEN:
- • The DS table type is set for the generic table interface lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when ds table type is configured for station lookup. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: The DS table type is configured for station lookup
- Applied to: Call Generic Table I/O Interface - GCCTBIO
- Action: The system needs to retrieve station information
Logic Flow:
IF The DS table type is configured for station lookup
AND The system needs to retrieve station information
THEN:
- • The generic table I/O interface GCCTBIO is called to access station data
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when generic table interface has been called for station lookup.
Trigger Criteria:
- Context: The generic table interface has been called for station lookup
- Applied to: Station Record Found?
- Action: The system checks the lookup results
Logic Flow:
IF The generic table interface has been called for station lookup
AND The system checks the lookup results
THEN:
- • If station record is found, proceed with station data retrieval,
otherwise generate station not found error
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when station record has been found in the destination station table.
Trigger Criteria:
- Context: A station record has been found in the destination station table
- Applied to: Retrieve Destination Station Information
- Action: The system accesses the station record
Logic Flow:
IF A station record has been found in the destination station table
AND The system accesses the station record
THEN:
- • The destination station information is retrieved from the table segments
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when destination station information has been retrieved.
Trigger Criteria:
- Context: Destination station information has been retrieved
- Applied to: Extract Station Name and Routing Data
- Action: The system processes the station record data
Logic Flow:
IF Destination station information has been retrieved
AND The system processes the station record data
THEN:
- • The station name and routing data are extracted from the station information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when station name and routing data have been extracted.
Trigger Criteria:
- Context: Station name and routing data have been extracted
- Applied to: Validate Station Information
- Action: The system validates the station information
Logic Flow:
IF Station name and routing data have been extracted
AND The system validates the station information
THEN:
- • The station information is checked for completeness and validity
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when station information has been validated.
Trigger Criteria:
- Context: Station information has been validated
- Applied to: Station Valid for Routing?
- Action: The system checks station validity for routing
Logic Flow:
IF Station information has been validated
AND The system checks station validity for routing
THEN:
- • If station is valid for routing, set station data in working storage,
otherwise log station lookup failure
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when station information is valid for routing operations.
Trigger Criteria:
- Context: Station information is valid for routing operations
- Applied to: Set Station Data in Working Storage
- Action: The system needs to store station data for processing
Logic Flow:
IF Station information is valid for routing operations
AND The system needs to store station data for processing
THEN:
- • The station data is set in working storage for cargo processing use
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when station data has been successfully set in working storage.
Trigger Criteria:
- Context: Station data has been successfully set in working storage
- Applied to: Log Station Lookup Success
- Action: The station lookup operation completes successfully
Logic Flow:
IF Station data has been successfully set in working storage
AND The station lookup operation completes successfully
THEN:
- • A success message is logged for the station lookup operation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when either no location identifier is present or station record is not found.
Trigger Criteria:
- Context: Either no location identifier is present or station record is not found
- Applied to: Generate Station Not Found Error
- Action: The station lookup operation fails
Logic Flow:
IF Either no location identifier is present or station record is not found
AND The station lookup operation fails
THEN:
- • A station not found error is generated for the cargo processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when station lookup has failed due to invalid station information or station not found.
Trigger Criteria:
- Context: Station lookup has failed due to invalid station information or station not found
- Applied to: Log Station Lookup Failure
- Action: The station lookup operation encounters an error
Logic Flow:
IF Station lookup has failed due to invalid station information or station not found
AND The station lookup operation encounters an error
THEN:
- • A failure message is logged for the station lookup operation
R-GCX016E-cbl-01088 (+8) File: GCX016E.cbl Business Rule: Key Station Lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when x4 segment containing disposition code information is being processed.
Trigger Criteria:
- Context: An X4 segment containing disposition code information is being processed
- Applied to: Extract Location Identifier from X4 Segment
- Action: The system needs to validate the location identifier for station lookup
Logic Flow:
IF An X4 segment containing disposition code information is being processed
AND The system needs to validate the location identifier for station lookup
THEN:
- • The location identifier is extracted from the X4 segment and prepared for key station table lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when location identifier has been extracted from the x4 segment. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A location identifier has been extracted from the X4 segment
- Applied to: Call Generic Table I/O Interface
- Action: The system needs to access key station information
Logic Flow:
IF A location identifier has been extracted from the X4 segment
AND The system needs to access key station information
THEN:
- • The generic table I/O interface is called to access the KS table via GCCTBIO
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when generic table i/o interface has been called with a location identifier.
Trigger Criteria:
- Context: The generic table I/O interface has been called with a location identifier
- Applied to: Access KS Table via GCCTBIO
- Action: The system accesses the KS table through GCCTBIO
Logic Flow:
IF The generic table I/O interface has been called with a location identifier
AND The system accesses the KS table through GCCTBIO
THEN:
- • Key station information is retrieved from the KS table for the specified location identifier
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when key station lookup has been performed using a location identifier.
Trigger Criteria:
- Context: A key station lookup has been performed using a location identifier
- Applied to: Key Station Found?
- Action: The system checks the lookup results
Logic Flow:
IF A key station lookup has been performed using a location identifier
AND The system checks the lookup results
THEN:
- • The system determines if the key station exists and branches processing accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when key station exists in the ks table for the specified location identifier.
Trigger Criteria:
- Context: A key station exists in the KS table for the specified location identifier
- Applied to: Retrieve Key Station Information
- Action: The system processes the found station record
Logic Flow:
IF A key station exists in the KS table for the specified location identifier
AND The system processes the found station record
THEN:
- • Key station information is retrieved and made available for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when key station information has been retrieved from the ks table.
Trigger Criteria:
- Context: Key station information has been retrieved from the KS table
- Applied to: Validate Location Identifier
- Action: The system validates the location identifier for business rules compliance
Logic Flow:
IF Key station information has been retrieved from the KS table
AND The system validates the location identifier for business rules compliance
THEN:
- • The location identifier is validated against business requirements and processing rules
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when location identifier has been validated successfully.
Trigger Criteria:
- Context: The location identifier has been validated successfully
- Applied to: Set Station Data for Processing
- Action: The system prepares station data for processing
Logic Flow:
IF The location identifier has been validated successfully
AND The system prepares station data for processing
THEN:
- • Station data is set and formatted for use in subsequent business operations
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when key station lookup has been performed for a location identifier.
Trigger Criteria:
- Context: A key station lookup has been performed for a location identifier
- Applied to: Generate Station Not Found Error
- Action: The key station is not found in the KS table
Logic Flow:
IF A key station lookup has been performed for a location identifier
AND The key station is not found in the KS table
THEN:
- • A station not found error is generated and processing continues with error handling
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when key station lookup processing has completed with either valid station data or error condition.
Trigger Criteria:
- Context: Key station lookup processing has completed with either valid station data or error condition
- Applied to: Continue with Validated Station Data
- Action: The system continues with subsequent processing steps
Logic Flow:
IF Key station lookup processing has completed with either valid station data or error condition
AND The system continues with subsequent processing steps
THEN:
- • Processing continues using the validated station data or appropriate error handling for missing stations
R-GCX016E-cbl-01097 (+11) File: GCX016E.cbl Business Rule: Table I/O Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when table lookup request is initiated with specific table type parameters.
Trigger Criteria:
- Context: A table lookup request is initiated with specific table type parameters
- Applied to: Table Type?
- Action: The system evaluates the table type identifier
Logic Flow:
IF A table lookup request is initiated with specific table type parameters
AND The system evaluates the table type identifier
THEN:
- • The system routes the request to the appropriate table processing logic (DS for station data, KS for key station data, DC for disposition codes, or broker table for broker information)
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when request for station data lookup is received with a valid station code.
Trigger Criteria:
- Context: A request for station data lookup is received with a valid station code
- Applied to: Station Data Lookup - DS Table
- Action: The system accesses the DS table in GCSTBRT
Logic Flow:
IF A request for station data lookup is received with a valid station code
AND The system accesses the DS table in GCSTBRT
THEN:
- • The system retrieves the corresponding station information including station name and location details
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when request for key station data lookup is received with a station identifier.
Trigger Criteria:
- Context: A request for key station data lookup is received with a station identifier
- Applied to: Key Station Lookup - KS Table
- Action: The system accesses the KS table in GCSTBRT
Logic Flow:
IF A request for key station data lookup is received with a station identifier
AND The system accesses the KS table in GCSTBRT
THEN:
- • The system retrieves key station operational data and configuration information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code lookup request is received with a specific disposition code.
Trigger Criteria:
- Context: A disposition code lookup request is received with a specific disposition code
- Applied to: Disposition Code Lookup - DC Table
- Action: The system accesses the DC table in GCSTBRT
Logic Flow:
IF A disposition code lookup request is received with a specific disposition code
AND The system accesses the DC table in GCSTBRT
THEN:
- • The system retrieves disposition code details including processing instructions, status implications, and validation rules
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when broker information lookup request is received with broker identification.
Trigger Criteria:
- Context: A broker information lookup request is received with broker identification
- Applied to: Broker Information Lookup
- Action: The system accesses the broker table in GCST2RT
Logic Flow:
IF A broker information lookup request is received with broker identification
AND The system accesses the broker table in GCST2RT
THEN:
- • The system retrieves broker contact information, credentials, and processing preferences
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when table lookup request has been routed to the appropriate table type. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A table lookup request has been routed to the appropriate table type
- Applied to: Call GCCTBIO Interface
- Action: The system needs to perform the actual table access operation
Logic Flow:
IF A table lookup request has been routed to the appropriate table type
AND The system needs to perform the actual table access operation
THEN:
- • The system calls the GCCTBIO interface with the table type and key parameters
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when table lookup key is provided for validation.
Trigger Criteria:
- Context: A table lookup key is provided for validation
- Applied to: Validate Table Key
- Action: The system performs key validation checks
Logic Flow:
IF A table lookup key is provided for validation
AND The system performs key validation checks
THEN:
- • The system verifies the key format, length, and content validity before proceeding with table access
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when validated table key has been used to search the target table.
Trigger Criteria:
- Context: A validated table key has been used to search the target table
- Applied to: Table Record Found?
- Action: The system checks for record existence
Logic Flow:
IF A validated table key has been used to search the target table
AND The system checks for record existence
THEN:
- • The system returns true if a matching record is found, false if no record exists for the given key
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when matching table record has been located.
Trigger Criteria:
- Context: A matching table record has been located
- Applied to: Retrieve Table Data
- Action: The system retrieves the record data
Logic Flow:
IF A matching table record has been located
AND The system retrieves the record data
THEN:
- • The system extracts all relevant fields and formats them for return to the requesting process
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when table data has been successfully retrieved and formatted.
Trigger Criteria:
- Context: Table data has been successfully retrieved and formatted
- Applied to: Return Table Information
- Action: The system prepares to return the information
Logic Flow:
IF Table data has been successfully retrieved and formatted
AND The system prepares to return the information
THEN:
- • The system returns the complete table information with success status to the calling process
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when table lookup has been performed but no matching record was found.
Trigger Criteria:
- Context: A table lookup has been performed but no matching record was found
- Applied to: Generate Table Not Found Error
- Action: The system needs to handle the not found condition
Logic Flow:
IF A table lookup has been performed but no matching record was found
AND The system needs to handle the not found condition
THEN:
- • The system generates a table not found error with relevant details about the failed lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when table lookup operation has failed or no record was found.
Trigger Criteria:
- Context: A table lookup operation has failed or no record was found
- Applied to: Return Error Status
- Action: The system needs to communicate the failure to the calling process
Logic Flow:
IF A table lookup operation has failed or no record was found
AND The system needs to communicate the failure to the calling process
THEN:
- • The system returns error status with descriptive information about the failure reason
R-GCX016E-cbl-01109 (+12) File: GCX016E.cbl Business Rule: Comprehensive Merlin Message Formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record exists in the system with valid equipment and manifest information.
Trigger Criteria:
- Context: A cargo record exists in the system with valid equipment and manifest information
- Applied to: Retrieve Cargo Information
- Action: The system prepares to format a Merlin message for cargo disposition processing
Logic Flow:
IF A cargo record exists in the system with valid equipment and manifest information
AND The system prepares to format a Merlin message for cargo disposition processing
THEN:
- • The system retrieves and formats the car ID, waybill number, US-CCN, and associated cargo identification details for message content
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo equipment information is available including car id and equipment type.
Trigger Criteria:
- Context: Cargo equipment information is available including car ID and equipment type
- Applied to: Format Equipment Details
- Action: The system formats equipment details for Merlin message content
Logic Flow:
IF Cargo equipment information is available including car ID and equipment type
AND The system formats equipment details for Merlin message content
THEN:
- • The system includes formatted equipment ID, car identification, and equipment type information in the message structure
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code has been processed for a cargo with valid code description available.
Trigger Criteria:
- Context: A disposition code has been processed for a cargo with valid code description available
- Applied to: Add Disposition Code Information
- Action: The system adds disposition code information to the Merlin message
Logic Flow:
IF A disposition code has been processed for a cargo with valid code description available
AND The system adds disposition code information to the Merlin message
THEN:
- • The system includes the disposition code, its description, and related processing information in the message content
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code affects cargo release quantities with current and target quantity values available.
Trigger Criteria:
- Context: A disposition code affects cargo release quantities with current and target quantity values available
- Applied to: Calculate Quantity Impact
- Action: The system calculates quantity impact for Merlin message formatting
Logic Flow:
IF A disposition code affects cargo release quantities with current and target quantity values available
AND The system calculates quantity impact for Merlin message formatting
THEN:
- • The system determines whether quantities will increase, decrease, or remain unchanged and formats the impact information for the message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when k1 segment comments are available for the cargo being processed.
Trigger Criteria:
- Context: K1 segment comments are available for the cargo being processed
- Applied to: Include K1 Free-Form Text
- Action: The system checks for K1 comments during Merlin message formatting
Logic Flow:
IF K1 segment comments are available for the cargo being processed
AND The system checks for K1 comments during Merlin message formatting
THEN:
- • The system includes up to 4 lines of K1 free-form text comments in the Merlin message content
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when special processing comments are available for the cargo disposition processing.
Trigger Criteria:
- Context: Special processing comments are available for the cargo disposition processing
- Applied to: Add Special Processing Comments
- Action: The system adds special processing information to the Merlin message
Logic Flow:
IF Special processing comments are available for the cargo disposition processing
AND The system adds special processing information to the Merlin message
THEN:
- • The system includes up to 3 lines of special comments, processing timestamps, and station/location data in the message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when k1 segment comments contain canadian pacific railway identifiers.
Trigger Criteria:
- Context: K1 segment comments contain Canadian Pacific Railway identifiers
- Applied to: Bond Creation Scenario?
- Action: The system checks for bond creation scenarios during message formatting
Logic Flow:
IF K1 segment comments contain Canadian Pacific Railway identifiers
AND The system checks for bond creation scenarios during message formatting
THEN:
- • The system identifies CP Rail transactions by detecting 'DIRECTOR OF CUSTOMS, CP RAIL', 'CANADIAN PACIFIC LIMITED', or 'CANADIAN PACIFIC RAILWAY CO' in K1 comments
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when canadian pacific railway transaction has been identified requiring bond creation messaging.
Trigger Criteria:
- Context: A Canadian Pacific Railway transaction has been identified requiring bond creation messaging
- Applied to: Format Canadian Pacific Railway Bond Creation Message
- Action: The system formats the CP Rail bond creation message
Logic Flow:
IF A Canadian Pacific Railway transaction has been identified requiring bond creation messaging
AND The system formats the CP Rail bond creation message
THEN:
- • The system creates a broker bond creation message with CP Rail specific formatting and routing information
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo quantities exist both before and after disposition code processing.
Trigger Criteria:
- Context: Cargo quantities exist both before and after disposition code processing
- Applied to: Create Before/After Quantity Comparison
- Action: The system creates quantity comparison information for the Merlin message
Logic Flow:
IF Cargo quantities exist both before and after disposition code processing
AND The system creates quantity comparison information for the Merlin message
THEN:
- • The system formats before and after quantity values to show the impact of disposition code processing on cargo release quantities
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code processing has resulted in changes to cargo release quantities.
Trigger Criteria:
- Context: Disposition code processing has resulted in changes to cargo release quantities
- Applied to: Format Release Quantity Impact Details
- Action: The system formats release quantity impact details
Logic Flow:
IF Disposition code processing has resulted in changes to cargo release quantities
AND The system formats release quantity impact details
THEN:
- • The system creates detailed quantity impact information showing specific changes to released, held, or processed quantities
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all message components including cargo details, disposition information, comments, and quantity impacts are available.
Trigger Criteria:
- Context: All message components including cargo details, disposition information, comments, and quantity impacts are available
- Applied to: Compile Complete Message Content
- Action: The system compiles the complete message content
Logic Flow:
IF All message components including cargo details, disposition information, comments, and quantity impacts are available
AND The system compiles the complete message content
THEN:
- • The system assembles all components into a structured Merlin message with proper formatting, sequencing, and content organization
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when complete merlin message has been compiled with disposition code and cargo information.
Trigger Criteria:
- Context: A complete Merlin message has been compiled with disposition code and cargo information
- Applied to: Set Message Type and Priority
- Action: The system sets message type and priority
Logic Flow:
IF A complete Merlin message has been compiled with disposition code and cargo information
AND The system sets message type and priority
THEN:
- • The system assigns appropriate message type classification and priority level based on disposition code type, cargo status, and business impact
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when complete merlin message with assigned type and priority is ready for distribution.
Trigger Criteria:
- Context: A complete Merlin message with assigned type and priority is ready for distribution
- Applied to: Prepare Message for Distribution
- Action: The system prepares the message for distribution
Logic Flow:
IF A complete Merlin message with assigned type and priority is ready for distribution
AND The system prepares the message for distribution
THEN:
- • The system finalizes message routing, determines delivery methods, and prepares the message for transmission to appropriate recipients
R-GCX016E-cbl-01122 (+9) File: GCX016E.cbl Business Rule: Broker Bond Creation Notification
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when k1 message segment is received for processing.
Trigger Criteria:
- Context: A K1 message segment is received for processing
- Applied to: Message Type Check
- Action: The system checks the K1 free-form text content for Canadian Pacific Railway identifiers including 'DIRECTOR OF CUSTOMS, CP RAIL', 'CANADIAN PACIFIC LIMITED', or 'CANADIAN PACIFIC RAILWAY CO'
Logic Flow:
IF A K1 message segment is received for processing
AND The system checks the K1 free-form text content for Canadian Pacific Railway identifiers including 'DIRECTOR OF CUSTOMS, CP RAIL', 'CANADIAN PACIFIC LIMITED', or 'CANADIAN PACIFIC RAILWAY CO'
THEN:
- • The message is classified as a CP Rail bond creation request and routed for specialized bond processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when k1 message segment identified as cp rail bond creation.
Trigger Criteria:
- Context: A K1 message segment identified as CP Rail bond creation
- Applied to: Extract K1 Free-Form Text
- Action: The system processes the K1 segment to extract free-form text content
Logic Flow:
IF A K1 message segment identified as CP Rail bond creation
AND The system processes the K1 segment to extract free-form text content
THEN:
- • The K1 text content is captured and made available for bond validation and notification formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when k1 text content has been extracted from a cp rail bond creation message.
Trigger Criteria:
- Context: K1 text content has been extracted from a CP Rail bond creation message
- Applied to: Validate Bond Creation Request
- Action: The system validates the bond creation request against broker database information and business rules
Logic Flow:
IF K1 text content has been extracted from a CP Rail bond creation message
AND The system validates the bond creation request against broker database information and business rules
THEN:
- • The bond creation request is either approved for notification processing or rejected with appropriate error handling
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when validated cp rail bond creation request with extracted k1 text content.
Trigger Criteria:
- Context: A validated CP Rail bond creation request with extracted K1 text content
- Applied to: Format Bond Creation Notification
- Action: The system formats the bond creation notification message including cargo information, processing details, and special comments
Logic Flow:
IF A validated CP Rail bond creation request with extracted K1 text content
AND The system formats the bond creation notification message including cargo information, processing details, and special comments
THEN:
- • A properly formatted Merlin message is created containing all necessary bond creation notification information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when bond creation notification message is being formatted and special comments exist for the cargo.
Trigger Criteria:
- Context: A bond creation notification message is being formatted and special comments exist for the cargo
- Applied to: Add Special Comments to Message
- Action: The system processes special comments associated with the cargo record
Logic Flow:
IF A bond creation notification message is being formatted and special comments exist for the cargo
AND The system processes special comments associated with the cargo record
THEN:
- • Up to 3 lines of special comments are included in the bond creation notification message
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when bond creation notification message is being prepared with validated bond information.
Trigger Criteria:
- Context: A bond creation notification message is being prepared with validated bond information
- Applied to: Include Processing Details
- Action: The system adds processing details including car identification, waybill numbers, US CCN, and processing timestamps
Logic Flow:
IF A bond creation notification message is being prepared with validated bond information
AND The system adds processing details including car identification, waybill numbers, US CCN, and processing timestamps
THEN:
- • The notification message contains complete processing context information for the bond creation request
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all bond creation notification components have been prepared including special comments and processing details.
Trigger Criteria:
- Context: All bond creation notification components have been prepared including special comments and processing details
- Applied to: Create Comprehensive Merlin Message
- Action: The system assembles the comprehensive Merlin message with all components properly formatted
Logic Flow:
IF All bond creation notification components have been prepared including special comments and processing details
AND The system assembles the comprehensive Merlin message with all components properly formatted
THEN:
- • A complete Merlin message is created ready for routing to appropriate recipients
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when comprehensive bond creation merlin message has been created.
Trigger Criteria:
- Context: A comprehensive bond creation Merlin message has been created
- Applied to: Route to Appropriate Recipients
- Action: The system determines routing based on broker configuration and notification preferences
Logic Flow:
IF A comprehensive bond creation Merlin message has been created
AND The system determines routing based on broker configuration and notification preferences
THEN:
- • The message is routed to the appropriate recipients including brokers, customs officials, and system administrators
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when bond creation notification message has been routed to appropriate recipients.
Trigger Criteria:
- Context: A bond creation notification message has been routed to appropriate recipients
- Applied to: Send Bond Creation Notification
- Action: The system transmits the notification through the Merlin messaging system
Logic Flow:
IF A bond creation notification message has been routed to appropriate recipients
AND The system transmits the notification through the Merlin messaging system
THEN:
- • The bond creation notification is successfully delivered to all designated recipients
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when bond creation notification has been successfully transmitted.
Trigger Criteria:
- Context: A bond creation notification has been successfully transmitted
- Applied to: Log Bond Creation Action
- Action: The system logs the bond creation action with relevant details and timestamps
Logic Flow:
IF A bond creation notification has been successfully transmitted
AND The system logs the bond creation action with relevant details and timestamps
THEN:
- • The bond creation action is recorded in the system audit trail for compliance and tracking purposes
R-GCX016E-cbl-01132 (+28) File: GCX016E.cbl Business Rule: Release Quantity Impact Messaging
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record exists with release quantity information.
Trigger Criteria:
- Context: A cargo record exists with release quantity information
- Applied to: Retrieve Current Cargo Release Quantity
- Action: Release quantity impact messaging is initiated
Logic Flow:
IF A cargo record exists with release quantity information
AND Release quantity impact messaging is initiated
THEN:
- • The current cargo release quantity is retrieved and stored for impact calculation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record exists with release quantity information.
Trigger Criteria:
- Context: A cargo record exists with release quantity information
- Applied to: Retrieve Current Cargo Release Quantity
- Action: The system needs to calculate quantity impact for disposition code processing
Logic Flow:
IF A cargo record exists with release quantity information
AND The system needs to calculate quantity impact for disposition code processing
THEN:
- • The current cargo release quantity is retrieved and stored for comparison calculations
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code is being processed.
Trigger Criteria:
- Context: A disposition code is being processed
- Applied to: Identify Disposition Code Type
- Action: The system needs to determine quantity impact
Logic Flow:
IF A disposition code is being processed
AND The system needs to determine quantity impact
THEN:
- • The disposition code type and characteristics are identified from the DC table
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code with defined characteristics.
Trigger Criteria:
- Context: A disposition code with defined characteristics
- Applied to: Disposition Code Affects Release Quantity?
- Action: The system evaluates quantity impact potential
Logic Flow:
IF A disposition code with defined characteristics
AND The system evaluates quantity impact potential
THEN:
- • The system determines if the disposition code affects release quantities based on code type and action flags
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code that affects release quantities and current cargo quantity information.
Trigger Criteria:
- Context: A disposition code that affects release quantities and current cargo quantity information
- Applied to: Calculate Quantity Impact
- Action: Quantity impact calculation is performed
Logic Flow:
IF A disposition code that affects release quantities and current cargo quantity information
AND Quantity impact calculation is performed
THEN:
- • The system calculates the specific quantity change amount based on disposition code parameters
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code with calculated quantity impact.
Trigger Criteria:
- Context: A disposition code with calculated quantity impact
- Applied to: Determine Add or Subtract Action
- Action: The system determines the direction of quantity change
Logic Flow:
IF A disposition code with calculated quantity impact
AND The system determines the direction of quantity change
THEN:
- • The system identifies whether the action is to add or subtract from current release quantity based on disposition code action type
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code that increases release quantity and calculated impact amount.
Trigger Criteria:
- Context: A disposition code that increases release quantity and calculated impact amount
- Applied to: Add to Release Quantity
- Action: The action type is determined to be addition
Logic Flow:
IF A disposition code that increases release quantity and calculated impact amount
AND The action type is determined to be addition
THEN:
- • The calculated amount is added to the current release quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code that decreases release quantity and calculated impact amount.
Trigger Criteria:
- Context: A disposition code that decreases release quantity and calculated impact amount
- Applied to: Subtract from Release Quantity
- Action: The action type is determined to be subtraction
Logic Flow:
IF A disposition code that decreases release quantity and calculated impact amount
AND The action type is determined to be subtraction
THEN:
- • The calculated amount is subtracted from the current release quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when current release quantity and calculated quantity impact with determined action.
Trigger Criteria:
- Context: Current release quantity and calculated quantity impact with determined action
- Applied to: Calculate New Release Quantity
- Action: Final quantity calculation is performed
Logic Flow:
IF Current release quantity and calculated quantity impact with determined action
AND Final quantity calculation is performed
THEN:
- • The system calculates the new release quantity by applying the add or subtract action to the current quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when current release quantity value.
Trigger Criteria:
- Context: Current release quantity value
- Applied to: Format Before Quantity Display
- Action: Impact report formatting is performed
Logic Flow:
IF Current release quantity value
AND Impact report formatting is performed
THEN:
- • The current quantity is formatted for display as the 'before' value in the impact message
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when calculated new release quantity value.
Trigger Criteria:
- Context: Calculated new release quantity value
- Applied to: Format After Quantity Display
- Action: Impact report formatting is performed
Logic Flow:
IF Calculated new release quantity value
AND Impact report formatting is performed
THEN:
- • The new quantity is formatted for display as the 'after' value in the impact message
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code information and description from dc table.
Trigger Criteria:
- Context: Disposition code information and description from DC table
- Applied to: Format Disposition Code Description
- Action: Impact message formatting is performed
Logic Flow:
IF Disposition code information and description from DC table
AND Impact message formatting is performed
THEN:
- • The disposition code description is formatted for inclusion in the impact report
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when formatted before quantity, after quantity, and disposition code description.
Trigger Criteria:
- Context: Formatted before quantity, after quantity, and disposition code description
- Applied to: Create Quantity Impact Message
- Action: Impact message creation is performed
Logic Flow:
IF Formatted before quantity, after quantity, and disposition code description
AND Impact message creation is performed
THEN:
- • The system creates a formatted message showing the quantity impact of the disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when created quantity impact message and existing merlin message structure.
Trigger Criteria:
- Context: Created quantity impact message and existing Merlin message structure
- Applied to: Include Impact Details in Merlin Message
- Action: Merlin message assembly is performed
Logic Flow:
IF Created quantity impact message and existing Merlin message structure
AND Merlin message assembly is performed
THEN:
- • The quantity impact details are included in the Merlin message for stakeholder notification
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when quantity impact message and available k1 segment comments.
Trigger Criteria:
- Context: Quantity impact message and available K1 segment comments
- Applied to: Add Special Comments if Available
- Action: Special comments are available for inclusion
Logic Flow:
IF Quantity impact message and available K1 segment comments
AND Special comments are available for inclusion
THEN:
- • The system adds up to the maximum allowed special comments to the impact message
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all impact message components including quantities, descriptions, and comments.
Trigger Criteria:
- Context: All impact message components including quantities, descriptions, and comments
- Applied to: Format Complete Release Impact Report
- Action: Final report formatting is performed
Logic Flow:
IF All impact message components including quantities, descriptions, and comments
AND Final report formatting is performed
THEN:
- • The system creates a complete formatted release impact report ready for distribution
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code is being processed for a cargo.
Trigger Criteria:
- Context: A disposition code is being processed for a cargo
- Applied to: Identify Disposition Code Action Type
- Action: The system evaluates the disposition code's impact on quantities
Logic Flow:
IF A disposition code is being processed for a cargo
AND The system evaluates the disposition code's impact on quantities
THEN:
- • The action type is identified as either quantity addition, quantity subtraction, or no quantity change
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code with defined quantity impact rules.
Trigger Criteria:
- Context: A disposition code with defined quantity impact rules
- Applied to: Disposition Code Action?
- Action: The system processes the disposition code for quantity calculations
Logic Flow:
IF A disposition code with defined quantity impact rules
AND The system processes the disposition code for quantity calculations
THEN:
- • The system routes to add quantity processing if the code increases release amounts, subtract quantity processing if it decreases amounts, or no change processing if quantities remain the same
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code that adds to cargo release quantities and the current release amount.
Trigger Criteria:
- Context: A disposition code that adds to cargo release quantities and the current release amount
- Applied to: Calculate Quantity Addition
- Action: The system processes a quantity-increasing disposition code
Logic Flow:
IF A disposition code that adds to cargo release quantities and the current release amount
AND The system processes a quantity-increasing disposition code
THEN:
- • The additional quantity amount is calculated based on the disposition code rules and cargo specifications
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code that subtracts from cargo release quantities and the current release amount.
Trigger Criteria:
- Context: A disposition code that subtracts from cargo release quantities and the current release amount
- Applied to: Calculate Quantity Subtraction
- Action: The system processes a quantity-decreasing disposition code
Logic Flow:
IF A disposition code that subtracts from cargo release quantities and the current release amount
AND The system processes a quantity-decreasing disposition code
THEN:
- • The subtraction quantity amount is calculated based on the disposition code rules and current cargo quantities
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when current cargo release quantity and calculated quantity change amount from disposition code processing.
Trigger Criteria:
- Context: Current cargo release quantity and calculated quantity change amount from disposition code processing
- Applied to: Determine New Release Quantity
- Action: The system applies the disposition code quantity impact
Logic Flow:
IF Current cargo release quantity and calculated quantity change amount from disposition code processing
AND The system applies the disposition code quantity impact
THEN:
- • The new release quantity is determined by applying the calculated addition, subtraction, or no change to the current quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when current cargo release quantity retrieved from cargo record.
Trigger Criteria:
- Context: Current cargo release quantity retrieved from cargo record
- Applied to: Format Before Quantity Display
- Action: The system prepares quantity impact messaging
Logic Flow:
IF Current cargo release quantity retrieved from cargo record
AND The system prepares quantity impact messaging
THEN:
- • The current quantity is formatted for display as the 'before' quantity in impact messages
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when new release quantity calculated after disposition code processing.
Trigger Criteria:
- Context: New release quantity calculated after disposition code processing
- Applied to: Format After Quantity Display
- Action: The system prepares quantity impact messaging
Logic Flow:
IF New release quantity calculated after disposition code processing
AND The system prepares quantity impact messaging
THEN:
- • The new quantity is formatted for display as the 'after' quantity in impact messages
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when formatted before and after quantity displays.
Trigger Criteria:
- Context: Formatted before and after quantity displays
- Applied to: Create Quantity Impact Message
- Action: The system generates quantity impact messaging
Logic Flow:
IF Formatted before and after quantity displays
AND The system generates quantity impact messaging
THEN:
- • A quantity impact message is created showing the quantity change from disposition code processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when quantity impact message and merlin message configuration rules.
Trigger Criteria:
- Context: A quantity impact message and Merlin message configuration rules
- Applied to: Include in Merlin Message?
- Action: The system evaluates whether to include quantity impact details in Merlin notifications
Logic Flow:
IF A quantity impact message and Merlin message configuration rules
AND The system evaluates whether to include quantity impact details in Merlin notifications
THEN:
- • The system includes impact details in the Merlin message if configuration rules require it,
otherwise finalizes the message without impact details
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when merlin message and quantity impact details that should be included.
Trigger Criteria:
- Context: A Merlin message and quantity impact details that should be included
- Applied to: Add Impact Details to Message
- Action: The system processes Merlin message formatting with quantity impact inclusion
Logic Flow:
IF A Merlin message and quantity impact details that should be included
AND The system processes Merlin message formatting with quantity impact inclusion
THEN:
- • The quantity impact details are added to the Merlin message content
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when quantity impact details and disposition code information.
Trigger Criteria:
- Context: Quantity impact details and disposition code information
- Applied to: Format Complete Impact Statement
- Action: The system creates comprehensive impact messaging
Logic Flow:
IF Quantity impact details and disposition code information
AND The system creates comprehensive impact messaging
THEN:
- • A complete impact statement is formatted showing both the disposition code action and its quantity effects
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when quantity impact message and k1 segment comments associated with the cargo.
Trigger Criteria:
- Context: A quantity impact message and K1 segment comments associated with the cargo
- Applied to: Include K1 Comments if Present
- Action: The system finalizes impact messaging and K1 comments exist
Logic Flow:
IF A quantity impact message and K1 segment comments associated with the cargo
AND The system finalizes impact messaging and K1 comments exist
THEN:
- • The K1 comments are included in the impact message to provide additional context
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all quantity impact message components including before/after quantities, disposition code details, and optional k1 comments.
Trigger Criteria:
- Context: All quantity impact message components including before/after quantities, disposition code details, and optional K1 comments
- Applied to: Finalize Release Quantity Impact Message
- Action: The system completes quantity impact message processing
Logic Flow:
IF All quantity impact message components including before/after quantities, disposition code details, and optional K1 comments
AND The system completes quantity impact message processing
THEN:
- • The release quantity impact message is finalized with all components properly formatted and ready for delivery
R-GCX016E-cbl-01147 (+12) File: GCX016E.cbl Business Rule: Cargo Status Integration
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record with equipment information is being processed for gcciis integration.
Trigger Criteria:
- Context: A cargo record with equipment information is being processed for GCCIIS integration
- Applied to: Equipment Type Valid?
- Action: The system checks the equipment type against valid categories
Logic Flow:
IF A cargo record with equipment information is being processed for GCCIIS integration
AND The system checks the equipment type against valid categories
THEN:
- • Only containers, trailers, and chassis equipment types are allowed to proceed with GCCIIS integration, all other equipment types are excluded
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record with valid equipment type is ready for gcciis processing.
Trigger Criteria:
- Context: A cargo record with valid equipment type is ready for GCCIIS processing
- Applied to: Cargo Status Available?
- Action: The system checks for the presence of cargo status information
Logic Flow:
IF A cargo record with valid equipment type is ready for GCCIIS processing
AND The system checks for the presence of cargo status information
THEN:
- • Integration proceeds only when cargo status data is available,
otherwise the integration is skipped
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record with available status information.
Trigger Criteria:
- Context: A cargo record with available status information
- Applied to: Map Internal Status to GCCIIS Format
- Action: The system processes the internal status code for GCCIIS transmission
Logic Flow:
IF A cargo record with available status information
AND The system processes the internal status code for GCCIIS transmission
THEN:
- • The internal status is mapped to the corresponding GCCIIS status format according to predefined conversion rules
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status has been mapped to gcciis format.
Trigger Criteria:
- Context: A cargo status has been mapped to GCCIIS format
- Applied to: Status Type?
- Action: The system evaluates the status type for routing to appropriate processing logic
Logic Flow:
IF A cargo status has been mapped to GCCIIS format
AND The system evaluates the status type for routing to appropriate processing logic
THEN:
- • Status is classified as HOLD, RELEASE, PTT (Proceed to Transit), or PTT-EX (Proceed to Export) based on cargo disposition
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo status is classified as a hold type.
Trigger Criteria:
- Context: A cargo status is classified as a hold type
- Applied to: Map to HOLD Status
- Action: The system processes the hold status for GCCIIS integration
Logic Flow:
IF A cargo status is classified as a hold type
AND The system processes the hold status for GCCIIS integration
THEN:
- • The status is mapped to HOLD format with appropriate hold reason codes and location information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo status is classified as a release type.
Trigger Criteria:
- Context: A cargo status is classified as a release type
- Applied to: Map to RELEASE Status
- Action: The system processes the release status for GCCIIS integration
Logic Flow:
IF A cargo status is classified as a release type
AND The system processes the release status for GCCIIS integration
THEN:
- • The status is mapped to RELEASE format with release authorization and quantity information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo status is classified as proceed to transit.
Trigger Criteria:
- Context: A cargo status is classified as Proceed to Transit
- Applied to: Map to PTT Status
- Action: The system processes the PTT status for GCCIIS integration
Logic Flow:
IF A cargo status is classified as Proceed to Transit
AND The system processes the PTT status for GCCIIS integration
THEN:
- • The status is mapped to PTT format with transit authorization and destination information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo status is classified as proceed to export.
Trigger Criteria:
- Context: A cargo status is classified as Proceed to Export
- Applied to: Map to PTT-EX Status
- Action: The system processes the PTT-EX status for GCCIIS integration
Logic Flow:
IF A cargo status is classified as Proceed to Export
AND The system processes the PTT-EX status for GCCIIS integration
THEN:
- • The status is mapped to PTT-EX format with export authorization and port information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo status has been processed and mapped for gcciis.
Trigger Criteria:
- Context: A cargo status has been processed and mapped for GCCIIS
- Applied to: Release Quantity Check
- Action: The system evaluates whether quantity validation is required
Logic Flow:
IF A cargo status has been processed and mapped for GCCIIS
AND The system evaluates whether quantity validation is required
THEN:
- • Release status types require quantity verification while other status types proceed directly to status update
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo with release status requires quantity verification.
Trigger Criteria:
- Context: A cargo with release status requires quantity verification
- Applied to: Verify Released Quantity = Total Quantity
- Action: The system compares released quantity against total cargo quantity
Logic Flow:
IF A cargo with release status requires quantity verification
AND The system compares released quantity against total cargo quantity
THEN:
- • Full release notification is sent only when released quantity equals total quantity,
otherwise partial release status is maintained
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has been verified as fully released with matching quantities.
Trigger Criteria:
- Context: A cargo has been verified as fully released with matching quantities
- Applied to: Send Full Release Notification to GCCIIS
- Action: The system sends notification to GCCIIS
Logic Flow:
IF A cargo has been verified as fully released with matching quantities
AND The system sends notification to GCCIIS
THEN:
- • A full release notification is transmitted with complete cargo and quantity details
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status has been processed and does not require full release verification or quantities do not match.
Trigger Criteria:
- Context: A cargo status has been processed and does not require full release verification or quantities do not match
- Applied to: Send Status Update to GCCIIS
- Action: The system sends status information to GCCIIS
Logic Flow:
IF A cargo status has been processed and does not require full release verification or quantities do not match
AND The system sends status information to GCCIIS
THEN:
- • A status update notification is transmitted with current cargo status and relevant details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when gcciis notification has been successfully transmitted.
Trigger Criteria:
- Context: GCCIIS notification has been successfully transmitted
- Applied to: Update Equipment Tracking Status
- Action: The system updates internal tracking records
Logic Flow:
IF GCCIIS notification has been successfully transmitted
AND The system updates internal tracking records
THEN:
- • Equipment tracking status is updated to reflect the GCCIIS integration completion and timestamp
R-GCX016E-cbl-01160 (+5) File: GCX016E.cbl Business Rule: Freight Forwarder Disposition Code Validation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code needs to be validated for freight forwarder processing.
Trigger Criteria:
- Context: A disposition code needs to be validated for freight forwarder processing
- Applied to: Search Broker Database for Freight Forwarder Codes
- Action: The system searches the GCST2RT broker database for freight forwarder disposition codes
Logic Flow:
IF A disposition code needs to be validated for freight forwarder processing
AND The system searches the GCST2RT broker database for freight forwarder disposition codes
THEN:
- • The system identifies whether the disposition code exists in the freight forwarder records
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code has been searched in the broker database.
Trigger Criteria:
- Context: A disposition code has been searched in the broker database
- Applied to: Disposition Code Found in Broker Database?
- Action: The system evaluates if the disposition code was found in the freight forwarder records
Logic Flow:
IF A disposition code has been searched in the broker database
AND The system evaluates if the disposition code was found in the freight forwarder records
THEN:
- • The system either proceeds with freight forwarder information retrieval or marks it as a standard disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code has been identified as a freight forwarder code in the broker database.
Trigger Criteria:
- Context: A disposition code has been identified as a freight forwarder code in the broker database
- Applied to: Retrieve Freight Forwarder Information
- Action: The system accesses GCSUSS03 and GCSUSS07 cargo segments to retrieve freight forwarder data
Logic Flow:
IF A disposition code has been identified as a freight forwarder code in the broker database
AND The system accesses GCSUSS03 and GCSUSS07 cargo segments to retrieve freight forwarder data
THEN:
- • The system obtains the complete freight forwarder information for further validation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when freight forwarder information has been retrieved from cargo segments.
Trigger Criteria:
- Context: Freight forwarder information has been retrieved from cargo segments
- Applied to: Is Valid Freight Forwarder Code?
- Action: The system validates the code against freight forwarder records in the broker database
Logic Flow:
IF Freight forwarder information has been retrieved from cargo segments
AND The system validates the code against freight forwarder records in the broker database
THEN:
- • The system determines if the code represents a valid freight forwarder disposition or should be processed as a standard code
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code has been validated as a legitimate freight forwarder code.
Trigger Criteria:
- Context: A disposition code has been validated as a legitimate freight forwarder code
- Applied to: Mark Code as Valid Freight Forwarder Disposition
- Action: The system marks the code as a valid freight forwarder disposition
Logic Flow:
IF A disposition code has been validated as a legitimate freight forwarder code
AND The system marks the code as a valid freight forwarder disposition
THEN:
- • The system sets the freight forwarder processing flag and continues with freight forwarder-specific processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is either not found in the broker database or fails freight forwarder validation.
Trigger Criteria:
- Context: A disposition code is either not found in the broker database or fails freight forwarder validation
- Applied to: Mark Code as Standard Disposition Code
- Action: The system marks the code as a standard disposition code
Logic Flow:
IF A disposition code is either not found in the broker database or fails freight forwarder validation
AND The system marks the code as a standard disposition code
THEN:
- • The system continues with standard disposition code processing without freight forwarder-specific handling
R-GCX016E-cbl-01166 (+11) File: GCX016E.cbl Business Rule: Cargo Segment Analysis for Freight Forwarders
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo requires freight forwarder analysis.
Trigger Criteria:
- Context: A cargo requires freight forwarder analysis
- Applied to: Retrieve Cargo Segment Data from GCSUSS03
- Action: The system initiates cargo segment retrieval from GCSUSS03
Logic Flow:
IF A cargo requires freight forwarder analysis
AND The system initiates cargo segment retrieval from GCSUSS03
THEN:
- • The primary cargo segment data is retrieved from GCSUSS03 for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo segment retrieval attempt has been made from gcsuss03.
Trigger Criteria:
- Context: A cargo segment retrieval attempt has been made from GCSUSS03
- Applied to: GCSUSS03 Segment Found?
- Action: The system checks if GCSUSS03 segment data was found
Logic Flow:
IF A cargo segment retrieval attempt has been made from GCSUSS03
AND The system checks if GCSUSS03 segment data was found
THEN:
- • The system determines if GCSUSS03 segment exists and routes processing accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when gcsuss03 cargo segment data is available.
Trigger Criteria:
- Context: GCSUSS03 cargo segment data is available
- Applied to: Extract Freight Forwarder Information from GCSUSS03
- Action: The system processes the GCSUSS03 segment
Logic Flow:
IF GCSUSS03 cargo segment data is available
AND The system processes the GCSUSS03 segment
THEN:
- • Freight forwarder information is extracted from the GCSUSS03 segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when primary cargo segment processing is complete or gcsuss03 segment was not found.
Trigger Criteria:
- Context: Primary cargo segment processing is complete or GCSUSS03 segment was not found
- Applied to: Retrieve Additional Cargo Data from GCSUSS07
- Action: The system initiates extended cargo data retrieval from GCSUSS07
Logic Flow:
IF Primary cargo segment processing is complete or GCSUSS03 segment was not found
AND The system initiates extended cargo data retrieval from GCSUSS07
THEN:
- • Additional cargo segment data is retrieved from GCSUSS07 for enhanced freight forwarder analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when extended cargo segment retrieval attempt has been made from gcsuss07.
Trigger Criteria:
- Context: An extended cargo segment retrieval attempt has been made from GCSUSS07
- Applied to: GCSUSS07 Segment Found?
- Action: The system checks if GCSUSS07 segment data was found
Logic Flow:
IF An extended cargo segment retrieval attempt has been made from GCSUSS07
AND The system checks if GCSUSS07 segment data was found
THEN:
- • The system determines if GCSUSS07 segment exists and routes processing accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when gcsuss07 extended cargo segment data is available.
Trigger Criteria:
- Context: GCSUSS07 extended cargo segment data is available
- Applied to: Extract Extended Freight Forwarder Details from GCSUSS07
- Action: The system processes the GCSUSS07 segment
Logic Flow:
IF GCSUSS07 extended cargo segment data is available
AND The system processes the GCSUSS07 segment
THEN:
- • Extended freight forwarder details are extracted from the GCSUSS07 segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when freight forwarder information has been extracted from available cargo segments.
Trigger Criteria:
- Context: Freight forwarder information has been extracted from available cargo segments
- Applied to: Consolidate Freight Forwarder Information
- Action: The system consolidates the extracted freight forwarder data
Logic Flow:
IF Freight forwarder information has been extracted from available cargo segments
AND The system consolidates the extracted freight forwarder data
THEN:
- • All available freight forwarder information is combined into a unified dataset for validation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when freight forwarder information has been consolidated from available cargo segments.
Trigger Criteria:
- Context: Freight forwarder information has been consolidated from available cargo segments
- Applied to: Validate Freight Forwarder Data Completeness
- Action: The system validates the completeness of freight forwarder data
Logic Flow:
IF Freight forwarder information has been consolidated from available cargo segments
AND The system validates the completeness of freight forwarder data
THEN:
- • The system determines if sufficient freight forwarder information exists for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when freight forwarder data validation has been completed.
Trigger Criteria:
- Context: Freight forwarder data validation has been completed
- Applied to: Freight Forwarder Identified?
- Action: The system evaluates if a freight forwarder has been successfully identified
Logic Flow:
IF Freight forwarder data validation has been completed
AND The system evaluates if a freight forwarder has been successfully identified
THEN:
- • The system determines the freight forwarder identification status and routes processing accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid freight forwarder has been successfully identified from cargo segment analysis.
Trigger Criteria:
- Context: A valid freight forwarder has been successfully identified from cargo segment analysis
- Applied to: Set Freight Forwarder Found Flag
- Action: The system processes the successful freight forwarder identification
Logic Flow:
IF A valid freight forwarder has been successfully identified from cargo segment analysis
AND The system processes the successful freight forwarder identification
THEN:
- • The freight forwarder found flag is set to indicate successful identification
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when freight forwarder has been successfully identified and the found flag has been set.
Trigger Criteria:
- Context: A freight forwarder has been successfully identified and the found flag has been set
- Applied to: Prepare Freight Forwarder Data for Processing
- Action: The system prepares the freight forwarder data for downstream processing
Logic Flow:
IF A freight forwarder has been successfully identified and the found flag has been set
AND The system prepares the freight forwarder data for downstream processing
THEN:
- • Freight forwarder data is formatted and made available for subsequent business processes
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo segment analysis has been completed but no valid freight forwarder was identified.
Trigger Criteria:
- Context: Cargo segment analysis has been completed but no valid freight forwarder was identified
- Applied to: Log Freight Forwarder Not Found
- Action: The system processes the freight forwarder not found condition
Logic Flow:
IF Cargo segment analysis has been completed but no valid freight forwarder was identified
AND The system processes the freight forwarder not found condition
THEN:
- • A freight forwarder not found event is logged for audit and tracking purposes
R-GCX016E-cbl-01178 (+10) File: GCX016E.cbl Business Rule: Freight Forwarder Information Retrieval
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code is being processed for cargo.
Trigger Criteria:
- Context: A disposition code is being processed for cargo
- Applied to: Search Broker Database for Freight Forwarder Disposition Codes
- Action: The system searches the broker table segments for freight forwarder disposition codes
Logic Flow:
IF A disposition code is being processed for cargo
AND The system searches the broker table segments for freight forwarder disposition codes
THEN:
- • The system identifies whether the disposition code is associated with a freight forwarder
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when broker table search for freight forwarder disposition codes has been completed.
Trigger Criteria:
- Context: The broker table search for freight forwarder disposition codes has been completed
- Applied to: Freight Forwarder Code Found?
- Action: The system evaluates the search results
Logic Flow:
IF The broker table search for freight forwarder disposition codes has been completed
AND The system evaluates the search results
THEN:
- • The system determines if a freight forwarder code was found and proceeds with appropriate processing path
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when freight forwarder code has been found in the broker table.
Trigger Criteria:
- Context: A freight forwarder code has been found in the broker table
- Applied to: Retrieve Cargo Segment Data from GCSUSS03
- Action: The system needs cargo segment information for freight forwarder processing
Logic Flow:
IF A freight forwarder code has been found in the broker table
AND The system needs cargo segment information for freight forwarder processing
THEN:
- • The system retrieves cargo segment data from GCSUSS03 database
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when primary cargo segment data has been retrieved from gcsuss03.
Trigger Criteria:
- Context: Primary cargo segment data has been retrieved from GCSUSS03
- Applied to: Retrieve Additional Cargo Data from GCSUSS07
- Action: The system requires additional cargo information for freight forwarder processing
Logic Flow:
IF Primary cargo segment data has been retrieved from GCSUSS03
AND The system requires additional cargo information for freight forwarder processing
THEN:
- • The system retrieves additional cargo data from GCSUSS07 database
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo segment data has been retrieved from both gcsuss03 and gcsuss07.
Trigger Criteria:
- Context: Cargo segment data has been retrieved from both GCSUSS03 and GCSUSS07
- Applied to: Extract Freight Forwarder Information from Cargo Segments
- Action: The system processes the cargo segment data
Logic Flow:
IF Cargo segment data has been retrieved from both GCSUSS03 and GCSUSS07
AND The system processes the cargo segment data
THEN:
- • The system extracts freight forwarder identification and related information from the cargo segments
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when freight forwarder information has been extracted from cargo segments.
Trigger Criteria:
- Context: Freight forwarder information has been extracted from cargo segments
- Applied to: Lookup Freight Forwarder Name in Broker Tables
- Action: The system needs to resolve the freight forwarder name
Logic Flow:
IF Freight forwarder information has been extracted from cargo segments
AND The system needs to resolve the freight forwarder name
THEN:
- • The system looks up the freight forwarder name in the GCST2RT broker name segments table
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when freight forwarder name has been successfully looked up in broker tables.
Trigger Criteria:
- Context: The freight forwarder name has been successfully looked up in broker tables
- Applied to: Retrieve Associated Broker Information
- Action: The system requires complete broker information for the freight forwarder
Logic Flow:
IF The freight forwarder name has been successfully looked up in broker tables
AND The system requires complete broker information for the freight forwarder
THEN:
- • The system retrieves associated broker information from the GCSTBRT broker table segments
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when associated broker information has been retrieved for the freight forwarder.
Trigger Criteria:
- Context: Associated broker information has been retrieved for the freight forwarder
- Applied to: Get Freight Forwarder Contact Details
- Action: The system needs contact information for freight forwarder notifications
Logic Flow:
IF Associated broker information has been retrieved for the freight forwarder
AND The system needs contact information for freight forwarder notifications
THEN:
- • The system retrieves freight forwarder contact details including email addresses and communication preferences from broker table segments
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when all freight forwarder information components have been retrieved including name, broker details, and contact information.
Trigger Criteria:
- Context: All freight forwarder information components have been retrieved including name, broker details, and contact information
- Applied to: Compile Complete Freight Forwarder Profile
- Action: The system needs to create a complete freight forwarder profile
Logic Flow:
IF All freight forwarder information components have been retrieved including name, broker details, and contact information
AND The system needs to create a complete freight forwarder profile
THEN:
- • The system compiles all retrieved information into a comprehensive freight forwarder profile
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when complete freight forwarder profile has been compiled.
Trigger Criteria:
- Context: A complete freight forwarder profile has been compiled
- Applied to: Return Freight Forwarder Information
- Action: The freight forwarder information retrieval process is complete
Logic Flow:
IF A complete freight forwarder profile has been compiled
AND The freight forwarder information retrieval process is complete
THEN:
- • The system returns the complete freight forwarder information for use in cargo processing and notifications
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when no freight forwarder code was found during the broker table search.
Trigger Criteria:
- Context: No freight forwarder code was found during the broker table search
- Applied to: No Freight Forwarder Information Available
- Action: The system cannot locate freight forwarder information for the disposition code
Logic Flow:
IF No freight forwarder code was found during the broker table search
AND The system cannot locate freight forwarder information for the disposition code
THEN:
- • The system indicates that no freight forwarder information is available and continues processing without freight forwarder-specific actions
R-GCX016E-cbl-01189 (+15) File: GCX016E.cbl Business Rule: Freight Forwarder Contact Information
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record exists with segment data.
Trigger Criteria:
- Context: A cargo record exists with segment data
- Applied to: Retrieve Freight Forwarder Information from Cargo Segments
- Action: The system processes freight forwarder contact information retrieval
Logic Flow:
IF A cargo record exists with segment data
AND The system processes freight forwarder contact information retrieval
THEN:
- • The freight forwarder code is extracted from the cargo segments for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo segment data has been retrieved.
Trigger Criteria:
- Context: Cargo segment data has been retrieved
- Applied to: Freight Forwarder Code Found?
- Action: The system checks for freight forwarder code presence
Logic Flow:
IF Cargo segment data has been retrieved
AND The system checks for freight forwarder code presence
THEN:
- • If freight forwarder code exists, proceed to name lookup;
otherwise log no code found and end process
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid freight forwarder code exists.
Trigger Criteria:
- Context: A valid freight forwarder code exists
- Applied to: Look up Freight Forwarder Name in Broker Database
- Action: The system performs a lookup in the GCST2RT broker name segments
Logic Flow:
IF A valid freight forwarder code exists
AND The system performs a lookup in the GCST2RT broker name segments
THEN:
- • The corresponding freight forwarder name is retrieved from the database
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when lookup has been performed in the broker name database.
Trigger Criteria:
- Context: A lookup has been performed in the broker name database
- Applied to: Freight Forwarder Name Found?
- Action: The system checks the lookup results
Logic Flow:
IF A lookup has been performed in the broker name database
AND The system checks the lookup results
THEN:
- • If freight forwarder name is found, proceed to retrieve broker information;
otherwise log name not found and end process
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid freight forwarder name has been found.
Trigger Criteria:
- Context: A valid freight forwarder name has been found
- Applied to: Retrieve Associated Broker Information
- Action: The system retrieves associated broker information
Logic Flow:
IF A valid freight forwarder name has been found
AND The system retrieves associated broker information
THEN:
- • The broker details linked to the freight forwarder are obtained for email address lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when freight forwarder name has been found in the database.
Trigger Criteria:
- Context: A freight forwarder name has been found in the database
- Applied to: Broker Information Available?
- Action: The system checks for associated broker information
Logic Flow:
IF A freight forwarder name has been found in the database
AND The system checks for associated broker information
THEN:
- • If broker information is available, proceed to fetch email address;
otherwise log no broker information and end process
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid broker information is available.
Trigger Criteria:
- Context: Valid broker information is available
- Applied to: Fetch Email Address from Broker Table
- Action: The system accesses the GCSTBRT broker table segments
Logic Flow:
IF Valid broker information is available
AND The system accesses the GCSTBRT broker table segments
THEN:
- • The email address associated with the broker is retrieved from the table
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when lookup has been performed in the broker table.
Trigger Criteria:
- Context: A lookup has been performed in the broker table
- Applied to: Email Address Found?
- Action: The system checks if an email address was found
Logic Flow:
IF A lookup has been performed in the broker table
AND The system checks if an email address was found
THEN:
- • If email address exists, proceed to validation;
otherwise log no email address found and end process
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when email address has been retrieved from the broker table.
Trigger Criteria:
- Context: An email address has been retrieved from the broker table
- Applied to: Validate Email Address Format
- Action: The system validates the email address format
Logic Flow:
IF An email address has been retrieved from the broker table
AND The system validates the email address format
THEN:
- • The email address format is checked for validity according to standard email formatting rules
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when email address format validation has been performed.
Trigger Criteria:
- Context: Email address format validation has been performed
- Applied to: Email Valid?
- Action: The system evaluates the validation results
Logic Flow:
IF Email address format validation has been performed
AND The system evaluates the validation results
THEN:
- • If email format is valid, store for notification;
otherwise log invalid format and end process
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid email address has been confirmed.
Trigger Criteria:
- Context: A valid email address has been confirmed
- Applied to: Store Email Address for Notification
- Action: The system stores the email address
Logic Flow:
IF A valid email address has been confirmed
AND The system stores the email address
THEN:
- • The email address is saved for subsequent notification processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo segment data has been processed.
Trigger Criteria:
- Context: Cargo segment data has been processed
- Applied to: No Freight Forwarder Code Found
- Action: No freight forwarder code is found in the data
Logic Flow:
IF Cargo segment data has been processed
AND No freight forwarder code is found in the data
THEN:
- • A log entry is created indicating no freight forwarder code was found
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when freight forwarder code exists but name lookup has been performed.
Trigger Criteria:
- Context: A freight forwarder code exists but name lookup has been performed
- Applied to: Freight Forwarder Name Not Found
- Action: The freight forwarder name is not found in the broker database
Logic Flow:
IF A freight forwarder code exists but name lookup has been performed
AND The freight forwarder name is not found in the broker database
THEN:
- • A log entry is created indicating the freight forwarder name was not found
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when freight forwarder name has been found.
Trigger Criteria:
- Context: A freight forwarder name has been found
- Applied to: No Broker Information Available
- Action: No associated broker information is available
Logic Flow:
IF A freight forwarder name has been found
AND No associated broker information is available
THEN:
- • A log entry is created indicating no broker information is available
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when broker information is available and email lookup has been performed.
Trigger Criteria:
- Context: Broker information is available and email lookup has been performed
- Applied to: No Email Address Found
- Action: No email address is found in the broker table
Logic Flow:
IF Broker information is available and email lookup has been performed
AND No email address is found in the broker table
THEN:
- • A log entry is created indicating no email address was found
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when email address has been retrieved and format validation performed.
Trigger Criteria:
- Context: An email address has been retrieved and format validation performed
- Applied to: Invalid Email Format
- Action: The email address format is determined to be invalid
Logic Flow:
IF An email address has been retrieved and format validation performed
AND The email address format is determined to be invalid
THEN:
- • A log entry is created indicating the email format is invalid
R-GCX016E-cbl-01205 (+23) File: GCX016E.cbl Business Rule: CIH Hold Email Notification
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is being processed for cargo.
Trigger Criteria:
- Context: A disposition code is being processed for cargo
- Applied to: Is Disposition Code CIH?
- Action: The system checks the disposition code value
Logic Flow:
IF A disposition code is being processed for cargo
AND The system checks the disposition code value
THEN:
- • If the disposition code equals 'CIH', proceed with email notification processing,
otherwise skip email notification
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is being processed for cargo.
Trigger Criteria:
- Context: A disposition code is being processed for cargo
- Applied to: Skip Email - No CIH Code
- Action: The disposition code is not equal to 'CIH'
Logic Flow:
IF A disposition code is being processed for cargo
AND The disposition code is not equal to 'CIH'
THEN:
- • The system skips all email notification processing and completes the notification process
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cih disposition code has been identified for cargo.
Trigger Criteria:
- Context: A CIH disposition code has been identified for cargo
- Applied to: Search Broker Database for Freight Forwarder
- Action: The system searches the broker name table for freight forwarder disposition codes
Logic Flow:
IF A CIH disposition code has been identified for cargo
AND The system searches the broker name table for freight forwarder disposition codes
THEN:
- • The system retrieves freight forwarder information from the broker database if available
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when system has searched the broker database for freight forwarder information.
Trigger Criteria:
- Context: The system has searched the broker database for freight forwarder information
- Applied to: Freight Forwarder Found?
- Action: The search results are evaluated
Logic Flow:
IF The system has searched the broker database for freight forwarder information
AND The search results are evaluated
THEN:
- • If a freight forwarder is found, continue with cargo data retrieval,
otherwise complete email notification process without sending email
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when freight forwarder has been found for the cargo.
Trigger Criteria:
- Context: A freight forwarder has been found for the cargo
- Applied to: Retrieve Cargo Segment Data
- Action: The system accesses cargo secondary data segments
Logic Flow:
IF A freight forwarder has been found for the cargo
AND The system accesses cargo secondary data segments
THEN:
- • The system retrieves forwarder and consignee information from cargo segments GCSUSS03 and GCSUSS07
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo segment data has been successfully retrieved.
Trigger Criteria:
- Context: Cargo segment data has been successfully retrieved
- Applied to: Extract Freight Forwarder Information
- Action: The system processes the cargo segment information
Logic Flow:
IF Cargo segment data has been successfully retrieved
AND The system processes the cargo segment information
THEN:
- • The system extracts freight forwarder identification and contact details from the cargo segments
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when freight forwarder information has been extracted from cargo segments.
Trigger Criteria:
- Context: Freight forwarder information has been extracted from cargo segments
- Applied to: Lookup Freight Forwarder Name and Broker Info
- Action: The system performs a lookup in the broker name segments table (GCST2RT)
Logic Flow:
IF Freight forwarder information has been extracted from cargo segments
AND The system performs a lookup in the broker name segments table (GCST2RT)
THEN:
- • The system retrieves the freight forwarder name and associated broker information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when freight forwarder name and broker information lookup has been completed.
Trigger Criteria:
- Context: Freight forwarder name and broker information lookup has been completed
- Applied to: Valid Freight Forwarder?
- Action: The system validates the retrieved freight forwarder data
Logic Flow:
IF Freight forwarder name and broker information lookup has been completed
AND The system validates the retrieved freight forwarder data
THEN:
- • If the freight forwarder information is valid and complete, proceed with email address retrieval,
otherwise complete notification process without sending email
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid freight forwarder has been identified.
Trigger Criteria:
- Context: A valid freight forwarder has been identified
- Applied to: Retrieve Email Address from Broker Table
- Action: The system accesses the broker table segments (GCSTBRT)
Logic Flow:
IF A valid freight forwarder has been identified
AND The system accesses the broker table segments (GCSTBRT)
THEN:
- • The system retrieves the email address associated with the freight forwarder
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when system has attempted to retrieve an email address from the broker table.
Trigger Criteria:
- Context: The system has attempted to retrieve an email address from the broker table
- Applied to: Email Address Found?
- Action: The email address retrieval results are evaluated
Logic Flow:
IF The system has attempted to retrieve an email address from the broker table
AND The email address retrieval results are evaluated
THEN:
- • If a valid email address is found, proceed with email content building,
otherwise complete notification process without sending email
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid email address has been found for the freight forwarder.
Trigger Criteria:
- Context: A valid email address has been found for the freight forwarder
- Applied to: Build Comprehensive Email Content
- Action: The system builds the email notification content
Logic Flow:
IF A valid email address has been found for the freight forwarder
AND The system builds the email notification content
THEN:
- • The system creates comprehensive email content including equipment information, waybill details, CCN information, content description, origin/destination stations, CIH disposition information, and processing timestamps
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when email content building has started for cih notification.
Trigger Criteria:
- Context: Email content building has started for CIH notification
- Applied to: Include Equipment Information
- Action: The system processes equipment data for the email
Logic Flow:
IF Email content building has started for CIH notification
AND The system processes equipment data for the email
THEN:
- • The system includes equipment type, identification, and related details in the email content
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment information has been included in the email content.
Trigger Criteria:
- Context: Equipment information has been included in the email content
- Applied to: Include Waybill and CCN Details
- Action: The system processes waybill and CCN information
Logic Flow:
IF Equipment information has been included in the email content
AND The system processes waybill and CCN information
THEN:
- • The system includes waybill number and CCN details in the email notification content
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when waybill and ccn details have been included in the email content.
Trigger Criteria:
- Context: Waybill and CCN details have been included in the email content
- Applied to: Include Content Description
- Action: The system processes cargo content description data
Logic Flow:
IF Waybill and CCN details have been included in the email content
AND The system processes cargo content description data
THEN:
- • The system includes detailed cargo content description in the email notification
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when content description has been included in the email content.
Trigger Criteria:
- Context: Content description has been included in the email content
- Applied to: Include Origin/Destination Stations
- Action: The system processes origin and destination station data
Logic Flow:
IF Content description has been included in the email content
AND The system processes origin and destination station data
THEN:
- • The system includes origin and destination station names and codes in the email notification
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when origin and destination station information has been included in the email content.
Trigger Criteria:
- Context: Origin and destination station information has been included in the email content
- Applied to: Include CIH Disposition Information
- Action: The system processes CIH disposition information
Logic Flow:
IF Origin and destination station information has been included in the email content
AND The system processes CIH disposition information
THEN:
- • The system includes CIH disposition code details, hold reasons, and related customs information in the email notification
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cih disposition information has been included in the email content.
Trigger Criteria:
- Context: CIH disposition information has been included in the email content
- Applied to: Include Processing Timestamps
- Action: The system processes timestamp information
Logic Flow:
IF CIH disposition information has been included in the email content
AND The system processes timestamp information
THEN:
- • The system includes processing date, time, and relevant timestamps in the email notification content
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when comprehensive email content has been built with all required information.
Trigger Criteria:
- Context: Comprehensive email content has been built with all required information
- Applied to: Send Email Notification
- Action: The system attempts to send the email notification
Logic Flow:
IF Comprehensive email content has been built with all required information
AND The system attempts to send the email notification
THEN:
- • The system transmits the email to the freight forwarder's email address and captures delivery status
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when email notification has been sent to the freight forwarder.
Trigger Criteria:
- Context: An email notification has been sent to the freight forwarder
- Applied to: Email Delivery Successful?
- Action: The system evaluates the email delivery status
Logic Flow:
IF An email notification has been sent to the freight forwarder
AND The system evaluates the email delivery status
THEN:
- • If email delivery is successful, log successful delivery,
otherwise initiate retry process
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when email notification has been successfully delivered.
Trigger Criteria:
- Context: Email notification has been successfully delivered
- Applied to: Log Successful Email Delivery
- Action: The system processes the successful delivery status
Logic Flow:
IF Email notification has been successfully delivered
AND The system processes the successful delivery status
THEN:
- • The system logs the successful email delivery with timestamp and recipient information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when email notification delivery has failed.
Trigger Criteria:
- Context: Email notification delivery has failed
- Applied to: Retry Email Delivery
- Action: The system initiates retry processing
Logic Flow:
IF Email notification delivery has failed
AND The system initiates retry processing
THEN:
- • The system attempts to resend the email notification and tracks retry attempts
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when email delivery retry has been attempted.
Trigger Criteria:
- Context: Email delivery retry has been attempted
- Applied to: Retry Limit Reached?
- Action: The system checks the retry attempt count against the maximum limit
Logic Flow:
IF Email delivery retry has been attempted
AND The system checks the retry attempt count against the maximum limit
THEN:
- • If retry limit has not been reached, attempt delivery again,
otherwise log delivery failure and route to error handler
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when email delivery retry limit has been reached without successful delivery.
Trigger Criteria:
- Context: Email delivery retry limit has been reached without successful delivery
- Applied to: Log Email Delivery Failure
- Action: The system processes the final delivery failure
Logic Flow:
IF Email delivery retry limit has been reached without successful delivery
AND The system processes the final delivery failure
THEN:
- • The system logs the email delivery failure with error details and retry attempt information
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when email delivery has failed after maximum retry attempts.
Trigger Criteria:
- Context: Email delivery has failed after maximum retry attempts
- Applied to: Route to Error Handler
- Action: The system routes to error handling
Logic Flow:
IF Email delivery has failed after maximum retry attempts
AND The system routes to error handling
THEN:
- • The system invokes error handler to process alternative notification methods such as routing to backup recipients (AEI9999, OM01247)
R-GCX016E-cbl-01229 (+8) File: GCX016E.cbl Business Rule: Email Distribution Management
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when email distribution request is received with recipient information.
Trigger Criteria:
- Context: An email distribution request is received with recipient information
- Applied to: Validate Email Recipients
- Action: The system validates the email recipients
Logic Flow:
IF An email distribution request is received with recipient information
AND The system validates the email recipients
THEN:
- • The system determines if recipients are valid based on configuration and proceeds with email preparation or routes to default recipient
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when email message is prepared with valid recipients.
Trigger Criteria:
- Context: Email message is prepared with valid recipients
- Applied to: Attempt Email Delivery
- Action: The system attempts email delivery
Logic Flow:
IF Email message is prepared with valid recipients
AND The system attempts email delivery
THEN:
- • The system executes email delivery process and returns delivery status
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when email delivery attempt was made.
Trigger Criteria:
- Context: Email delivery attempt was made
- Applied to: Log Successful Delivery
- Action: The delivery is successful
Logic Flow:
IF Email delivery attempt was made
AND The delivery is successful
THEN:
- • The system logs successful delivery and completes the email distribution process
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when email delivery attempt failed.
Trigger Criteria:
- Context: Email delivery attempt failed
- Applied to: Increment Retry Counter
- Action: The delivery is not successful
Logic Flow:
IF Email delivery attempt failed
AND The delivery is not successful
THEN:
- • The system increments the retry counter to track delivery attempts
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when email delivery has failed and retry counter has been incremented.
Trigger Criteria:
- Context: Email delivery has failed and retry counter has been incremented
- Applied to: Retry Limit Reached?
- Action: The system checks if retry limit is reached
Logic Flow:
IF Email delivery has failed and retry counter has been incremented
AND The system checks if retry limit is reached
THEN:
- • The system determines whether to attempt another retry or log delivery failure based on retry limit configuration
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when email delivery failed and retry limit has not been reached.
Trigger Criteria:
- Context: Email delivery failed and retry limit has not been reached
- Applied to: Wait for Retry Interval
- Action: The system processes retry interval
Logic Flow:
IF Email delivery failed and retry limit has not been reached
AND The system processes retry interval
THEN:
- • The system waits for the configured retry interval before attempting delivery again
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when email delivery has failed and retry limit has been reached.
Trigger Criteria:
- Context: Email delivery has failed and retry limit has been reached
- Applied to: Log Delivery Failure
- Action: The system processes the final delivery failure
Logic Flow:
IF Email delivery has failed and retry limit has been reached
AND The system processes the final delivery failure
THEN:
- • The system logs the delivery failure for audit and troubleshooting purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when email delivery has failed completely or recipients are invalid.
Trigger Criteria:
- Context: Email delivery has failed completely or recipients are invalid
- Applied to: Route to Default Recipient
- Action: The system routes to default recipient
Logic Flow:
IF Email delivery has failed completely or recipients are invalid
AND The system routes to default recipient
THEN:
- • The system sends the email to configured default recipient as fallback delivery method
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when email has been routed to default recipient due to delivery failure or invalid recipients.
Trigger Criteria:
- Context: Email has been routed to default recipient due to delivery failure or invalid recipients
- Applied to: Generate Error Notification
- Action: The system generates error notification
Logic Flow:
IF Email has been routed to default recipient due to delivery failure or invalid recipients
AND The system generates error notification
THEN:
- • The system creates error notification message indicating the delivery issue and fallback action taken
R-GCX016E-cbl-01238 (+13) File: GCX016E.cbl Business Rule: Status Array Debug Logging
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record exists with status information.
Trigger Criteria:
- Context: A cargo record exists with status information
- Applied to: Capture Current Cargo Status
- Action: Debug logging is requested for status array processing
Logic Flow:
IF A cargo record exists with status information
AND Debug logging is requested for status array processing
THEN:
- • The system captures the current cargo status including RT10 and RT11 status codes
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo status information is available in rt10 and rt11 fields.
Trigger Criteria:
- Context: Cargo status information is available in RT10 and RT11 fields
- Applied to: Record RT10/RT11 Status Information
- Action: Creating debug log entries for cargo status
Logic Flow:
IF Cargo status information is available in RT10 and RT11 fields
AND Creating debug log entries for cargo status
THEN:
- • The system records RT10 and RT11 status information for inclusion in debug output
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record contains quantity information.
Trigger Criteria:
- Context: Cargo record contains quantity information
- Applied to: Log Cargo Quantities and Totals
- Action: Debug logging is performed for cargo status changes
Logic Flow:
IF Cargo record contains quantity information
AND Debug logging is performed for cargo status changes
THEN:
- • The system logs cargo quantities and totals including released quantities
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when s09a status array contains disposition code information.
Trigger Criteria:
- Context: S09A status array contains disposition code information
- Applied to: Dump S09A Status Array Contents
- Action: Debug logging is requested for status array processing
Logic Flow:
IF S09A status array contains disposition code information
AND Debug logging is requested for status array processing
THEN:
- • The system dumps all S09A status array contents including disposition codes, quantities, and sequence information
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status array contains disposition codes.
Trigger Criteria:
- Context: Cargo status array contains disposition codes
- Applied to: Record All Disposition Codes
- Action: Creating debug log for status processing
Logic Flow:
IF Cargo status array contains disposition codes
AND Creating debug log for status processing
THEN:
- • The system records all disposition codes with their associated details
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo status information exists before processing.
Trigger Criteria:
- Context: Cargo status information exists before processing
- Applied to: Create Before Processing Snapshot
- Action: Debug logging is enabled for status array changes
Logic Flow:
IF Cargo status information exists before processing
AND Debug logging is enabled for status array changes
THEN:
- • The system creates a before processing snapshot of all cargo status information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo status processing has been completed.
Trigger Criteria:
- Context: Cargo status processing has been completed
- Applied to: Create After Processing Snapshot
- Action: Debug logging is enabled for status array changes
Logic Flow:
IF Cargo status processing has been completed
AND Debug logging is enabled for status array changes
THEN:
- • The system creates an after processing snapshot of all cargo status information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when before and after processing snapshots exist.
Trigger Criteria:
- Context: Before and after processing snapshots exist
- Applied to: Compare Status Changes
- Action: Debug analysis is performed on status changes
Logic Flow:
IF Before and after processing snapshots exist
AND Debug analysis is performed on status changes
THEN:
- • The system compares the snapshots and identifies all status changes that occurred
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when debug information has been captured from status processing.
Trigger Criteria:
- Context: Debug information has been captured from status processing
- Applied to: Format Debug Message Content
- Action: Creating debug output message
Logic Flow:
IF Debug information has been captured from status processing
AND Creating debug output message
THEN:
- • The system formats all debug information into a structured message format
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment information is available for the cargo.
Trigger Criteria:
- Context: Equipment information is available for the cargo
- Applied to: Include Equipment Information
- Action: Formatting debug message content
Logic Flow:
IF Equipment information is available for the cargo
AND Formatting debug message content
THEN:
- • The system includes equipment information such as car ID and equipment details in the debug output
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when waybill and ccn information exists for the cargo.
Trigger Criteria:
- Context: Waybill and CCN information exists for the cargo
- Applied to: Include Waybill and CCN Details
- Action: Creating debug log entries
Logic Flow:
IF Waybill and CCN information exists for the cargo
AND Creating debug log entries
THEN:
- • The system includes waybill number and CCN details for cargo identification
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when debug logging is being performed.
Trigger Criteria:
- Context: Debug logging is being performed
- Applied to: Add Timestamp Information
- Action: Creating debug log entries
Logic Flow:
IF Debug logging is being performed
AND Creating debug log entries
THEN:
- • The system adds current timestamp information to track when the status processing occurred
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when debug message has been formatted with all required information.
Trigger Criteria:
- Context: Debug message has been formatted with all required information
- Applied to: Route Debug Message to Recipients
- Action: Debug message routing is initiated
Logic Flow:
IF Debug message has been formatted with all required information
AND Debug message routing is initiated
THEN:
- • The system routes the debug message to appropriate recipients for review
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when debug message is ready for distribution.
Trigger Criteria:
- Context: Debug message is ready for distribution
- Applied to: Send to Merlin Message Distribution
- Action: Sending debug message through Merlin system
Logic Flow:
IF Debug message is ready for distribution
AND Sending debug message through Merlin system
THEN:
- • The system sends the debug message through Merlin message distribution for delivery
R-GCX016E-cbl-01252 (+13) File: GCX016E.cbl Business Rule: Merlin Message Distribution
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when merlin message has been generated.
Trigger Criteria:
- Context: A Merlin message has been generated
- Applied to: Route ERROR Message
- Action: The message type is ERROR
Logic Flow:
IF A Merlin message has been generated
AND The message type is ERROR
THEN:
- • The message should be routed to the IN destination
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when merlin message has been generated with sd segment recipient information.
Trigger Criteria:
- Context: A Merlin message has been generated with SD segment recipient information
- Applied to: Route INFO Message
- Action: The message type is INFO
Logic Flow:
IF A Merlin message has been generated with SD segment recipient information
AND The message type is INFO
THEN:
- • The message should be routed to the IN destination and all SD segment Merlin IDs
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when merlin message has been generated with sd segment recipient information.
Trigger Criteria:
- Context: A Merlin message has been generated with SD segment recipient information
- Applied to: Route RELEASE Message
- Action: The message type is RELEASE
Logic Flow:
IF A Merlin message has been generated with SD segment recipient information
AND The message type is RELEASE
THEN:
- • The message should be routed only to SD segment Merlin IDs
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when merlin message has been generated for an export transaction with equipment information.
Trigger Criteria:
- Context: A Merlin message has been generated for an export transaction with equipment information
- Applied to: Route EXPORT Message
- Action: The message type is EXPORT
Logic Flow:
IF A Merlin message has been generated for an export transaction with equipment information
AND The message type is EXPORT
THEN:
- • The message should be routed based on equipment type routing rules
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when merlin message has been generated with sd segment cancel recipient information.
Trigger Criteria:
- Context: A Merlin message has been generated with SD segment cancel recipient information
- Applied to: Route UNRLSE Message
- Action: The message type is UNRLSE
Logic Flow:
IF A Merlin message has been generated with SD segment cancel recipient information
AND The message type is UNRLSE
THEN:
- • The message should be routed to OM01247 and all SD segment cancel Merlin IDs
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when merlin message has been generated for arrival cancellation.
Trigger Criteria:
- Context: A Merlin message has been generated for arrival cancellation
- Applied to: Route ARRCANL Message
- Action: The message type is ARRCANL
Logic Flow:
IF A Merlin message has been generated for arrival cancellation
AND The message type is ARRCANL
THEN:
- • The message should be routed to configured arrival cancellation recipients
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when message needs to be distributed.
Trigger Criteria:
- Context: A message needs to be distributed
- Applied to: Check AD Segment Configuration
- Action: Recipient determination is required
Logic Flow:
IF A message needs to be distributed
AND Recipient determination is required
THEN:
- • The system should check AD segment configuration for valid recipients
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when ad segment configuration has been checked.
Trigger Criteria:
- Context: AD segment configuration has been checked
- Applied to: Use Configured Recipient
- Action: A valid recipient is found in the configuration
Logic Flow:
IF AD segment configuration has been checked
AND A valid recipient is found in the configuration
THEN:
- • The configured recipient should be used for message delivery
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when ad segment configuration has been checked.
Trigger Criteria:
- Context: AD segment configuration has been checked
- Applied to: Use Default Recipient OM01247
- Action: No valid recipient is found in the configuration
Logic Flow:
IF AD segment configuration has been checked
AND No valid recipient is found in the configuration
THEN:
- • The default recipient OM01247 should be used for message delivery
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when message recipient has been determined.
Trigger Criteria:
- Context: A message recipient has been determined
- Applied to: Send Message to Basket
- Action: Message delivery is initiated
Logic Flow:
IF A message recipient has been determined
AND Message delivery is initiated
THEN:
- • The message should be sent to the recipient's designated basket
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when message has been sent to a recipient's basket.
Trigger Criteria:
- Context: A message has been sent to a recipient's basket
- Applied to: Message Delivered Successfully
- Action: The delivery is successful
Logic Flow:
IF A message has been sent to a recipient's basket
AND The delivery is successful
THEN:
- • The system should confirm successful message delivery
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when message has been sent to a recipient's basket.
Trigger Criteria:
- Context: A message has been sent to a recipient's basket
- Applied to: Generate Error Notification
- Action: The delivery fails
Logic Flow:
IF A message has been sent to a recipient's basket
AND The delivery fails
THEN:
- • An error notification should be generated
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when message delivery has failed and an error notification has been generated.
Trigger Criteria:
- Context: A message delivery has failed and an error notification has been generated
- Applied to: Reroute to Default Recipient
- Action: Rerouting is attempted
Logic Flow:
IF A message delivery has failed and an error notification has been generated
AND Rerouting is attempted
THEN:
- • The message should be rerouted to the default recipient
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when message delivery has failed and rerouting has been attempted.
Trigger Criteria:
- Context: A message delivery has failed and rerouting has been attempted
- Applied to: Log Delivery Failure
- Action: The rerouting also fails
Logic Flow:
IF A message delivery has failed and rerouting has been attempted
AND The rerouting also fails
THEN:
- • The delivery failure should be logged
R-GCX016E-cbl-01266 (+19) File: GCX016E.cbl Business Rule: Merlin Message Sending
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when merlin message is ready for distribution.
Trigger Criteria:
- Context: A Merlin message is ready for distribution
- Applied to: Message Type Classification
- Action: The system evaluates the message type indicator
Logic Flow:
IF A Merlin message is ready for distribution
AND The system evaluates the message type indicator
THEN:
- • The message is classified as ERROR, INFO, RELEASE, EXPORT, UNRLSE, or ARRCANL type for routing purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when message has been classified as error type.
Trigger Criteria:
- Context: A message has been classified as ERROR type
- Applied to: Route ERROR Messages
- Action: The routing process begins
Logic Flow:
IF A message has been classified as ERROR type
AND The routing process begins
THEN:
- • The message is directed to the 'IN' destination queue
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when message has been classified as info type.
Trigger Criteria:
- Context: A message has been classified as INFO type
- Applied to: Route INFO Messages
- Action: The routing process begins
Logic Flow:
IF A message has been classified as INFO type
AND The routing process begins
THEN:
- • The message is sent to 'IN' destination and all configured SD segment Merlin IDs
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when message has been classified as release type.
Trigger Criteria:
- Context: A message has been classified as RELEASE type
- Applied to: Route RELEASE Messages
- Action: The routing process begins
Logic Flow:
IF A message has been classified as RELEASE type
AND The routing process begins
THEN:
- • The message is sent only to configured SD segment Merlin IDs
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when message has been classified as export type.
Trigger Criteria:
- Context: A message has been classified as EXPORT type
- Applied to: Route EXPORT Messages
- Action: The routing process evaluates the equipment type
Logic Flow:
IF A message has been classified as EXPORT type
AND The routing process evaluates the equipment type
THEN:
- • The message is routed to destinations specific to the equipment type
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when message has been classified as unrlse type.
Trigger Criteria:
- Context: A message has been classified as UNRLSE type
- Applied to: Route UNRLSE Messages
- Action: The routing process begins
Logic Flow:
IF A message has been classified as UNRLSE type
AND The routing process begins
THEN:
- • The message is sent to OM01247 and all configured SD cancel Merlin IDs
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when message has been classified as arrcanl type.
Trigger Criteria:
- Context: A message has been classified as ARRCANL type
- Applied to: Route ARRCANL Messages
- Action: The routing process begins
Logic Flow:
IF A message has been classified as ARRCANL type
AND The routing process begins
THEN:
- • The message is routed according to arrival cancellation notification rules
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when message has been classified and routing rules applied.
Trigger Criteria:
- Context: A message has been classified and routing rules applied
- Applied to: Determine Message Recipient
- Action: The system looks up recipient configuration
Logic Flow:
IF A message has been classified and routing rules applied
AND The system looks up recipient configuration
THEN:
- • The appropriate recipient Merlin ID or destination is identified
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when recipient has been determined for the message.
Trigger Criteria:
- Context: A recipient has been determined for the message
- Applied to: Valid Recipient Found?
- Action: The system validates the recipient configuration
Logic Flow:
IF A recipient has been determined for the message
AND The system validates the recipient configuration
THEN:
- • The recipient is confirmed as valid or invalid for delivery
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid recipient has been identified.
Trigger Criteria:
- Context: A valid recipient has been identified
- Applied to: Send to Configured Recipient
- Action: The delivery process executes
Logic Flow:
IF A valid recipient has been identified
AND The delivery process executes
THEN:
- • The message is sent to the configured recipient
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when no valid configured recipient was found.
Trigger Criteria:
- Context: No valid configured recipient was found
- Applied to: Send to Default Recipient OM01247
- Action: The fallback process activates
Logic Flow:
IF No valid configured recipient was found
AND The fallback process activates
THEN:
- • The message is automatically sent to default recipient OM01247
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when invalid recipient was encountered during routing.
Trigger Criteria:
- Context: An invalid recipient was encountered during routing
- Applied to: Generate Error Notification
- Action: The error handling process executes
Logic Flow:
IF An invalid recipient was encountered during routing
AND The error handling process executes
THEN:
- • An error notification is generated indicating the recipient validation failure
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when message delivery attempt has been made.
Trigger Criteria:
- Context: A message delivery attempt has been made
- Applied to: Delivery Successful?
- Action: The system checks delivery status
Logic Flow:
IF A message delivery attempt has been made
AND The system checks delivery status
THEN:
- • The delivery is confirmed as successful or failed
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when message delivery was successful.
Trigger Criteria:
- Context: A message delivery was successful
- Applied to: Log Successful Delivery
- Action: The logging process executes
Logic Flow:
IF A message delivery was successful
AND The logging process executes
THEN:
- • The successful delivery is recorded with timestamp and recipient information
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when message delivery has failed.
Trigger Criteria:
- Context: A message delivery has failed
- Applied to: Initiate Rerouting Process
- Action: The rerouting process is triggered
Logic Flow:
IF A message delivery has failed
AND The rerouting process is triggered
THEN:
- • Alternative delivery routes are identified and activated
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when rerouting process has identified alternative recipients.
Trigger Criteria:
- Context: Rerouting process has identified alternative recipients
- Applied to: Send to Alternative Recipient
- Action: The alternative delivery executes
Logic Flow:
IF Rerouting process has identified alternative recipients
AND The alternative delivery executes
THEN:
- • The message is sent to backup recipients AEI9999 and OM01247
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when rerouting delivery attempt has been made.
Trigger Criteria:
- Context: A rerouting delivery attempt has been made
- Applied to: Rerouting Successful?
- Action: The system checks rerouting delivery status
Logic Flow:
IF A rerouting delivery attempt has been made
AND The system checks rerouting delivery status
THEN:
- • The rerouting is confirmed as successful or failed
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when rerouting delivery was successful.
Trigger Criteria:
- Context: A rerouting delivery was successful
- Applied to: Log Rerouting Success
- Action: The logging process executes
Logic Flow:
IF A rerouting delivery was successful
AND The logging process executes
THEN:
- • The successful rerouting is recorded with timestamp and alternative recipient information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when both primary delivery and rerouting have failed.
Trigger Criteria:
- Context: Both primary delivery and rerouting have failed
- Applied to: Generate Delivery Failure Alert
- Action: The alert generation process executes
Logic Flow:
IF Both primary delivery and rerouting have failed
AND The alert generation process executes
THEN:
- • A delivery failure alert is generated for system administrators
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all delivery attempts have been completed.
Trigger Criteria:
- Context: All delivery attempts have been completed
- Applied to: Complete Message Distribution
- Action: The completion process executes
Logic Flow:
IF All delivery attempts have been completed
AND The completion process executes
THEN:
- • The message distribution process is marked as complete with final status
R-GCX016E-cbl-01286 (+12) File: GCX016E.cbl Business Rule: MQ Connection Management
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when system needs to connect to message queue services.
Trigger Criteria:
- Context: The system needs to connect to message queue services
- Applied to: Initialize MQ Connection Parameters
- Action: MQ connection management process starts
Logic Flow:
IF The system needs to connect to message queue services
AND MQ connection management process starts
THEN:
- • All MQ connection parameters are initialized to default values
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when mq connection parameters are initialized.
Trigger Criteria:
- Context: MQ connection parameters are initialized
- Applied to: Establish MQ Manager Connection
- Action: System attempts to connect to MQ Manager
Logic Flow:
IF MQ connection parameters are initialized
AND System attempts to connect to MQ Manager
THEN:
- • Connection to MQ Manager is established
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when system has attempted to connect to mq manager.
Trigger Criteria:
- Context: System has attempted to connect to MQ Manager
- Applied to: Connection Successful?
- Action: Connection attempt completes
Logic Flow:
IF System has attempted to connect to MQ Manager
AND Connection attempt completes
THEN:
- • System determines if connection was successful or failed
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when mq manager connection is successfully established.
Trigger Criteria:
- Context: MQ Manager connection is successfully established
- Applied to: Open GC350.EXP.INPUT Queue
- Action: System attempts to open GC350.EXP.INPUT queue
Logic Flow:
IF MQ Manager connection is successfully established
AND System attempts to open GC350.EXP.INPUT queue
THEN:
- • The export input queue is opened for message processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when system has attempted to open gc350.exp.input queue.
Trigger Criteria:
- Context: System has attempted to open GC350.EXP.INPUT queue
- Applied to: Queue Open Successful?
- Action: Queue opening attempt completes
Logic Flow:
IF System has attempted to open GC350.EXP.INPUT queue
AND Queue opening attempt completes
THEN:
- • System determines if queue opening was successful or failed
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when mq manager connection is established and gc350.exp.input queue is successfully opened.
Trigger Criteria:
- Context: MQ Manager connection is established AND GC350.EXP.INPUT queue is successfully opened
- Applied to: Set Queue Ready Status
- Action: Both connection and queue opening are validated as successful
Logic Flow:
IF MQ Manager connection is established AND GC350.EXP.INPUT queue is successfully opened
AND Both connection and queue opening are validated as successful
THEN:
- • Queue status is set to ready for message processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when queue status has been set to ready.
Trigger Criteria:
- Context: Queue status has been set to ready
- Applied to: Log Connection Success
- Action: MQ connection setup is complete
Logic Flow:
IF Queue status has been set to ready
AND MQ connection setup is complete
THEN:
- • Connection success is logged to system audit trail
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when system attempted to connect to mq manager.
Trigger Criteria:
- Context: System attempted to connect to MQ Manager
- Applied to: Handle Connection Error
- Action: MQ Manager connection fails
Logic Flow:
IF System attempted to connect to MQ Manager
AND MQ Manager connection fails
THEN:
- • Connection error is handled and appropriate error processing is initiated
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when mq manager connection has failed.
Trigger Criteria:
- Context: MQ Manager connection has failed
- Applied to: Log Connection Failure
- Action: Connection error handling is processed
Logic Flow:
IF MQ Manager connection has failed
AND Connection error handling is processed
THEN:
- • Connection failure details are logged to system audit trail
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when mq manager connection is successful and system attempted to open gc350.exp.input queue.
Trigger Criteria:
- Context: MQ Manager connection is successful AND system attempted to open GC350.EXP.INPUT queue
- Applied to: Handle Queue Open Error
- Action: Queue opening fails
Logic Flow:
IF MQ Manager connection is successful AND system attempted to open GC350.EXP.INPUT queue
AND Queue opening fails
THEN:
- • Queue opening error is handled and appropriate error processing is initiated
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when gc350.exp.input queue opening has failed.
Trigger Criteria:
- Context: GC350.EXP.INPUT queue opening has failed
- Applied to: Log Queue Open Failure
- Action: Queue opening error handling is processed
Logic Flow:
IF GC350.EXP.INPUT queue opening has failed
AND Queue opening error handling is processed
THEN:
- • Queue opening failure details are logged to system audit trail
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when connection success has been logged.
Trigger Criteria:
- Context: Connection success has been logged
- Applied to: MQ Connection Ready for Processing
- Action: All MQ setup operations are complete
Logic Flow:
IF Connection success has been logged
AND All MQ setup operations are complete
THEN:
- • MQ connection is confirmed ready for processing export messages from GC350.EXP.INPUT queue
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when either connection failure or queue opening failure has been logged.
Trigger Criteria:
- Context: Either connection failure OR queue opening failure has been logged
- Applied to: Connection Failed - Exit
- Action: Error handling is complete
Logic Flow:
IF Either connection failure OR queue opening failure has been logged
AND Error handling is complete
THEN:
- • MQ connection management process exits without establishing ready status
R-GCX016E-cbl-01299 (+22) File: GCX016E.cbl Business Rule: Message Array Initialization
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when message needs to be processed for array initialization.
Trigger Criteria:
- Context: A message needs to be processed for array initialization
- Applied to: Message Type?
- Action: The system evaluates the message type
Logic Flow:
IF A message needs to be processed for array initialization
AND The system evaluates the message type
THEN:
- • The system routes to cargo message array initialization for cargo messages or train message array initialization for train messages
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo message type has been identified.
Trigger Criteria:
- Context: A cargo message type has been identified
- Applied to: Initialize Cargo Message Arrays
- Action: The system initializes cargo message arrays
Logic Flow:
IF A cargo message type has been identified
AND The system initializes cargo message arrays
THEN:
- • The system creates empty array structures ready to receive X4 and N7 segment information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo message arrays are being initialized.
Trigger Criteria:
- Context: Cargo message arrays are being initialized
- Applied to: Create X4 Segment Structure
- Action: The system creates X4 segment structure
Logic Flow:
IF Cargo message arrays are being initialized
AND The system creates X4 segment structure
THEN:
- • The system defines fields for disposition codes, entry numbers, quantities, and processing instructions
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when x4 segment structure has been created.
Trigger Criteria:
- Context: X4 segment structure has been created
- Applied to: Set Equipment Information
- Action: The system sets equipment information
Logic Flow:
IF X4 segment structure has been created
AND The system sets equipment information
THEN:
- • The system assigns equipment type, equipment number, and related identification data to the X4 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment information has been set in the x4 segment.
Trigger Criteria:
- Context: Equipment information has been set in the X4 segment
- Applied to: Set Disposition Code Data
- Action: The system sets disposition code data
Logic Flow:
IF Equipment information has been set in the X4 segment
AND The system sets disposition code data
THEN:
- • The system populates disposition code, associated quantities, entry numbers, and processing flags
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code data has been set in the x4 segment.
Trigger Criteria:
- Context: Disposition code data has been set in the X4 segment
- Applied to: Set Date/Time Information
- Action: The system sets date/time information
Logic Flow:
IF Disposition code data has been set in the X4 segment
AND The system sets date/time information
THEN:
- • The system assigns current date, time, and timezone information to the X4 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when x4 segment has been completed with date/time information.
Trigger Criteria:
- Context: X4 segment has been completed with date/time information
- Applied to: Create N7 Segment Structure
- Action: The system creates N7 segment structure
Logic Flow:
IF X4 segment has been completed with date/time information
AND The system creates N7 segment structure
THEN:
- • The system defines fields for equipment details, cargo identification, and quantity information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when n7 segment structure has been created.
Trigger Criteria:
- Context: N7 segment structure has been created
- Applied to: Set Equipment Details
- Action: The system sets equipment details
Logic Flow:
IF N7 segment structure has been created
AND The system sets equipment details
THEN:
- • The system assigns equipment initial, equipment number, equipment type, and equipment specifications to the N7 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment details have been set in the n7 segment.
Trigger Criteria:
- Context: Equipment details have been set in the N7 segment
- Applied to: Set Quantity Information
- Action: The system sets quantity information
Logic Flow:
IF Equipment details have been set in the N7 segment
AND The system sets quantity information
THEN:
- • The system populates quantity values, unit of measure, and weight information in the N7 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when quantity information has been set in the n7 segment.
Trigger Criteria:
- Context: Quantity information has been set in the N7 segment
- Applied to: Set Car ID and Waybill
- Action: The system sets car ID and waybill
Logic Flow:
IF Quantity information has been set in the N7 segment
AND The system sets car ID and waybill
THEN:
- • The system assigns car identification number and waybill reference to the N7 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train message type has been identified.
Trigger Criteria:
- Context: A train message type has been identified
- Applied to: Initialize Train Message Arrays
- Action: The system initializes train message arrays
Logic Flow:
IF A train message type has been identified
AND The system initializes train message arrays
THEN:
- • The system creates empty array structures ready to receive M10 and V9 segment information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train message arrays are being initialized.
Trigger Criteria:
- Context: Train message arrays are being initialized
- Applied to: Create M10 Segment Structure
- Action: The system creates M10 segment structure
Logic Flow:
IF Train message arrays are being initialized
AND The system creates M10 segment structure
THEN:
- • The system defines fields for vessel name, train identification, and transport details
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when m10 segment structure has been created.
Trigger Criteria:
- Context: M10 segment structure has been created
- Applied to: Set Vessel/Train Information
- Action: The system sets vessel/train information
Logic Flow:
IF M10 segment structure has been created
AND The system sets vessel/train information
THEN:
- • The system assigns vessel name, train number, and train identification data to the M10 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when vessel/train information has been set in the m10 segment.
Trigger Criteria:
- Context: Vessel/train information has been set in the M10 segment
- Applied to: Set SCAC and Transport Type
- Action: The system sets SCAC and transport type
Logic Flow:
IF Vessel/train information has been set in the M10 segment
AND The system sets SCAC and transport type
THEN:
- • The system populates SCAC code and transport mode information in the M10 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when scac and transport type have been set in the m10 segment.
Trigger Criteria:
- Context: SCAC and transport type have been set in the M10 segment
- Applied to: Set Country Code Details
- Action: The system sets country code details
Logic Flow:
IF SCAC and transport type have been set in the M10 segment
AND The system sets country code details
THEN:
- • The system assigns origin country code and destination country code to the M10 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when m10 segment has been completed with country code details.
Trigger Criteria:
- Context: M10 segment has been completed with country code details
- Applied to: Create V9 Segment Structure
- Action: The system creates V9 segment structure
Logic Flow:
IF M10 segment has been completed with country code details
AND The system creates V9 segment structure
THEN:
- • The system defines fields for event codes, status information, and location data
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when v9 segment structure has been created.
Trigger Criteria:
- Context: V9 segment structure has been created
- Applied to: Set Event Information
- Action: The system sets event information
Logic Flow:
IF V9 segment structure has been created
AND The system sets event information
THEN:
- • The system assigns event code, event date, event time, and event description to the V9 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when event information has been set in the v9 segment.
Trigger Criteria:
- Context: Event information has been set in the V9 segment
- Applied to: Set Disposition Code
- Action: The system sets disposition code
Logic Flow:
IF Event information has been set in the V9 segment
AND The system sets disposition code
THEN:
- • The system populates disposition code and related processing flags in the V9 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code has been set in the v9 segment.
Trigger Criteria:
- Context: Disposition code has been set in the V9 segment
- Applied to: Set Location Data
- Action: The system sets location data
Logic Flow:
IF Disposition code has been set in the V9 segment
AND The system sets location data
THEN:
- • The system assigns location code, location name, and geographic coordinates to the V9 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all segment structures have been created and populated.
Trigger Criteria:
- Context: All segment structures have been created and populated
- Applied to: Validate Segment Completeness
- Action: The system validates segment completeness
Logic Flow:
IF All segment structures have been created and populated
AND The system validates segment completeness
THEN:
- • The system checks that all mandatory fields contain valid data and all segment structures are properly formed
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when segment completeness validation has been performed.
Trigger Criteria:
- Context: Segment completeness validation has been performed
- Applied to: All Required Fields Set?
- Action: The system checks if all required fields are set
Logic Flow:
IF Segment completeness validation has been performed
AND The system checks if all required fields are set
THEN:
- • The system returns true if all mandatory fields contain valid data,
otherwise returns false
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all required fields validation check returns true.
Trigger Criteria:
- Context: All required fields validation check returns true
- Applied to: Mark Arrays Ready for Processing
- Action: The system marks arrays ready for processing
Logic Flow:
IF All required fields validation check returns true
AND The system marks arrays ready for processing
THEN:
- • The system sets the ready status flag and makes the arrays available for message processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all required fields validation check returns false.
Trigger Criteria:
- Context: All required fields validation check returns false
- Applied to: Log Initialization Error
- Action: The system logs initialization error
Logic Flow:
IF All required fields validation check returns false
AND The system logs initialization error
THEN:
- • The system records error details including missing fields and sets error status for the initialization process
R-GCX016E-cbl-01322 (+10) File: GCX016E.cbl Business Rule: Cargo Information Logging
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo processing action has been initiated.
Trigger Criteria:
- Context: A cargo processing action has been initiated
- Applied to: Cargo Processing Action Occurs
- Action: The system detects a cargo processing event
Logic Flow:
IF A cargo processing action has been initiated
AND The system detects a cargo processing event
THEN:
- • The system should trigger the audit logging process
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo processing action needs to be logged.
Trigger Criteria:
- Context: A cargo processing action needs to be logged
- Applied to: Prepare Audit Log Entry
- Action: The audit logging process is initiated
Logic Flow:
IF A cargo processing action needs to be logged
AND The audit logging process is initiated
THEN:
- • The system should prepare the audit log entry structure with all required fields
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when audit log entry is being prepared for cargo processing.
Trigger Criteria:
- Context: An audit log entry is being prepared for cargo processing
- Applied to: Set LOG-USE-INPUT-MESSAGE Action Code
- Action: The system sets up the log entry parameters
Logic Flow:
IF An audit log entry is being prepared for cargo processing
AND The system sets up the log entry parameters
THEN:
- • The action code should be set to LOG-USE-INPUT-MESSAGE
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when audit log entry is being created.
Trigger Criteria:
- Context: An audit log entry is being created
- Applied to: Capture Timestamp Information & Capture User Information
- Action: The system captures audit information
Logic Flow:
IF An audit log entry is being created
AND The system captures audit information
THEN:
- • The current timestamp should be recorded in the log entry
- • The user identification information should be recorded in the log entry
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when audit log entry is being created for a cargo processing action.
Trigger Criteria:
- Context: An audit log entry is being created for a cargo processing action
- Applied to: Capture Cargo Processing Details
- Action: The system captures audit information
Logic Flow:
IF An audit log entry is being created for a cargo processing action
AND The system captures audit information
THEN:
- • The specific cargo processing details should be recorded in the log entry
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all audit log information has been prepared.
Trigger Criteria:
- Context: All audit log information has been prepared
- Applied to: Spawn GCT1051E Transaction
- Action: The system is ready to create the log entry
Logic Flow:
IF All audit log information has been prepared
AND The system is ready to create the log entry
THEN:
- • The GCT1051E transaction should be spawned to create the audit log
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when gct1051e transaction has been spawned for audit logging.
Trigger Criteria:
- Context: The GCT1051E transaction has been spawned for audit logging
- Applied to: Transaction Spawn Successful?
- Action: The system checks the transaction spawn result
Logic Flow:
IF The GCT1051E transaction has been spawned for audit logging
AND The system checks the transaction spawn result
THEN:
- • The system should determine if the spawn was successful or failed
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when gct1051e transaction spawn was successful.
Trigger Criteria:
- Context: The GCT1051E transaction spawn was successful
- Applied to: Log Entry Created Successfully
- Action: The system processes the successful spawn result
Logic Flow:
IF The GCT1051E transaction spawn was successful
AND The system processes the successful spawn result
THEN:
- • The system should confirm the log entry was created successfully
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when gct1051e transaction spawn failed.
Trigger Criteria:
- Context: The GCT1051E transaction spawn failed
- Applied to: Handle Logging Error
- Action: The system processes the failed spawn result
Logic Flow:
IF The GCT1051E transaction spawn failed
AND The system processes the failed spawn result
THEN:
- • The system should handle the logging error without interrupting cargo processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when audit logging attempt has been completed (successfully or with error).
Trigger Criteria:
- Context: The audit logging attempt has been completed (successfully or with error)
- Applied to: Continue Processing
- Action: The logging process finishes
Logic Flow:
IF The audit logging attempt has been completed (successfully or with error)
AND The logging process finishes
THEN:
- • The system should continue with the main cargo processing workflow
R-GCX016E-cbl-01333 (+15) File: GCX016E.cbl Business Rule: Merlin Report Formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record exists with equipment information.
Trigger Criteria:
- Context: A cargo record exists with equipment information
- Applied to: Format Equipment Information
- Action: The system processes Merlin report formatting
Logic Flow:
IF A cargo record exists with equipment information
AND The system processes Merlin report formatting
THEN:
- • Equipment information is extracted and formatted for the report
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo data contains car identification information.
Trigger Criteria:
- Context: Cargo data contains car identification information
- Applied to: Extract Car ID
- Action: Car ID extraction is performed
Logic Flow:
IF Cargo data contains car identification information
AND Car ID extraction is performed
THEN:
- • The car ID is retrieved and made available for report formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo data contains waybill information.
Trigger Criteria:
- Context: Cargo data contains waybill information
- Applied to: Extract Waybill Number
- Action: Waybill number extraction is performed
Logic Flow:
IF Cargo data contains waybill information
AND Waybill number extraction is performed
THEN:
- • The waybill number is retrieved and made available for report formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo data contains us customs control number information.
Trigger Criteria:
- Context: Cargo data contains US Customs Control Number information
- Applied to: Extract US-CCN
- Action: US-CCN extraction is performed
Logic Flow:
IF Cargo data contains US Customs Control Number information
AND US-CCN extraction is performed
THEN:
- • The US-CCN is retrieved and made available for report formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code exists for processing.
Trigger Criteria:
- Context: A disposition code exists for processing
- Applied to: Format Disposition Code Information
- Action: Disposition code information formatting is performed
Logic Flow:
IF A disposition code exists for processing
AND Disposition code information formatting is performed
THEN:
- • Disposition code details are formatted for the report
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code is being processed.
Trigger Criteria:
- Context: A disposition code is being processed
- Applied to: Retrieve Disposition Code
- Action: Disposition code retrieval is performed
Logic Flow:
IF A disposition code is being processed
AND Disposition code retrieval is performed
THEN:
- • The current disposition code is retrieved for formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code is being processed.
Trigger Criteria:
- Context: A disposition code is being processed
- Applied to: Apply Release Quantity Impact Logic
- Action: Release quantity impact logic is applied
Logic Flow:
IF A disposition code is being processed
AND Release quantity impact logic is applied
THEN:
- • The system determines whether the disposition code affects release quantities
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code exists and disposition code table is available.
Trigger Criteria:
- Context: A disposition code exists and disposition code table is available
- Applied to: Retrieve Disposition Description
- Action: Disposition description lookup is performed
Logic Flow:
IF A disposition code exists and disposition code table is available
AND Disposition description lookup is performed
THEN:
- • The corresponding description is retrieved from the disposition code table
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when system processing times are available.
Trigger Criteria:
- Context: System processing times are available
- Applied to: Format Date/Time Information
- Action: Date/time information formatting is performed
Logic Flow:
IF System processing times are available
AND Date/time information formatting is performed
THEN:
- • Date and time information is formatted for the report
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when uscs processing time information is available.
Trigger Criteria:
- Context: USCS processing time information is available
- Applied to: Format USCS Processing Time
- Action: USCS processing time formatting is performed
Logic Flow:
IF USCS processing time information is available
AND USCS processing time formatting is performed
THEN:
- • USCS processing time is formatted for the report
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when system processing time information is available.
Trigger Criteria:
- Context: System processing time information is available
- Applied to: Format System Processing Time
- Action: System processing time formatting is performed
Logic Flow:
IF System processing time information is available
AND System processing time formatting is performed
THEN:
- • System processing time is formatted for the report
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code is being evaluated for quantity impact.
Trigger Criteria:
- Context: A disposition code is being evaluated for quantity impact
- Applied to: Should Disposition Code Affect Release Quantities?
- Action: The system checks if the disposition code affects release quantities
Logic Flow:
IF A disposition code is being evaluated for quantity impact
AND The system checks if the disposition code affects release quantities
THEN:
- • The system returns yes if the code affects quantities, no if it does not
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code affects release quantities.
Trigger Criteria:
- Context: A disposition code affects release quantities
- Applied to: Include Quantity Impact in Report
- Action: Report formatting includes quantity impact processing
Logic Flow:
IF A disposition code affects release quantities
AND Report formatting includes quantity impact processing
THEN:
- • Quantity impact information is included in the report
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code does not affect release quantities.
Trigger Criteria:
- Context: A disposition code does not affect release quantities
- Applied to: Exclude Quantity Impact from Report
- Action: Report formatting excludes quantity impact processing
Logic Flow:
IF A disposition code does not affect release quantities
AND Report formatting excludes quantity impact processing
THEN:
- • Quantity impact information is excluded from the report
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all report elements have been individually formatted.
Trigger Criteria:
- Context: All report elements have been individually formatted
- Applied to: Combine All Formatted Elements
- Action: Element combination is performed
Logic Flow:
IF All report elements have been individually formatted
AND Element combination is performed
THEN:
- • All formatted elements are combined into a unified report structure
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all report elements have been combined.
Trigger Criteria:
- Context: All report elements have been combined
- Applied to: Generate Final Merlin Report Format
- Action: Final report generation is performed
Logic Flow:
IF All report elements have been combined
AND Final report generation is performed
THEN:
- • A complete formatted Merlin report is generated
R-GCX016E-cbl-01349 (+15) File: GCX016E.cbl Business Rule: Release Quantity Processing Logic
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record exists in the system.
Trigger Criteria:
- Context: A cargo record exists in the system
- Applied to: Retrieve Current Cargo Release Quantity
- Action: The system needs to process disposition code quantity impacts
Logic Flow:
IF A cargo record exists in the system
AND The system needs to process disposition code quantity impacts
THEN:
- • The current cargo release quantity is retrieved and made available for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo status array contains disposition codes.
Trigger Criteria:
- Context: A cargo status array contains disposition codes
- Applied to: Get Disposition Code from Status Array
- Action: The system processes quantity impacts for disposition codes
Logic Flow:
IF A cargo status array contains disposition codes
AND The system processes quantity impacts for disposition codes
THEN:
- • Each disposition code is extracted from the status array for evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code needs to be processed.
Trigger Criteria:
- Context: A disposition code needs to be processed
- Applied to: Lookup Disposition Code in DC Table
- Action: The system looks up the disposition code in the DC table
Logic Flow:
IF A disposition code needs to be processed
AND The system looks up the disposition code in the DC table
THEN:
- • The disposition code details and action type are retrieved if found
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code is being processed for quantity impact.
Trigger Criteria:
- Context: A disposition code is being processed for quantity impact
- Applied to: Disposition Code Found?
- Action: The system checks if the disposition code exists in the DC table
Logic Flow:
IF A disposition code is being processed for quantity impact
AND The system checks if the disposition code exists in the DC table
THEN:
- • Processing continues if found,
otherwise an error is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid disposition code exists in the dc table.
Trigger Criteria:
- Context: A valid disposition code exists in the DC table
- Applied to: Retrieve Disposition Code Action Type
- Action: The system retrieves the disposition code configuration
Logic Flow:
IF A valid disposition code exists in the DC table
AND The system retrieves the disposition code configuration
THEN:
- • The action type (Add, Subtract, or Status Info) is determined for quantity processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code has a defined action type.
Trigger Criteria:
- Context: A disposition code has a defined action type
- Applied to: Action Type?
- Action: The system evaluates the action type for quantity impact
Logic Flow:
IF A disposition code has a defined action type
AND The system evaluates the action type for quantity impact
THEN:
- • The system routes to Add, Subtract, or No Quantity Impact processing based on the action type
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code has an 'add' action type.
Trigger Criteria:
- Context: A disposition code has an 'Add' action type
- Applied to: Add to Release Quantity
- Action: The system processes the quantity impact
Logic Flow:
IF A disposition code has an 'Add' action type
AND The system processes the quantity impact
THEN:
- • The disposition code quantity is added to the current release quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code has a 'subtract' action type.
Trigger Criteria:
- Context: A disposition code has a 'Subtract' action type
- Applied to: Subtract from Release Quantity
- Action: The system processes the quantity impact
Logic Flow:
IF A disposition code has a 'Subtract' action type
AND The system processes the quantity impact
THEN:
- • The disposition code quantity is subtracted from the current release quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code has 'status info' action type.
Trigger Criteria:
- Context: A disposition code has 'Status Info' action type
- Applied to: No Quantity Impact
- Action: The system processes the disposition code
Logic Flow:
IF A disposition code has 'Status Info' action type
AND The system processes the disposition code
THEN:
- • No quantity calculations are performed and processing continues to set impact flag
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when release quantity has been calculated from disposition code processing.
Trigger Criteria:
- Context: A release quantity has been calculated from disposition code processing
- Applied to: Validate Quantity Against Total Cargo
- Action: The system validates the calculated quantity
Logic Flow:
IF A release quantity has been calculated from disposition code processing
AND The system validates the calculated quantity
THEN:
- • The quantity must be between zero and the total cargo quantity inclusive
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when release quantity has been calculated and validated.
Trigger Criteria:
- Context: A release quantity has been calculated and validated
- Applied to: Quantity Valid?
- Action: The system checks if the quantity is valid
Logic Flow:
IF A release quantity has been calculated and validated
AND The system checks if the quantity is valid
THEN:
- • Processing continues to update if valid,
otherwise an error is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid release quantity has been calculated.
Trigger Criteria:
- Context: A valid release quantity has been calculated
- Applied to: Update Release Quantity
- Action: The system updates the cargo release quantity
Logic Flow:
IF A valid release quantity has been calculated
AND The system updates the cargo release quantity
THEN:
- • The cargo record is updated with the new release quantity value
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo release quantity has been updated.
Trigger Criteria:
- Context: A cargo release quantity has been updated
- Applied to: Generate Quantity Impact Message
- Action: The system generates impact messaging
Logic Flow:
IF A cargo release quantity has been updated
AND The system generates impact messaging
THEN:
- • A message is created showing the before and after quantity values and the disposition code causing the change
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when quantity impact has been processed and messaged.
Trigger Criteria:
- Context: A quantity impact has been processed and messaged
- Applied to: Log Before/After Comparison
- Action: The system logs the quantity change
Logic Flow:
IF A quantity impact has been processed and messaged
AND The system logs the quantity change
THEN:
- • The original quantity, new quantity, and disposition code are recorded in the system log
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code processing has been completed.
Trigger Criteria:
- Context: Disposition code processing has been completed
- Applied to: Set Quantity Impact Flag
- Action: The system finalizes quantity impact processing
Logic Flow:
IF Disposition code processing has been completed
AND The system finalizes quantity impact processing
THEN:
- • A quantity impact flag is set to indicate whether quantities were affected by the disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code is not found in dc table or calculated quantity is invalid.
Trigger Criteria:
- Context: A disposition code is not found in DC table OR calculated quantity is invalid
- Applied to: Generate Error Message
- Action: The system encounters a validation error
Logic Flow:
IF A disposition code is not found in DC table OR calculated quantity is invalid
AND The system encounters a validation error
THEN:
- • An error message is generated indicating the specific validation failure
R-GCX016E-cbl-01365 (+8) File: GCX016E.cbl Business Rule: Julian Date Conversion
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when date input is required for cargo age calculation.
Trigger Criteria:
- Context: A date input is required for cargo age calculation
- Applied to: Validate Input Date Format
- Action: The system receives a date value for processing
Logic Flow:
IF A date input is required for cargo age calculation
AND The system receives a date value for processing
THEN:
- • The system validates the date format is correct and numeric before proceeding with conversion
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when date input has been provided for age calculation.
Trigger Criteria:
- Context: A date input has been provided for age calculation
- Applied to: Set Error Flag for Invalid Date
- Action: The date format validation fails or date is invalid
Logic Flow:
IF A date input has been provided for age calculation
AND The date format validation fails or date is invalid
THEN:
- • The system sets an error flag to indicate date processing failure
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when invalid date has been detected during validation.
Trigger Criteria:
- Context: An invalid date has been detected during validation
- Applied to: Use Default System Date
- Action: The system cannot process the provided date
Logic Flow:
IF An invalid date has been detected during validation
AND The system cannot process the provided date
THEN:
- • The system uses the current system date as the default value for age calculation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid date has been confirmed through validation.
Trigger Criteria:
- Context: A valid date has been confirmed through validation
- Applied to: Convert Date to Julian Format
- Action: The system needs to perform age calculations
Logic Flow:
IF A valid date has been confirmed through validation
AND The system needs to perform age calculations
THEN:
- • The system converts the date to Julian format using standard conversion algorithms
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when date has been successfully converted to julian format.
Trigger Criteria:
- Context: A date has been successfully converted to Julian format
- Applied to: Calculate Days Since Base Date
- Action: The system needs to determine cargo age
Logic Flow:
IF A date has been successfully converted to Julian format
AND The system needs to determine cargo age
THEN:
- • The system calculates the difference in days between the Julian date and the established base date
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when julian date conversion and age calculation have been completed successfully.
Trigger Criteria:
- Context: Julian date conversion and age calculation have been completed successfully
- Applied to: Return Julian Date Value
- Action: The calling process requires the Julian date result
Logic Flow:
IF Julian date conversion and age calculation have been completed successfully
AND The calling process requires the Julian date result
THEN:
- • The system returns the calculated Julian date value for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo processing is being performed.
Trigger Criteria:
- Context: Cargo processing is being performed
- Applied to: Cargo Age Calculation Required
- Action: The system needs to determine cargo age for business rules
Logic Flow:
IF Cargo processing is being performed
AND The system needs to determine cargo age for business rules
THEN:
- • The system initiates date input processing for age calculation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when julian date calculation has been completed.
Trigger Criteria:
- Context: Julian date calculation has been completed
- Applied to: Destination Index Management
- Action: The system needs to update destination information
Logic Flow:
IF Julian date calculation has been completed
AND The system needs to update destination information
THEN:
- • The system uses the Julian date result to manage destination index values
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when destination index management has been completed.
Trigger Criteria:
- Context: Destination index management has been completed
- Applied to: Bond Start Date Processing
- Action: The system needs to process bond information
Logic Flow:
IF Destination index management has been completed
AND The system needs to process bond information
THEN:
- • The system uses Julian date calculations to determine bond start date processing requirements
R-GCX016E-cbl-01374 (+5) File: GCX016E.cbl Business Rule: Shiproot Validation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when shipment identifier has been extracted from an edi message.
Trigger Criteria:
- Context: A shipment identifier has been extracted from an EDI message
- Applied to: Query SHIPROOT Database
- Action: The system queries the SHIPROOT database for the shipment identifier
Logic Flow:
IF A shipment identifier has been extracted from an EDI message
AND The system queries the SHIPROOT database for the shipment identifier
THEN:
- • The system should retrieve the shipment root record if it exists
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when system has queried the shiproot database for a shipment identifier.
Trigger Criteria:
- Context: The system has queried the SHIPROOT database for a shipment identifier
- Applied to: Shipment Root Record Exists?
- Action: The query result indicates whether a shipment root record exists or not
Logic Flow:
IF The system has queried the SHIPROOT database for a shipment identifier
AND The query result indicates whether a shipment root record exists or not
THEN:
- • The system should set validation successful flag if record exists,
otherwise set error flag
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when shipment root record does not exist in the shiproot database.
Trigger Criteria:
- Context: A shipment root record does not exist in the SHIPROOT database
- Applied to: Log Validation Error
- Action: The validation check fails
Logic Flow:
IF A shipment root record does not exist in the SHIPROOT database
AND The validation check fails
THEN:
- • The system should log a validation error indicating the missing shipment root record
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when validation error has been logged for a missing shipment root record.
Trigger Criteria:
- Context: A validation error has been logged for a missing shipment root record
- Applied to: Set Error Flag
- Action: The shipment root validation process completes with failure
Logic Flow:
IF A validation error has been logged for a missing shipment root record
AND The shipment root validation process completes with failure
THEN:
- • The system should set an error flag to indicate validation failure
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when shipment root record exists in the shiproot database.
Trigger Criteria:
- Context: A shipment root record exists in the SHIPROOT database
- Applied to: Continue EDI Processing
- Action: The validation is successful
Logic Flow:
IF A shipment root record exists in the SHIPROOT database
AND The validation is successful
THEN:
- • The system should continue with normal EDI processing workflow
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when shipment root record does not exist and error flag has been set.
Trigger Criteria:
- Context: A shipment root record does not exist and error flag has been set
- Applied to: Skip EDI Processing
- Action: The validation process completes with failure
Logic Flow:
IF A shipment root record does not exist and error flag has been set
AND The validation process completes with failure
THEN:
- • The system should skip the EDI processing for this shipment
R-GCX016E-cbl-01380 (+13) File: GCX016E.cbl Business Rule: Shipment Minimum Information Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when shipment requires minimum information processing.
Trigger Criteria:
- Context: A shipment requires minimum information processing
- Applied to: Validate Shiproot Record Exists
- Action: The system attempts to validate the shiproot record existence
Logic Flow:
IF A shipment requires minimum information processing
AND The system attempts to validate the shiproot record existence
THEN:
- • The system should verify the shiproot record exists in the database
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when shipment requires minimum information processing.
Trigger Criteria:
- Context: A shipment requires minimum information processing
- Applied to: Generate Error - Shiproot Not Found
- Action: The shiproot record is not found in the database
Logic Flow:
IF A shipment requires minimum information processing
AND The shiproot record is not found in the database
THEN:
- • The system should generate an error indicating shiproot not found and terminate processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid shiproot record exists for the shipment.
Trigger Criteria:
- Context: A valid shiproot record exists for the shipment
- Applied to: Retrieve In-Bond Type Codes
- Action: The system processes shipment minimum information
Logic Flow:
IF A valid shiproot record exists for the shipment
AND The system processes shipment minimum information
THEN:
- • The system should retrieve the applicable in-bond type codes from the shipment data
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid shiproot record exists and in-bond type codes are retrieved.
Trigger Criteria:
- Context: A valid shiproot record exists and in-bond type codes are retrieved
- Applied to: Retrieve Entry Numbers
- Action: The system processes shipment minimum information
Logic Flow:
IF A valid shiproot record exists and in-bond type codes are retrieved
AND The system processes shipment minimum information
THEN:
- • The system should retrieve all applicable entry numbers for the shipment
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when entry numbers have been successfully retrieved for the shipment.
Trigger Criteria:
- Context: Entry numbers have been successfully retrieved for the shipment
- Applied to: Retrieve Location Identifiers
- Action: The system processes location information
Logic Flow:
IF Entry numbers have been successfully retrieved for the shipment
AND The system processes location information
THEN:
- • The system should retrieve all relevant location identifiers for the shipment
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when location identifiers have been retrieved and x4 segments are available.
Trigger Criteria:
- Context: Location identifiers have been retrieved and X4 segments are available
- Applied to: Process Destination Station Information from X4 Segments
- Action: The system processes destination station information
Logic Flow:
IF Location identifiers have been retrieved and X4 segments are available
AND The system processes destination station information
THEN:
- • The system should extract destination station data from X4 segments and validate the information
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when destination station information has been processed from x4 segments.
Trigger Criteria:
- Context: Destination station information has been processed from X4 segments
- Applied to: Process Key Station Information
- Action: The system processes key station information
Logic Flow:
IF Destination station information has been processed from X4 segments
AND The system processes key station information
THEN:
- • The system should identify and validate key station data for shipment routing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when all required shipment data including station information has been processed.
Trigger Criteria:
- Context: All required shipment data including station information has been processed
- Applied to: Create U1 Shipment Minimum Segment
- Action: The system creates the U1 segment
Logic Flow:
IF All required shipment data including station information has been processed
AND The system creates the U1 segment
THEN:
- • The system should initialize a new U1 shipment minimum segment with proper structure
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when u1 segment has been created and in-bond type codes are available.
Trigger Criteria:
- Context: A U1 segment has been created and in-bond type codes are available
- Applied to: Populate In-Bond Type Codes in U1
- Action: The system populates the U1 segment with in-bond information
Logic Flow:
IF A U1 segment has been created and in-bond type codes are available
AND The system populates the U1 segment with in-bond information
THEN:
- • The system should insert all applicable in-bond type codes into the U1 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when in-bond type codes have been populated in the u1 segment and entry numbers are available.
Trigger Criteria:
- Context: In-bond type codes have been populated in the U1 segment and entry numbers are available
- Applied to: Populate Entry Numbers in U1
- Action: The system populates entry number information
Logic Flow:
IF In-bond type codes have been populated in the U1 segment and entry numbers are available
AND The system populates entry number information
THEN:
- • The system should insert all retrieved entry numbers into the appropriate fields of the U1 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when entry numbers have been populated in the u1 segment and location identifiers are available.
Trigger Criteria:
- Context: Entry numbers have been populated in the U1 segment and location identifiers are available
- Applied to: Populate Location Identifiers in U1
- Action: The system populates location information
Logic Flow:
IF Entry numbers have been populated in the U1 segment and location identifiers are available
AND The system populates location information
THEN:
- • The system should insert all location identifiers into the appropriate fields of the U1 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when u1 segment has been populated with all required data elements.
Trigger Criteria:
- Context: The U1 segment has been populated with all required data elements
- Applied to: Validate U1 Segment Data
- Action: The system validates the U1 segment data
Logic Flow:
IF The U1 segment has been populated with all required data elements
AND The system validates the U1 segment data
THEN:
- • The system should verify that all mandatory fields are populated and data formats are correct
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when u1 segment has been validated and all data is correct.
Trigger Criteria:
- Context: The U1 segment has been validated and all data is correct
- Applied to: Store U1 Segment for EDI Processing
- Action: The system stores the U1 segment
Logic Flow:
IF The U1 segment has been validated and all data is correct
AND The system stores the U1 segment
THEN:
- • The system should save the U1 segment to the SHIPMINU database for EDI processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when u1 segment has been successfully stored for edi processing.
Trigger Criteria:
- Context: The U1 segment has been successfully stored for EDI processing
- Applied to: Log Shipment Processing Action
- Action: The system completes shipment processing
Logic Flow:
IF The U1 segment has been successfully stored for EDI processing
AND The system completes shipment processing
THEN:
- • The system should create a log entry documenting the successful completion of shipment minimum information processing
R-GCX016E-cbl-01394 (+13) File: GCX016E.cbl Business Rule: Destination Station Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when x4 segment has been received for processing.
Trigger Criteria:
- Context: An X4 segment has been received for processing
- Applied to: Extract Destination Station Code
- Action: The system processes the X4 segment
Logic Flow:
IF An X4 segment has been received for processing
AND The system processes the X4 segment
THEN:
- • The destination station code is extracted from the segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when destination station code has been extracted from x4 segment.
Trigger Criteria:
- Context: A destination station code has been extracted from X4 segment
- Applied to: Station Code Present?
- Action: The system validates the extracted station code
Logic Flow:
IF A destination station code has been extracted from X4 segment
AND The system validates the extracted station code
THEN:
- • The system determines if the station code is present or missing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when destination station code is present.
Trigger Criteria:
- Context: A destination station code is present
- Applied to: Valid Format?
- Action: The system validates the station code format
Logic Flow:
IF A destination station code is present
AND The system validates the station code format
THEN:
- • The system determines if the format is valid according to business standards
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid format destination station code exists.
Trigger Criteria:
- Context: A valid format destination station code exists
- Applied to: Lookup Station in Destination Table
- Action: The system performs a lookup in the destination station table
Logic Flow:
IF A valid format destination station code exists
AND The system performs a lookup in the destination station table
THEN:
- • The system searches for matching station information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when lookup has been performed in the destination station table.
Trigger Criteria:
- Context: A lookup has been performed in the destination station table
- Applied to: Station Found?
- Action: The system evaluates the lookup results
Logic Flow:
IF A lookup has been performed in the destination station table
AND The system evaluates the lookup results
THEN:
- • The system determines if the station was found or not found
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when destination station is found in the reference table.
Trigger Criteria:
- Context: A destination station is found in the reference table
- Applied to: Retrieve Station Information
- Action: The system retrieves station data
Logic Flow:
IF A destination station is found in the reference table
AND The system retrieves station data
THEN:
- • Complete station information including name and attributes is retrieved
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when complete station information has been retrieved.
Trigger Criteria:
- Context: Complete station information has been retrieved
- Applied to: Set Destination Station Data
- Action: The system sets destination station data
Logic Flow:
IF Complete station information has been retrieved
AND The system sets destination station data
THEN:
- • All relevant destination station fields are populated with the retrieved information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when destination station data has been set.
Trigger Criteria:
- Context: Destination station data has been set
- Applied to: Update Cargo Record with Station Info
- Action: The system updates the cargo record
Logic Flow:
IF Destination station data has been set
AND The system updates the cargo record
THEN:
- • The cargo record is updated with the destination station information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record has been updated with station information.
Trigger Criteria:
- Context: Cargo record has been updated with station information
- Applied to: Log Station Processing Success
- Action: The system completes station processing
Logic Flow:
IF Cargo record has been updated with station information
AND The system completes station processing
THEN:
- • A success log entry is created for station processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when no destination station code is present in the x4 segment.
Trigger Criteria:
- Context: No destination station code is present in the X4 segment
- Applied to: Set Default Station Information
- Action: The system processes the missing station code
Logic Flow:
IF No destination station code is present in the X4 segment
AND The system processes the missing station code
THEN:
- • Default station information is applied to maintain data integrity
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when x4 segment is processed without a destination station code.
Trigger Criteria:
- Context: An X4 segment is processed without a destination station code
- Applied to: Log Station Code Missing
- Action: The system detects the missing station code
Logic Flow:
IF An X4 segment is processed without a destination station code
AND The system detects the missing station code
THEN:
- • A log entry is created indicating the station code is missing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when destination station code is present but has invalid format.
Trigger Criteria:
- Context: A destination station code is present but has invalid format
- Applied to: Log Invalid Station Format
- Action: The system validates the station code format
Logic Flow:
IF A destination station code is present but has invalid format
AND The system validates the station code format
THEN:
- • A log entry is created indicating invalid station format
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid format destination station code is not found in the reference table.
Trigger Criteria:
- Context: A valid format destination station code is not found in the reference table
- Applied to: Log Station Not Found Error
- Action: The system completes the lookup process
Logic Flow:
IF A valid format destination station code is not found in the reference table
AND The system completes the lookup process
THEN:
- • An error log entry is created indicating the station was not found
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when destination station processing is complete (successful or with defaults).
Trigger Criteria:
- Context: Destination station processing is complete (successful or with defaults)
- Applied to: Continue X4 Processing
- Action: The system finishes station processing
Logic Flow:
IF Destination station processing is complete (successful or with defaults)
AND The system finishes station processing
THEN:
- • Processing continues with the next components of the X4 segment
R-GCX016E-cbl-01408 (+12) File: GCX016E.cbl Business Rule: Key Station Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when x4 segment contains cargo disposition data with location information.
Trigger Criteria:
- Context: An X4 segment contains cargo disposition data with location information
- Applied to: Extract Location Identifier from X4 Segment
- Action: The system processes the X4 segment for key station lookup
Logic Flow:
IF An X4 segment contains cargo disposition data with location information
AND The system processes the X4 segment for key station lookup
THEN:
- • The location identifier is extracted from the X4 segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when location identifier has been extracted from x4 segment data.
Trigger Criteria:
- Context: A location identifier has been extracted from X4 segment data
- Applied to: Validate Location Identifier Format
- Action: The system validates the location identifier format
Logic Flow:
IF A location identifier has been extracted from X4 segment data
AND The system validates the location identifier format
THEN:
- • The location identifier format is confirmed as valid or invalid
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when location identifier has undergone format validation.
Trigger Criteria:
- Context: A location identifier has undergone format validation
- Applied to: Location Identifier Valid?
- Action: The system evaluates the validation results
Logic Flow:
IF A location identifier has undergone format validation
AND The system evaluates the validation results
THEN:
- • The system proceeds with key station lookup if valid or generates error message if invalid
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid location identifier has been confirmed.
Trigger Criteria:
- Context: A valid location identifier has been confirmed
- Applied to: Retrieve Key Station Information from KS Table
- Action: The system queries the KS table for key station information
Logic Flow:
IF A valid location identifier has been confirmed
AND The system queries the KS table for key station information
THEN:
- • The system retrieves matching key station data from the KS table
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when system needs to lookup key station information in the ks table. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: The system needs to lookup key station information in the KS table
- Applied to: Call GCCTBIO for Table Lookup
- Action: The system calls GCCTBIO with the location identifier
Logic Flow:
IF The system needs to lookup key station information in the KS table
AND The system calls GCCTBIO with the location identifier
THEN:
- • GCCTBIO performs the table lookup and returns results
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when gcctbio has completed the key station table lookup.
Trigger Criteria:
- Context: GCCTBIO has completed the key station table lookup
- Applied to: Key Station Found?
- Action: The system evaluates the lookup results
Logic Flow:
IF GCCTBIO has completed the key station table lookup
AND The system evaluates the lookup results
THEN:
- • The system proceeds with data loading if station found or generates error if not found
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when key station information has been successfully retrieved from the ks table.
Trigger Criteria:
- Context: Key station information has been successfully retrieved from the KS table
- Applied to: Load Key Station Data
- Action: The system loads the station data
Logic Flow:
IF Key station information has been successfully retrieved from the KS table
AND The system loads the station data
THEN:
- • Key station data is available in working storage for validation and field setting
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when key station data has been loaded into working storage.
Trigger Criteria:
- Context: Key station data has been loaded into working storage
- Applied to: Validate Station Information
- Action: The system validates the station information
Logic Flow:
IF Key station data has been loaded into working storage
AND The system validates the station information
THEN:
- • The station data is confirmed as valid or invalid based on business rules
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when station information has undergone validation checks.
Trigger Criteria:
- Context: Station information has undergone validation checks
- Applied to: Station Data Valid?
- Action: The system evaluates the validation results
Logic Flow:
IF Station information has undergone validation checks
AND The system evaluates the validation results
THEN:
- • The system proceeds with field setting if valid or generates error message if invalid
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid key station data is available in working storage.
Trigger Criteria:
- Context: Valid key station data is available in working storage
- Applied to: Set Key Station Fields
- Action: The system sets key station fields
Logic Flow:
IF Valid key station data is available in working storage
AND The system sets key station fields
THEN:
- • Key station fields are populated with validated station information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when key station fields have been successfully set.
Trigger Criteria:
- Context: Key station fields have been successfully set
- Applied to: Update Location Validation Status
- Action: The system updates location validation status
Logic Flow:
IF Key station fields have been successfully set
AND The system updates location validation status
THEN:
- • Location validation status indicates successful key station processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when location identifier has failed format validation.
Trigger Criteria:
- Context: A location identifier has failed format validation
- Applied to: Generate Error Message for Invalid Location
- Action: The system generates an error message
Logic Flow:
IF A location identifier has failed format validation
AND The system generates an error message
THEN:
- • An error message is created indicating invalid location identifier
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when key station lookup has failed to find matching station data.
Trigger Criteria:
- Context: Key station lookup has failed to find matching station data
- Applied to: Generate Error Message for Station Not Found
- Action: The system generates an error message
Logic Flow:
IF Key station lookup has failed to find matching station data
AND The system generates an error message
THEN:
- • An error message is created indicating station not found
R-GCX016E-cbl-01421 (+12) File: GCX016E.cbl Business Rule: N9 Reference Information Retrieval
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo processing request is received.
Trigger Criteria:
- Context: A cargo processing request is received
- Applied to: Start N9 Reference Information Retrieval
- Action: The system begins N9 reference information retrieval
Logic Flow:
IF A cargo processing request is received
AND The system begins N9 reference information retrieval
THEN:
- • The N9 reference retrieval process is initiated
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when n9 reference retrieval process has been initiated.
Trigger Criteria:
- Context: N9 reference retrieval process has been initiated
- Applied to: Identify Cargo Record
- Action: The system needs to locate the target cargo record
Logic Flow:
IF N9 reference retrieval process has been initiated
AND The system needs to locate the target cargo record
THEN:
- • The cargo record is identified using the cargo key information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record has been identified.
Trigger Criteria:
- Context: The cargo record has been identified
- Applied to: Access Cargo Segments Database
- Action: The system needs to access N9 reference segments
Logic Flow:
IF The cargo record has been identified
AND The system needs to access N9 reference segments
THEN:
- • The GCSUSS02 cargo segments database is accessed
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo segments database has been accessed.
Trigger Criteria:
- Context: The cargo segments database has been accessed
- Applied to: N9 Segments Available?
- Action: The system searches for N9 segments for the cargo
Logic Flow:
IF The cargo segments database has been accessed
AND The system searches for N9 segments for the cargo
THEN:
- • The system determines if N9 segments are available or not available
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when n9 segments are available for the cargo.
Trigger Criteria:
- Context: N9 segments are available for the cargo
- Applied to: Retrieve N9 Reference Numbers
- Action: The system processes the available N9 segments
Logic Flow:
IF N9 segments are available for the cargo
AND The system processes the available N9 segments
THEN:
- • All N9 reference numbers are retrieved from the segments
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when n9 reference numbers have been retrieved.
Trigger Criteria:
- Context: N9 reference numbers have been retrieved
- Applied to: Validate Reference Number Format
- Action: The system validates the format of each reference number
Logic Flow:
IF N9 reference numbers have been retrieved
AND The system validates the format of each reference number
THEN:
- • Each reference number is confirmed to meet format requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when n9 reference numbers have been validated for format.
Trigger Criteria:
- Context: N9 reference numbers have been validated for format
- Applied to: Reference Type?
- Action: The system examines the reference type qualifier
Logic Flow:
IF N9 reference numbers have been validated for format
AND The system examines the reference type qualifier
THEN:
- • References are classified as either FDA references (A1/A3) or general references
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when n9 references are classified as fda type with a1 or a3 qualifiers.
Trigger Criteria:
- Context: N9 references are classified as FDA type with A1 or A3 qualifiers
- Applied to: Process FDA Reference Numbers - A1/A3
- Action: The system processes these FDA references
Logic Flow:
IF N9 references are classified as FDA type with A1 or A3 qualifiers
AND The system processes these FDA references
THEN:
- • FDA reference numbers are processed with specialized FDA handling rules
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when n9 references are classified as general (non-fda) type.
Trigger Criteria:
- Context: N9 references are classified as general (non-FDA) type
- Applied to: Process General Reference Numbers
- Action: The system processes these general references
Logic Flow:
IF N9 references are classified as general (non-FDA) type
AND The system processes these general references
THEN:
- • General reference numbers are processed using standard reference handling procedures
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when reference numbers have been processed (either fda or general).
Trigger Criteria:
- Context: Reference numbers have been processed (either FDA or general)
- Applied to: Format Reference Information
- Action: The system formats the reference information
Logic Flow:
IF Reference numbers have been processed (either FDA or general)
AND The system formats the reference information
THEN:
- • Reference information is formatted into standardized structure with proper qualifiers and values
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when reference information has been formatted.
Trigger Criteria:
- Context: Reference information has been formatted
- Applied to: Store Reference Data in Working Storage
- Action: The system stores the reference data
Logic Flow:
IF Reference information has been formatted
AND The system stores the reference data
THEN:
- • Formatted reference information is stored in working storage N9 arrays
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when reference data has been stored in working storage.
Trigger Criteria:
- Context: Reference data has been stored in working storage
- Applied to: Update Cargo Record with References
- Action: The system updates the cargo record
Logic Flow:
IF Reference data has been stored in working storage
AND The system updates the cargo record
THEN:
- • The cargo record is updated with all processed N9 reference information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all n9 reference processing has been completed or no n9 segments were available.
Trigger Criteria:
- Context: All N9 reference processing has been completed OR no N9 segments were available
- Applied to: End N9 Reference Retrieval
- Action: The system reaches the end of the N9 reference retrieval process
Logic Flow:
IF All N9 reference processing has been completed OR no N9 segments were available
AND The system reaches the end of the N9 reference retrieval process
THEN:
- • The N9 reference information retrieval process is completed
R-GCX016E-cbl-01434 (+10) File: GCX016E.cbl Business Rule: Canadian Cargo Lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when us cargo record exists with equipment information.
Trigger Criteria:
- Context: A US cargo record exists with equipment information
- Applied to: Extract Equipment ID from US Cargo Record
- Action: The system processes the cargo for cross-border tracking
Logic Flow:
IF A US cargo record exists with equipment information
AND The system processes the cargo for cross-border tracking
THEN:
- • The equipment ID is extracted from the cargo record for Canadian cargo lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment id has been extracted from the us cargo record.
Trigger Criteria:
- Context: An equipment ID has been extracted from the US cargo record
- Applied to: Search Canadian Cargo Database GCCC-CARGO-ROOT
- Action: The system searches the Canadian cargo database GCCC-CARGO-ROOT
Logic Flow:
IF An equipment ID has been extracted from the US cargo record
AND The system searches the Canadian cargo database GCCC-CARGO-ROOT
THEN:
- • The system retrieves any Canadian cargo records that match the equipment ID
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when search has been performed in the canadian cargo database.
Trigger Criteria:
- Context: A search has been performed in the Canadian cargo database
- Applied to: Canadian Cargo Record Found?
- Action: The system evaluates the search results
Logic Flow:
IF A search has been performed in the Canadian cargo database
AND The system evaluates the search results
THEN:
- • If a Canadian cargo record is found, proceed to status validation;
otherwise, log no Canadian cargo found and continue processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when canadian cargo record has been found.
Trigger Criteria:
- Context: A Canadian cargo record has been found
- Applied to: Validate Canadian Cargo Status
- Action: The system validates the cargo status
Logic Flow:
IF A Canadian cargo record has been found
AND The system validates the cargo status
THEN:
- • The cargo status is checked to ensure it is valid for processing and not in an excluded state
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when canadian cargo record status has been validated.
Trigger Criteria:
- Context: A Canadian cargo record status has been validated
- Applied to: Status Valid for Processing?
- Action: The system evaluates processing eligibility
Logic Flow:
IF A Canadian cargo record status has been validated
AND The system evaluates processing eligibility
THEN:
- • If status is valid, proceed to equipment ID matching; if status is deleted or new bond created, skip the record and continue processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid canadian cargo record exists for processing.
Trigger Criteria:
- Context: A valid Canadian cargo record exists for processing
- Applied to: Match Equipment IDs Between Systems
- Action: The system matches equipment IDs between US and Canadian systems
Logic Flow:
IF A valid Canadian cargo record exists for processing
AND The system matches equipment IDs between US and Canadian systems
THEN:
- • Equipment IDs are compared and validated for creating cross-border tracking links
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when equipment ids have been successfully matched between systems.
Trigger Criteria:
- Context: Equipment IDs have been successfully matched between systems
- Applied to: Create Cross-Border Tracking Link
- Action: The system creates cross-border tracking links
Logic Flow:
IF Equipment IDs have been successfully matched between systems
AND The system creates cross-border tracking links
THEN:
- • A tracking relationship is established between the US and Canadian cargo records
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cross-border tracking link has been created.
Trigger Criteria:
- Context: A cross-border tracking link has been created
- Applied to: Update Cargo with Canadian Reference
- Action: The system updates the US cargo record
Logic Flow:
IF A cross-border tracking link has been created
AND The system updates the US cargo record
THEN:
- • The US cargo record is updated with Canadian cargo reference information for cross-border tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when canadian cargo record has been successfully matched and linked.
Trigger Criteria:
- Context: A Canadian cargo record has been successfully matched and linked
- Applied to: Log Canadian Cargo Match Found
- Action: The system completes the cross-border linking process
Logic Flow:
IF A Canadian cargo record has been successfully matched and linked
AND The system completes the cross-border linking process
THEN:
- • A log entry is created documenting the successful Canadian cargo match
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when no canadian cargo record is found for the equipment id.
Trigger Criteria:
- Context: No Canadian cargo record is found for the equipment ID
- Applied to: Log No Canadian Cargo Found
- Action: The system completes the Canadian cargo search
Logic Flow:
IF No Canadian cargo record is found for the equipment ID
AND The system completes the Canadian cargo search
THEN:
- • A log entry is created documenting that no Canadian cargo was found and processing continues
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when canadian cargo record is found but has deleted or new bond created status.
Trigger Criteria:
- Context: A Canadian cargo record is found but has deleted or new bond created status
- Applied to: Skip Deleted/Invalid Records
- Action: The system evaluates the record for processing
Logic Flow:
IF A Canadian cargo record is found but has deleted or new bond created status
AND The system evaluates the record for processing
THEN:
- • The record is skipped and excluded from cross-border tracking, and processing continues with the next record
R-GCX016E-cbl-01445 (+13) File: GCX016E.cbl Business Rule: Transaction Spawning
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo processing transaction is being executed.
Trigger Criteria:
- Context: A cargo processing transaction is being executed
- Applied to: Multi-Manifest Scenario?
- Action: The system evaluates whether multiple manifests are involved in the current transaction
Logic Flow:
IF A cargo processing transaction is being executed
AND The system evaluates whether multiple manifests are involved in the current transaction
THEN:
- • The system determines if follower manifest processing is required and routes accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when multi-manifest scenario has been identified.
Trigger Criteria:
- Context: A multi-manifest scenario has been identified
- Applied to: Identify Lead Manifest CCN
- Action: The system needs to process follower manifests
Logic Flow:
IF A multi-manifest scenario has been identified
AND The system needs to process follower manifests
THEN:
- • The lead manifest CCN is identified and stored for comparison with follower manifest CCNs
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when lead manifest ccn has been identified.
Trigger Criteria:
- Context: Lead manifest CCN has been identified
- Applied to: Identify US CCN Key
- Action: The system prepares to compare manifests
Logic Flow:
IF Lead manifest CCN has been identified
AND The system prepares to compare manifests
THEN:
- • The US CCN key is extracted and prepared for comparison with the lead manifest CCN
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when both lead manifest ccn and us ccn key have been identified.
Trigger Criteria:
- Context: Both lead manifest CCN and US CCN key have been identified
- Applied to: Lead Manifest CCN ≠ US CCN Key?
- Action: The system compares the lead manifest CCN with the US CCN key
Logic Flow:
IF Both lead manifest CCN and US CCN key have been identified
AND The system compares the lead manifest CCN with the US CCN key
THEN:
- • If the CCNs are different, follower manifest processing is initiated; if they are the same, no additional processing is required
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when lead manifest ccn differs from us ccn key.
Trigger Criteria:
- Context: Lead manifest CCN differs from US CCN key
- Applied to: Prepare 350 Special Action Message
- Action: The system prepares to spawn a follower manifest transaction
Logic Flow:
IF Lead manifest CCN differs from US CCN key
AND The system prepares to spawn a follower manifest transaction
THEN:
- • A special action message with action code 350 is prepared for the GCT0162E transaction
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when special action message is being prepared for follower manifest processing.
Trigger Criteria:
- Context: A special action message is being prepared for follower manifest processing
- Applied to: Include Disposition Codes
- Action: The system builds the transaction message content
Logic Flow:
IF A special action message is being prepared for follower manifest processing
AND The system builds the transaction message content
THEN:
- • All relevant disposition codes from the original transaction are included in the follower manifest message
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition codes have been included in the follower manifest message.
Trigger Criteria:
- Context: Disposition codes have been included in the follower manifest message
- Applied to: Include Quantities
- Action: The system continues building the transaction message
Logic Flow:
IF Disposition codes have been included in the follower manifest message
AND The system continues building the transaction message
THEN:
- • All relevant quantity information from the original transaction is included in the follower manifest message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when quantities have been included in the follower manifest message.
Trigger Criteria:
- Context: Quantities have been included in the follower manifest message
- Applied to: Include Entry Numbers
- Action: The system completes building the transaction message
Logic Flow:
IF Quantities have been included in the follower manifest message
AND The system completes building the transaction message
THEN:
- • All relevant entry numbers from the original transaction are included in the follower manifest message
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when complete follower manifest message has been prepared with all required information.
Trigger Criteria:
- Context: A complete follower manifest message has been prepared with all required information
- Applied to: Spawn GCT0162E Transaction
- Action: The system is ready to process the follower manifest
Logic Flow:
IF A complete follower manifest message has been prepared with all required information
AND The system is ready to process the follower manifest
THEN:
- • A GCT0162E transaction is spawned with the prepared message for follower manifest processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when gct0162e transaction has been successfully spawned for follower manifest processing.
Trigger Criteria:
- Context: A GCT0162E transaction has been successfully spawned for follower manifest processing
- Applied to: Set Follower Manifest Processing Flag
- Action: The system updates processing status
Logic Flow:
IF A GCT0162E transaction has been successfully spawned for follower manifest processing
AND The system updates processing status
THEN:
- • Follower manifest processing flags are set to indicate the current processing state
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when follower manifest processing flags have been set for the current manifest.
Trigger Criteria:
- Context: Follower manifest processing flags have been set for the current manifest
- Applied to: Continue with Next Manifest
- Action: The system is ready to process additional manifests
Logic Flow:
IF Follower manifest processing flags have been set for the current manifest
AND The system is ready to process additional manifests
THEN:
- • Processing continues with the next manifest in the sequence
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when current follower manifest has been processed.
Trigger Criteria:
- Context: The current follower manifest has been processed
- Applied to: More Follower Manifests?
- Action: The system checks for additional manifests in the sequence
Logic Flow:
IF The current follower manifest has been processed
AND The system checks for additional manifests in the sequence
THEN:
- • If more follower manifests exist, processing continues;
otherwise, transaction spawning is completed
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all follower manifests have been processed or no follower manifests were required.
Trigger Criteria:
- Context: All follower manifests have been processed or no follower manifests were required
- Applied to: Complete Transaction Spawning
- Action: The transaction spawning process reaches completion
Logic Flow:
IF All follower manifests have been processed or no follower manifests were required
AND The transaction spawning process reaches completion
THEN:
- • The transaction spawning process is marked as complete and control returns to the main processing flow
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when either no multi-manifest scenario exists or lead manifest ccn equals us ccn key.
Trigger Criteria:
- Context: Either no multi-manifest scenario exists or lead manifest CCN equals US CCN key
- Applied to: No Transaction Spawning Required
- Action: The system determines that no follower manifest processing is needed
Logic Flow:
IF Either no multi-manifest scenario exists or lead manifest CCN equals US CCN key
AND The system determines that no follower manifest processing is needed
THEN:
- • No transaction spawning occurs and processing continues with the normal flow
R-GCX016E-cbl-01459 (+13) File: GCX016E.cbl Business Rule: Error Handling and Abend Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when message is being processed from the message queue.
Trigger Criteria:
- Context: A message is being processed from the message queue
- Applied to: MQ Message Error
- Action: MQ completion code is not OK or reason code indicates message unavailable (2033) or backout count is not zero
Logic Flow:
IF A message is being processed from the message queue
AND MQ completion code is not OK or reason code indicates message unavailable (2033) or backout count is not zero
THEN:
- • Set appropriate message status flags (message not available or skip message) and generate error notification to Merlin system
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when database read, write, or update operation is being performed. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A database read, write, or update operation is being performed
- Applied to: Database I/O Error
- Action: Database operation returns an error status code
Logic Flow:
IF A database read, write, or update operation is being performed
AND Database operation returns an error status code
THEN:
- • Log error information, generate Merlin error message, and either continue processing or abend based on error severity
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when lookup is performed against reference tables (dc table, train list, broker table, etc.).
Trigger Criteria:
- Context: A lookup is performed against reference tables (DC table, train list, broker table, etc.)
- Applied to: Table Lookup Error
- Action: The lookup operation fails to find matching records or returns an error
Logic Flow:
IF A lookup is performed against reference tables (DC table, train list, broker table, etc.)
AND The lookup operation fails to find matching records or returns an error
THEN:
- • Generate appropriate error message, log the lookup failure, and continue processing with default values or error handling
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when m10 segment contains vessel name that does not start with 'train' or 'day'.
Trigger Criteria:
- Context: M10 segment contains vessel name that does not start with 'TRAIN' or 'DAY'
- Applied to: Train Not Found Error
- Action: Train lookup in train list fails to find matching train record
Logic Flow:
IF M10 segment contains vessel name that does not start with 'TRAIN' or 'DAY'
AND Train lookup in train list fails to find matching train record
THEN:
- • Generate train not found error message to Merlin system and continue processing remaining segments
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when x4 and n7 segments specify cargo identification information.
Trigger Criteria:
- Context: X4 and N7 segments specify cargo identification information
- Applied to: Cargo Not Found Error
- Action: Cargo lookup fails to find matching cargo records in the database
Logic Flow:
IF X4 and N7 segments specify cargo identification information
AND Cargo lookup fails to find matching cargo records in the database
THEN:
- • Generate cargo not found error message, log the missing cargo information, and continue processing other cargos
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when x4 segment contains disposition code information.
Trigger Criteria:
- Context: X4 segment contains disposition code information
- Applied to: Invalid Disposition Code Error
- Action: Disposition code lookup in DC table fails or returns invalid status
Logic Flow:
IF X4 segment contains disposition code information
AND Disposition code lookup in DC table fails or returns invalid status
THEN:
- • Generate invalid disposition code error message, log the invalid code, and skip processing for that specific disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when error condition has been detected during message processing.
Trigger Criteria:
- Context: An error condition has been detected during message processing
- Applied to: Generate Merlin Error Message
- Action: Error information needs to be communicated to business users
Logic Flow:
IF An error condition has been detected during message processing
AND Error information needs to be communicated to business users
THEN:
- • Format error message with relevant business context (train ID, cargo information, disposition codes) and route to Merlin system
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when error has occurred during message processing.
Trigger Criteria:
- Context: An error has occurred during message processing
- Applied to: Log Error Information
- Action: Error logging is required for audit trail
Logic Flow:
IF An error has occurred during message processing
AND Error logging is required for audit trail
THEN:
- • Log error details including message ID, segment information, error type, and relevant business data for debugging purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when error condition has been identified and logged.
Trigger Criteria:
- Context: An error condition has been identified and logged
- Applied to: Set Error Flags
- Action: Processing flow needs to be controlled based on error status
Logic Flow:
IF An error condition has been identified and logged
AND Processing flow needs to be controlled based on error status
THEN:
- • Set appropriate error flags to indicate error type and severity for downstream processing decisions
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when error message has been generated for routing.
Trigger Criteria:
- Context: An error message has been generated for routing
- Applied to: Route Error Message to Default Recipient
- Action: Primary Merlin ID routing fails or is unavailable
Logic Flow:
IF An error message has been generated for routing
AND Primary Merlin ID routing fails or is unavailable
THEN:
- • Route error message to default recipients (OM01247, AEI9999) with fallback notification
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when error has been detected and appropriate error handling has been performed.
Trigger Criteria:
- Context: An error has been detected and appropriate error handling has been performed
- Applied to: Continue Processing or Terminate
- Action: Decision is needed on whether to continue processing remaining messages/segments
Logic Flow:
IF An error has been detected and appropriate error handling has been performed
AND Decision is needed on whether to continue processing remaining messages/segments
THEN:
- • Continue processing for non-critical errors (train not found, cargo not found) or terminate for critical system errors (database failures, MQ errors)
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when business-level error has occurred (train not found, cargo not found, invalid disposition code).
Trigger Criteria:
- Context: A business-level error has occurred (train not found, cargo not found, invalid disposition code)
- Applied to: Reroute Message with Error Notification
- Action: Original message routing cannot be completed due to the error
Logic Flow:
IF A business-level error has occurred (train not found, cargo not found, invalid disposition code)
AND Original message routing cannot be completed due to the error
THEN:
- • Reroute message to backup recipients with error notification explaining the business issue
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when error handling is in progress and debug logging is enabled.
Trigger Criteria:
- Context: Error handling is in progress and debug logging is enabled
- Applied to: Create Debug Log Entry
- Action: Detailed troubleshooting information is needed for business rule analysis
Logic Flow:
IF Error handling is in progress and debug logging is enabled
AND Detailed troubleshooting information is needed for business rule analysis
THEN:
- • Create debug log entries showing before/after status arrays, disposition codes, and cargo status changes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when error handling has been completed for a specific error condition.
Trigger Criteria:
- Context: Error handling has been completed for a specific error condition
- Applied to: Update Processing Status
- Action: Processing status needs to reflect the current state after error handling
Logic Flow:
IF Error handling has been completed for a specific error condition
AND Processing status needs to reflect the current state after error handling
THEN:
- • Update processing status flags and counters to indicate error resolution and readiness for continued processing
R-GCX016E-cbl-01473 (+12) File: GCX016E.cbl Business Rule: Train ID Validation Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when m10 vessel name segment is received.
Trigger Criteria:
- Context: An M10 vessel name segment is received
- Applied to: Extract Train ID from Vessel Name
- Action: The system processes the vessel name field
Logic Flow:
IF An M10 vessel name segment is received
AND The system processes the vessel name field
THEN:
- • The train ID is extracted from the vessel name for validation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when vessel name has been processed for train id extraction.
Trigger Criteria:
- Context: A vessel name has been processed for train ID extraction
- Applied to: Train ID Present?
- Action: The system checks if a valid train ID was extracted
Logic Flow:
IF A vessel name has been processed for train ID extraction
AND The system checks if a valid train ID was extracted
THEN:
- • If train ID is present, proceed to train lookup; if not present, generate train not found error
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid train id has been extracted from the vessel name. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A valid train ID has been extracted from the vessel name
- Applied to: Call GCCUTRIO to Lookup Train in System
- Action: The system needs to validate the train exists in the system
Logic Flow:
IF A valid train ID has been extracted from the vessel name
AND The system needs to validate the train exists in the system
THEN:
- • Call GCCUTRIO program to lookup train data from GCWTL train list segments
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when gccutrio has been called to lookup train information.
Trigger Criteria:
- Context: GCCUTRIO has been called to lookup train information
- Applied to: Train Found in System?
- Action: The system evaluates the lookup results
Logic Flow:
IF GCCUTRIO has been called to lookup train information
AND The system evaluates the lookup results
THEN:
- • If train is found, proceed to validate train record status; if not found, generate train not found error
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train record has been found in the system.
Trigger Criteria:
- Context: A train record has been found in the system
- Applied to: Validate Train Record Status
- Action: The system validates the train record status
Logic Flow:
IF A train record has been found in the system
AND The system validates the train record status
THEN:
- • Check if the train is a CPRS train for special processing requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train record has been validated and found in the system.
Trigger Criteria:
- Context: A train record has been validated and found in the system
- Applied to: CPRS Train?
- Action: The system checks the train type
Logic Flow:
IF A train record has been validated and found in the system
AND The system checks the train type
THEN:
- • If train is CPRS type, apply CPRS special processing rules;
otherwise set train found flag
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train has been identified as cprs type.
Trigger Criteria:
- Context: A train has been identified as CPRS type
- Applied to: Apply CPRS Special Processing Rules
- Action: The system applies CPRS-specific processing rules
Logic Flow:
IF A train has been identified as CPRS type
AND The system applies CPRS-specific processing rules
THEN:
- • Execute CPRS special processing logic and
then set train found flag
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train has been successfully validated (either regular or cprs).
Trigger Criteria:
- Context: A train has been successfully validated (either regular or CPRS)
- Applied to: Set Train Found Flag
- Action: The system completes train validation processing
Logic Flow:
IF A train has been successfully validated (either regular or CPRS)
AND The system completes train validation processing
THEN:
- • Set train found flag to true and continue with train processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train id is not present in vessel name or train is not found in system lookup.
Trigger Criteria:
- Context: Train ID is not present in vessel name OR train is not found in system lookup
- Applied to: Generate Train Not Found Error Message
- Action: The system encounters train validation failure
Logic Flow:
IF Train ID is not present in vessel name OR train is not found in system lookup
AND The system encounters train validation failure
THEN:
- • Generate a train not found error message for Merlin system notification
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train not found error message has been generated.
Trigger Criteria:
- Context: A train not found error message has been generated
- Applied to: Send Error to Merlin System
- Action: The system needs to notify about the validation failure
Logic Flow:
IF A train not found error message has been generated
AND The system needs to notify about the validation failure
THEN:
- • Send the error message to Merlin system for appropriate notification handling
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when error message has been sent to merlin system for train not found.
Trigger Criteria:
- Context: An error message has been sent to Merlin system for train not found
- Applied to: Set Train Processing Flag to Skip
- Action: The system needs to prevent further processing of invalid train
Logic Flow:
IF An error message has been sent to Merlin system for train not found
AND The system needs to prevent further processing of invalid train
THEN:
- • Set train processing flag to skip to bypass subsequent train-related operations
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train found flag has been set after successful validation.
Trigger Criteria:
- Context: Train found flag has been set after successful validation
- Applied to: Continue with Train Processing
- Action: The system is ready to proceed with train operations
Logic Flow:
IF Train found flag has been set after successful validation
AND The system is ready to proceed with train operations
THEN:
- • Continue with normal train processing workflow and log validation results
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train validation processing has completed (either successful or failed).
Trigger Criteria:
- Context: Train validation processing has completed (either successful or failed)
- Applied to: Log Train Validation Results
- Action: The system needs to record validation results
Logic Flow:
IF Train validation processing has completed (either successful or failed)
AND The system needs to record validation results
THEN:
- • Log the train validation results including success/failure status and any relevant details
R-GCX016E-cbl-01486 (+15) File: GCX016E.cbl Business Rule: Equipment Hold Processing by VID Segment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when vid segment has been received for equipment hold processing.
Trigger Criteria:
- Context: A VID segment has been received for equipment hold processing
- Applied to: Extract Equipment ID from VID Segment
- Action: The system processes the VID segment
Logic Flow:
IF A VID segment has been received for equipment hold processing
AND The system processes the VID segment
THEN:
- • The equipment ID is extracted from the VID segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment id has been extracted from a vid segment.
Trigger Criteria:
- Context: An equipment ID has been extracted from a VID segment
- Applied to: Validate Equipment ID Format
- Action: The system validates the equipment ID format
Logic Flow:
IF An equipment ID has been extracted from a VID segment
AND The system validates the equipment ID format
THEN:
- • The equipment ID format is checked against validation criteria
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when equipment id format has been validated.
Trigger Criteria:
- Context: An equipment ID format has been validated
- Applied to: Equipment ID Valid?
- Action: The system checks equipment ID validity
Logic Flow:
IF An equipment ID format has been validated
AND The system checks equipment ID validity
THEN:
- • If equipment ID is invalid, generate invalid equipment ID error,
otherwise proceed to locate equipment in train
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid equipment id has been confirmed.
Trigger Criteria:
- Context: A valid equipment ID has been confirmed
- Applied to: Locate Equipment in Train Consist
- Action: The system searches for the equipment in the train consist
Logic Flow:
IF A valid equipment ID has been confirmed
AND The system searches for the equipment in the train consist
THEN:
- • The equipment is located within the train's equipment list
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when system has searched for equipment in the train consist.
Trigger Criteria:
- Context: The system has searched for equipment in the train consist
- Applied to: Equipment Found in Train?
- Action: The equipment search is completed
Logic Flow:
IF The system has searched for equipment in the train consist
AND The equipment search is completed
THEN:
- • If equipment is not found in train, generate equipment not found error,
otherwise check current equipment status
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment has been found in the train consist.
Trigger Criteria:
- Context: Equipment has been found in the train consist
- Applied to: Check Current Equipment Status
- Action: The system checks the current equipment status
Logic Flow:
IF Equipment has been found in the train consist
AND The system checks the current equipment status
THEN:
- • The current hold status of the equipment is retrieved
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when current equipment status has been checked.
Trigger Criteria:
- Context: The current equipment status has been checked
- Applied to: Equipment Already Held?
- Action: The system evaluates the equipment hold status
Logic Flow:
IF The current equipment status has been checked
AND The system evaluates the equipment hold status
THEN:
- • If equipment is already held, generate already held warning,
otherwise apply hold status to equipment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when equipment is not currently held.
Trigger Criteria:
- Context: Equipment is not currently held
- Applied to: Apply Hold Status to Equipment
- Action: The system applies hold status to the equipment
Logic Flow:
IF Equipment is not currently held
AND The system applies hold status to the equipment
THEN:
- • The equipment hold status is set
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when hold status has been applied to equipment.
Trigger Criteria:
- Context: Hold status has been applied to equipment
- Applied to: Update Equipment Status Flags
- Action: The system updates equipment status flags
Logic Flow:
IF Hold status has been applied to equipment
AND The system updates equipment status flags
THEN:
- • Equipment status flags are updated to reflect held status
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment status flags have been updated.
Trigger Criteria:
- Context: Equipment status flags have been updated
- Applied to: Increment Train Hold Counter
- Action: The system increments the train hold counter
Logic Flow:
IF Equipment status flags have been updated
AND The system increments the train hold counter
THEN:
- • The train hold counter is increased by one
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train hold counter has been incremented.
Trigger Criteria:
- Context: Train hold counter has been incremented
- Applied to: Log Equipment Hold Action
- Action: The system logs the equipment hold action
Logic Flow:
IF Train hold counter has been incremented
AND The system logs the equipment hold action
THEN:
- • A log entry is created documenting the equipment hold with timestamp and equipment details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment hold action has been logged.
Trigger Criteria:
- Context: Equipment hold action has been logged
- Applied to: Generate Hold Confirmation Message
- Action: The system generates hold confirmation message
Logic Flow:
IF Equipment hold action has been logged
AND The system generates hold confirmation message
THEN:
- • A confirmation message is created indicating successful equipment hold
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when hold confirmation message has been generated.
Trigger Criteria:
- Context: Hold confirmation message has been generated
- Applied to: Update Train Equipment List
- Action: The system updates the train equipment list
Logic Flow:
IF Hold confirmation message has been generated
AND The system updates the train equipment list
THEN:
- • The train equipment list is updated with the equipment's new held status
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment search in train consist has been completed.
Trigger Criteria:
- Context: Equipment search in train consist has been completed
- Applied to: Generate Equipment Not Found Error
- Action: Equipment is not found in the train
Logic Flow:
IF Equipment search in train consist has been completed
AND Equipment is not found in the train
THEN:
- • An equipment not found error message is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment id format validation has been performed.
Trigger Criteria:
- Context: Equipment ID format validation has been performed
- Applied to: Generate Invalid Equipment ID Error
- Action: Equipment ID is determined to be invalid
Logic Flow:
IF Equipment ID format validation has been performed
AND Equipment ID is determined to be invalid
THEN:
- • An invalid equipment ID error message is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment hold status has been evaluated.
Trigger Criteria:
- Context: Equipment hold status has been evaluated
- Applied to: Generate Already Held Warning
- Action: Equipment is already in held status
Logic Flow:
IF Equipment hold status has been evaluated
AND Equipment is already in held status
THEN:
- • An already held warning message is generated
R-GCX016E-cbl-01502 (+17) File: GCX016E.cbl Business Rule: Equipment Release Processing by VID Segment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when vid segment is received for equipment release processing.
Trigger Criteria:
- Context: A VID segment is received for equipment release processing
- Applied to: Extract Equipment ID from VID Segment
- Action: The system processes the VID segment
Logic Flow:
IF A VID segment is received for equipment release processing
AND The system processes the VID segment
THEN:
- • The equipment ID is extracted from the VID segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment id has been extracted from vid segment.
Trigger Criteria:
- Context: An equipment ID has been extracted from VID segment
- Applied to: Equipment Found in Train?
- Action: The system searches for the equipment in the train equipment list
Logic Flow:
IF An equipment ID has been extracted from VID segment
AND The system searches for the equipment in the train equipment list
THEN:
- • The system determines if the equipment exists in the train or generates equipment not found error
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment exists in the train and release request data is available.
Trigger Criteria:
- Context: Equipment exists in the train and release request data is available
- Applied to: Valid Release Request?
- Action: The system validates the release request parameters
Logic Flow:
IF Equipment exists in the train and release request data is available
AND The system validates the release request parameters
THEN:
- • The system determines if the release request is valid or generates invalid release request error
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid release request exists for equipment found in train.
Trigger Criteria:
- Context: A valid release request exists for equipment found in train
- Applied to: Equipment Currently Held?
- Action: The system checks the current hold status of the equipment
Logic Flow:
IF A valid release request exists for equipment found in train
AND The system checks the current hold status of the equipment
THEN:
- • The system determines if equipment is held or generates warning for equipment not held
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment is currently held and release request is valid.
Trigger Criteria:
- Context: Equipment is currently held and release request is valid
- Applied to: Process Equipment Release
- Action: The system processes the equipment release
Logic Flow:
IF Equipment is currently held and release request is valid
AND The system processes the equipment release
THEN:
- • The equipment release is processed and hold counter is decremented
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment release is being processed.
Trigger Criteria:
- Context: Equipment release is being processed
- Applied to: Decrement Hold Counter
- Action: The system updates the hold counter
Logic Flow:
IF Equipment release is being processed
AND The system updates the hold counter
THEN:
- • The hold counter is decremented by one
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when hold counter has been decremented for equipment release.
Trigger Criteria:
- Context: Hold counter has been decremented for equipment release
- Applied to: Hold Counter = 0?
- Action: The system checks the hold counter value
Logic Flow:
IF Hold counter has been decremented for equipment release
AND The system checks the hold counter value
THEN:
- • The system determines if hold counter equals zero to set equipment status to released
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when hold counter equals zero after decrement.
Trigger Criteria:
- Context: Hold counter equals zero after decrement
- Applied to: Set Equipment Status to Released
- Action: The system updates equipment status
Logic Flow:
IF Hold counter equals zero after decrement
AND The system updates equipment status
THEN:
- • The equipment status is set to released
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment status has been processed for release.
Trigger Criteria:
- Context: Equipment status has been processed for release
- Applied to: Update Equipment Status in Train List
- Action: The system updates the train equipment list
Logic Flow:
IF Equipment status has been processed for release
AND The system updates the train equipment list
THEN:
- • The equipment status is updated in the train list
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment status has been updated in train list.
Trigger Criteria:
- Context: Equipment status has been updated in train list
- Applied to: Log Equipment Release Action
- Action: The system logs the release action
Logic Flow:
IF Equipment status has been updated in train list
AND The system logs the release action
THEN:
- • The equipment release action is logged with relevant details
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment release action has been logged.
Trigger Criteria:
- Context: Equipment release action has been logged
- Applied to: Generate Equipment Release Notification
- Action: The system generates release notification
Logic Flow:
IF Equipment release action has been logged
AND The system generates release notification
THEN:
- • An equipment release notification is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment release notification has been generated.
Trigger Criteria:
- Context: Equipment release notification has been generated
- Applied to: Update Train Equipment Status Flags
- Action: The system updates train equipment status flags
Logic Flow:
IF Equipment release notification has been generated
AND The system updates train equipment status flags
THEN:
- • The train equipment status flags are updated to reflect current equipment states
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train equipment status flags have been updated.
Trigger Criteria:
- Context: Train equipment status flags have been updated
- Applied to: All Equipment in Train Released?
- Action: The system checks if all equipment in train is released
Logic Flow:
IF Train equipment status flags have been updated
AND The system checks if all equipment in train is released
THEN:
- • The system determines if all equipment is released or if some equipment remains held
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all equipment in the train has been released.
Trigger Criteria:
- Context: All equipment in the train has been released
- Applied to: Update Overall Train Status
- Action: The system updates overall train status
Logic Flow:
IF All equipment in the train has been released
AND The system updates overall train status
THEN:
- • The overall train status is updated to reflect that all equipment is released
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when equipment release processing is complete and train status is updated.
Trigger Criteria:
- Context: Equipment release processing is complete and train status is updated
- Applied to: Send Release Confirmation Message
- Action: The system sends release confirmation
Logic Flow:
IF Equipment release processing is complete and train status is updated
AND The system sends release confirmation
THEN:
- • A release confirmation message is sent
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when equipment id has been extracted from vid segment.
Trigger Criteria:
- Context: Equipment ID has been extracted from VID segment
- Applied to: Generate Error - Equipment Not Found
- Action: Equipment is not found in the train equipment list
Logic Flow:
IF Equipment ID has been extracted from VID segment
AND Equipment is not found in the train equipment list
THEN:
- • An equipment not found error is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment exists in train but release request validation is performed.
Trigger Criteria:
- Context: Equipment exists in train but release request validation is performed
- Applied to: Generate Error - Invalid Release Request
- Action: Release request validation fails
Logic Flow:
IF Equipment exists in train but release request validation is performed
AND Release request validation fails
THEN:
- • An invalid release request error is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid release request exists for equipment found in train.
Trigger Criteria:
- Context: Valid release request exists for equipment found in train
- Applied to: Generate Warning - Equipment Not Held
- Action: Equipment is not currently in held status
Logic Flow:
IF Valid release request exists for equipment found in train
AND Equipment is not currently in held status
THEN:
- • A warning is generated indicating equipment is not held
R-GCX016E-cbl-01520 (+17) File: GCX016E.cbl Business Rule: Equipment Seizure Processing by VID Segment
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when vid segment is received in the message queue.
Trigger Criteria:
- Context: A VID segment is received in the message queue
- Applied to: VID Segment Received
- Action: The system processes the VID segment
Logic Flow:
IF A VID segment is received in the message queue
AND The system processes the VID segment
THEN:
- • The equipment ID is extracted from the VID segment for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when vid segment contains equipment identification data.
Trigger Criteria:
- Context: A VID segment contains equipment identification data
- Applied to: Extract Equipment ID from VID Segment
- Action: The system processes the VID segment
Logic Flow:
IF A VID segment contains equipment identification data
AND The system processes the VID segment
THEN:
- • The equipment ID is extracted and made available for validation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when vid segment has been processed and disposition code is available.
Trigger Criteria:
- Context: A VID segment has been processed and disposition code is available
- Applied to: Disposition Code = SEI?
- Action: The system checks the disposition code
Logic Flow:
IF A VID segment has been processed and disposition code is available
AND The system checks the disposition code
THEN:
- • If disposition code equals SEI, proceed with seizure processing,
otherwise complete processing without seizure
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment id has been extracted from vid segment and disposition code is sei.
Trigger Criteria:
- Context: An equipment ID has been extracted from VID segment and disposition code is SEI
- Applied to: Validate Equipment ID Format
- Action: The system validates the equipment ID format
Logic Flow:
IF An equipment ID has been extracted from VID segment and disposition code is SEI
AND The system validates the equipment ID format
THEN:
- • The equipment ID format is checked against validation rules
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment id format validation has been performed.
Trigger Criteria:
- Context: Equipment ID format validation has been performed
- Applied to: Equipment ID Valid?
- Action: The system evaluates validation results
Logic Flow:
IF Equipment ID format validation has been performed
AND The system evaluates validation results
THEN:
- • If equipment ID is valid, proceed to locate equipment in train,
otherwise generate invalid equipment ID error
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment id is valid and formatted correctly.
Trigger Criteria:
- Context: Equipment ID is valid and formatted correctly
- Applied to: Locate Equipment in Train Consist
- Action: The system searches the train consist
Logic Flow:
IF Equipment ID is valid and formatted correctly
AND The system searches the train consist
THEN:
- • The system attempts to locate the equipment within the train's equipment list
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment location search has been completed.
Trigger Criteria:
- Context: Equipment location search has been completed
- Applied to: Equipment Found in Train?
- Action: The system evaluates search results
Logic Flow:
IF Equipment location search has been completed
AND The system evaluates search results
THEN:
- • If equipment is found in train, proceed to check current status,
otherwise generate equipment not found error
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has been found in the train consist.
Trigger Criteria:
- Context: Equipment has been found in the train consist
- Applied to: Check Current Equipment Status
- Action: The system checks equipment status
Logic Flow:
IF Equipment has been found in the train consist
AND The system checks equipment status
THEN:
- • The current seizure status of the equipment is retrieved and evaluated
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when current equipment status has been retrieved.
Trigger Criteria:
- Context: Current equipment status has been retrieved
- Applied to: Equipment Already Seized?
- Action: The system evaluates seizure status
Logic Flow:
IF Current equipment status has been retrieved
AND The system evaluates seizure status
THEN:
- • If equipment is not already seized, proceed with seizure,
otherwise generate already seized warning
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment is found in train and not already seized.
Trigger Criteria:
- Context: Equipment is found in train and not already seized
- Applied to: Set Equipment Seizure Flag
- Action: The system processes seizure request
Logic Flow:
IF Equipment is found in train and not already seized
AND The system processes seizure request
THEN:
- • The equipment seizure flag is set to indicate seized status
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment seizure flag has been set.
Trigger Criteria:
- Context: Equipment seizure flag has been set
- Applied to: Update Equipment Status in Train List
- Action: The system updates train records
Logic Flow:
IF Equipment seizure flag has been set
AND The system updates train records
THEN:
- • The equipment status in the train list is updated to reflect seized status
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment status has been updated in train list.
Trigger Criteria:
- Context: Equipment status has been updated in train list
- Applied to: Log Equipment Seizure Action
- Action: The system performs logging
Logic Flow:
IF Equipment status has been updated in train list
AND The system performs logging
THEN:
- • A log entry is created documenting the equipment seizure action with relevant details
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment seizure action has been logged.
Trigger Criteria:
- Context: Equipment seizure action has been logged
- Applied to: Generate Equipment Seizure Notification
- Action: The system generates notifications
Logic Flow:
IF Equipment seizure action has been logged
AND The system generates notifications
THEN:
- • Seizure notification messages are created and sent to appropriate recipients
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment seizure notification has been generated.
Trigger Criteria:
- Context: Equipment seizure notification has been generated
- Applied to: Update Train Equipment Counter
- Action: The system updates counters
Logic Flow:
IF Equipment seizure notification has been generated
AND The system updates counters
THEN:
- • Train equipment counters are updated to reflect the newly seized equipment
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when all seizure processing steps have been completed successfully.
Trigger Criteria:
- Context: All seizure processing steps have been completed successfully
- Applied to: Process Complete - Equipment Seized
- Action: The system finalizes processing
Logic Flow:
IF All seizure processing steps have been completed successfully
AND The system finalizes processing
THEN:
- • The equipment seizure process is marked as complete
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment id format validation has failed.
Trigger Criteria:
- Context: Equipment ID format validation has failed
- Applied to: Generate Error - Invalid Equipment ID
- Action: The system handles validation failure
Logic Flow:
IF Equipment ID format validation has failed
AND The system handles validation failure
THEN:
- • An error message is generated indicating invalid equipment ID format
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when equipment search in train consist has failed to locate the specified equipment.
Trigger Criteria:
- Context: Equipment search in train consist has failed to locate the specified equipment
- Applied to: Generate Error - Equipment Not Found
- Action: The system handles search failure
Logic Flow:
IF Equipment search in train consist has failed to locate the specified equipment
AND The system handles search failure
THEN:
- • An error message is generated indicating equipment not found in train
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when equipment is found but already has seized status.
Trigger Criteria:
- Context: Equipment is found but already has seized status
- Applied to: Generate Warning - Equipment Already Seized
- Action: The system detects duplicate seizure attempt
Logic Flow:
IF Equipment is found but already has seized status
AND The system detects duplicate seizure attempt
THEN:
- • A warning message is generated indicating equipment is already seized
R-GCX016E-cbl-01538 (+13) File: GCX016E.cbl Business Rule: Equipment Seizure Release Processing by VID Segment
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when vid segment is received with ser disposition code.
Trigger Criteria:
- Context: A VID segment is received with SER disposition code
- Applied to: Validate Equipment ID in VID Segment
- Action: The system processes the VID segment equipment ID field
Logic Flow:
IF A VID segment is received with SER disposition code
AND The system processes the VID segment equipment ID field
THEN:
- • The equipment ID must be validated for proper format and non-blank content
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid equipment id from vid segment.
Trigger Criteria:
- Context: A valid equipment ID from VID segment
- Applied to: Lookup Equipment in Train Consist
- Action: The system searches the train equipment consist
Logic Flow:
IF A valid equipment ID from VID segment
AND The system searches the train equipment consist
THEN:
- • The equipment must be found in the train's equipment list to proceed with seizure release
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid equipment id from vid segment.
Trigger Criteria:
- Context: A valid equipment ID from VID segment
- Applied to: Generate Error - Equipment Not Found
- Action: The equipment is not found in the train equipment consist
Logic Flow:
IF A valid equipment ID from VID segment
AND The equipment is not found in the train equipment consist
THEN:
- • An error must be generated indicating equipment not found in train
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment is found in the train consist.
Trigger Criteria:
- Context: Equipment is found in the train consist
- Applied to: Check Current Seizure Status
- Action: The system checks the equipment's current seizure status flags
Logic Flow:
IF Equipment is found in the train consist
AND The system checks the equipment's current seizure status flags
THEN:
- • The equipment must currently be in seized status to allow seizure release
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment is currently seized and seizure release is authorized.
Trigger Criteria:
- Context: Equipment is currently seized and seizure release is authorized
- Applied to: Remove Seizure Status from Equipment
- Action: The system processes the seizure release request
Logic Flow:
IF Equipment is currently seized and seizure release is authorized
AND The system processes the seizure release request
THEN:
- • The seizure status flag must be removed from the equipment record
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment seizure status has been removed.
Trigger Criteria:
- Context: Equipment seizure status has been removed
- Applied to: Update Equipment Status Flags
- Action: The system updates equipment status information
Logic Flow:
IF Equipment seizure status has been removed
AND The system updates equipment status information
THEN:
- • All equipment status flags must be updated to reflect the released from seizure state
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment seizure status has been successfully removed.
Trigger Criteria:
- Context: Equipment seizure status has been successfully removed
- Applied to: Decrement Train Seizure Counter
- Action: The system updates train-level seizure tracking
Logic Flow:
IF Equipment seizure status has been successfully removed
AND The system updates train-level seizure tracking
THEN:
- • The train seizure counter must be decremented by one
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train seizure counter has been decremented.
Trigger Criteria:
- Context: Train seizure counter has been decremented
- Applied to: All Equipment Released from Seizure?
- Action: The system evaluates the remaining seizure counter value
Logic Flow:
IF Train seizure counter has been decremented
AND The system evaluates the remaining seizure counter value
THEN:
- • If seizure counter equals zero,
then all equipment is released from seizure,
otherwise some equipment remains seized
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all equipment in the train has been released from seizure.
Trigger Criteria:
- Context: All equipment in the train has been released from seizure
- Applied to: Update Train Seizure Status Flag
- Action: The system updates train status information
Logic Flow:
IF All equipment in the train has been released from seizure
AND The system updates train status information
THEN:
- • The train seizure status flag must be cleared to indicate no equipment is seized
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment seizure release has been processed successfully.
Trigger Criteria:
- Context: Equipment seizure release has been processed successfully
- Applied to: Log Seizure Release Action
- Action: The system performs audit logging
Logic Flow:
IF Equipment seizure release has been processed successfully
AND The system performs audit logging
THEN:
- • A log entry must be created documenting the seizure release action with equipment details and timestamp
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment seizure release action has been logged.
Trigger Criteria:
- Context: Equipment seizure release action has been logged
- Applied to: Generate Equipment Release Notification
- Action: The system generates notifications
Logic Flow:
IF Equipment seizure release action has been logged
AND The system generates notifications
THEN:
- • A release notification must be created containing equipment identification and release details
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment status flags have been updated and notifications generated.
Trigger Criteria:
- Context: Equipment status flags have been updated and notifications generated
- Applied to: Update Equipment Status in Database
- Action: The system commits the changes
Logic Flow:
IF Equipment status flags have been updated and notifications generated
AND The system commits the changes
THEN:
- • The equipment status must be updated in the database to reflect the seizure release
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when vid segment with ser disposition is received.
Trigger Criteria:
- Context: A VID segment with SER disposition is received
- Applied to: Generate Error - Invalid Equipment ID
- Action: The equipment ID validation fails due to invalid format or blank content
Logic Flow:
IF A VID segment with SER disposition is received
AND The equipment ID validation fails due to invalid format or blank content
THEN:
- • An error must be generated indicating invalid equipment ID
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment is found in train consist but seizure release is requested.
Trigger Criteria:
- Context: Equipment is found in train consist but seizure release is requested
- Applied to: Generate Error - Equipment Not Seized
- Action: The equipment is not currently in seized status
Logic Flow:
IF Equipment is found in train consist but seizure release is requested
AND The equipment is not currently in seized status
THEN:
- • An error must be generated indicating equipment is not currently seized
R-GCX016E-cbl-01552 (+8) File: GCX016E.cbl Business Rule: Export Manifest Pre
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train arrival event (pod/aad disposition) is being processed.
Trigger Criteria:
- Context: A train arrival event (POD/AAD disposition) is being processed
- Applied to: Train ID ends with 'T'?
- Action: The system evaluates the train ID suffix
Logic Flow:
IF A train arrival event (POD/AAD disposition) is being processed
AND The system evaluates the train ID suffix
THEN:
- • If train ID ends with 'T', classify as export manifest train,
otherwise process as standard import train
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when export manifest train has been identified and arrival port has been extracted from p4 location segment.
Trigger Criteria:
- Context: An export manifest train has been identified and arrival port has been extracted from P4 location segment
- Applied to: Is Port Designated for Export Manifests?
- Action: The system checks the port against the export port validation table
Logic Flow:
IF An export manifest train has been identified and arrival port has been extracted from P4 location segment
AND The system checks the port against the export port validation table
THEN:
- • If port is designated for export manifests, proceed with export processing,
otherwise generate port validation error
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when export manifest train has been identified and port validation has been successful.
Trigger Criteria:
- Context: An export manifest train has been identified and port validation has been successful
- Applied to: Set Export Manifest Pre-Arrival Status
- Action: The system processes the export manifest pre-arrival
Logic Flow:
IF An export manifest train has been identified and port validation has been successful
AND The system processes the export manifest pre-arrival
THEN:
- • Set the train status to export manifest pre-arrival status
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when export manifest pre-arrival status has been set for a train.
Trigger Criteria:
- Context: Export manifest pre-arrival status has been set for a train
- Applied to: Update Train Status Flags
- Action: The system updates train status information
Logic Flow:
IF Export manifest pre-arrival status has been set for a train
AND The system updates train status information
THEN:
- • Update train status flags in train records to reflect export manifest pre-arrival state
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train status flags have been updated for export manifest pre-arrival.
Trigger Criteria:
- Context: Train status flags have been updated for export manifest pre-arrival
- Applied to: Log Export Manifest Pre-Arrival Action
- Action: The system completes export manifest processing
Logic Flow:
IF Train status flags have been updated for export manifest pre-arrival
AND The system completes export manifest processing
THEN:
- • Log the export manifest pre-arrival action with relevant train and port information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when export manifest pre-arrival action has been logged.
Trigger Criteria:
- Context: Export manifest pre-arrival action has been logged
- Applied to: Generate Pre-Arrival Notification
- Action: The system completes export processing workflow
Logic Flow:
IF Export manifest pre-arrival action has been logged
AND The system completes export processing workflow
THEN:
- • Generate pre-arrival notification message for the export manifest train
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when export manifest train has been identified but port validation has failed.
Trigger Criteria:
- Context: An export manifest train has been identified but port validation has failed
- Applied to: Generate Port Validation Error
- Action: The arrival port is not found in the export port validation table
Logic Flow:
IF An export manifest train has been identified but port validation has failed
AND The arrival port is not found in the export port validation table
THEN:
- • Generate port validation error message indicating the port is not authorized for export manifests
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when port validation error has been generated for an export manifest train.
Trigger Criteria:
- Context: A port validation error has been generated for an export manifest train
- Applied to: Route Error to Default Recipient
- Action: The system processes the error routing
Logic Flow:
IF A port validation error has been generated for an export manifest train
AND The system processes the error routing
THEN:
- • Route the port validation error message to the default error recipient for resolution
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train arrival event is being processed and train id does not end with 't'.
Trigger Criteria:
- Context: A train arrival event is being processed and train ID does not end with 'T'
- Applied to: Continue with Standard Import Processing
- Action: The system determines the train is not an export manifest train
Logic Flow:
IF A train arrival event is being processed and train ID does not end with 'T'
AND The system determines the train is not an export manifest train
THEN:
- • Continue processing the train using standard import manifest procedures
R-GCX016E-cbl-01561 (+8) File: GCX016E.cbl Business Rule: Import Manifest Arrival Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train arrival event (pod/aad) is being processed.
Trigger Criteria:
- Context: A train arrival event (POD/AAD) is being processed
- Applied to: Train ID has 'T' suffix?
- Action: The system checks the train ID for 'T' suffix
Logic Flow:
IF A train arrival event (POD/AAD) is being processed
AND The system checks the train ID for 'T' suffix
THEN:
- • If train ID does not have 'T' suffix, classify as import manifest for standard processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when import manifest train arrival is being processed and arrival date/time is extracted from v9 segment.
Trigger Criteria:
- Context: An import manifest train arrival is being processed and arrival date/time is extracted from V9 segment
- Applied to: Valid Arrival Date?
- Action: The system validates the arrival date format and content
Logic Flow:
IF An import manifest train arrival is being processed and arrival date/time is extracted from V9 segment
AND The system validates the arrival date format and content
THEN:
- • If arrival date is valid, use it for train arrival processing,
otherwise use system current date/time
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when import manifest train arrival is being processed and the v9 segment arrival date is invalid or missing.
Trigger Criteria:
- Context: An import manifest train arrival is being processed and the V9 segment arrival date is invalid or missing
- Applied to: Use System Current Date/Time
- Action: The system needs to set train arrival date/time
Logic Flow:
IF An import manifest train arrival is being processed and the V9 segment arrival date is invalid or missing
AND The system needs to set train arrival date/time
THEN:
- • Use system current date/time as the train arrival date/time
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when import manifest train has valid arrival date/time established.
Trigger Criteria:
- Context: An import manifest train has valid arrival date/time established
- Applied to: Set Train Arrival Status Flag
- Action: The system processes the train arrival
Logic Flow:
IF An import manifest train has valid arrival date/time established
AND The system processes the train arrival
THEN:
- • Set the train arrival status flag to indicate successful arrival processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train arrival status flag has been set for an import manifest train.
Trigger Criteria:
- Context: A train arrival status flag has been set for an import manifest train
- Applied to: Update Train Status in Database
- Action: The system updates train information
Logic Flow:
IF A train arrival status flag has been set for an import manifest train
AND The system updates train information
THEN:
- • Update the train status in GCWTL train list segments database with arrival information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when import manifest train status has been updated in the database.
Trigger Criteria:
- Context: An import manifest train status has been updated in the database
- Applied to: Process US Cargo Arrival Notifications
- Action: The system processes associated cargo arrivals
Logic Flow:
IF An import manifest train status has been updated in the database
AND The system processes associated cargo arrivals
THEN:
- • Process arrival notifications for all US cargos in GCSUSRT segments associated with the train
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when us cargo arrival notifications have been processed for an import manifest train.
Trigger Criteria:
- Context: US cargo arrival notifications have been processed for an import manifest train
- Applied to: Send AEI Messages for Train Arrival
- Action: The system generates external notifications
Logic Flow:
IF US cargo arrival notifications have been processed for an import manifest train
AND The system generates external notifications
THEN:
- • Send AEI messages to notify external systems of the train arrival event
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when aei messages have been sent for an import manifest train arrival.
Trigger Criteria:
- Context: AEI messages have been sent for an import manifest train arrival
- Applied to: Generate Train Arrival Merlin Messages
- Action: The system generates internal notifications
Logic Flow:
IF AEI messages have been sent for an import manifest train arrival
AND The system generates internal notifications
THEN:
- • Generate and send Merlin messages to notify internal stakeholders of the train arrival
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when merlin messages have been generated for an import manifest train arrival.
Trigger Criteria:
- Context: Merlin messages have been generated for an import manifest train arrival
- Applied to: Log Train Arrival Action
- Action: The system completes arrival processing
Logic Flow:
IF Merlin messages have been generated for an import manifest train arrival
AND The system completes arrival processing
THEN:
- • Log the train arrival action with relevant details for audit and tracking purposes
R-GCX016E-cbl-01570 (+17) File: GCX016E.cbl Business Rule: Train Equipment List Management
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when vid segment is received in the message.
Trigger Criteria:
- Context: A VID segment is received in the message
- Applied to: Extract Equipment ID from VID Segment
- Action: The VID segment contains equipment ID information
Logic Flow:
IF A VID segment is received in the message
AND The VID segment contains equipment ID information
THEN:
- • The system extracts the equipment ID for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when vid segment is received.
Trigger Criteria:
- Context: A VID segment is received
- Applied to: Equipment ID Present?
- Action: The system checks for equipment ID presence
Logic Flow:
IF A VID segment is received
AND The system checks for equipment ID presence
THEN:
- • Processing continues if equipment ID is present,
otherwise equipment processing is skipped
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment id has been extracted from vid segment.
Trigger Criteria:
- Context: An equipment ID has been extracted from VID segment
- Applied to: Locate Equipment in Train Consist
- Action: The system searches the train consist for the equipment
Logic Flow:
IF An equipment ID has been extracted from VID segment
AND The system searches the train consist for the equipment
THEN:
- • The system determines whether the equipment is found in the train list
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has been searched in the train consist.
Trigger Criteria:
- Context: Equipment has been searched in the train consist
- Applied to: Equipment Found in Train?
- Action: The system evaluates the search results
Logic Flow:
IF Equipment has been searched in the train consist
AND The system evaluates the search results
THEN:
- • If equipment is not found, it is added to the train list; if found, disposition processing continues
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment is not found in the current train consist.
Trigger Criteria:
- Context: Equipment is not found in the current train consist
- Applied to: Add Equipment to Train List
- Action: The system processes the equipment for the first time
Logic Flow:
IF Equipment is not found in the current train consist
AND The system processes the equipment for the first time
THEN:
- • The equipment is added to the train equipment list for future reference
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment exists or has been added to the train list.
Trigger Criteria:
- Context: Equipment exists or has been added to the train list
- Applied to: Disposition Code Type?
- Action: The system evaluates the disposition code type
Logic Flow:
IF Equipment exists or has been added to the train list
AND The system evaluates the disposition code type
THEN:
- • The system routes to appropriate status update based on code type: HRE for hold release, SEI for seizure, SER for seizure release, or other hold types
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when hold-related disposition code is being processed for equipment.
Trigger Criteria:
- Context: A hold-related disposition code is being processed for equipment
- Applied to: Update Equipment Hold Status Flag
- Action: The disposition code is not HRE, SEI, or SER
Logic Flow:
IF A hold-related disposition code is being processed for equipment
AND The disposition code is not HRE, SEI, or SER
THEN:
- • The system sets the equipment hold status flag to indicate the equipment is held
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when hre hold release disposition code is being processed for equipment.
Trigger Criteria:
- Context: An HRE hold release disposition code is being processed for equipment
- Applied to: Update Equipment Release Status Flag
- Action: The system processes the hold release action
Logic Flow:
IF An HRE hold release disposition code is being processed for equipment
AND The system processes the hold release action
THEN:
- • The system sets the equipment release status flag to indicate the equipment hold is released
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when sei seizure disposition code is being processed for equipment.
Trigger Criteria:
- Context: An SEI seizure disposition code is being processed for equipment
- Applied to: Update Equipment Seizure Status Flag
- Action: The system processes the seizure action
Logic Flow:
IF An SEI seizure disposition code is being processed for equipment
AND The system processes the seizure action
THEN:
- • The system sets the equipment seizure status flag to indicate the equipment is seized
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when ser seizure release disposition code is being processed for equipment.
Trigger Criteria:
- Context: An SER seizure release disposition code is being processed for equipment
- Applied to: Update Equipment Seizure Release Status Flag
- Action: The system processes the seizure release action
Logic Flow:
IF An SER seizure release disposition code is being processed for equipment
AND The system processes the seizure release action
THEN:
- • The system sets the equipment seizure release status flag to indicate the equipment seizure is released
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment hold status flag has been updated.
Trigger Criteria:
- Context: Equipment hold status flag has been updated
- Applied to: Update Equipment Hold Counter
- Action: The system processes the hold action
Logic Flow:
IF Equipment hold status flag has been updated
AND The system processes the hold action
THEN:
- • The system increments the equipment hold counter to track the number of holds applied
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment release status flag has been updated.
Trigger Criteria:
- Context: Equipment release status flag has been updated
- Applied to: Update Equipment Release Counter
- Action: The system processes the release action
Logic Flow:
IF Equipment release status flag has been updated
AND The system processes the release action
THEN:
- • The system increments the equipment release counter to track the number of releases applied
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment seizure status flag has been updated.
Trigger Criteria:
- Context: Equipment seizure status flag has been updated
- Applied to: Update Equipment Seizure Counter
- Action: The system processes the seizure action
Logic Flow:
IF Equipment seizure status flag has been updated
AND The system processes the seizure action
THEN:
- • The system increments the equipment seizure counter to track the number of seizures applied
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment seizure release status flag has been updated.
Trigger Criteria:
- Context: Equipment seizure release status flag has been updated
- Applied to: Update Equipment Seizure Release Counter
- Action: The system processes the seizure release action
Logic Flow:
IF Equipment seizure release status flag has been updated
AND The system processes the seizure release action
THEN:
- • The system increments the equipment seizure release counter to track the number of seizure releases applied
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment status flags and counters have been updated.
Trigger Criteria:
- Context: Equipment status flags and counters have been updated
- Applied to: Update Train Equipment List
- Action: The system completes status processing for the equipment
Logic Flow:
IF Equipment status flags and counters have been updated
AND The system completes status processing for the equipment
THEN:
- • The system updates the train equipment list with the current equipment status and counter values
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train equipment list has been updated with new status information.
Trigger Criteria:
- Context: Train equipment list has been updated with new status information
- Applied to: Log Equipment Status Change
- Action: The system completes equipment status processing
Logic Flow:
IF Train equipment list has been updated with new status information
AND The system completes equipment status processing
THEN:
- • The system logs the equipment status change for audit trail and tracking purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when current equipment status change has been logged.
Trigger Criteria:
- Context: Current equipment status change has been logged
- Applied to: Continue to Next Equipment
- Action: There are additional equipment items to process in the VID segment
Logic Flow:
IF Current equipment status change has been logged
AND There are additional equipment items to process in the VID segment
THEN:
- • The system continues to process the next equipment item in the list
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all equipment items have been processed or no equipment id was present in vid segment.
Trigger Criteria:
- Context: All equipment items have been processed or no equipment ID was present in VID segment
- Applied to: Equipment Processing Complete
- Action: The system reaches the end of equipment processing
Logic Flow:
IF All equipment items have been processed or no equipment ID was present in VID segment
AND The system reaches the end of equipment processing
THEN:
- • The system marks equipment processing as complete and continues with next segment processing
R-GCX016E-cbl-01588 (+9) File: GCX016E.cbl Business Rule: Train Status Flag Management
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when v9 segment with disposition code hmi is being processed for a train.
Trigger Criteria:
- Context: A V9 segment with disposition code HMI is being processed for a train
- Applied to: Process HMI - Hold Train
- Action: The HMI hold event is processed
Logic Flow:
IF A V9 segment with disposition code HMI is being processed for a train
AND The HMI hold event is processed
THEN:
- • The train held flag is set to 'Y' and the hold action is logged
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when v9 segment with disposition code hre is being processed for a train.
Trigger Criteria:
- Context: A V9 segment with disposition code HRE is being processed for a train
- Applied to: Process HRE - Release Hold
- Action: The HRE hold release event is processed
Logic Flow:
IF A V9 segment with disposition code HRE is being processed for a train
AND The HRE hold release event is processed
THEN:
- • The train held flag is set to 'N' and the release action is logged
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when v9 segment with disposition code sei is being processed for a train.
Trigger Criteria:
- Context: A V9 segment with disposition code SEI is being processed for a train
- Applied to: Process SEI - Seize Train
- Action: The SEI seizure event is processed
Logic Flow:
IF A V9 segment with disposition code SEI is being processed for a train
AND The SEI seizure event is processed
THEN:
- • The train seized flag is set to 'Y' and the seizure action is logged
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when v9 segment with disposition code ser is being processed for a train.
Trigger Criteria:
- Context: A V9 segment with disposition code SER is being processed for a train
- Applied to: Process SER - Release Seizure
- Action: The SER seizure release event is processed
Logic Flow:
IF A V9 segment with disposition code SER is being processed for a train
AND The SER seizure release event is processed
THEN:
- • The train seized flag is set to 'N' and the release action is logged
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when v9 segment with disposition code lck is being processed for a train.
Trigger Criteria:
- Context: A V9 segment with disposition code LCK is being processed for a train
- Applied to: Process LCK - Lock Train
- Action: The LCK lock event is processed
Logic Flow:
IF A V9 segment with disposition code LCK is being processed for a train
AND The LCK lock event is processed
THEN:
- • The train locked flag is set to 'Y'
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when v9 segment with disposition code ulc is being processed for a train.
Trigger Criteria:
- Context: A V9 segment with disposition code ULC is being processed for a train
- Applied to: Process ULC - Unlock Train
- Action: The ULC unlock event is processed and the train is currently locked
Logic Flow:
IF A V9 segment with disposition code ULC is being processed for a train
AND The ULC unlock event is processed and the train is currently locked
THEN:
- • The train locked flag is set to 'N'
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when v9 segment with disposition code pod or aad is being processed for a train.
Trigger Criteria:
- Context: A V9 segment with disposition code POD or AAD is being processed for a train
- Applied to: Process POD/AAD - Train Arrival
- Action: The arrival event is processed
Logic Flow:
IF A V9 segment with disposition code POD or AAD is being processed for a train
AND The arrival event is processed
THEN:
- • The train arrival flag is set to 'Y' and the train arrival date is recorded
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when v9 segment with disposition code coc is being processed for a train.
Trigger Criteria:
- Context: A V9 segment with disposition code COC is being processed for a train
- Applied to: Process COC - Cancel Arrival
- Action: The COC cancellation event is processed
Logic Flow:
IF A V9 segment with disposition code COC is being processed for a train
AND The COC cancellation event is processed
THEN:
- • The train arrival flag is set to 'N' and the train arrival date is cleared
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train status event requires vid equipment processing for hold or seizure actions.
Trigger Criteria:
- Context: A train status event requires VID equipment processing for hold or seizure actions
- Applied to: Update Individual Equipment Hold Status
- Action: Individual equipment processing is performed
Logic Flow:
IF A train status event requires VID equipment processing for hold or seizure actions
AND Individual equipment processing is performed
THEN:
- • Equipment hold status is updated, equipment seizure status is updated, and equipment hold/seizure counters are incremented or decremented accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train status flag has been modified due to a v9 disposition code event.
Trigger Criteria:
- Context: A train status flag has been modified due to a V9 disposition code event
- Applied to: Update Train Status in Database
- Action: The status processing is complete
Logic Flow:
IF A train status flag has been modified due to a V9 disposition code event
AND The status processing is complete
THEN:
- • The train status is updated in the database and the status change is logged
R-GCX016E-cbl-01598 (+22) File: GCX016E.cbl Business Rule: Equipment Status Tracking within Trains
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when vid segment has been received for processing.
Trigger Criteria:
- Context: A VID segment has been received for processing
- Applied to: Extract Equipment ID from VID Segment
- Action: The system processes the VID segment to extract equipment identification
Logic Flow:
IF A VID segment has been received for processing
AND The system processes the VID segment to extract equipment identification
THEN:
- • The equipment ID is extracted from the VID segment data structure
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment id has been extracted from a vid segment.
Trigger Criteria:
- Context: An equipment ID has been extracted from a VID segment
- Applied to: Equipment ID Valid?
- Action: The system validates the equipment ID format and content
Logic Flow:
IF An equipment ID has been extracted from a VID segment
AND The system validates the equipment ID format and content
THEN:
- • The equipment ID is accepted if valid or rejected if invalid with appropriate error handling
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid equipment id has been extracted from a vid segment.
Trigger Criteria:
- Context: A valid equipment ID has been extracted from a VID segment
- Applied to: Locate Equipment in Train Consist
- Action: The system searches for the equipment in the current train consist
Logic Flow:
IF A valid equipment ID has been extracted from a VID segment
AND The system searches for the equipment in the current train consist
THEN:
- • The equipment location is identified within the train consist data structure
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when system has searched for equipment in the train consist.
Trigger Criteria:
- Context: The system has searched for equipment in the train consist
- Applied to: Equipment Found in Train?
- Action: The search results are evaluated
Logic Flow:
IF The system has searched for equipment in the train consist
AND The search results are evaluated
THEN:
- • The system confirms equipment exists in train or generates equipment not found condition
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has been found in the train consist.
Trigger Criteria:
- Context: Equipment has been found in the train consist
- Applied to: Determine VID Disposition Code
- Action: The system analyzes the VID segment for disposition code information
Logic Flow:
IF Equipment has been found in the train consist
AND The system analyzes the VID segment for disposition code information
THEN:
- • The specific disposition code (HMI, HRE, SEI, SER) is determined for equipment status processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when vid disposition code has been determined.
Trigger Criteria:
- Context: A VID disposition code has been determined
- Applied to: Disposition Code Type?
- Action: The system evaluates the disposition code type
Logic Flow:
IF A VID disposition code has been determined
AND The system evaluates the disposition code type
THEN:
- • The code is classified as HMI Hold, HRE Release, SEI Seizure, or SER Seizure Release for appropriate processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when vid segment contains hmi disposition code for valid equipment in train.
Trigger Criteria:
- Context: A VID segment contains HMI disposition code for valid equipment in train
- Applied to: Process Equipment Hold - HMI
- Action: The system processes the equipment hold request
Logic Flow:
IF A VID segment contains HMI disposition code for valid equipment in train
AND The system processes the equipment hold request
THEN:
- • Equipment hold processing is initiated for the specified equipment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when vid segment contains hre disposition code for valid equipment in train.
Trigger Criteria:
- Context: A VID segment contains HRE disposition code for valid equipment in train
- Applied to: Process Equipment Release - HRE
- Action: The system processes the equipment release request
Logic Flow:
IF A VID segment contains HRE disposition code for valid equipment in train
AND The system processes the equipment release request
THEN:
- • Equipment release processing is initiated for the specified equipment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when vid segment contains sei disposition code for valid equipment in train.
Trigger Criteria:
- Context: A VID segment contains SEI disposition code for valid equipment in train
- Applied to: Process Equipment Seizure - SEI
- Action: The system processes the equipment seizure request
Logic Flow:
IF A VID segment contains SEI disposition code for valid equipment in train
AND The system processes the equipment seizure request
THEN:
- • Equipment seizure processing is initiated for the specified equipment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when vid segment contains ser disposition code for valid equipment in train.
Trigger Criteria:
- Context: A VID segment contains SER disposition code for valid equipment in train
- Applied to: Process Equipment Seizure Release - SER
- Action: The system processes the equipment seizure release request
Logic Flow:
IF A VID segment contains SER disposition code for valid equipment in train
AND The system processes the equipment seizure release request
THEN:
- • Equipment seizure release processing is initiated for the specified equipment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when equipment hold processing has been initiated for specific equipment.
Trigger Criteria:
- Context: Equipment hold processing has been initiated for specific equipment
- Applied to: Update Equipment Hold Status Flag
- Action: The system updates equipment status information
Logic Flow:
IF Equipment hold processing has been initiated for specific equipment
AND The system updates equipment status information
THEN:
- • The equipment hold status flag is set to indicate hold condition
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment release processing has been initiated for specific equipment.
Trigger Criteria:
- Context: Equipment release processing has been initiated for specific equipment
- Applied to: Update Equipment Release Status Flag
- Action: The system updates equipment status information
Logic Flow:
IF Equipment release processing has been initiated for specific equipment
AND The system updates equipment status information
THEN:
- • The equipment release status flag is set to indicate release condition
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment seizure processing has been initiated for specific equipment.
Trigger Criteria:
- Context: Equipment seizure processing has been initiated for specific equipment
- Applied to: Update Equipment Seizure Status Flag
- Action: The system updates equipment status information
Logic Flow:
IF Equipment seizure processing has been initiated for specific equipment
AND The system updates equipment status information
THEN:
- • The equipment seizure status flag is set to indicate seizure condition
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment seizure release processing has been initiated for specific equipment.
Trigger Criteria:
- Context: Equipment seizure release processing has been initiated for specific equipment
- Applied to: Update Equipment Seizure Release Status Flag
- Action: The system updates equipment status information
Logic Flow:
IF Equipment seizure release processing has been initiated for specific equipment
AND The system updates equipment status information
THEN:
- • The equipment seizure release status flag is set to indicate release from seizure condition
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment hold status flag has been updated for specific equipment.
Trigger Criteria:
- Context: Equipment hold status flag has been updated for specific equipment
- Applied to: Update Equipment Hold Counter
- Action: The system updates equipment tracking counters
Logic Flow:
IF Equipment hold status flag has been updated for specific equipment
AND The system updates equipment tracking counters
THEN:
- • The equipment hold counter is incremented to reflect the additional hold action
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment release status flag has been updated for specific equipment.
Trigger Criteria:
- Context: Equipment release status flag has been updated for specific equipment
- Applied to: Update Equipment Release Counter
- Action: The system updates equipment tracking counters
Logic Flow:
IF Equipment release status flag has been updated for specific equipment
AND The system updates equipment tracking counters
THEN:
- • The equipment release counter is incremented to reflect the additional release action
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment seizure status flag has been updated for specific equipment.
Trigger Criteria:
- Context: Equipment seizure status flag has been updated for specific equipment
- Applied to: Update Equipment Seizure Counter
- Action: The system updates equipment tracking counters
Logic Flow:
IF Equipment seizure status flag has been updated for specific equipment
AND The system updates equipment tracking counters
THEN:
- • The equipment seizure counter is incremented to reflect the additional seizure action
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when equipment seizure release status flag has been updated for specific equipment.
Trigger Criteria:
- Context: Equipment seizure release status flag has been updated for specific equipment
- Applied to: Update Equipment Seizure Release Counter
- Action: The system updates equipment tracking counters
Logic Flow:
IF Equipment seizure release status flag has been updated for specific equipment
AND The system updates equipment tracking counters
THEN:
- • The equipment seizure release counter is incremented to reflect the additional seizure release action
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment status counters have been updated for specific equipment.
Trigger Criteria:
- Context: Equipment status counters have been updated for specific equipment
- Applied to: Update Train Equipment List
- Action: The system updates the train equipment list
Logic Flow:
IF Equipment status counters have been updated for specific equipment
AND The system updates the train equipment list
THEN:
- • The train equipment list reflects the current status information for the processed equipment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train equipment list has been updated with current equipment status.
Trigger Criteria:
- Context: Train equipment list has been updated with current equipment status
- Applied to: Log Equipment Status Change
- Action: The system creates audit trail documentation
Logic Flow:
IF Train equipment list has been updated with current equipment status
AND The system creates audit trail documentation
THEN:
- • Equipment status change is logged with timestamp, equipment ID, and status change details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment status change has been logged in the system.
Trigger Criteria:
- Context: Equipment status change has been logged in the system
- Applied to: Generate Equipment Status Notification
- Action: The system generates status notifications
Logic Flow:
IF Equipment status change has been logged in the system
AND The system generates status notifications
THEN:
- • Equipment status notification is created and sent to appropriate recipients
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when equipment search in train consist has been completed.
Trigger Criteria:
- Context: Equipment search in train consist has been completed
- Applied to: Generate Equipment Not Found Error
- Action: The specified equipment is not found in the train consist
Logic Flow:
IF Equipment search in train consist has been completed
AND The specified equipment is not found in the train consist
THEN:
- • Equipment not found error is generated with appropriate error details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment id has been extracted from vid segment.
Trigger Criteria:
- Context: Equipment ID has been extracted from VID segment
- Applied to: Generate Invalid Equipment ID Error
- Action: The equipment ID fails validation requirements
Logic Flow:
IF Equipment ID has been extracted from VID segment
AND The equipment ID fails validation requirements
THEN:
- • Invalid equipment ID error is generated with appropriate error details
R-GCX016E-cbl-01621 (+12) File: GCX016E.cbl Business Rule: Train Arrival Date Management
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when v9 segment is received with event code data.
Trigger Criteria:
- Context: A V9 segment is received with event code data
- Applied to: Disposition Code?
- Action: The system evaluates the disposition code in the V9 segment
Logic Flow:
IF A V9 segment is received with event code data
AND The system evaluates the disposition code in the V9 segment
THEN:
- • The system identifies POD (Proof of Delivery) or AAD (Actual Arrival Date) events and routes to appropriate arrival processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when v9 segment contains pod or aad event code.
Trigger Criteria:
- Context: A V9 segment contains POD or AAD event code
- Applied to: Extract Date from V9 Segment
- Action: The system processes the V9 segment for date information
Logic Flow:
IF A V9 segment contains POD or AAD event code
AND The system processes the V9 segment for date information
THEN:
- • The system extracts the date value from the V9 segment for validation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when date has been extracted from the v9 segment.
Trigger Criteria:
- Context: A date has been extracted from the V9 segment
- Applied to: Date Valid?
- Action: The system validates the date format and value
Logic Flow:
IF A date has been extracted from the V9 segment
AND The system validates the date format and value
THEN:
- • The system determines if the date is valid for business processing or requires default system date
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when v9 segment date has been validated as correct.
Trigger Criteria:
- Context: The V9 segment date has been validated as correct
- Applied to: Use V9 Segment Date
- Action: The system processes the train arrival date assignment
Logic Flow:
IF The V9 segment date has been validated as correct
AND The system processes the train arrival date assignment
THEN:
- • The system assigns the V9 segment date as the official train arrival date
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when v9 segment date is invalid, missing, or fails validation.
Trigger Criteria:
- Context: The V9 segment date is invalid, missing, or fails validation
- Applied to: Default to System Date
- Action: The system requires a train arrival date for processing
Logic Flow:
IF The V9 segment date is invalid, missing, or fails validation
AND The system requires a train arrival date for processing
THEN:
- • The system assigns the current system date as the default train arrival date
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train arrival date has been determined (either from v9 segment or system default).
Trigger Criteria:
- Context: A train arrival date has been determined (either from V9 segment or system default)
- Applied to: Format Date for Processing
- Action: The system prepares the date for train record processing
Logic Flow:
IF A train arrival date has been determined (either from V9 segment or system default)
AND The system prepares the date for train record processing
THEN:
- • The system formats the date into the standard format required for train arrival processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train arrival is being processed with a formatted arrival date.
Trigger Criteria:
- Context: A train arrival is being processed with a formatted arrival date
- Applied to: Train Type?
- Action: The system evaluates the train type based on manifest characteristics
Logic Flow:
IF A train arrival is being processed with a formatted arrival date
AND The system evaluates the train type based on manifest characteristics
THEN:
- • The system classifies the train as either export manifest train (with 'T' suffix) or import manifest train for specialized processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train is classified as an export manifest train with 't' suffix.
Trigger Criteria:
- Context: A train is classified as an export manifest train with 'T' suffix
- Applied to: Validate Export Port Authorization
- Action: The system processes the export train arrival
Logic Flow:
IF A train is classified as an export manifest train with 'T' suffix
AND The system processes the export train arrival
THEN:
- • The system validates that the export port is authorized for the train's export operations before proceeding with arrival processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train arrival date has been validated and formatted, and train type processing is complete.
Trigger Criteria:
- Context: A train arrival date has been validated and formatted, and train type processing is complete
- Applied to: Set Train Arrival Date
- Action: The system updates the train record
Logic Flow:
IF A train arrival date has been validated and formatted, and train type processing is complete
AND The system updates the train record
THEN:
- • The system assigns the arrival date to the train record for all subsequent processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train arrival date has been successfully set in the train record.
Trigger Criteria:
- Context: The train arrival date has been successfully set in the train record
- Applied to: Update Train Status to Arrived
- Action: The system updates the train operational status
Logic Flow:
IF The train arrival date has been successfully set in the train record
AND The system updates the train operational status
THEN:
- • The system changes the train status to 'Arrived' to reflect the current operational state
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train status has been updated to arrived with the assigned arrival date.
Trigger Criteria:
- Context: The train status has been updated to arrived with the assigned arrival date
- Applied to: Log Arrival Date Assignment
- Action: The system performs audit logging for the arrival event
Logic Flow:
IF The train status has been updated to arrived with the assigned arrival date
AND The system performs audit logging for the arrival event
THEN:
- • The system creates a log entry documenting the arrival date assignment, source of date (V9 segment or system default), and timestamp of the assignment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train arrival has been logged and all arrival processing is complete.
Trigger Criteria:
- Context: The train arrival has been logged and all arrival processing is complete
- Applied to: Generate AEI Notification
- Action: The system generates external notifications for the arrival event
Logic Flow:
IF The train arrival has been logged and all arrival processing is complete
AND The system generates external notifications for the arrival event
THEN:
- • The system creates an AEI notification containing train identification, arrival date, and location information for external systems
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when aei notification has been generated for the train arrival.
Trigger Criteria:
- Context: The AEI notification has been generated for the train arrival
- Applied to: Send Arrival Confirmation
- Action: The system sends confirmation messages to business stakeholders
Logic Flow:
IF The AEI notification has been generated for the train arrival
AND The system sends confirmation messages to business stakeholders
THEN:
- • The system transmits arrival confirmation containing train details, arrival date, and status to all configured recipients and external systems
R-GCX016E-cbl-01634 (+13) File: GCX016E.cbl Business Rule: US Cargo Arrival Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train arrival event (pod/aad disposition) has been received.
Trigger Criteria:
- Context: A train arrival event (POD/AAD disposition) has been received
- Applied to: Train Type Check
- Action: The system checks the train manifest type suffix
Logic Flow:
IF A train arrival event (POD/AAD disposition) has been received
AND The system checks the train manifest type suffix
THEN:
- • If the manifest has 'T' suffix, classify as export manifest train,
otherwise classify as import manifest train
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when export manifest train with 't' suffix is being processed for arrival.
Trigger Criteria:
- Context: An export manifest train with 'T' suffix is being processed for arrival
- Applied to: Port Valid for Export?
- Action: The system validates the arrival port against authorized export ports
Logic Flow:
IF An export manifest train with 'T' suffix is being processed for arrival
AND The system validates the arrival port against authorized export ports
THEN:
- • If the port is valid for export operations, continue with arrival processing,
otherwise terminate processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train has been validated for arrival processing.
Trigger Criteria:
- Context: A train has been validated for arrival processing
- Applied to: Set Train Arrival Status
- Action: The system processes the arrival event
Logic Flow:
IF A train has been validated for arrival processing
AND The system processes the arrival event
THEN:
- • Set the train arrival status flag to indicate the train has arrived
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train arrival status has been set.
Trigger Criteria:
- Context: A train arrival status has been set
- Applied to: Update Train Arrival Date from V9 Segment
- Action: The system processes the V9 segment containing arrival date and time
Logic Flow:
IF A train arrival status has been set
AND The system processes the V9 segment containing arrival date and time
THEN:
- • Update the train arrival date with the date and time from the V9 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train arrival date has been updated.
Trigger Criteria:
- Context: A train arrival date has been updated
- Applied to: US Cargo Found?
- Action: The system searches for US cargo in the train manifest
Logic Flow:
IF A train arrival date has been updated
AND The system searches for US cargo in the train manifest
THEN:
- • If US cargo is found in the train, proceed with cargo arrival processing,
otherwise complete train processing without cargo updates
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when us cargo has been found in an arriving train.
Trigger Criteria:
- Context: US cargo has been found in an arriving train
- Applied to: Set Cargo Arrival Flag
- Action: The system processes each cargo shipment
Logic Flow:
IF US cargo has been found in an arriving train
AND The system processes each cargo shipment
THEN:
- • Set the arrival flag for each cargo to indicate it has arrived at destination
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo arrival flag has been set.
Trigger Criteria:
- Context: Cargo arrival flag has been set
- Applied to: Calculate Cargo Age
- Action: The system calculates cargo transit time
Logic Flow:
IF Cargo arrival flag has been set
AND The system calculates cargo transit time
THEN:
- • Calculate the age of cargo based on the difference between current date and original shipment date
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo age has been calculated.
Trigger Criteria:
- Context: Cargo age has been calculated
- Applied to: Clear Bond Start Dates
- Action: The system processes bond information for arrived cargo
Logic Flow:
IF Cargo age has been calculated
AND The system processes bond information for arrived cargo
THEN:
- • Clear the bond start dates to reset the bonding period for the arrived cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when bond start dates have been cleared for cargo.
Trigger Criteria:
- Context: Bond start dates have been cleared for cargo
- Applied to: Set Arrival Index
- Action: The system assigns tracking references
Logic Flow:
IF Bond start dates have been cleared for cargo
AND The system assigns tracking references
THEN:
- • Set the arrival index for the cargo to enable proper tracking and reference
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when arrival index has been set for cargo.
Trigger Criteria:
- Context: Arrival index has been set for cargo
- Applied to: Generate AEI Message
- Action: The system generates arrival notifications
Logic Flow:
IF Arrival index has been set for cargo
AND The system generates arrival notifications
THEN:
- • Create an AEI message containing train and cargo arrival information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when aei message has been generated.
Trigger Criteria:
- Context: AEI message has been generated
- Applied to: Send AEI Notification
- Action: The system sends arrival notifications
Logic Flow:
IF AEI message has been generated
AND The system sends arrival notifications
THEN:
- • Transmit the AEI notification to configured recipients and external systems
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when aei notification has been sent.
Trigger Criteria:
- Context: AEI notification has been sent
- Applied to: Create Arrival Notification Message
- Action: The system creates business notifications
Logic Flow:
IF AEI notification has been sent
AND The system creates business notifications
THEN:
- • Create a detailed arrival notification message containing train and cargo details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when arrival notification message has been created.
Trigger Criteria:
- Context: Arrival notification message has been created
- Applied to: Log Train Arrival Action
- Action: The system logs the arrival event
Logic Flow:
IF Arrival notification message has been created
AND The system logs the arrival event
THEN:
- • Record the train arrival action in system logs with timestamp and details
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train arrival action has been logged.
Trigger Criteria:
- Context: Train arrival action has been logged
- Applied to: Update Equipment Status in Train
- Action: The system updates equipment records
Logic Flow:
IF Train arrival action has been logged
AND The system updates equipment records
THEN:
- • Update the status of all equipment in the train to reflect arrival at destination
R-GCX016E-cbl-01648 (+9) File: GCX016E.cbl Business Rule: K1 Remark Message Processing for Trains
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when message segment is being processed.
Trigger Criteria:
- Context: A message segment is being processed
- Applied to: K1 Segment Detected in Message Stream
- Action: The segment type is 'K1' and train context is being evaluated
Logic Flow:
IF A message segment is being processed
AND The segment type is 'K1' and train context is being evaluated
THEN:
- • The system should identify the K1 segment and check if train processing context is active
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when k1 segment is detected and train context is active.
Trigger Criteria:
- Context: A K1 segment is detected and train context is active
- Applied to: Extract Free-Form Text from K1 Segment
- Action: The system processes the K1 segment content
Logic Flow:
IF A K1 segment is detected and train context is active
AND The system processes the K1 segment content
THEN:
- • The free-form text should be extracted from the K1 segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when free-form text has been extracted from k1 segment.
Trigger Criteria:
- Context: Free-form text has been extracted from K1 segment
- Applied to: Associate Text with Current Train ID
- Action: The system processes train identification
Logic Flow:
IF Free-form text has been extracted from K1 segment
AND The system processes train identification
THEN:
- • The K1 text should be associated with the current train ID
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when k1 text is associated with current train id.
Trigger Criteria:
- Context: K1 text is associated with current train ID
- Applied to: Link Text to Train Disposition Code
- Action: The system processes disposition code context
Logic Flow:
IF K1 text is associated with current train ID
AND The system processes disposition code context
THEN:
- • The K1 text should be linked to the train disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when k1 text is linked to train disposition code.
Trigger Criteria:
- Context: K1 text is linked to train disposition code
- Applied to: Special Bond Creation Message?
- Action: The system checks for Canadian Pacific Railway identifiers including 'DIRECTOR OF CUSTOMS, CP RAIL', 'CANADIAN PACIFIC LIMITED', or 'CANADIAN PACIFIC RAILWAY CO'
Logic Flow:
IF K1 text is linked to train disposition code
AND The system checks for Canadian Pacific Railway identifiers including 'DIRECTOR OF CUSTOMS, CP RAIL', 'CANADIAN PACIFIC LIMITED', or 'CANADIAN PACIFIC RAILWAY CO'
THEN:
- • The system should identify if this is a special CPR bond creation message
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when canadian pacific railway bond creation message is detected.
Trigger Criteria:
- Context: A Canadian Pacific Railway bond creation message is detected
- Applied to: Process Canadian Pacific Railway Bond Creation
- Action: The system processes the CPR-specific bond creation
Logic Flow:
IF A Canadian Pacific Railway bond creation message is detected
AND The system processes the CPR-specific bond creation
THEN:
- • The system should execute Canadian Pacific Railway bond creation processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when k1 text processing is complete (either regular or cpr bond processing).
Trigger Criteria:
- Context: K1 text processing is complete (either regular or CPR bond processing)
- Applied to: Store K1 Text in Train Processing Context
- Action: The system stores the K1 text information
Logic Flow:
IF K1 text processing is complete (either regular or CPR bond processing)
AND The system stores the K1 text information
THEN:
- • The K1 text should be stored in the train processing context
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when k1 text is stored in train processing context.
Trigger Criteria:
- Context: K1 text is stored in train processing context
- Applied to: Log K1 Remark for Train
- Action: The system performs logging operations
Logic Flow:
IF K1 text is stored in train processing context
AND The system performs logging operations
THEN:
- • The K1 remark should be logged for the train
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when k1 remark is logged for the train.
Trigger Criteria:
- Context: K1 remark is logged for the train
- Applied to: Include K1 Text in Train Merlin Messages
- Action: The system generates Merlin messages for the train
Logic Flow:
IF K1 remark is logged for the train
AND The system generates Merlin messages for the train
THEN:
- • The K1 text should be included in the train Merlin messages
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when k1 processing is complete (either with train context or without).
Trigger Criteria:
- Context: K1 processing is complete (either with train context or without)
- Applied to: Continue to Next Message Segment
- Action: The system finishes K1 segment processing
Logic Flow:
IF K1 processing is complete (either with train context or without)
AND The system finishes K1 segment processing
THEN:
- • The system should continue to process the next message segment
R-GCX016E-cbl-01658 (+10) File: GCX016E.cbl Business Rule: K1 Remark Message Processing for Cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when message segment is being processed.
Trigger Criteria:
- Context: A message segment is being processed
- Applied to: K1 Segment Detected in Message
- Action: The segment type is identified as 'K1'
Logic Flow:
IF A message segment is being processed
AND The segment type is identified as 'K1'
THEN:
- • The system should invoke B400-PROCESS-K1-SEGMENT routine
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when k1 segment is being processed.
Trigger Criteria:
- Context: A K1 segment is being processed
- Applied to: Extract Free-Form Text Message
- Action: The segment contains free-form text data
Logic Flow:
IF A K1 segment is being processed
AND The segment contains free-form text data
THEN:
- • The system should extract and store the text message content
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when k1 comment has been extracted from the segment.
Trigger Criteria:
- Context: A K1 comment has been extracted from the segment
- Applied to: Associated with Cargo?
- Action: The system evaluates the processing context
Logic Flow:
IF A K1 comment has been extracted from the segment
AND The system evaluates the processing context
THEN:
- • The system should determine if the comment is cargo-related and route accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when k1 comment is determined to be cargo-associated.
Trigger Criteria:
- Context: A K1 comment is determined to be cargo-associated
- Applied to: Store K1 Text in Cargo Context
- Action: The comment text needs to be preserved
Logic Flow:
IF A K1 comment is determined to be cargo-associated
AND The comment text needs to be preserved
THEN:
- • The system should store the K1 text in the cargo processing context
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when k1 comment is stored in cargo context.
Trigger Criteria:
- Context: A K1 comment is stored in cargo context
- Applied to: Link K1 Message to Disposition Code
- Action: A disposition code is being processed
Logic Flow:
IF A K1 comment is stored in cargo context
AND A disposition code is being processed
THEN:
- • The system should link the K1 message to the appropriate disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when k1 comment is linked to a disposition code.
Trigger Criteria:
- Context: A K1 comment is linked to a disposition code
- Applied to: Add to K1 Comment Array
- Action: The comment needs to be stored in the array structure
Logic Flow:
IF A K1 comment is linked to a disposition code
AND The comment needs to be stored in the array structure
THEN:
- • The system should add the K1 comment to the appropriate comment array position
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when k1 segment has been processed and stored.
Trigger Criteria:
- Context: A K1 segment has been processed and stored
- Applied to: More K1 Segments?
- Action: The system checks for additional K1 segments in the message
Logic Flow:
IF A K1 segment has been processed and stored
AND The system checks for additional K1 segments in the message
THEN:
- • The system should continue K1 processing if more segments exist or proceed to integration if complete
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when all k1 segments have been processed and stored.
Trigger Criteria:
- Context: All K1 segments have been processed and stored
- Applied to: Integrate K1 Comments into Processing
- Action: The system needs to integrate comments into cargo processing
Logic Flow:
IF All K1 segments have been processed and stored
AND The system needs to integrate comments into cargo processing
THEN:
- • The system should make K1 comments available for subsequent processing steps
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when k1 comments are integrated into processing and merlin notifications are being generated.
Trigger Criteria:
- Context: K1 comments are integrated into processing and Merlin notifications are being generated
- Applied to: Include K1 Text in Merlin Notifications
- Action: The system creates notification messages
Logic Flow:
IF K1 comments are integrated into processing and Merlin notifications are being generated
AND The system creates notification messages
THEN:
- • The system should include relevant K1 comment text in the Merlin notification content
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when k1 comments have been included in merlin notifications.
Trigger Criteria:
- Context: K1 comments have been included in Merlin notifications
- Applied to: Log K1 Message for Audit Trail
- Action: The system needs to maintain audit trail records
Logic Flow:
IF K1 comments have been included in Merlin notifications
AND The system needs to maintain audit trail records
THEN:
- • The system should log K1 message details for audit and compliance purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when k1 segment processing is complete including logging.
Trigger Criteria:
- Context: K1 segment processing is complete including logging
- Applied to: Continue Message Processing
- Action: The system needs to continue with remaining message segments
Logic Flow:
IF K1 segment processing is complete including logging
AND The system needs to continue with remaining message segments
THEN:
- • The system should proceed to process the next segment in the message sequence
R-GCX016E-cbl-01669 (+11) File: GCX016E.cbl Business Rule: X4 Segment Date and Time Validation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when x4 segment is received with a disposition code date field.
Trigger Criteria:
- Context: An X4 segment is received with a disposition code date field
- Applied to: Date Valid?
- Action: The system extracts and validates the disposition code date
Logic Flow:
IF An X4 segment is received with a disposition code date field
AND The system extracts and validates the disposition code date
THEN:
- • If the date is valid, use the extracted date; if the date is invalid or missing, default to the current system date
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when x4 segment is received with a disposition code time field.
Trigger Criteria:
- Context: An X4 segment is received with a disposition code time field
- Applied to: Time Valid?
- Action: The system extracts and validates the disposition code time
Logic Flow:
IF An X4 segment is received with a disposition code time field
AND The system extracts and validates the disposition code time
THEN:
- • If the time is valid, use the extracted time; if the time is invalid or missing, default to the current system time
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when x4 segment containing disposition code information.
Trigger Criteria:
- Context: An X4 segment containing disposition code information
- Applied to: Extract Disposition Code Date & Extract Disposition Code Time
- Action: The system processes the X4 segment
Logic Flow:
IF An X4 segment containing disposition code information
AND The system processes the X4 segment
THEN:
- • Extract the date field from the disposition code data for further validation
- • Extract the time field from the disposition code data for further validation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code date has been extracted from x4 segment and validated as correct.
Trigger Criteria:
- Context: A disposition code date has been extracted from X4 segment and validated as correct
- Applied to: Use Extracted Date
- Action: The date validation passes
Logic Flow:
IF A disposition code date has been extracted from X4 segment and validated as correct
AND The date validation passes
THEN:
- • Use the extracted date value for disposition code date/time processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code date has been extracted from x4 segment and is invalid or missing.
Trigger Criteria:
- Context: A disposition code date has been extracted from X4 segment and is invalid or missing
- Applied to: Default to System Date
- Action: The date validation fails
Logic Flow:
IF A disposition code date has been extracted from X4 segment and is invalid or missing
AND The date validation fails
THEN:
- • Use the current system date as the default value for disposition code processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code time has been extracted from x4 segment and validated as correct.
Trigger Criteria:
- Context: A disposition code time has been extracted from X4 segment and validated as correct
- Applied to: Use Extracted Time
- Action: The time validation passes
Logic Flow:
IF A disposition code time has been extracted from X4 segment and validated as correct
AND The time validation passes
THEN:
- • Use the extracted time value for disposition code date/time processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code time has been extracted from x4 segment and is invalid or missing.
Trigger Criteria:
- Context: A disposition code time has been extracted from X4 segment and is invalid or missing
- Applied to: Default to System Time
- Action: The time validation fails
Logic Flow:
IF A disposition code time has been extracted from X4 segment and is invalid or missing
AND The time validation fails
THEN:
- • Use the current system time as the default value for disposition code processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid date (either extracted or system default) for disposition code processing.
Trigger Criteria:
- Context: A valid date (either extracted or system default) for disposition code processing
- Applied to: Format Date for Processing
- Action: The date needs to be formatted for system processing
Logic Flow:
IF A valid date (either extracted or system default) for disposition code processing
AND The date needs to be formatted for system processing
THEN:
- • Convert the date into the standard format required for disposition code operations
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid time (either extracted or system default) for disposition code processing.
Trigger Criteria:
- Context: A valid time (either extracted or system default) for disposition code processing
- Applied to: Format Time for Processing
- Action: The time needs to be formatted for system processing
Logic Flow:
IF A valid time (either extracted or system default) for disposition code processing
AND The time needs to be formatted for system processing
THEN:
- • Convert the time into the standard format required for disposition code operations
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when formatted date and time components for disposition code processing.
Trigger Criteria:
- Context: Formatted date and time components for disposition code processing
- Applied to: Combine Date and Time
- Action: Both date and time have been validated and formatted
Logic Flow:
IF Formatted date and time components for disposition code processing
AND Both date and time have been validated and formatted
THEN:
- • Combine the date and time into a single datetime value for storage and processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when combined datetime value from validated date and time components.
Trigger Criteria:
- Context: A combined datetime value from validated date and time components
- Applied to: Store Formatted DateTime
- Action: The datetime combination is complete
Logic Flow:
IF A combined datetime value from validated date and time components
AND The datetime combination is complete
THEN:
- • Store the formatted datetime value in the appropriate field for disposition code processing
R-GCX016E-cbl-01681 (+7) File: GCX016E.cbl Business Rule: Disposition Code Re
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code is being processed for a cargo shipment.
Trigger Criteria:
- Context: A disposition code is being processed for a cargo shipment
- Applied to: Is Disposition Code 'Proceed'?
- Action: The disposition code is 'PROCEED' and the cargo arrival status is checked
Logic Flow:
IF A disposition code is being processed for a cargo shipment
AND The disposition code is 'PROCEED' and the cargo arrival status is checked
THEN:
- • If cargo has arrived, apply standard proceed processing; if cargo has not arrived, skip proceed processing and continue with normal flow
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code is being processed for a cargo shipment.
Trigger Criteria:
- Context: A disposition code is being processed for a cargo shipment
- Applied to: Is Disposition Code 'Cancel'?
- Action: The disposition code is 'CANCEL-XJ' and previous disposition codes are searched
Logic Flow:
IF A disposition code is being processed for a cargo shipment
AND The disposition code is 'CANCEL-XJ' and previous disposition codes are searched
THEN:
- • If a matching proceed code is found, remove the previous proceed code and
then apply cancel processing; if no matching code is found, proceed directly to cancel processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when proceed disposition code is being processed for a cargo shipment.
Trigger Criteria:
- Context: A proceed disposition code is being processed for a cargo shipment
- Applied to: Has Cargo Arrived?
- Action: The cargo arrival status is evaluated
Logic Flow:
IF A proceed disposition code is being processed for a cargo shipment
AND The cargo arrival status is evaluated
THEN:
- • Return true if cargo arrival date exists and cargo status indicates arrival,
otherwise return false
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cancel disposition code is being processed and previous disposition codes exist.
Trigger Criteria:
- Context: A cancel disposition code is being processed and previous disposition codes exist
- Applied to: Find Matching Proceed Code?
- Action: The system searches through the cargo's disposition code history
Logic Flow:
IF A cancel disposition code is being processed and previous disposition codes exist
AND The system searches through the cargo's disposition code history
THEN:
- • Return true if a proceed disposition code with matching entry number and quantity is found,
otherwise return false
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when matching proceed disposition code has been identified in the cargo's disposition history.
Trigger Criteria:
- Context: A matching proceed disposition code has been identified in the cargo's disposition history
- Applied to: Remove Previous Proceed Code
- Action: The cancel disposition processing requires removal of the previous code
Logic Flow:
IF A matching proceed disposition code has been identified in the cargo's disposition history
AND The cancel disposition processing requires removal of the previous code
THEN:
- • Remove the proceed code from the disposition array and update the array sequence numbers accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cancel disposition processing has been completed for a cargo shipment.
Trigger Criteria:
- Context: Cancel disposition processing has been completed for a cargo shipment
- Applied to: Cargo Status Changed?
- Action: The cargo status before and after cancel processing is compared
Logic Flow:
IF Cancel disposition processing has been completed for a cargo shipment
AND The cargo status before and after cancel processing is compared
THEN:
- • Return true if the cargo status flags, release quantities, or arrival status have changed,
otherwise return false
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo status has changed as a result of disposition code re-processing.
Trigger Criteria:
- Context: Cargo status has changed as a result of disposition code re-processing
- Applied to: Update Cargo Status Flags
- Action: Status flags need to be updated to reflect the new cargo state
Logic Flow:
IF Cargo status has changed as a result of disposition code re-processing
AND Status flags need to be updated to reflect the new cargo state
THEN:
- • Update arrival status, release status, hold status, and any other relevant cargo status indicators based on the final disposition code array
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code re-processing has occurred for a cargo shipment.
Trigger Criteria:
- Context: Disposition code re-processing has occurred for a cargo shipment
- Applied to: Log Re-processing Action
- Action: The re-processing action needs to be recorded
Logic Flow:
IF Disposition code re-processing has occurred for a cargo shipment
AND The re-processing action needs to be recorded
THEN:
- • Create a log entry containing the original disposition code, re-processing type, cargo identifier, and timestamp
R-GCX016E-cbl-01689 (+12) File: GCX016E.cbl Business Rule: Cargo Processing by US CCN Key
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has not been found via primary search methods.
Trigger Criteria:
- Context: Cargo has not been found via primary search methods
- Applied to: US CCN Key Available?
- Action: The system checks for US CCN key availability in the cargo record
Logic Flow:
IF Cargo has not been found via primary search methods
AND The system checks for US CCN key availability in the cargo record
THEN:
- • If US CCN key exists and is not empty, proceed with US CCN search;
otherwise generate cargo not found error
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid cargo record exists and us ccn key is available.
Trigger Criteria:
- Context: A valid cargo record exists and US CCN key is available
- Applied to: Extract US CCN from Cargo Record
- Action: The system extracts the US CCN value from the cargo record
Logic Flow:
IF A valid cargo record exists and US CCN key is available
AND The system extracts the US CCN value from the cargo record
THEN:
- • The US CCN value is retrieved and prepared for formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when us ccn has been extracted from the cargo record.
Trigger Criteria:
- Context: US CCN has been extracted from the cargo record
- Applied to: Format US CCN Key for Search
- Action: The system formats the US CCN into a search key
Logic Flow:
IF US CCN has been extracted from the cargo record
AND The system formats the US CCN into a search key
THEN:
- • The US CCN is properly formatted according to database key requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when us ccn key has been properly formatted for search.
Trigger Criteria:
- Context: US CCN key has been properly formatted for search
- Applied to: Search Cargo Database by US CCN Key
- Action: The system searches the cargo database using the US CCN key
Logic Flow:
IF US CCN key has been properly formatted for search
AND The system searches the cargo database using the US CCN key
THEN:
- • Database search is executed against GCSUSRT using the US CCN key
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when database search by us ccn has been completed.
Trigger Criteria:
- Context: Database search by US CCN has been completed
- Applied to: Cargo Found by US CCN?
- Action: The system evaluates the search results
Logic Flow:
IF Database search by US CCN has been completed
AND The system evaluates the search results
THEN:
- • If cargo record is found, proceed with record retrieval;
otherwise generate cargo not found error
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has been found by us ccn search.
Trigger Criteria:
- Context: Cargo has been found by US CCN search
- Applied to: Retrieve Cargo Record
- Action: The system retrieves the cargo record from GCSUSRT
Logic Flow:
IF Cargo has been found by US CCN search
AND The system retrieves the cargo record from GCSUSRT
THEN:
- • Complete cargo record is loaded for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record has been retrieved from the database.
Trigger Criteria:
- Context: Cargo record has been retrieved from the database
- Applied to: Validate Cargo Record Status
- Action: The system validates the cargo record status using GCSCCRT
Logic Flow:
IF Cargo record has been retrieved from the database
AND The system validates the cargo record status using GCSCCRT
THEN:
- • Cargo record status is checked for validity and processing eligibility
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record status validation has been completed.
Trigger Criteria:
- Context: Cargo record status validation has been completed
- Applied to: Valid Cargo Record?
- Action: The system evaluates cargo record validity
Logic Flow:
IF Cargo record status validation has been completed
AND The system evaluates cargo record validity
THEN:
- • If cargo record is valid, proceed with cargo processing;
otherwise generate cargo not found error
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record has been found and validated as eligible for processing.
Trigger Criteria:
- Context: Cargo record has been found and validated as eligible for processing
- Applied to: Process Found Cargo
- Action: The system begins cargo processing operations
Logic Flow:
IF Cargo record has been found and validated as eligible for processing
AND The system begins cargo processing operations
THEN:
- • Cargo processing is initiated with the validated cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo processing has been initiated.
Trigger Criteria:
- Context: Cargo processing has been initiated
- Applied to: Update Cargo Processing Flags
- Action: The system updates cargo processing status flags
Logic Flow:
IF Cargo processing has been initiated
AND The system updates cargo processing status flags
THEN:
- • Processing flags are set to indicate successful cargo location and processing status
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has been found, validated, and processing flags updated.
Trigger Criteria:
- Context: Cargo has been found, validated, and processing flags updated
- Applied to: Continue with Disposition Processing
- Action: The system continues with disposition processing
Logic Flow:
IF Cargo has been found, validated, and processing flags updated
AND The system continues with disposition processing
THEN:
- • Disposition code processing proceeds with the located cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when us ccn key is not available, cargo is not found by us ccn search, or cargo record validation fails.
Trigger Criteria:
- Context: US CCN key is not available, cargo is not found by US CCN search, or cargo record validation fails
- Applied to: Generate Cargo Not Found Error
- Action: The system generates a cargo not found error
Logic Flow:
IF US CCN key is not available, cargo is not found by US CCN search, or cargo record validation fails
AND The system generates a cargo not found error
THEN:
- • Error is generated indicating cargo could not be located for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo not found error has been generated.
Trigger Criteria:
- Context: Cargo not found error has been generated
- Applied to: Log Search Attempt
- Action: The system logs the search attempt
Logic Flow:
IF Cargo not found error has been generated
AND The system logs the search attempt
THEN:
- • Search attempt details are recorded for audit trail
R-GCX016E-cbl-01702 (+9) File: GCX016E.cbl Business Rule: Bond Information Clearing for DC95
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code 95 is received for processing.
Trigger Criteria:
- Context: A disposition code 95 is received for processing
- Applied to: Validate DC95 in Disposition Code Table
- Action: The system looks up disposition code 95 in the disposition code table
Logic Flow:
IF A disposition code 95 is received for processing
AND The system looks up disposition code 95 in the disposition code table
THEN:
- • If DC95 is not found in the table, generate an error message and stop processing,
otherwise continue with bond clearing process
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code 95 has been validated and bond cancellation is being processed.
Trigger Criteria:
- Context: Disposition code 95 has been validated and bond cancellation is being processed
- Applied to: Clear BOL Type Code
- Action: The system processes the bond information clearing
Logic Flow:
IF Disposition code 95 has been validated and bond cancellation is being processed
AND The system processes the bond information clearing
THEN:
- • The BOL type code field in the cargo record is cleared to spaces
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when bol type code has been cleared and bond cancellation is in progress.
Trigger Criteria:
- Context: BOL type code has been cleared and bond cancellation is in progress
- Applied to: Clear M12 Bond Data
- Action: The system processes M12 bond data clearing
Logic Flow:
IF BOL type code has been cleared and bond cancellation is in progress
AND The system processes M12 bond data clearing
THEN:
- • All M12 segment bond-related fields are cleared to their default values
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when m12 bond data has been cleared and bond cancellation continues.
Trigger Criteria:
- Context: M12 bond data has been cleared and bond cancellation continues
- Applied to: Clear Bond Number Index
- Action: The system processes bond number index clearing
Logic Flow:
IF M12 bond data has been cleared and bond cancellation continues
AND The system processes bond number index clearing
THEN:
- • The bond number index field is set to zero to remove the bond reference
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when bond number index has been cleared and bond cancellation processing continues.
Trigger Criteria:
- Context: Bond number index has been cleared and bond cancellation processing continues
- Applied to: Clear Broker QP Information
- Action: The system processes broker QP information clearing
Logic Flow:
IF Bond number index has been cleared and bond cancellation processing continues
AND The system processes broker QP information clearing
THEN:
- • All broker qualification and permit fields are cleared to spaces or zero values
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when broker qp information has been cleared and bond cancellation is proceeding.
Trigger Criteria:
- Context: Broker QP information has been cleared and bond cancellation is proceeding
- Applied to: Clear Bond Owner Information
- Action: The system processes bond owner information clearing
Logic Flow:
IF Broker QP information has been cleared and bond cancellation is proceeding
AND The system processes bond owner information clearing
THEN:
- • Bond owner identification fields are cleared to remove ownership references
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all bond information has been cleared from the cargo record.
Trigger Criteria:
- Context: All bond information has been cleared from the cargo record
- Applied to: Update Cargo Status Arrays
- Action: The system updates the cargo status arrays
Logic Flow:
IF All bond information has been cleared from the cargo record
AND The system updates the cargo status arrays
THEN:
- • The status array is updated with disposition code 95 and appropriate sequence numbers to track the bond cancellation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo status arrays have been updated with the bond cancellation.
Trigger Criteria:
- Context: Cargo status arrays have been updated with the bond cancellation
- Applied to: Log Bond Clearing Action
- Action: The system creates audit log entries
Logic Flow:
IF Cargo status arrays have been updated with the bond cancellation
AND The system creates audit log entries
THEN:
- • A log entry is created with timestamp, user information, and details of the bond clearing action for audit trail purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when bond clearing action has been logged and all updates are complete.
Trigger Criteria:
- Context: Bond clearing action has been logged and all updates are complete
- Applied to: Generate Merlin Notification
- Action: The system generates Merlin notifications
Logic Flow:
IF Bond clearing action has been logged and all updates are complete
AND The system generates Merlin notifications
THEN:
- • A Merlin message is created and sent to appropriate recipients containing cargo details and bond cancellation information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code 95 is being validated against the disposition code table.
Trigger Criteria:
- Context: Disposition code 95 is being validated against the disposition code table
- Applied to: DC95 Not Found - Generate Error
- Action: DC95 is not found in the disposition code table
Logic Flow:
IF Disposition code 95 is being validated against the disposition code table
AND DC95 is not found in the disposition code table
THEN:
- • Generate an error message indicating invalid disposition code and terminate the bond cancellation process
R-GCX016E-cbl-01724 (+9) File: GCX016E.cbl Business Rule: Canadian Border Location Mapping
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record contains cross-border movement information.
Trigger Criteria:
- Context: A cargo record contains cross-border movement information
- Applied to: Extract US Port Code from Cargo Data
- Action: The system processes cargo for cross-border movement
Logic Flow:
IF A cargo record contains cross-border movement information
AND The system processes cargo for cross-border movement
THEN:
- • The US port code is extracted from the cargo data for mapping purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when us port code needs to be mapped to a canadian border location.
Trigger Criteria:
- Context: A US port code needs to be mapped to a Canadian border location
- Applied to: Access Canadian Border Mapping Table
- Action: The system requires Canadian location mapping
Logic Flow:
IF A US port code needs to be mapped to a Canadian border location
AND The system requires Canadian location mapping
THEN:
- • The Canadian border mapping table is accessed for lookup operations
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when us port code is available and the canadian border mapping table is accessible.
Trigger Criteria:
- Context: A US port code is available and the Canadian border mapping table is accessible
- Applied to: Lookup US Port Code in Mapping Table
- Action: The system performs a lookup operation for the US port code
Logic Flow:
IF A US port code is available and the Canadian border mapping table is accessible
AND The system performs a lookup operation for the US port code
THEN:
- • The system searches the mapping table to find a corresponding Canadian border location
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when us port code lookup has been performed in the canadian border mapping table.
Trigger Criteria:
- Context: A US port code lookup has been performed in the Canadian border mapping table
- Applied to: Mapping Found?
- Action: The system evaluates the lookup results
Logic Flow:
IF A US port code lookup has been performed in the Canadian border mapping table
AND The system evaluates the lookup results
THEN:
- • The system determines if a valid mapping exists for the US port code
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid mapping exists for the us port code in the canadian border mapping table.
Trigger Criteria:
- Context: A valid mapping exists for the US port code in the Canadian border mapping table
- Applied to: Retrieve Canadian Border Location Name
- Action: The mapping is found during lookup
Logic Flow:
IF A valid mapping exists for the US port code in the Canadian border mapping table
AND The mapping is found during lookup
THEN:
- • The system retrieves the corresponding Canadian border location name
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when canadian border location name has been retrieved from the mapping table.
Trigger Criteria:
- Context: A Canadian border location name has been retrieved from the mapping table
- Applied to: Update Cargo Record with Canadian Location
- Action: The location mapping is successful
Logic Flow:
IF A Canadian border location name has been retrieved from the mapping table
AND The location mapping is successful
THEN:
- • The cargo record is updated with the Canadian border location information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record has been updated with canadian border location information.
Trigger Criteria:
- Context: A cargo record has been updated with Canadian border location information
- Applied to: Set Cross-Border Flag
- Action: The location update is completed
Logic Flow:
IF A cargo record has been updated with Canadian border location information
AND The location update is completed
THEN:
- • A cross-border flag is set to indicate the cargo involves cross-border movement
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cross-border flag has been set for the cargo.
Trigger Criteria:
- Context: A cross-border flag has been set for the cargo
- Applied to: Log Mapping Success
- Action: The mapping process completes successfully
Logic Flow:
IF A cross-border flag has been set for the cargo
AND The mapping process completes successfully
THEN:
- • The system logs the successful mapping operation for audit purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when us port code lookup in the canadian border mapping table returns no results.
Trigger Criteria:
- Context: A US port code lookup in the Canadian border mapping table returns no results
- Applied to: Generate Error for Unmapped Port
- Action: No valid mapping is found for the US port code
Logic Flow:
IF A US port code lookup in the Canadian border mapping table returns no results
AND No valid mapping is found for the US port code
THEN:
- • The system generates an error indicating the port code cannot be mapped
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when error has been generated for an unmapped us port code.
Trigger Criteria:
- Context: An error has been generated for an unmapped US port code
- Applied to: Use Default Canadian Location
- Action: No specific mapping is available
Logic Flow:
IF An error has been generated for an unmapped US port code
AND No specific mapping is available
THEN:
- • The system uses a default Canadian location to continue processing
R-GCX016E-cbl-01734 (+11) File: GCX016E.cbl Business Rule: FDA Reference Number Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has an a1 disposition code requiring fda reference number processing.
Trigger Criteria:
- Context: A cargo has an A1 disposition code requiring FDA reference number processing
- Applied to: A1 Disposition Code Processing
- Action: The system processes the A1 disposition code
Logic Flow:
IF A cargo has an A1 disposition code requiring FDA reference number processing
AND The system processes the A1 disposition code
THEN:
- • The FDA reference number is formatted and processed for A1 specific requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has an a3 disposition code requiring fda reference number processing.
Trigger Criteria:
- Context: A cargo has an A3 disposition code requiring FDA reference number processing
- Applied to: A3 Disposition Code Processing
- Action: The system processes the A3 disposition code
Logic Flow:
IF A cargo has an A3 disposition code requiring FDA reference number processing
AND The system processes the A3 disposition code
THEN:
- • The FDA reference number is formatted and processed for A3 specific requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when a1 disposition code is being processed with an fda reference number.
Trigger Criteria:
- Context: An A1 disposition code is being processed with an FDA reference number
- Applied to: Format FDA Reference Number for A1
- Action: The system formats the FDA reference number
Logic Flow:
IF An A1 disposition code is being processed with an FDA reference number
AND The system formats the FDA reference number
THEN:
- • The FDA reference number is formatted according to A1 disposition code requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when a1 disposition code is being processed with an fda reference number.
Trigger Criteria:
- Context: An A1 disposition code is being processed with an FDA reference number
- Applied to: Add 'FDA PN' Prefix for A1
- Action: The system adds the required prefix
Logic Flow:
IF An A1 disposition code is being processed with an FDA reference number
AND The system adds the required prefix
THEN:
- • The FDA reference number is prefixed with 'FDA PN'
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when a3 disposition code is being processed with an fda reference number.
Trigger Criteria:
- Context: An A3 disposition code is being processed with an FDA reference number
- Applied to: Format FDA Reference Number for A3
- Action: The system formats the FDA reference number
Logic Flow:
IF An A3 disposition code is being processed with an FDA reference number
AND The system formats the FDA reference number
THEN:
- • The FDA reference number is formatted according to A3 disposition code requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when a3 disposition code is being processed with an fda reference number.
Trigger Criteria:
- Context: An A3 disposition code is being processed with an FDA reference number
- Applied to: Add 'FDA' Prefix for A3
- Action: The system adds the required prefix
Logic Flow:
IF An A3 disposition code is being processed with an FDA reference number
AND The system adds the required prefix
THEN:
- • The FDA reference number is prefixed with 'FDA'
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when fda reference number processing is required for a cargo.
Trigger Criteria:
- Context: FDA reference number processing is required for a cargo
- Applied to: N9 Segment Exists?
- Action: The system checks for existing N9 reference segments
Logic Flow:
IF FDA reference number processing is required for a cargo
AND The system checks for existing N9 reference segments
THEN:
- • The system determines if an N9 segment exists and routes processing accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when no existing n9 reference segment exists for the cargo.
Trigger Criteria:
- Context: No existing N9 reference segment exists for the cargo
- Applied to: Create New N9 Reference Segment
- Action: FDA reference number processing is required
Logic Flow:
IF No existing N9 reference segment exists for the cargo
AND FDA reference number processing is required
THEN:
- • A new N9 reference segment is created to store the FDA reference number
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when existing n9 reference segment exists for the cargo.
Trigger Criteria:
- Context: An existing N9 reference segment exists for the cargo
- Applied to: Update Existing N9 Reference Segment
- Action: FDA reference number processing is required
Logic Flow:
IF An existing N9 reference segment exists for the cargo
AND FDA reference number processing is required
THEN:
- • The existing N9 reference segment is updated with the FDA reference number
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when fda reference number is being processed for a1 or a3 disposition codes.
Trigger Criteria:
- Context: An FDA reference number is being processed for A1 or A3 disposition codes
- Applied to: Validate FDA Reference Number Format
- Action: The system validates the reference number format
Logic Flow:
IF An FDA reference number is being processed for A1 or A3 disposition codes
AND The system validates the reference number format
THEN:
- • The FDA reference number format is verified to meet business requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when existing n9 reference segment needs to be updated with fda reference number.
Trigger Criteria:
- Context: An existing N9 reference segment needs to be updated with FDA reference number
- Applied to: Replace N9 Reference Segment
- Action: The system processes the segment replacement
Logic Flow:
IF An existing N9 reference segment needs to be updated with FDA reference number
AND The system processes the segment replacement
THEN:
- • The N9 reference segment is replaced with the updated FDA reference information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when new n9 reference segment needs to be created with fda reference number.
Trigger Criteria:
- Context: A new N9 reference segment needs to be created with FDA reference number
- Applied to: Insert N9 Reference Segment
- Action: The system processes the segment insertion
Logic Flow:
IF A new N9 reference segment needs to be created with FDA reference number
AND The system processes the segment insertion
THEN:
- • The N9 reference segment is inserted with the FDA reference information into the cargo record
R-GCX016E-cbl-01757 (+16) File: GCX016E.cbl Business Rule: Cargo Database Lookup by Bond Number
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo lookup request is initiated.
Trigger Criteria:
- Context: A cargo lookup request is initiated
- Applied to: Receive Bond Number as Search Key
- Action: The system receives the search parameters
Logic Flow:
IF A cargo lookup request is initiated
AND The system receives the search parameters
THEN:
- • The bond number must be present and valid as the primary search key
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid bond number is provided for search. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A valid bond number is provided for search
- Applied to: Call GCCUSIO2 Database Interface
- Action: The system needs to access cargo database records
Logic Flow:
IF A valid bond number is provided for search
AND The system needs to access cargo database records
THEN:
- • The GCCUSIO2 database interface program must be invoked with the bond number parameter
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when database interface is active and bond number is provided.
Trigger Criteria:
- Context: The database interface is active and bond number is provided
- Applied to: Search GCSUSRT US Cargo Root Segments
- Action: The system searches the GCSUSRT table
Logic Flow:
IF The database interface is active and bond number is provided
AND The system searches the GCSUSRT table
THEN:
- • All cargo root segments with matching bond numbers must be identified and retrieved
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when search has been performed on the cargo database using bond number.
Trigger Criteria:
- Context: A search has been performed on the cargo database using bond number
- Applied to: First Cargo Record Found?
- Action: The system evaluates the search results
Logic Flow:
IF A search has been performed on the cargo database using bond number
AND The system evaluates the search results
THEN:
- • If no cargo records are found for the bond number, the system must return 'No Records Found' status,
otherwise proceed with record retrieval
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when at least one cargo record exists for the specified bond number.
Trigger Criteria:
- Context: At least one cargo record exists for the specified bond number
- Applied to: Retrieve First Cargo Record
- Action: The system processes the first matching record
Logic Flow:
IF At least one cargo record exists for the specified bond number
AND The system processes the first matching record
THEN:
- • The complete cargo record data must be retrieved and made available for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when first cargo record has been successfully retrieved.
Trigger Criteria:
- Context: The first cargo record has been successfully retrieved
- Applied to: Set Bond Index Position
- Action: The system prepares for additional record searches
Logic Flow:
IF The first cargo record has been successfully retrieved
AND The system prepares for additional record searches
THEN:
- • The bond index position must be set to enable sequential access to remaining records with the same bond number
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when first cargo record has been processed and bond index position is set.
Trigger Criteria:
- Context: The first cargo record has been processed and bond index position is set
- Applied to: Search for Subsequent Records
- Action: The system searches for additional records
Logic Flow:
IF The first cargo record has been processed and bond index position is set
AND The system searches for additional records
THEN:
- • All remaining cargo records with the same bond number must be identified in sequential order
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when search for subsequent records has been performed.
Trigger Criteria:
- Context: A search for subsequent records has been performed
- Applied to: More Records with Same Bond?
- Action: The system evaluates if more records exist with the same bond number
Logic Flow:
IF A search for subsequent records has been performed
AND The system evaluates if more records exist with the same bond number
THEN:
- • If additional records exist, continue processing the next record,
otherwise complete the bond lookup process
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when additional cargo records exist with the same bond number.
Trigger Criteria:
- Context: Additional cargo records exist with the same bond number
- Applied to: Retrieve Next Cargo Record
- Action: The system processes the next record in sequence
Logic Flow:
IF Additional cargo records exist with the same bond number
AND The system processes the next record in sequence
THEN:
- • The complete cargo record data must be retrieved and prepared for validation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record has been retrieved from the database.
Trigger Criteria:
- Context: A cargo record has been retrieved from the database
- Applied to: Validate Status Code
- Action: The system examines the record's status code
Logic Flow:
IF A cargo record has been retrieved from the database
AND The system examines the record's status code
THEN:
- • The status code must be validated against business rules to determine if the record should be included in processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record's status code has been validated.
Trigger Criteria:
- Context: A cargo record's status code has been validated
- Applied to: Status Code Valid?
- Action: The system evaluates the validation results
Logic Flow:
IF A cargo record's status code has been validated
AND The system evaluates the validation results
THEN:
- • If the status code is valid, the record must be considered for inclusion in the cargo processing list,
otherwise the record must be excluded and the search must continue
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record has a valid status code.
Trigger Criteria:
- Context: A cargo record has a valid status code
- Applied to: Add to Cargo Processing List
- Action: The system determines the record should be included
Logic Flow:
IF A cargo record has a valid status code
AND The system determines the record should be included
THEN:
- • The cargo record must be added to the cargo processing list for further business processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record has been processed (either included or excluded).
Trigger Criteria:
- Context: A cargo record has been processed (either included or excluded)
- Applied to: Continue Search Loop
- Action: The system needs to check for additional records
Logic Flow:
IF A cargo record has been processed (either included or excluded)
AND The system needs to check for additional records
THEN:
- • The search loop must continue to evaluate remaining cargo records with the same bond number
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when all cargo records with the specified bond number have been evaluated.
Trigger Criteria:
- Context: All cargo records with the specified bond number have been evaluated
- Applied to: Complete Bond Lookup
- Action: No more records exist with the same bond number
Logic Flow:
IF All cargo records with the specified bond number have been evaluated
AND No more records exist with the same bond number
THEN:
- • The bond lookup process must be completed and the system must prepare to return the cargo record set
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when bond lookup process has been completed.
Trigger Criteria:
- Context: The bond lookup process has been completed
- Applied to: Return Cargo Record Set
- Action: The system has identified all valid cargo records for the bond number
Logic Flow:
IF The bond lookup process has been completed
AND The system has identified all valid cargo records for the bond number
THEN:
- • The complete set of cargo records must be returned to the calling process for further business operations
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when error occurs during the bond lookup process.
Trigger Criteria:
- Context: An error occurs during the bond lookup process
- Applied to: Log Bond Lookup Error
- Action: The system encounters a database access error or invalid search condition
Logic Flow:
IF An error occurs during the bond lookup process
AND The system encounters a database access error or invalid search condition
THEN:
- • The error details must be logged and the system must prepare to return a 'No Records Found' status
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when no cargo records exist for the bond number or an error has occurred.
Trigger Criteria:
- Context: No cargo records exist for the bond number or an error has occurred
- Applied to: Return No Records Found
- Action: The system completes the lookup process
Logic Flow:
IF No cargo records exist for the bond number or an error has occurred
AND The system completes the lookup process
THEN:
- • A 'No Records Found' status must be returned to indicate that no valid cargo records are available for processing
R-GCX016E-cbl-01774 (+15) File: GCX016E.cbl Business Rule: Cargo Database Lookup by Car/Waybill Index
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when input message containing car identification information is received.
Trigger Criteria:
- Context: An input message containing car identification information is received
- Applied to: Extract Car ID from Input Message
- Action: The system processes the message to extract car ID
Logic Flow:
IF An input message containing car identification information is received
AND The system processes the message to extract car ID
THEN:
- • The car ID is extracted and made available for database search operations
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when input message containing waybill number information is received.
Trigger Criteria:
- Context: An input message containing waybill number information is received
- Applied to: Extract Waybill Number from Input Message
- Action: The system processes the message to extract waybill number
Logic Flow:
IF An input message containing waybill number information is received
AND The system processes the message to extract waybill number
THEN:
- • The waybill number is extracted and prepared for use in database search key construction
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when raw car id has been extracted from the input message.
Trigger Criteria:
- Context: A raw car ID has been extracted from the input message
- Applied to: Format Car ID for Database Search
- Action: The system formats the car ID for database compatibility
Logic Flow:
IF A raw car ID has been extracted from the input message
AND The system formats the car ID for database compatibility
THEN:
- • The car ID is properly formatted and ready for use in database search operations
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when formatted car id and extracted waybill number are available.
Trigger Criteria:
- Context: A formatted car ID and extracted waybill number are available
- Applied to: Construct Car/Waybill Search Key
- Action: The system constructs the combined search key
Logic Flow:
IF A formatted car ID and extracted waybill number are available
AND The system constructs the combined search key
THEN:
- • A composite car/waybill search key is created for database query operations
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when car/waybill search key has been constructed.
Trigger Criteria:
- Context: A car/waybill search key has been constructed
- Applied to: Access GCSUSRT Database
- Action: The system accesses the GCSUSRT database
Logic Flow:
IF A car/waybill search key has been constructed
AND The system accesses the GCSUSRT database
THEN:
- • Database connection is established and ready for cargo record search operations
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when gcsusrt database has been accessed with a car/waybill search key.
Trigger Criteria:
- Context: The GCSUSRT database has been accessed with a car/waybill search key
- Applied to: First Record Found?
- Action: The system searches for the first matching cargo record
Logic Flow:
IF The GCSUSRT database has been accessed with a car/waybill search key
AND The system searches for the first matching cargo record
THEN:
- • The system determines whether a matching cargo record exists or not
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when matching cargo record has been found in the database.
Trigger Criteria:
- Context: A matching cargo record has been found in the database
- Applied to: Retrieve First Cargo Record
- Action: The system retrieves the first cargo record
Logic Flow:
IF A matching cargo record has been found in the database
AND The system retrieves the first cargo record
THEN:
- • The first matching cargo record is loaded and available for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when first cargo record has been successfully retrieved.
Trigger Criteria:
- Context: The first cargo record has been successfully retrieved
- Applied to: Set Record Found Flag
- Action: The system updates the record found status
Logic Flow:
IF The first cargo record has been successfully retrieved
AND The system updates the record found status
THEN:
- • The record found flag is set to indicate successful cargo record retrieval
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when first cargo record has been retrieved successfully.
Trigger Criteria:
- Context: The first cargo record has been retrieved successfully
- Applied to: Check for Additional Records
- Action: The system checks for additional records with the same search key
Logic Flow:
IF The first cargo record has been retrieved successfully
AND The system checks for additional records with the same search key
THEN:
- • The system determines whether more matching cargo records exist
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when system is checking for additional cargo records.
Trigger Criteria:
- Context: The system is checking for additional cargo records
- Applied to: More Records with Same Key?
- Action: The database search continues for more records with the same key
Logic Flow:
IF The system is checking for additional cargo records
AND The database search continues for more records with the same key
THEN:
- • The system determines if additional matching records are available for retrieval
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when additional matching cargo records have been identified.
Trigger Criteria:
- Context: Additional matching cargo records have been identified
- Applied to: Retrieve Next Cargo Record
- Action: The system retrieves the next cargo record
Logic Flow:
IF Additional matching cargo records have been identified
AND The system retrieves the next cargo record
THEN:
- • The next matching cargo record is loaded and available for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record has been successfully retrieved from the database.
Trigger Criteria:
- Context: A cargo record has been successfully retrieved from the database
- Applied to: Add to Cargo Record List
- Action: The system adds the record to the cargo record collection
Logic Flow:
IF A cargo record has been successfully retrieved from the database
AND The system adds the record to the cargo record collection
THEN:
- • The cargo record is included in the list of records for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record has been added to the collection.
Trigger Criteria:
- Context: A cargo record has been added to the collection
- Applied to: Continue Search for Additional Records
- Action: The system continues searching for additional records
Logic Flow:
IF A cargo record has been added to the collection
AND The system continues searching for additional records
THEN:
- • The search process loops back to check for more matching cargo records
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all matching cargo records have been retrieved and collected.
Trigger Criteria:
- Context: All matching cargo records have been retrieved and collected
- Applied to: Return All Found Records
- Action: No more matching records exist in the database
Logic Flow:
IF All matching cargo records have been retrieved and collected
AND No more matching records exist in the database
THEN:
- • The complete collection of found cargo records is returned for business processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when database search has been completed.
Trigger Criteria:
- Context: The database search has been completed
- Applied to: Set No Records Found Flag
- Action: No cargo records match the car/waybill search criteria
Logic Flow:
IF The database search has been completed
AND No cargo records match the car/waybill search criteria
THEN:
- • The no records found flag is set to indicate unsuccessful search results
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when no cargo records were found matching the search criteria.
Trigger Criteria:
- Context: No cargo records were found matching the search criteria
- Applied to: Generate Not Found Message
- Action: The system generates a not found message
Logic Flow:
IF No cargo records were found matching the search criteria
AND The system generates a not found message
THEN:
- • An appropriate message is created indicating that no matching cargo records exist
R-GCX016E-cbl-01790 (+13) File: GCX016E.cbl Business Rule: CPRS New Cargo Creation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cprs cargo lookup request with car id and waybill information.
Trigger Criteria:
- Context: A CPRS cargo lookup request with car ID and waybill information
- Applied to: CPRS Cargo Found in System?
- Action: The system searches for existing CPRS cargo records using the car ID and waybill as search criteria
Logic Flow:
IF A CPRS cargo lookup request with car ID and waybill information
AND The system searches for existing CPRS cargo records using the car ID and waybill as search criteria
THEN:
- • The system returns whether the CPRS cargo record exists or not in the database
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when raw car equipment initial and number from n7 segment data.
Trigger Criteria:
- Context: Raw car equipment initial and number from N7 segment data
- Applied to: Format Car ID Using Standard Rules
- Action: The system processes the car information for CPRS cargo creation
Logic Flow:
IF Raw car equipment initial and number from N7 segment data
AND The system processes the car information for CPRS cargo creation
THEN:
- • The system formats the car ID by combining equipment initial and number according to standard formatting rules
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when new cprs cargo record being created.
Trigger Criteria:
- Context: A new CPRS cargo record being created
- Applied to: Set CPRS-Specific Flags and Identifiers
- Action: The system initializes CPRS cargo attributes
Logic Flow:
IF A new CPRS cargo record being created
AND The system initializes CPRS cargo attributes
THEN:
- • The system sets CPRS-specific processing flags and identifiers to enable proper CPRS handling
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when new cprs cargo record being created.
Trigger Criteria:
- Context: A new CPRS cargo record being created
- Applied to: Initialize Cargo Status Arrays
- Action: The system initializes cargo status tracking
Logic Flow:
IF A new CPRS cargo record being created
AND The system initializes cargo status tracking
THEN:
- • The system creates empty status arrays and sets up status segment structures for tracking CPRS cargo disposition codes
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when x4 segment data containing disposition codes, quantities, and entry information.
Trigger Criteria:
- Context: X4 segment data containing disposition codes, quantities, and entry information
- Applied to: Build Cargo Record from X4 Segment Data
- Action: The system builds a new CPRS cargo record
Logic Flow:
IF X4 segment data containing disposition codes, quantities, and entry information
AND The system builds a new CPRS cargo record
THEN:
- • The system populates cargo record fields with disposition code, quantity, entry number, and related X4 segment information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when n7 segment data containing equipment initial, number, and related equipment information.
Trigger Criteria:
- Context: N7 segment data containing equipment initial, number, and related equipment information
- Applied to: Build Cargo Record from N7 Segment Data
- Action: The system builds a new CPRS cargo record
Logic Flow:
IF N7 segment data containing equipment initial, number, and related equipment information
AND The system builds a new CPRS cargo record
THEN:
- • The system populates cargo record fields with equipment information, car ID, and related N7 segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when new cprs cargo record with disposition code and entry information.
Trigger Criteria:
- Context: A new CPRS cargo record with disposition code and entry information
- Applied to: Set CPRS Bond Information
- Action: The system sets bond information for the CPRS cargo
Logic Flow:
IF A new CPRS cargo record with disposition code and entry information
AND The system sets bond information for the CPRS cargo
THEN:
- • The system assigns bond number and related bond information based on CPRS processing rules
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when new cprs cargo record and access to carrier information database.
Trigger Criteria:
- Context: A new CPRS cargo record and access to carrier information database
- Applied to: Set CPRS Broker Information
- Action: The system sets broker information for the CPRS cargo
Logic Flow:
IF A new CPRS cargo record and access to carrier information database
AND The system sets broker information for the CPRS cargo
THEN:
- • The system assigns broker code and related broker information from the carrier information database
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when new cprs cargo record with basic information populated.
Trigger Criteria:
- Context: A new CPRS cargo record with basic information populated
- Applied to: Set Default CPRS Processing Flags
- Action: The system sets default processing flags
Logic Flow:
IF A new CPRS cargo record with basic information populated
AND The system sets default processing flags
THEN:
- • The system assigns default values for processing flags that control CPRS cargo handling and workflow
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when complete cprs cargo record ready for database insertion.
Trigger Criteria:
- Context: A complete CPRS cargo record ready for database insertion
- Applied to: Insert New CPRS Cargo Record into Database
- Action: The system attempts to insert the record into the US cargo root database
Logic Flow:
IF A complete CPRS cargo record ready for database insertion
AND The system attempts to insert the record into the US cargo root database
THEN:
- • The system successfully adds the new CPRS cargo record to the database or returns an insertion failure status
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when attempt to insert a new cprs cargo record into the database.
Trigger Criteria:
- Context: An attempt to insert a new CPRS cargo record into the database
- Applied to: Database Insert Successful?
- Action: The system checks the database insertion result
Logic Flow:
IF An attempt to insert a new CPRS cargo record into the database
AND The system checks the database insertion result
THEN:
- • The system determines whether the insertion was successful or failed based on the database response
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when successfully created cprs cargo record.
Trigger Criteria:
- Context: A successfully created CPRS cargo record
- Applied to: Log CPRS Cargo Creation Action
- Action: The system logs the creation action
Logic Flow:
IF A successfully created CPRS cargo record
AND The system logs the creation action
THEN:
- • The system records the CPRS cargo creation event with relevant details for audit trail and tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when successfully created and logged cprs cargo record.
Trigger Criteria:
- Context: A successfully created and logged CPRS cargo record
- Applied to: Generate CPRS Creation Notification
- Action: The system generates creation notifications
Logic Flow:
IF A successfully created and logged CPRS cargo record
AND The system generates creation notifications
THEN:
- • The system sends notifications to appropriate recipients about the new CPRS cargo creation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when failed cprs cargo record insertion or creation error.
Trigger Criteria:
- Context: A failed CPRS cargo record insertion or creation error
- Applied to: Handle CPRS Creation Error
- Action: The system handles the creation error
Logic Flow:
IF A failed CPRS cargo record insertion or creation error
AND The system handles the creation error
THEN:
- • The system processes the error condition and takes appropriate corrective action or error reporting
R-GCX016E-cbl-01804 (+13) File: GCX016E.cbl Business Rule: Foreign Cargo Creation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when foreign bill of lading number is provided in the x4 segment.
Trigger Criteria:
- Context: A foreign bill of lading number is provided in the X4 segment
- Applied to: Foreign Bill Not Found in System
- Action: The system searches the cargo database for the bill of lading
Logic Flow:
IF A foreign bill of lading number is provided in the X4 segment
AND The system searches the cargo database for the bill of lading
THEN:
- • The system confirms the bill does not exist and proceeds with new cargo creation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when foreign bill requires a new cargo record.
Trigger Criteria:
- Context: A foreign bill requires a new cargo record
- Applied to: Initialize New Cargo Record
- Action: The system begins cargo record creation
Logic Flow:
IF A foreign bill requires a new cargo record
AND The system begins cargo record creation
THEN:
- • A new cargo record structure is initialized with default values and cleared fields
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when x4 segment contains cargo disposition information.
Trigger Criteria:
- Context: An X4 segment contains cargo disposition information
- Applied to: Set Up Cargo Record with X4 Segment Data
- Action: The system processes the X4 segment for new cargo creation
Logic Flow:
IF An X4 segment contains cargo disposition information
AND The system processes the X4 segment for new cargo creation
THEN:
- • The cargo record is populated with disposition code, entry number, quantity, and date/time information from the X4 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when n7 segment contains equipment information.
Trigger Criteria:
- Context: An N7 segment contains equipment information
- Applied to: Set Up Cargo Record with N7 Segment Data
- Action: The system processes the N7 segment for new cargo creation
Logic Flow:
IF An N7 segment contains equipment information
AND The system processes the N7 segment for new cargo creation
THEN:
- • The cargo record is populated with equipment initial, equipment number, and formatted car ID from the N7 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when m10 segments contain manifest header information.
Trigger Criteria:
- Context: M10 segments contain manifest header information
- Applied to: Build Foreign Manifest from M10 Segments
- Action: The system processes M10 segments for foreign cargo creation
Logic Flow:
IF M10 segments contain manifest header information
AND The system processes M10 segments for foreign cargo creation
THEN:
- • The cargo record is populated with vessel name, voyage number, and manifest routing information from the M10 segments
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when manifest information contains carrier identification.
Trigger Criteria:
- Context: Manifest information contains carrier identification
- Applied to: Extract SCAC Information
- Action: The system processes carrier information for foreign cargo
Logic Flow:
IF Manifest information contains carrier identification
AND The system processes carrier information for foreign cargo
THEN:
- • The SCAC code is extracted and stored in the cargo record for carrier identification
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when manifest data contains transportation mode information.
Trigger Criteria:
- Context: Manifest data contains transportation mode information
- Applied to: Extract Transport Type
- Action: The system processes transportation details for foreign cargo
Logic Flow:
IF Manifest data contains transportation mode information
AND The system processes transportation details for foreign cargo
THEN:
- • The transport type is identified and recorded in the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when manifest data contains country identification information.
Trigger Criteria:
- Context: Manifest data contains country identification information
- Applied to: Extract Country Code
- Action: The system processes location details for foreign cargo
Logic Flow:
IF Manifest data contains country identification information
AND The system processes location details for foreign cargo
THEN:
- • The country code is extracted and assigned to the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when m10 segments contain vessel identification and voyage information.
Trigger Criteria:
- Context: M10 segments contain vessel identification and voyage information
- Applied to: Extract Vessel Details
- Action: The system processes vessel details for foreign cargo
Logic Flow:
IF M10 segments contain vessel identification and voyage information
AND The system processes vessel details for foreign cargo
THEN:
- • Vessel name, voyage number, and vessel identifiers are extracted and stored in the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment initial and number are available from n7 segment.
Trigger Criteria:
- Context: Equipment initial and number are available from N7 segment
- Applied to: Format Car ID for Database
- Action: The system prepares car identification for database storage
Logic Flow:
IF Equipment initial and number are available from N7 segment
AND The system prepares car identification for database storage
THEN:
- • The car ID is formatted into standardized database format combining equipment initial and number
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when complete foreign cargo record has been constructed with all required information.
Trigger Criteria:
- Context: A complete foreign cargo record has been constructed with all required information
- Applied to: Insert New Cargo Record into Database
- Action: The system performs database insertion
Logic Flow:
IF A complete foreign cargo record has been constructed with all required information
AND The system performs database insertion
THEN:
- • The new cargo record is successfully inserted into the cargo database
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record insertion has been attempted.
Trigger Criteria:
- Context: A cargo record insertion has been attempted
- Applied to: Validate Record Creation
- Action: The system checks the insertion result
Logic Flow:
IF A cargo record insertion has been attempted
AND The system checks the insertion result
THEN:
- • The system confirms successful record creation or identifies creation failures
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when foreign cargo record has been successfully created.
Trigger Criteria:
- Context: A foreign cargo record has been successfully created
- Applied to: Log Foreign Cargo Creation
- Action: The system completes the cargo creation process
Logic Flow:
IF A foreign cargo record has been successfully created
AND The system completes the cargo creation process
THEN:
- • The cargo creation event is logged with relevant details for audit and tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when all foreign cargo creation steps have been completed.
Trigger Criteria:
- Context: All foreign cargo creation steps have been completed
- Applied to: Foreign Cargo Record Created Successfully
- Action: The system finalizes the cargo creation process
Logic Flow:
IF All foreign cargo creation steps have been completed
AND The system finalizes the cargo creation process
THEN:
- • The system confirms successful creation of the foreign cargo record and makes it available for further processing
R-GCX016E-cbl-01818 (+7) File: GCX016E.cbl Business Rule: Car ID Formatting and Validation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when n7 segment contains equipment initial and equipment number.
Trigger Criteria:
- Context: An N7 segment contains equipment initial and equipment number
- Applied to: Apply Standard Formatting Rules
- Action: The system processes the N7 segment for car ID formatting
Logic Flow:
IF An N7 segment contains equipment initial and equipment number
AND The system processes the N7 segment for car ID formatting
THEN:
- • The equipment initial and number are concatenated and formatted into a standardized car ID format
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when formatted car id from equipment initial and number.
Trigger Criteria:
- Context: A formatted car ID from equipment initial and number
- Applied to: Validate Car ID Length and Characters
- Action: The system validates the car ID format
Logic Flow:
IF A formatted car ID from equipment initial and number
AND The system validates the car ID format
THEN:
- • The car ID must meet specified length requirements and contain only valid characters
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record with traffic type information.
Trigger Criteria:
- Context: A cargo record with traffic type information
- Applied to: CPRS Traffic?
- Action: The system checks if the cargo is CPRS traffic
Logic Flow:
IF A cargo record with traffic type information
AND The system checks if the cargo is CPRS traffic
THEN:
- • The system identifies whether CPRS-specific formatting rules should be applied
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when car id that belongs to cprs traffic type.
Trigger Criteria:
- Context: A car ID that belongs to CPRS traffic type
- Applied to: Apply CPRS Specific Formatting
- Action: The system applies CPRS-specific formatting rules
Logic Flow:
IF A car ID that belongs to CPRS traffic type
AND The system applies CPRS-specific formatting rules
THEN:
- • The car ID is formatted according to CPRS business requirements which may clear or modify the standard car ID format
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when car id that is not cprs traffic type.
Trigger Criteria:
- Context: A car ID that is not CPRS traffic type
- Applied to: Apply Standard Formatting
- Action: The system applies standard formatting rules
Logic Flow:
IF A car ID that is not CPRS traffic type
AND The system applies standard formatting rules
THEN:
- • The car ID is formatted using standard business formatting requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when properly formatted and validated car id.
Trigger Criteria:
- Context: A properly formatted and validated car ID
- Applied to: Update Car ID in Cargo Record
- Action: The system updates the cargo record
Logic Flow:
IF A properly formatted and validated car ID
AND The system updates the cargo record
THEN:
- • The car ID information is stored in the cargo record for future processing and tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when car id that fails format validation.
Trigger Criteria:
- Context: A car ID that fails format validation
- Applied to: Generate Format Error
- Action: The system detects invalid car ID format
Logic Flow:
IF A car ID that fails format validation
AND The system detects invalid car ID format
THEN:
- • An appropriate format error is generated to indicate the car ID formatting issue
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when completed car id formatting process.
Trigger Criteria:
- Context: A completed car ID formatting process
- Applied to: Log Formatting Action
- Action: The system completes car ID formatting (successful or with errors)
Logic Flow:
IF A completed car ID formatting process
AND The system completes car ID formatting (successful or with errors)
THEN:
- • The formatting action and results are logged for audit trail and troubleshooting purposes
R-GCX016E-cbl-01826 (+10) File: GCX016E.cbl Business Rule: Bond Information Clearing Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo is being processed with disposition codes.
Trigger Criteria:
- Context: A cargo is being processed with disposition codes
- Applied to: Cargo Disposition Code Processing
- Action: The disposition code is 95
Logic Flow:
IF A cargo is being processed with disposition codes
AND The disposition code is 95
THEN:
- • The system should initiate bond information clearing process
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code 95 has been identified for processing.
Trigger Criteria:
- Context: Disposition code 95 has been identified for processing
- Applied to: Validate DC95 Authorization
- Action: The system validates the authorization for DC95
Logic Flow:
IF Disposition code 95 has been identified for processing
AND The system validates the authorization for DC95
THEN:
- • The system should verify the disposition code is valid and authorized before proceeding with bond clearing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when dc95 authorization has been validated.
Trigger Criteria:
- Context: DC95 authorization has been validated
- Applied to: Clear BOL Type Code
- Action: The system processes bond information clearing
Logic Flow:
IF DC95 authorization has been validated
AND The system processes bond information clearing
THEN:
- • The BOL type code field should be cleared or set to blank
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when bol type code has been cleared.
Trigger Criteria:
- Context: BOL type code has been cleared
- Applied to: Clear M12 Data
- Action: The system continues bond information clearing
Logic Flow:
IF BOL type code has been cleared
AND The system continues bond information clearing
THEN:
- • All M12 data fields should be cleared or reset to initial values
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when m12 data has been cleared.
Trigger Criteria:
- Context: M12 data has been cleared
- Applied to: Clear Bond Number Index
- Action: The system processes bond number clearing
Logic Flow:
IF M12 data has been cleared
AND The system processes bond number clearing
THEN:
- • The bond number index field should be cleared or set to zero
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when bond number index has been cleared.
Trigger Criteria:
- Context: Bond number index has been cleared
- Applied to: Clear Broker QP Information
- Action: The system processes broker information clearing
Logic Flow:
IF Bond number index has been cleared
AND The system processes broker information clearing
THEN:
- • All broker QP (Qualified Person) information fields should be cleared
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when broker qp information has been cleared.
Trigger Criteria:
- Context: Broker QP information has been cleared
- Applied to: Clear Bond Owner Information
- Action: The system processes bond owner clearing
Logic Flow:
IF Broker QP information has been cleared
AND The system processes bond owner clearing
THEN:
- • All bond owner information fields should be cleared or reset
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all bond information has been cleared.
Trigger Criteria:
- Context: All bond information has been cleared
- Applied to: Log Bond Clearing Action
- Action: The system completes bond clearing process
Logic Flow:
IF All bond information has been cleared
AND The system completes bond clearing process
THEN:
- • A log entry should be created documenting the bond clearing action with relevant details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when bond clearing action has been logged.
Trigger Criteria:
- Context: Bond clearing action has been logged
- Applied to: Update Cargo Status
- Action: The system updates cargo status
Logic Flow:
IF Bond clearing action has been logged
AND The system updates cargo status
THEN:
- • The cargo status should be updated to reflect that bond information has been cleared
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo status has been updated after bond clearing.
Trigger Criteria:
- Context: Cargo status has been updated after bond clearing
- Applied to: Generate Cancellation Notification
- Action: The system generates notifications
Logic Flow:
IF Cargo status has been updated after bond clearing
AND The system generates notifications
THEN:
- • A cancellation notification should be generated and sent to appropriate recipients regarding the bond clearing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when bond clearing operations have been completed or disposition code is not 95.
Trigger Criteria:
- Context: Bond clearing operations have been completed OR disposition code is not 95
- Applied to: Continue Cargo Processing
- Action: The system continues cargo processing
Logic Flow:
IF Bond clearing operations have been completed OR disposition code is not 95
AND The system continues cargo processing
THEN:
- • Normal cargo processing workflow should continue with the next processing steps
R-GCX016E-cbl-01847 (+12) File: GCX016E.cbl Business Rule: Entry Type Code Conversion Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when x4 segment is being processed for cargo disposition.
Trigger Criteria:
- Context: An X4 segment is being processed for cargo disposition
- Applied to: Entry Type Code Present?
- Action: The system checks for the presence of an entry type code in the segment
Logic Flow:
IF An X4 segment is being processed for cargo disposition
AND The system checks for the presence of an entry type code in the segment
THEN:
- • If entry type code is present, proceed to lookup conversion; if not present, skip entry type processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when edi entry type code is present in the x4 segment.
Trigger Criteria:
- Context: An EDI entry type code is present in the X4 segment
- Applied to: Lookup Entry Type in Conversion Array
- Action: The system searches the entry type conversion arrays for a matching EDI code
Logic Flow:
IF An EDI entry type code is present in the X4 segment
AND The system searches the entry type conversion arrays for a matching EDI code
THEN:
- • Return the corresponding internal system entry type value if found in the conversion arrays
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when entry type code lookup has been performed in conversion arrays.
Trigger Criteria:
- Context: Entry type code lookup has been performed in conversion arrays
- Applied to: Valid Entry Type Found?
- Action: The system evaluates the lookup result
Logic Flow:
IF Entry type code lookup has been performed in conversion arrays
AND The system evaluates the lookup result
THEN:
- • If valid entry type found, proceed with conversion; if invalid, generate error; if not found, use default value
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid entry type code has been found in the conversion arrays.
Trigger Criteria:
- Context: A valid entry type code has been found in the conversion arrays
- Applied to: Convert EDI Code to Internal System Value
- Action: The system performs the conversion from EDI format to internal format
Logic Flow:
IF A valid entry type code has been found in the conversion arrays
AND The system performs the conversion from EDI format to internal format
THEN:
- • The EDI entry type code is converted to the corresponding internal system entry type value
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when entry type code has been successfully converted to internal system value.
Trigger Criteria:
- Context: An entry type code has been successfully converted to internal system value
- Applied to: Entry Type = 61, 62, 63, or 69?
- Action: The system checks if the entry type is 61, 62, 63, or 69
Logic Flow:
IF An entry type code has been successfully converted to internal system value
AND The system checks if the entry type is 61, 62, 63, or 69
THEN:
- • If entry type matches any of these values, set master in-bond flag;
otherwise continue to border crossing check
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when entry type is identified as 61, 62, 63, or 69.
Trigger Criteria:
- Context: The entry type is identified as 61, 62, 63, or 69
- Applied to: Set Master In-Bond Flag
- Action: The system processes the in-bond entry type
Logic Flow:
IF The entry type is identified as 61, 62, 63, or 69
AND The system processes the in-bond entry type
THEN:
- • Set the master in-bond flag to indicate special in-bond processing is required
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when entry type conversion has been completed.
Trigger Criteria:
- Context: Entry type conversion has been completed
- Applied to: Border Crossing Scenario?
- Action: The system evaluates if this is a border crossing scenario
Logic Flow:
IF Entry type conversion has been completed
AND The system evaluates if this is a border crossing scenario
THEN:
- • If border crossing scenario detected, apply special border crossing rules;
otherwise update cargo record directly
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when border crossing scenario has been detected.
Trigger Criteria:
- Context: A border crossing scenario has been detected
- Applied to: Apply Special Border Crossing Rules
- Action: The system applies special border crossing processing rules
Logic Flow:
IF A border crossing scenario has been detected
AND The system applies special border crossing processing rules
THEN:
- • Execute border crossing specific logic before updating the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when entry type conversion is complete and any special rules have been applied.
Trigger Criteria:
- Context: Entry type conversion is complete and any special rules have been applied
- Applied to: Update Cargo Record with Converted Entry Type
- Action: The system updates the cargo record
Logic Flow:
IF Entry type conversion is complete and any special rules have been applied
AND The system updates the cargo record
THEN:
- • Store the converted entry type value in the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when entry type conversion and cargo record update are complete.
Trigger Criteria:
- Context: Entry type conversion and cargo record update are complete
- Applied to: Log Entry Type Conversion Action
- Action: The system performs logging operations
Logic Flow:
IF Entry type conversion and cargo record update are complete
AND The system performs logging operations
THEN:
- • Create a log entry documenting the entry type conversion action
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when entry type code lookup did not find a valid conversion.
Trigger Criteria:
- Context: Entry type code lookup did not find a valid conversion
- Applied to: Use Default Entry Type Value
- Action: The system needs to assign an entry type value
Logic Flow:
IF Entry type code lookup did not find a valid conversion
AND The system needs to assign an entry type value
THEN:
- • Use the default entry type value and proceed with cargo record update
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when entry type code is present but invalid or conversion fails.
Trigger Criteria:
- Context: Entry type code is present but invalid or conversion fails
- Applied to: Generate Entry Type Conversion Error
- Action: The system encounters an invalid entry type code
Logic Flow:
IF Entry type code is present but invalid or conversion fails
AND The system encounters an invalid entry type code
THEN:
- • Generate an entry type conversion error and continue processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when no entry type code is present in the x4 segment.
Trigger Criteria:
- Context: No entry type code is present in the X4 segment
- Applied to: Skip Entry Type Processing
- Action: The system evaluates entry type processing requirements
Logic Flow:
IF No entry type code is present in the X4 segment
AND The system evaluates entry type processing requirements
THEN:
- • Skip all entry type conversion processing and continue to next processing step
R-GCX016E-cbl-01860 (+7) File: GCX016E.cbl Business Rule: Master In
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when x4 segment is being processed and contains an entry type code.
Trigger Criteria:
- Context: An X4 segment is being processed and contains an entry type code
- Applied to: Set Master In-Bond Flag for Code 61
- Action: The entry type code value is 61
Logic Flow:
IF An X4 segment is being processed and contains an entry type code
AND The entry type code value is 61
THEN:
- • The master in-bond flag is set for entry type code 61 and the cargo record is updated with master in-bond status
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when x4 segment is being processed and contains an entry type code.
Trigger Criteria:
- Context: An X4 segment is being processed and contains an entry type code
- Applied to: Set Master In-Bond Flag for Code 62
- Action: The entry type code value is 62
Logic Flow:
IF An X4 segment is being processed and contains an entry type code
AND The entry type code value is 62
THEN:
- • The master in-bond flag is set for entry type code 62 and the cargo record is updated with master in-bond status
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when x4 segment is being processed and contains an entry type code.
Trigger Criteria:
- Context: An X4 segment is being processed and contains an entry type code
- Applied to: Set Master In-Bond Flag for Code 63
- Action: The entry type code value is 63
Logic Flow:
IF An X4 segment is being processed and contains an entry type code
AND The entry type code value is 63
THEN:
- • The master in-bond flag is set for entry type code 63 and the cargo record is updated with master in-bond status
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when x4 segment is being processed and contains an entry type code.
Trigger Criteria:
- Context: An X4 segment is being processed and contains an entry type code
- Applied to: Set Master In-Bond Flag for Code 69
- Action: The entry type code value is 69
Logic Flow:
IF An X4 segment is being processed and contains an entry type code
AND The entry type code value is 69
THEN:
- • The master in-bond flag is set for entry type code 69 and the cargo record is updated with master in-bond status
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when x4 segment is being processed for master in-bond flag setting.
Trigger Criteria:
- Context: An X4 segment is being processed for master in-bond flag setting
- Applied to: Entry Type Code Present?
- Action: The system checks for the presence of an entry type code
Logic Flow:
IF An X4 segment is being processed for master in-bond flag setting
AND The system checks for the presence of an entry type code
THEN:
- • If entry type code is present, retrieve and evaluate the code value,
otherwise continue with standard entry processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when x4 segment is being processed.
Trigger Criteria:
- Context: An X4 segment is being processed
- Applied to: Continue with Standard Entry Processing
- Action: The entry type code is not present or the entry type code value is not 61, 62, 63, or 69
Logic Flow:
IF An X4 segment is being processed
AND The entry type code is not present or the entry type code value is not 61, 62, 63, or 69
THEN:
- • Continue with standard entry processing without setting master in-bond flags
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when master in-bond flag has been set for entry type codes 61, 62, 63, or 69.
Trigger Criteria:
- Context: A master in-bond flag has been set for entry type codes 61, 62, 63, or 69
- Applied to: Update Cargo Record with Master In-Bond Status
- Action: The cargo record needs to be updated with the master in-bond status
Logic Flow:
IF A master in-bond flag has been set for entry type codes 61, 62, 63, or 69
AND The cargo record needs to be updated with the master in-bond status
THEN:
- • The cargo record is updated to reflect the master in-bond status for the specific entry type code
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when master in-bond flag has been set and cargo record has been updated.
Trigger Criteria:
- Context: A master in-bond flag has been set and cargo record has been updated
- Applied to: Log Master In-Bond Flag Setting Action
- Action: The master in-bond flag setting action needs to be logged
Logic Flow:
IF A master in-bond flag has been set and cargo record has been updated
AND The master in-bond flag setting action needs to be logged
THEN:
- • The system logs the master in-bond flag setting action for audit trail purposes
R-GCX016E-cbl-01868 (+10) File: GCX016E.cbl Business Rule: Canadian Border Port Name Mapping
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record with location and routing data is being processed.
Trigger Criteria:
- Context: A cargo record with location and routing data is being processed
- Applied to: Is Cargo Cross-Border?
- Action: The system evaluates cargo characteristics for cross-border requirements
Logic Flow:
IF A cargo record with location and routing data is being processed
AND The system evaluates cargo characteristics for cross-border requirements
THEN:
- • The cargo is identified as cross-border if it meets the criteria for international movement between US and Canadian borders
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cross-border cargo with location data containing us port information.
Trigger Criteria:
- Context: Cross-border cargo with location data containing US port information
- Applied to: Extract US Port Code from Location Data
- Action: The system processes the cargo location data
Logic Flow:
IF Cross-border cargo with location data containing US port information
AND The system processes the cargo location data
THEN:
- • The US port code is extracted from the location data for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when us port code has been extracted from cargo location data.
Trigger Criteria:
- Context: A US port code has been extracted from cargo location data
- Applied to: Access Canadian Border Mapping Table
- Action: The system needs to find the corresponding Canadian border port name
Logic Flow:
IF A US port code has been extracted from cargo location data
AND The system needs to find the corresponding Canadian border port name
THEN:
- • The Canadian border mapping table is accessed for port code lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when us port code and access to the canadian border mapping table.
Trigger Criteria:
- Context: A US port code and access to the Canadian border mapping table
- Applied to: US Port Code Found in Mapping?
- Action: The system searches for the US port code in the mapping table
Logic Flow:
IF A US port code and access to the Canadian border mapping table
AND The system searches for the US port code in the mapping table
THEN:
- • The system determines if a valid mapping exists for the port code
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when us port code that exists in the canadian border mapping table.
Trigger Criteria:
- Context: A US port code that exists in the Canadian border mapping table
- Applied to: Retrieve Canadian Border Port Name
- Action: The system finds a valid mapping entry
Logic Flow:
IF A US port code that exists in the Canadian border mapping table
AND The system finds a valid mapping entry
THEN:
- • The corresponding Canadian border port name is retrieved from the mapping table
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when canadian border port name has been successfully retrieved from the mapping table.
Trigger Criteria:
- Context: A Canadian border port name has been successfully retrieved from the mapping table
- Applied to: Set Canadian Border Location for Cargo
- Action: The system processes the mapping result
Logic Flow:
IF A Canadian border port name has been successfully retrieved from the mapping table
AND The system processes the mapping result
THEN:
- • The Canadian border location is set in the cargo record for cross-border processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo with a set canadian border location.
Trigger Criteria:
- Context: Cargo with a set Canadian border location
- Applied to: Update Cargo Routing Information
- Action: The system updates cargo routing information
Logic Flow:
IF Cargo with a set Canadian border location
AND The system updates cargo routing information
THEN:
- • The routing information is updated to include the Canadian border location for proper cargo flow
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo with updated routing information including canadian border location.
Trigger Criteria:
- Context: Cargo with updated routing information including Canadian border location
- Applied to: Log Border Crossing Information
- Action: The system completes the border location assignment
Logic Flow:
IF Cargo with updated routing information including Canadian border location
AND The system completes the border location assignment
THEN:
- • Border crossing information is logged for audit trail and cargo tracking purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when us port code that does not exist in the canadian border mapping table.
Trigger Criteria:
- Context: A US port code that does not exist in the Canadian border mapping table
- Applied to: Use Default Border Location
- Action: The system cannot find a valid mapping for the port code
Logic Flow:
IF A US port code that does not exist in the Canadian border mapping table
AND The system cannot find a valid mapping for the port code
THEN:
- • A default border location is assigned to ensure cargo processing can continue
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when us port code with no mapping found and default border location being used.
Trigger Criteria:
- Context: A US port code with no mapping found and default border location being used
- Applied to: Generate Warning Message
- Action: The system assigns the default border location
Logic Flow:
IF A US port code with no mapping found and default border location being used
AND The system assigns the default border location
THEN:
- • A warning message is generated to alert users about the missing port code mapping
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo with either mapped canadian border location or default border location assigned.
Trigger Criteria:
- Context: Cargo with either mapped Canadian border location or default border location assigned
- Applied to: Continue Cargo Processing
- Action: Border location processing is complete
Logic Flow:
IF Cargo with either mapped Canadian border location or default border location assigned
AND Border location processing is complete
THEN:
- • The system continues with normal cargo processing workflow
R-GCX016E-cbl-01879 (+7) File: GCX016E.cbl Business Rule: FDA Reference Number Formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when n9 reference segment is received with a1 disposition code.
Trigger Criteria:
- Context: An N9 reference segment is received with A1 disposition code
- Applied to: A1 Disposition Code Processing
- Action: The system processes the FDA reference number formatting
Logic Flow:
IF An N9 reference segment is received with A1 disposition code
AND The system processes the FDA reference number formatting
THEN:
- • The FDA reference number should be prefixed with 'FDA PN' and properly formatted
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when n9 reference segment is received with a3 disposition code.
Trigger Criteria:
- Context: An N9 reference segment is received with A3 disposition code
- Applied to: A3 Disposition Code Processing
- Action: The system processes the FDA reference number formatting
Logic Flow:
IF An N9 reference segment is received with A3 disposition code
AND The system processes the FDA reference number formatting
THEN:
- • The FDA reference number should be prefixed with 'FDA' and properly formatted
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when n9 reference segment with disposition code is being processed.
Trigger Criteria:
- Context: An N9 reference segment with disposition code is being processed
- Applied to: Disposition Code Type?
- Action: The system evaluates the disposition code type
Logic Flow:
IF An N9 reference segment with disposition code is being processed
AND The system evaluates the disposition code type
THEN:
- • The system should route to A1 processing if A1 code or A3 processing if A3 code
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when n9 segment is being processed for fda reference formatting.
Trigger Criteria:
- Context: An N9 segment is being processed for FDA reference formatting
- Applied to: Existing FDA Data Found?
- Action: Existing FDA data is found in the segment
Logic Flow:
IF An N9 segment is being processed for FDA reference formatting
AND Existing FDA data is found in the segment
THEN:
- • The original FDA information should be preserved and not overwritten
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when n9 segment is being processed and no existing fda data is found.
Trigger Criteria:
- Context: An N9 segment is being processed and no existing FDA data is found
- Applied to: Create New FDA Reference Entry
- Action: The system creates a new FDA reference entry
Logic Flow:
IF An N9 segment is being processed and no existing FDA data is found
AND The system creates a new FDA reference entry
THEN:
- • A new FDA reference entry should be created with appropriate prefix formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when n9 segment contains existing data that needs fda prefix formatting.
Trigger Criteria:
- Context: An N9 segment contains existing data that needs FDA prefix formatting
- Applied to: Reposition Existing N9 Data
- Action: The system repositions the existing N9 data
Logic Flow:
IF An N9 segment contains existing data that needs FDA prefix formatting
AND The system repositions the existing N9 data
THEN:
- • The existing data should be moved to appropriate positions to make room for FDA prefix
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when fda reference number has been formatted with appropriate prefix.
Trigger Criteria:
- Context: An FDA reference number has been formatted with appropriate prefix
- Applied to: Validate FDA Reference Number Format
- Action: The system validates the FDA reference number format
Logic Flow:
IF An FDA reference number has been formatted with appropriate prefix
AND The system validates the FDA reference number format
THEN:
- • The FDA reference number format should be verified as compliant with regulatory standards
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when fda reference data has been formatted and validated.
Trigger Criteria:
- Context: FDA reference data has been formatted and validated
- Applied to: Update N9 Segment with Formatted Data
- Action: The system updates the N9 segment with formatted data
Logic Flow:
IF FDA reference data has been formatted and validated
AND The system updates the N9 segment with formatted data
THEN:
- • The N9 segment should contain the properly formatted FDA reference information
R-GCX016E-cbl-01887 (+9) File: GCX016E.cbl Business Rule: N9 Reference Segment Management
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is being processed for n9 reference segment management.
Trigger Criteria:
- Context: A disposition code is being processed for N9 reference segment management
- Applied to: FDA Disposition Code?
- Action: The system evaluates the disposition code type
Logic Flow:
IF A disposition code is being processed for N9 reference segment management
AND The system evaluates the disposition code type
THEN:
- • The system routes to A1 code processing if disposition code is A1, routes to A3 code processing if disposition code is A3, or exits processing for any other disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when a1 disposition code is being processed.
Trigger Criteria:
- Context: An A1 disposition code is being processed
- Applied to: Format FDA PN Prefix for A1
- Action: The system formats the FDA reference prefix
Logic Flow:
IF An A1 disposition code is being processed
AND The system formats the FDA reference prefix
THEN:
- • The system creates a PN prefix format for the FDA reference number
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when a3 disposition code is being processed.
Trigger Criteria:
- Context: An A3 disposition code is being processed
- Applied to: Format FDA Prefix for A3
- Action: The system formats the FDA reference prefix
Logic Flow:
IF An A3 disposition code is being processed
AND The system formats the FDA reference prefix
THEN:
- • The system creates a standard FDA prefix format for the reference number
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when system has retrieved existing n9 reference data from the database.
Trigger Criteria:
- Context: The system has retrieved existing N9 reference data from the database
- Applied to: N9 Segment Exists?
- Action: The system checks for N9 segment existence
Logic Flow:
IF The system has retrieved existing N9 reference data from the database
AND The system checks for N9 segment existence
THEN:
- • The system creates a new N9 segment if none exists, or updates the existing N9 segment if one is found
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when fda reference number has been formatted with the appropriate prefix.
Trigger Criteria:
- Context: An FDA reference number has been formatted with the appropriate prefix
- Applied to: Reference Number Valid?
- Action: The system validates the reference number format
Logic Flow:
IF An FDA reference number has been formatted with the appropriate prefix
AND The system validates the reference number format
THEN:
- • The system proceeds with FDA reference information setting if the format is valid, or completes processing without updates if the format is invalid
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when no existing n9 segment is found in the database.
Trigger Criteria:
- Context: No existing N9 segment is found in the database
- Applied to: Create New N9 Segment
- Action: The system processes the FDA reference information
Logic Flow:
IF No existing N9 segment is found in the database
AND The system processes the FDA reference information
THEN:
- • The system creates a new N9 segment with the formatted FDA reference data
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when existing n9 segment is found in the database.
Trigger Criteria:
- Context: An existing N9 segment is found in the database
- Applied to: Update Existing N9 Segment
- Action: The system processes new FDA reference information
Logic Flow:
IF An existing N9 segment is found in the database
AND The system processes new FDA reference information
THEN:
- • The system updates the existing N9 segment with the new reference data
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when fda reference number format has been validated as correct.
Trigger Criteria:
- Context: The FDA reference number format has been validated as correct
- Applied to: Set FDA Reference Information
- Action: The system processes the reference information
Logic Flow:
IF The FDA reference number format has been validated as correct
AND The system processes the reference information
THEN:
- • The system sets the FDA reference information in the N9 segment for database replacement
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when fda reference information has been set in the n9 segment.
Trigger Criteria:
- Context: The FDA reference information has been set in the N9 segment
- Applied to: Replace N9 Segment in Database
- Action: The system performs database operations
Logic Flow:
IF The FDA reference information has been set in the N9 segment
AND The system performs database operations
THEN:
- • The system replaces the N9 segment in the database with the updated reference information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when n9 segment has been successfully replaced in the database.
Trigger Criteria:
- Context: The N9 segment has been successfully replaced in the database
- Applied to: Log N9 Reference Update
- Action: The system completes the reference update process
Logic Flow:
IF The N9 segment has been successfully replaced in the database
AND The system completes the reference update process
THEN:
- • The system logs the N9 reference update activity for audit trail maintenance
R-GCX016E-cbl-01897 (+17) File: GCX016E.cbl Business Rule: Cargo Database Retrieval by Bond Index
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo retrieval request is initiated.
Trigger Criteria:
- Context: A cargo retrieval request is initiated
- Applied to: Receive Bond Number as Input
- Action: The system receives the bond number parameter
Logic Flow:
IF A cargo retrieval request is initiated
AND The system receives the bond number parameter
THEN:
- • The bond number must be present and not empty to proceed with cargo search
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid bond number is received.
Trigger Criteria:
- Context: A valid bond number is received
- Applied to: Initialize Bond Search Parameters
- Action: The system prepares to search for cargo records
Logic Flow:
IF A valid bond number is received
AND The system prepares to search for cargo records
THEN:
- • Search parameters including bond index key and search criteria must be initialized with proper values
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when bond search parameters are properly initialized. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Bond search parameters are properly initialized
- Applied to: Call GCCUSIO2 with Bond Index
- Action: The system needs to retrieve cargo records for a specific bond
Logic Flow:
IF Bond search parameters are properly initialized
AND The system needs to retrieve cargo records for a specific bond
THEN:
- • GCCUSIO2 module must be called with bond index parameters to access the cargo database
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when database search has been performed using bond index.
Trigger Criteria:
- Context: A database search has been performed using bond index
- Applied to: Cargo Record Found?
- Action: The system evaluates the search results
Logic Flow:
IF A database search has been performed using bond index
AND The system evaluates the search results
THEN:
- • If no cargo records are found for the bond number, return 'No Records Found' status,
otherwise proceed to retrieve the first record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when at least one cargo record exists for the bond number.
Trigger Criteria:
- Context: At least one cargo record exists for the bond number
- Applied to: Retrieve First Cargo Record
- Action: The system begins cargo record processing
Logic Flow:
IF At least one cargo record exists for the bond number
AND The system begins cargo record processing
THEN:
- • The first cargo record associated with the bond must be retrieved and made available for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record has been retrieved from the database.
Trigger Criteria:
- Context: A cargo record has been retrieved from the database
- Applied to: Check Status Code
- Action: The system examines the record's status code
Logic Flow:
IF A cargo record has been retrieved from the database
AND The system examines the record's status code
THEN:
- • The status code must be valid and indicate an active, processable record state
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record has been retrieved and status code checked.
Trigger Criteria:
- Context: A cargo record has been retrieved and status code checked
- Applied to: Status Code Valid?
- Action: The status code is invalid or indicates an inactive record
Logic Flow:
IF A cargo record has been retrieved and status code checked
AND The status code is invalid or indicates an inactive record
THEN:
- • Return 'Invalid Status' error and do not process the record further
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record with valid status code has been retrieved.
Trigger Criteria:
- Context: A cargo record with valid status code has been retrieved
- Applied to: Load Cargo Data into Working Storage
- Action: The system needs to process the cargo data
Logic Flow:
IF A cargo record with valid status code has been retrieved
AND The system needs to process the cargo data
THEN:
- • All relevant cargo information must be loaded into working storage areas for subsequent processing operations
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when first cargo record for a bond has been processed.
Trigger Criteria:
- Context: The first cargo record for a bond has been processed
- Applied to: Check for Additional Records
- Action: The system checks for additional records
Logic Flow:
IF The first cargo record for a bond has been processed
AND The system checks for additional records
THEN:
- • The system must determine if more cargo records exist for the same bond number
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when system has checked for additional bond records.
Trigger Criteria:
- Context: The system has checked for additional bond records
- Applied to: More Records with Same Bond?
- Action: Multiple records exist for the same bond number
Logic Flow:
IF The system has checked for additional bond records
AND Multiple records exist for the same bond number
THEN:
- • Continue to retrieve and process the next record,
otherwise complete the bond index retrieval process
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when additional cargo records exist for the current bond number.
Trigger Criteria:
- Context: Additional cargo records exist for the current bond number
- Applied to: Retrieve Next Cargo Record
- Action: The system continues processing multiple bond records
Logic Flow:
IF Additional cargo records exist for the current bond number
AND The system continues processing multiple bond records
THEN:
- • The next cargo record in the sequence must be retrieved from the database
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when additional cargo record has been retrieved for the bond.
Trigger Criteria:
- Context: An additional cargo record has been retrieved for the bond
- Applied to: Validate Record Status
- Action: The system validates the record before processing
Logic Flow:
IF An additional cargo record has been retrieved for the bond
AND The system validates the record before processing
THEN:
- • The record status must be checked to ensure it represents an active, processable cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record status has been validated.
Trigger Criteria:
- Context: A cargo record status has been validated
- Applied to: Record Status Active?
- Action: The system evaluates whether the record is active
Logic Flow:
IF A cargo record status has been validated
AND The system evaluates whether the record is active
THEN:
- • If the record status is active, add it to the cargo processing list,
otherwise skip to the next record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record has been validated as active.
Trigger Criteria:
- Context: A cargo record has been validated as active
- Applied to: Add to Cargo Processing List
- Action: The record needs to be included in processing
Logic Flow:
IF A cargo record has been validated as active
AND The record needs to be included in processing
THEN:
- • The cargo record must be added to the cargo processing list for further business rule application
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record has been determined to be inactive.
Trigger Criteria:
- Context: A cargo record has been determined to be inactive
- Applied to: Continue to Next Record
- Action: The system processes multiple records for a bond
Logic Flow:
IF A cargo record has been determined to be inactive
AND The system processes multiple records for a bond
THEN:
- • Skip the inactive record and continue processing the next record in the sequence
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all cargo records for a bond number have been processed.
Trigger Criteria:
- Context: All cargo records for a bond number have been processed
- Applied to: Complete Bond Index Retrieval
- Action: No more records exist for the current bond
Logic Flow:
IF All cargo records for a bond number have been processed
AND No more records exist for the current bond
THEN:
- • Complete the bond index retrieval operation and return the processed cargo list
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when bond number search has been performed.
Trigger Criteria:
- Context: A bond number search has been performed
- Applied to: Return No Records Found
- Action: No cargo records are found for the specified bond
Logic Flow:
IF A bond number search has been performed
AND No cargo records are found for the specified bond
THEN:
- • Return 'No Records Found' status to indicate that no cargo exists for the bond number
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo records have been retrieved for a bond number.
Trigger Criteria:
- Context: Cargo records have been retrieved for a bond number
- Applied to: Return Error - Invalid Status
- Action: The records contain invalid or unprocessable status codes
Logic Flow:
IF Cargo records have been retrieved for a bond number
AND The records contain invalid or unprocessable status codes
THEN:
- • Return 'Invalid Status' error to indicate that the cargo records cannot be processed due to status issues
R-GCX016E-cbl-01915 (+12) File: GCX016E.cbl Business Rule: Cargo Database Retrieval by Car/Waybill Index
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record contains equipment initial and equipment number from n7 segment.
Trigger Criteria:
- Context: A cargo record contains equipment initial and equipment number from N7 segment
- Applied to: Format Car ID for Search
- Action: The system needs to create a car ID for database search
Logic Flow:
IF A cargo record contains equipment initial and equipment number from N7 segment
AND The system needs to create a car ID for database search
THEN:
- • The system concatenates equipment initial and equipment number to form the car ID search key
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when formatted car id and a waybill number are available.
Trigger Criteria:
- Context: A formatted car ID and a waybill number are available
- Applied to: Combine Car ID and Waybill as Search Key
- Action: The system prepares to search for cargo records
Logic Flow:
IF A formatted car ID and a waybill number are available
AND The system prepares to search for cargo records
THEN:
- • The system combines car ID and waybill into a single composite search key
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when composite search key containing car id and waybill is prepared. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A composite search key containing car ID and waybill is prepared
- Applied to: Call GCCUSIO2 Database Lookup
- Action: The system needs to retrieve cargo records from the database
Logic Flow:
IF A composite search key containing car ID and waybill is prepared
AND The system needs to retrieve cargo records from the database
THEN:
- • The system calls GCCUSIO2 service with the search key to perform the database lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when database lookup has been performed using car id and waybill search key.
Trigger Criteria:
- Context: A database lookup has been performed using car ID and waybill search key
- Applied to: Cargo Record Found?
- Action: The system evaluates the lookup results
Logic Flow:
IF A database lookup has been performed using car ID and waybill search key
AND The system evaluates the lookup results
THEN:
- • The system determines if at least one matching cargo record was found and proceeds accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when database lookup has returned one or more matching cargo records.
Trigger Criteria:
- Context: Database lookup has returned one or more matching cargo records
- Applied to: Retrieve First Cargo Record
- Action: The system begins processing the found records
Logic Flow:
IF Database lookup has returned one or more matching cargo records
AND The system begins processing the found records
THEN:
- • The system retrieves and loads the first cargo record from the result set
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when first cargo record has been retrieved successfully.
Trigger Criteria:
- Context: The first cargo record has been retrieved successfully
- Applied to: Check for Additional Records
- Action: The system evaluates the complete result set
Logic Flow:
IF The first cargo record has been retrieved successfully
AND The system evaluates the complete result set
THEN:
- • The system checks if more records exist with the same car ID and waybill combination
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when at least one cargo record has been processed.
Trigger Criteria:
- Context: At least one cargo record has been processed
- Applied to: More Records with Same Car/Waybill?
- Action: The system checks for additional matching records
Logic Flow:
IF At least one cargo record has been processed
AND The system checks for additional matching records
THEN:
- • The system determines if more records with identical car ID and waybill exist and routes processing accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when additional cargo records exist with the same car id and waybill.
Trigger Criteria:
- Context: Additional cargo records exist with the same car ID and waybill
- Applied to: Retrieve Subsequent Records
- Action: The system continues processing the record set
Logic Flow:
IF Additional cargo records exist with the same car ID and waybill
AND The system continues processing the record set
THEN:
- • The system retrieves the next cargo record in the sequence
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record has been retrieved from the database.
Trigger Criteria:
- Context: A cargo record has been retrieved from the database
- Applied to: Validate Record Status
- Action: The system evaluates the record for processing eligibility
Logic Flow:
IF A cargo record has been retrieved from the database
AND The system evaluates the record for processing eligibility
THEN:
- • The system validates the record status to ensure it meets processing criteria
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record has undergone status validation.
Trigger Criteria:
- Context: A cargo record has undergone status validation
- Applied to: Record Valid?
- Action: The system evaluates the validation results
Logic Flow:
IF A cargo record has undergone status validation
AND The system evaluates the validation results
THEN:
- • The system decides whether the record is valid for processing or should be skipped
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record has passed validation checks.
Trigger Criteria:
- Context: A cargo record has passed validation checks
- Applied to: Add to Processing List
- Action: The system processes valid records
Logic Flow:
IF A cargo record has passed validation checks
AND The system processes valid records
THEN:
- • The system adds the valid cargo record to the processing list for further operations
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record has failed validation checks.
Trigger Criteria:
- Context: A cargo record has failed validation checks
- Applied to: Skip Invalid Record
- Action: The system processes invalid records
Logic Flow:
IF A cargo record has failed validation checks
AND The system processes invalid records
THEN:
- • The system skips the invalid cargo record and continues with the next record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all available cargo records with matching car id and waybill have been evaluated.
Trigger Criteria:
- Context: All available cargo records with matching car ID and waybill have been evaluated
- Applied to: Complete Record Set Retrieved
- Action: No more records remain to be processed
Logic Flow:
IF All available cargo records with matching car ID and waybill have been evaluated
AND No more records remain to be processed
THEN:
- • The system confirms that the complete record set has been retrieved and processed
R-GCX016E-cbl-01928 (+15) File: GCX016E.cbl Business Rule: CPRS Cargo Creation for Missing Records
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record is not found in the system and cprs cargo creation is requested.
Trigger Criteria:
- Context: A cargo record is not found in the system and CPRS cargo creation is requested
- Applied to: Validate CPRS Traffic Type
- Action: The system checks the traffic type indicators and CPRS-specific identifiers
Logic Flow:
IF A cargo record is not found in the system and CPRS cargo creation is requested
AND The system checks the traffic type indicators and CPRS-specific identifiers
THEN:
- • The system should validate that this is legitimate CPRS traffic and proceed with creation, or reject invalid traffic types
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cprs traffic type has been validated and car id information is available from n7 segment.
Trigger Criteria:
- Context: CPRS traffic type has been validated and car ID information is available from N7 segment
- Applied to: Check Car ID Format
- Action: The system processes the car initial and car number from the equipment data
Logic Flow:
IF CPRS traffic type has been validated and car ID information is available from N7 segment
AND The system processes the car initial and car number from the equipment data
THEN:
- • The system should validate the car ID format meets CPRS standards and format it appropriately
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when car id format has been validated for cprs standards.
Trigger Criteria:
- Context: Car ID format has been validated for CPRS standards
- Applied to: Initialize New Cargo Record
- Action: The system begins creating a new cargo record
Logic Flow:
IF Car ID format has been validated for CPRS standards
AND The system begins creating a new cargo record
THEN:
- • The system should initialize all cargo record fields to appropriate default values for new CPRS cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when new cargo record has been initialized for cprs traffic.
Trigger Criteria:
- Context: A new cargo record has been initialized for CPRS traffic
- Applied to: Set CPRS-Specific Fields
- Action: The system assigns CPRS-specific field values
Logic Flow:
IF A new cargo record has been initialized for CPRS traffic
AND The system assigns CPRS-specific field values
THEN:
- • The system should set cargo type indicators, processing flags, and other CPRS-specific attributes
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cprs-specific fields have been set in the new cargo record and x4 segment data is available. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: CPRS-specific fields have been set in the new cargo record and X4 segment data is available
- Applied to: Copy X4 Segment Data
- Action: The system copies X4 segment information to the cargo record
Logic Flow:
IF CPRS-specific fields have been set in the new cargo record and X4 segment data is available
AND The system copies X4 segment information to the cargo record
THEN:
- • The system should transfer disposition code, entry number, quantity, and date/time information from X4 segment to cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when x4 segment data has been copied to the cargo record and n7 equipment data is available. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: X4 segment data has been copied to the cargo record and N7 equipment data is available
- Applied to: Copy N7 Equipment Data
- Action: The system copies N7 equipment information to the cargo record
Logic Flow:
IF X4 segment data has been copied to the cargo record and N7 equipment data is available
AND The system copies N7 equipment information to the cargo record
THEN:
- • The system should transfer car initial, car number, and other equipment details from N7 segment to cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when x4 and n7 segment data has been copied to the cargo record.
Trigger Criteria:
- Context: X4 and N7 segment data has been copied to the cargo record
- Applied to: Set Default Values for Missing Fields
- Action: The system identifies fields that do not have values from the source segments
Logic Flow:
IF X4 and N7 segment data has been copied to the cargo record
AND The system identifies fields that do not have values from the source segments
THEN:
- • The system should assign appropriate default values for missing mandatory fields and leave optional fields blank
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when default values have been set for missing fields and raw car id components are available.
Trigger Criteria:
- Context: Default values have been set for missing fields and raw car ID components are available
- Applied to: Format Car ID for CPRS Standards
- Action: The system formats the car ID for CPRS processing
Logic Flow:
IF Default values have been set for missing fields and raw car ID components are available
AND The system formats the car ID for CPRS processing
THEN:
- • The system should combine car initial and car number according to CPRS formatting rules and standards
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when car id has been formatted according to cprs standards.
Trigger Criteria:
- Context: Car ID has been formatted according to CPRS standards
- Applied to: Assign US-CCN Key
- Action: The system assigns a US-CCN key to the cargo record
Logic Flow:
IF Car ID has been formatted according to CPRS standards
AND The system assigns a US-CCN key to the cargo record
THEN:
- • The system should generate or assign a unique US Cargo Control Number that serves as the primary key for the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when us-ccn key has been assigned to the cargo record.
Trigger Criteria:
- Context: US-CCN key has been assigned to the cargo record
- Applied to: Set Cargo Status to New
- Action: The system sets the initial cargo status
Logic Flow:
IF US-CCN key has been assigned to the cargo record
AND The system sets the initial cargo status
THEN:
- • The system should set the cargo status to 'New' to indicate this is a newly created cargo record awaiting processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when new cargo record has been prepared with status set to 'new'.
Trigger Criteria:
- Context: A new cargo record has been prepared with status set to 'New'
- Applied to: Database Insert Successful?
- Action: The system attempts to insert the cargo record into the database
Logic Flow:
IF A new cargo record has been prepared with status set to 'New'
AND The system attempts to insert the cargo record into the database
THEN:
- • The system should verify the database insert operation completed successfully and handle any insertion failures
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when database insert operation was successful.
Trigger Criteria:
- Context: The database insert operation was successful
- Applied to: Log CPRS Cargo Creation
- Action: The system logs the cargo creation event
Logic Flow:
IF The database insert operation was successful
AND The system logs the cargo creation event
THEN:
- • The system should create an audit log entry documenting the creation of the new CPRS cargo record with relevant details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cprs cargo creation has been logged successfully.
Trigger Criteria:
- Context: CPRS cargo creation has been logged successfully
- Applied to: Update Cargo Processing Counters
- Action: The system updates processing counters
Logic Flow:
IF CPRS cargo creation has been logged successfully
AND The system updates processing counters
THEN:
- • The system should increment counters for new cargo records created and total cargos processed
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo processing counters have been updated after successful cprs cargo creation.
Trigger Criteria:
- Context: Cargo processing counters have been updated after successful CPRS cargo creation
- Applied to: Continue with Disposition Processing
- Action: The system continues with cargo processing
Logic Flow:
IF Cargo processing counters have been updated after successful CPRS cargo creation
AND The system continues with cargo processing
THEN:
- • The system should proceed with disposition code processing for the newly created CPRS cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cprs traffic validation failed or database insert operation failed.
Trigger Criteria:
- Context: CPRS traffic validation failed or database insert operation failed
- Applied to: Generate Error Message
- Action: The system encounters an error during CPRS cargo creation
Logic Flow:
IF CPRS traffic validation failed or database insert operation failed
AND The system encounters an error during CPRS cargo creation
THEN:
- • The system should generate an appropriate error message describing the failure reason and route it to the appropriate destination
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when error message has been generated due to cprs cargo creation failure.
Trigger Criteria:
- Context: An error message has been generated due to CPRS cargo creation failure
- Applied to: Skip Cargo Processing
- Action: The system determines next processing steps
Logic Flow:
IF An error message has been generated due to CPRS cargo creation failure
AND The system determines next processing steps
THEN:
- • The system should skip all further processing for this cargo and continue with the next cargo or segment
R-GCX016E-cbl-01944 (+10) File: GCX016E.cbl Business Rule: Foreign Bill Cargo Creation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when foreign bill is not found in the existing cargo system.
Trigger Criteria:
- Context: A foreign bill is not found in the existing cargo system
- Applied to: Initialize New Cargo Record
- Action: The system needs to create a new cargo record
Logic Flow:
IF A foreign bill is not found in the existing cargo system
AND The system needs to create a new cargo record
THEN:
- • A new cargo record structure is initialized with default values and prepared for data population
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when initialized cargo record and x4 segment data containing disposition codes and cargo details.
Trigger Criteria:
- Context: An initialized cargo record and X4 segment data containing disposition codes and cargo details
- Applied to: Set Up Cargo Record with X4 Segment Data
- Action: The system processes X4 segment information for foreign bill cargo creation
Logic Flow:
IF An initialized cargo record and X4 segment data containing disposition codes and cargo details
AND The system processes X4 segment information for foreign bill cargo creation
THEN:
- • The cargo record is populated with disposition code, entry number, quantity, and other X4 segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record with x4 data populated and n7 segment data containing equipment information.
Trigger Criteria:
- Context: A cargo record with X4 data populated and N7 segment data containing equipment information
- Applied to: Set Up Cargo Record with N7 Segment Data
- Action: The system processes N7 segment information for equipment details
Logic Flow:
IF A cargo record with X4 data populated and N7 segment data containing equipment information
AND The system processes N7 segment information for equipment details
THEN:
- • The cargo record is updated with car ID, equipment initial, equipment number, and other N7 equipment data
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when m10 segments containing manifest header information for foreign bills.
Trigger Criteria:
- Context: M10 segments containing manifest header information for foreign bills
- Applied to: Build Foreign Manifest Information from M10 Segments
- Action: The system processes M10 segments to build foreign manifest data
Logic Flow:
IF M10 segments containing manifest header information for foreign bills
AND The system processes M10 segments to build foreign manifest data
THEN:
- • Manifest information including SCAC code, transport type, country code, and vessel details are extracted and prepared for cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when m10 manifest segments containing carrier information.
Trigger Criteria:
- Context: M10 manifest segments containing carrier information
- Applied to: Extract SCAC Code
- Action: The system processes manifest data to identify the carrier
Logic Flow:
IF M10 manifest segments containing carrier information
AND The system processes manifest data to identify the carrier
THEN:
- • The SCAC code is extracted and assigned to the cargo record for carrier identification
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when m10 manifest segments containing transportation mode information.
Trigger Criteria:
- Context: M10 manifest segments containing transportation mode information
- Applied to: Extract Transport Type
- Action: The system processes manifest data to classify transport method
Logic Flow:
IF M10 manifest segments containing transportation mode information
AND The system processes manifest data to classify transport method
THEN:
- • The transport type is identified and recorded in the cargo record for proper routing and handling
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when m10 manifest segments containing country information.
Trigger Criteria:
- Context: M10 manifest segments containing country information
- Applied to: Extract Country Code
- Action: The system processes manifest data to identify country details
Logic Flow:
IF M10 manifest segments containing country information
AND The system processes manifest data to identify country details
THEN:
- • The appropriate country code is extracted and assigned to the cargo record for customs and regulatory purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when m10 manifest segments containing vessel or conveyance information.
Trigger Criteria:
- Context: M10 manifest segments containing vessel or conveyance information
- Applied to: Extract Vessel Details
- Action: The system processes manifest data to capture vessel details
Logic Flow:
IF M10 manifest segments containing vessel or conveyance information
AND The system processes manifest data to capture vessel details
THEN:
- • Vessel name, voyage number, and other conveyance details are extracted and recorded in the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when raw car id information from n7 equipment segments.
Trigger Criteria:
- Context: Raw car ID information from N7 equipment segments
- Applied to: Format Car ID for Database
- Action: The system prepares car ID for database insertion
Logic Flow:
IF Raw car ID information from N7 equipment segments
AND The system prepares car ID for database insertion
THEN:
- • The car ID is formatted according to database requirements with proper padding, case conversion, and structure validation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when complete cargo record populated with all required foreign bill information.
Trigger Criteria:
- Context: A complete cargo record populated with all required foreign bill information
- Applied to: Insert New Cargo Record into Database
- Action: The system performs database insertion for the new cargo record
Logic Flow:
IF A complete cargo record populated with all required foreign bill information
AND The system performs database insertion for the new cargo record
THEN:
- • The cargo record is successfully inserted into GCSUSRT database with all populated fields and proper indexing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when successfully created foreign cargo record in the database.
Trigger Criteria:
- Context: A successfully created foreign cargo record in the database
- Applied to: Log Foreign Cargo Creation Action
- Action: The system completes foreign cargo creation process
Logic Flow:
IF A successfully created foreign cargo record in the database
AND The system completes foreign cargo creation process
THEN:
- • A log entry is created documenting the foreign cargo creation with timestamp, cargo details, and creation context for audit trail
R-GCX016E-cbl-01955 (+11) File: GCX016E.cbl Business Rule: Car ID Cargo Search with SCAC Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when car id is provided for cargo lookup.
Trigger Criteria:
- Context: A car ID is provided for cargo lookup
- Applied to: Search Cargo by Car ID
- Action: The system performs initial cargo search using the car ID
Logic Flow:
IF A car ID is provided for cargo lookup
AND The system performs initial cargo search using the car ID
THEN:
- • The system queries the cargo database to find matching cargo records
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo search has been performed using car id.
Trigger Criteria:
- Context: A cargo search has been performed using car ID
- Applied to: Cargo Found?
- Action: The system evaluates the search results
Logic Flow:
IF A cargo search has been performed using car ID
AND The system evaluates the search results
THEN:
- • The system determines if a cargo record was found or not found
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record has been found using car id search.
Trigger Criteria:
- Context: A cargo record has been found using car ID search
- Applied to: Check SCAC Code
- Action: The system checks the SCAC code in the cargo record
Logic Flow:
IF A cargo record has been found using car ID search
AND The system checks the SCAC code in the cargo record
THEN:
- • The system retrieves and evaluates the SCAC code for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when scac code has been retrieved from the cargo record.
Trigger Criteria:
- Context: A SCAC code has been retrieved from the cargo record
- Applied to: SCAC Unknown?
- Action: The system evaluates the SCAC code status
Logic Flow:
IF A SCAC code has been retrieved from the cargo record
AND The system evaluates the SCAC code status
THEN:
- • The system determines if the SCAC is unknown and requires US-CCN key renumbering
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record has been found but scac is marked as unknown.
Trigger Criteria:
- Context: A cargo record has been found but SCAC is marked as unknown
- Applied to: Perform US-CCN Key Renumbering
- Action: The system performs US-CCN key renumbering
Logic Flow:
IF A cargo record has been found but SCAC is marked as unknown
AND The system performs US-CCN key renumbering
THEN:
- • The system updates the US-CCN key index to create a new searchable key
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when us-ccn key renumbering has been completed.
Trigger Criteria:
- Context: US-CCN key renumbering has been completed
- Applied to: Search Again with New Key
- Action: The system searches for cargo using the new key
Logic Flow:
IF US-CCN key renumbering has been completed
AND The system searches for cargo using the new key
THEN:
- • The system queries the cargo database with the renumbered US-CCN key
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when secondary cargo search has been performed with renumbered key.
Trigger Criteria:
- Context: A secondary cargo search has been performed with renumbered key
- Applied to: Cargo Found with New Key?
- Action: The system evaluates the secondary search results
Logic Flow:
IF A secondary cargo search has been performed with renumbered key
AND The system evaluates the secondary search results
THEN:
- • The system determines if cargo was successfully found with the new key
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo has been found using renumbered key after scac unknown determination.
Trigger Criteria:
- Context: Cargo has been found using renumbered key after SCAC unknown determination
- Applied to: Handle SCAC Unknown Scenario
- Action: The system handles the SCAC unknown scenario
Logic Flow:
IF Cargo has been found using renumbered key after SCAC unknown determination
AND The system handles the SCAC unknown scenario
THEN:
- • The system applies special processing rules for unknown SCAC situations
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when scac unknown scenario processing has been completed.
Trigger Criteria:
- Context: SCAC unknown scenario processing has been completed
- Applied to: Log SCAC Processing Action
- Action: The system logs the processing action
Logic Flow:
IF SCAC unknown scenario processing has been completed
AND The system logs the processing action
THEN:
- • The system records the SCAC processing details for audit trail
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record has been found and scac is not unknown.
Trigger Criteria:
- Context: A cargo record has been found and SCAC is not unknown
- Applied to: Return Found Cargo Record
- Action: The system processes the found cargo
Logic Flow:
IF A cargo record has been found and SCAC is not unknown
AND The system processes the found cargo
THEN:
- • The system returns the cargo record for further business processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid cargo record has been found through either initial search or scac unknown processing.
Trigger Criteria:
- Context: A valid cargo record has been found through either initial search or SCAC unknown processing
- Applied to: Continue with Found Cargo
- Action: The system continues with cargo processing
Logic Flow:
IF A valid cargo record has been found through either initial search or SCAC unknown processing
AND The system continues with cargo processing
THEN:
- • The system proceeds with standard cargo business logic using the found record
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo search has failed in both initial search and secondary search with renumbered key.
Trigger Criteria:
- Context: Cargo search has failed in both initial search and secondary search with renumbered key
- Applied to: Generate Cargo Not Found Error
- Action: The system cannot locate any matching cargo record
Logic Flow:
IF Cargo search has failed in both initial search and secondary search with renumbered key
AND The system cannot locate any matching cargo record
THEN:
- • The system generates a cargo not found error for business exception handling
R-GCX016E-cbl-01967 (+9) File: GCX016E.cbl Business Rule: Cargo Status Segment Retrieval
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo status segment retrieval process is starting.
Trigger Criteria:
- Context: A cargo status segment retrieval process is starting
- Applied to: Initialize Status Segment Variables
- Action: The system begins status segment processing
Logic Flow:
IF A cargo status segment retrieval process is starting
AND The system begins status segment processing
THEN:
- • All status segment variables, arrays, and counters are initialized to their default values
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo requires status segment retrieval.
Trigger Criteria:
- Context: A cargo requires status segment retrieval
- Applied to: Set Car ID and US-CCN Keys
- Action: The system prepares to query status segments
Logic Flow:
IF A cargo requires status segment retrieval
AND The system prepares to query status segments
THEN:
- • The Car ID and US-CCN keys are set to identify the specific cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when car id and us-ccn keys are properly set. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Car ID and US-CCN keys are properly set
- Applied to: Call GCCUSIO2 to Retrieve S09 Segments
- Action: The system needs to retrieve cargo status segments
Logic Flow:
IF Car ID and US-CCN keys are properly set
AND The system needs to retrieve cargo status segments
THEN:
- • GCCUSIO2 program is called to fetch S09 segments from GCSUSS09 database
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when gccusio2 has completed the status segment retrieval attempt.
Trigger Criteria:
- Context: GCCUSIO2 has completed the status segment retrieval attempt
- Applied to: S09 Segments Found?
- Action: The system evaluates the retrieval results
Logic Flow:
IF GCCUSIO2 has completed the status segment retrieval attempt
AND The system evaluates the retrieval results
THEN:
- • If segments are found, proceed to process them; if no segments found or database error occurred, initialize empty status arrays
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when no s09 status segments were found or a database error occurred.
Trigger Criteria:
- Context: No S09 status segments were found or a database error occurred
- Applied to: Initialize Empty Status Arrays
- Action: The system needs to continue processing without existing status data
Logic Flow:
IF No S09 status segments were found or a database error occurred
AND The system needs to continue processing without existing status data
THEN:
- • Empty status arrays are initialized to allow new status processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when s09 status segments have been successfully retrieved from the database.
Trigger Criteria:
- Context: S09 status segments have been successfully retrieved from the database
- Applied to: Process Retrieved S09 Segments
- Action: The system processes each retrieved segment
Logic Flow:
IF S09 status segments have been successfully retrieved from the database
AND The system processes each retrieved segment
THEN:
- • Each S09 segment is processed to extract status data for array population
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when s09 segments have been processed and status data extracted.
Trigger Criteria:
- Context: S09 segments have been processed and status data extracted
- Applied to: Populate S09A Status Arrays
- Action: The system populates status arrays
Logic Flow:
IF S09 segments have been processed and status data extracted
AND The system populates status arrays
THEN:
- • S09A status arrays are populated with the extracted status information from each segment
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status segments are being processed with sequence numbers.
Trigger Criteria:
- Context: Status segments are being processed with sequence numbers
- Applied to: Track Maximum Sequence Numbers
- Action: The system encounters sequence numbers in the segments
Logic Flow:
IF Status segments are being processed with sequence numbers
AND The system encounters sequence numbers in the segments
THEN:
- • The maximum sequence numbers are tracked and stored for future reference
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status segments are being processed sequentially.
Trigger Criteria:
- Context: Status segments are being processed sequentially
- Applied to: More Segments to Process?
- Action: The system completes processing of a segment
Logic Flow:
IF Status segments are being processed sequentially
AND The system completes processing of a segment
THEN:
- • If more segments exist, continue processing; if no more segments, proceed to finalize arrays
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all status segments have been processed and arrays populated.
Trigger Criteria:
- Context: All status segments have been processed and arrays populated
- Applied to: Set Status Arrays Ready Flag
- Action: The status segment retrieval process is complete
Logic Flow:
IF All status segments have been processed and arrays populated
AND The status segment retrieval process is complete
THEN:
- • The status arrays ready flag is set to indicate successful completion
R-GCX016E-cbl-01977 (+10) File: GCX016E.cbl Business Rule: Status Array Population from Database
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo requires status array population from database segments.
Trigger Criteria:
- Context: A cargo requires status array population from database segments
- Applied to: Initialize Status Array Counter
- Action: The status array population process begins
Logic Flow:
IF A cargo requires status array population from database segments
AND The status array population process begins
THEN:
- • The status array counter is initialized to zero to track processed segments
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo identifier exists in the system.
Trigger Criteria:
- Context: A cargo identifier exists in the system
- Applied to: Retrieve S09 Status Segments from Database
- Action: Status array population is requested for the cargo
Logic Flow:
IF A cargo identifier exists in the system
AND Status array population is requested for the cargo
THEN:
- • All S09 status segments are retrieved from the GCSUSS09 database table for that cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when database query for s09 status segments has been executed.
Trigger Criteria:
- Context: A database query for S09 status segments has been executed
- Applied to: Status Segments Found?
- Action: The query results are evaluated
Logic Flow:
IF A database query for S09 status segments has been executed
AND The query results are evaluated
THEN:
- • If status segments are found, continue with array population,
otherwise complete the process without population
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status segment is being processed.
Trigger Criteria:
- Context: A status segment is being processed
- Applied to: Extract Disposition Code Information
- Action: Disposition code information needs to be extracted
Logic Flow:
IF A status segment is being processed
AND Disposition code information needs to be extracted
THEN:
- • The disposition code, entry number, and quantity information are extracted from the segment
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status segment is being processed.
Trigger Criteria:
- Context: A status segment is being processed
- Applied to: Extract Status Information Code
- Action: Status information needs to be extracted
Logic Flow:
IF A status segment is being processed
AND Status information needs to be extracted
THEN:
- • The status information code is extracted to identify the type of status change recorded
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status segment contains date and time information.
Trigger Criteria:
- Context: A status segment contains date and time information
- Applied to: Extract Date and Time Information
- Action: The segment is being processed for array population
Logic Flow:
IF A status segment contains date and time information
AND The segment is being processed for array population
THEN:
- • The date and time information is extracted and formatted for storage in the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status information has been extracted from a database segment.
Trigger Criteria:
- Context: Status information has been extracted from a database segment
- Applied to: Store in S09A Status Array
- Action: The information needs to be stored for processing
Logic Flow:
IF Status information has been extracted from a database segment
AND The information needs to be stored for processing
THEN:
- • The disposition code, dates, times, and status information are stored in the corresponding S09A array element
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status segment has been successfully stored in the status array.
Trigger Criteria:
- Context: A status segment has been successfully stored in the status array
- Applied to: Increment Array Counter
- Action: The storage operation is complete
Logic Flow:
IF A status segment has been successfully stored in the status array
AND The storage operation is complete
THEN:
- • The array counter is incremented by one to reflect the additional stored segment
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status segment with a sequence number is being processed.
Trigger Criteria:
- Context: A status segment with a sequence number is being processed
- Applied to: Track Maximum Sequence Number
- Action: The sequence number is compared to the current maximum
Logic Flow:
IF A status segment with a sequence number is being processed
AND The sequence number is compared to the current maximum
THEN:
- • If the current sequence number is higher than the tracked maximum, update the maximum sequence number
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status segment has been processed and stored.
Trigger Criteria:
- Context: A status segment has been processed and stored
- Applied to: More Status Segments?
- Action: The system checks for remaining segments
Logic Flow:
IF A status segment has been processed and stored
AND The system checks for remaining segments
THEN:
- • If more status segments exist for the cargo, continue processing the next segment,
otherwise proceed to completion
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all status segments for a cargo have been processed.
Trigger Criteria:
- Context: All status segments for a cargo have been processed
- Applied to: Update Maximum Sequences Fetched
- Action: The population process is completing
Logic Flow:
IF All status segments for a cargo have been processed
AND The population process is completing
THEN:
- • The maximum sequences fetched counter is updated with the highest sequence number processed
R-GCX016E-cbl-01988 (+9) File: GCX016E.cbl Business Rule: Status Segment Database Replacement
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo status processing operation has been completed.
Trigger Criteria:
- Context: A cargo status processing operation has been completed
- Applied to: Status Array Updated?
- Action: The system checks if the status array has been modified
Logic Flow:
IF A cargo status processing operation has been completed
AND The system checks if the status array has been modified
THEN:
- • If the status array is updated, proceed to convert to database format,
otherwise complete the process without database operations
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status array has been updated with new cargo status information.
Trigger Criteria:
- Context: The status array has been updated with new cargo status information
- Applied to: Convert Status Array to Database Format
- Action: The system needs to prepare data for database storage
Logic Flow:
IF The status array has been updated with new cargo status information
AND The system needs to prepare data for database storage
THEN:
- • Convert the status array elements to the proper database segment format maintaining all status codes, quantities, and sequence information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record is being processed for status segment replacement.
Trigger Criteria:
- Context: A cargo record is being processed for status segment replacement
- Applied to: Cargo Type Check
- Action: The system evaluates the cargo type
Logic Flow:
IF A cargo record is being processed for status segment replacement
AND The system evaluates the cargo type
THEN:
- • If the cargo is Non-CPRS, proceed to update car ID information, if CPRS, skip car ID updates and proceed directly to database segment preparation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when non-cprs cargo is being processed and car id information is available from n7 equipment segments.
Trigger Criteria:
- Context: A non-CPRS cargo is being processed and car ID information is available from N7 equipment segments
- Applied to: Update Car ID for Non-CPRS Cargo
- Action: The system updates cargo information before database storage
Logic Flow:
IF A non-CPRS cargo is being processed and car ID information is available from N7 equipment segments
AND The system updates cargo information before database storage
THEN:
- • Update the cargo record with the current car ID information from the equipment segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status array data has been converted to database format and car id updates have been applied if applicable.
Trigger Criteria:
- Context: Status array data has been converted to database format and car ID updates have been applied if applicable
- Applied to: Prepare Database Segment
- Action: The system prepares the final database segment for storage
Logic Flow:
IF Status array data has been converted to database format and car ID updates have been applied if applicable
AND The system prepares the final database segment for storage
THEN:
- • Format the segment with proper sequence numbers, status codes, quantities, and cargo identification for database replacement operation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when properly formatted database segment is ready for storage.
Trigger Criteria:
- Context: A properly formatted database segment is ready for storage
- Applied to: Replace Status Segment in GCSUSS09
- Action: The system performs the database replacement operation
Logic Flow:
IF A properly formatted database segment is ready for storage
AND The system performs the database replacement operation
THEN:
- • Replace the existing status segment in GCSUSS09 table with the updated segment containing current status information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when database replacement operation has been attempted on gcsuss09.
Trigger Criteria:
- Context: A database replacement operation has been attempted on GCSUSS09
- Applied to: Database Update Successful?
- Action: The system checks the operation result
Logic Flow:
IF A database replacement operation has been attempted on GCSUSS09
AND The system checks the operation result
THEN:
- • If the update was successful, proceed to log successful replacement, if there was an error, handle the database error appropriately
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when database replacement operation completed successfully.
Trigger Criteria:
- Context: The database replacement operation completed successfully
- Applied to: Log Successful Replacement
- Action: The system needs to record the successful operation
Logic Flow:
IF The database replacement operation completed successfully
AND The system needs to record the successful operation
THEN:
- • Log the successful replacement of status segment with cargo identification and timestamp information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when database replacement operation has failed.
Trigger Criteria:
- Context: A database replacement operation has failed
- Applied to: Handle Database Error
- Action: The system encounters a database error
Logic Flow:
IF A database replacement operation has failed
AND The system encounters a database error
THEN:
- • Handle the error by logging the failure details and determining appropriate recovery or notification actions
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when database replacement operation has been completed (successfully or with error).
Trigger Criteria:
- Context: A database replacement operation has been completed (successfully or with error)
- Applied to: Update Status Tracking
- Action: The system updates internal tracking information
Logic Flow:
IF A database replacement operation has been completed (successfully or with error)
AND The system updates internal tracking information
THEN:
- • Update status tracking records to reflect the current state of the cargo status segment replacement operation
R-GCX016E-cbl-01998 (+19) File: GCX016E.cbl Business Rule: Status Array to Database Conversion
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status array conversion process is starting.
Trigger Criteria:
- Context: A status array conversion process is starting
- Applied to: Initialize Database Segment Counter
- Action: The system begins the conversion operation
Logic Flow:
IF A status array conversion process is starting
AND The system begins the conversion operation
THEN:
- • The database segment counter is set to zero and work areas are cleared
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when database segment work area exists.
Trigger Criteria:
- Context: A database segment work area exists
- Applied to: Clear Database Segment Work Area
- Action: The system prepares to process status array entries
Logic Flow:
IF A database segment work area exists
AND The system prepares to process status array entries
THEN:
- • All fields in the database segment work area are cleared to initial values
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status array with multiple entries exists.
Trigger Criteria:
- Context: A status array with multiple entries exists
- Applied to: More Status Array Entries?
- Action: The system checks for remaining entries to process
Logic Flow:
IF A status array with multiple entries exists
AND The system checks for remaining entries to process
THEN:
- • The system returns true if more entries exist or false if all entries have been processed
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when status array entries are available for processing.
Trigger Criteria:
- Context: Status array entries are available for processing
- Applied to: Get Next Status Array Entry
- Action: The system needs to process the next entry
Logic Flow:
IF Status array entries are available for processing
AND The system needs to process the next entry
THEN:
- • The next status array entry is retrieved and made available for data extraction
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status array entry contains disposition code information.
Trigger Criteria:
- Context: A status array entry contains disposition code information
- Applied to: Extract Disposition Code
- Action: The system processes the entry for database conversion
Logic Flow:
IF A status array entry contains disposition code information
AND The system processes the entry for database conversion
THEN:
- • The disposition code is extracted and prepared for database segment formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status array entry contains date information.
Trigger Criteria:
- Context: A status array entry contains date information
- Applied to: Extract Date Information
- Action: The system processes the entry for database conversion
Logic Flow:
IF A status array entry contains date information
AND The system processes the entry for database conversion
THEN:
- • The date information is extracted and prepared for database segment formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status array entry contains time information.
Trigger Criteria:
- Context: A status array entry contains time information
- Applied to: Extract Time Information
- Action: The system processes the entry for database conversion
Logic Flow:
IF A status array entry contains time information
AND The system processes the entry for database conversion
THEN:
- • The time information is extracted and prepared for database segment formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status array entry contains quantity information.
Trigger Criteria:
- Context: A status array entry contains quantity information
- Applied to: Extract Quantity Information
- Action: The system processes the entry for database conversion
Logic Flow:
IF A status array entry contains quantity information
AND The system processes the entry for database conversion
THEN:
- • The quantity information is extracted and prepared for database segment formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when extracted data from status array entry is available.
Trigger Criteria:
- Context: Extracted data from status array entry is available
- Applied to: Format Database Segment Fields
- Action: The system prepares data for database storage
Logic Flow:
IF Extracted data from status array entry is available
AND The system prepares data for database storage
THEN:
- • All extracted data is formatted according to database segment field specifications
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when formatted data is ready for database storage.
Trigger Criteria:
- Context: Formatted data is ready for database storage
- Applied to: Move Data to Database Segment
- Action: The system populates the database segment
Logic Flow:
IF Formatted data is ready for database storage
AND The system populates the database segment
THEN:
- • All formatted data is moved to the appropriate database segment fields
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status array entry has been successfully processed into database format.
Trigger Criteria:
- Context: A status array entry has been successfully processed into database format
- Applied to: Increment Segment Counter
- Action: The system completes processing of one entry
Logic Flow:
IF A status array entry has been successfully processed into database format
AND The system completes processing of one entry
THEN:
- • The database segment counter is incremented by one
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when database segment has a defined maximum capacity for entries.
Trigger Criteria:
- Context: A database segment has a defined maximum capacity for entries
- Applied to: Check Segment Capacity
- Action: The system adds an entry to the segment
Logic Flow:
IF A database segment has a defined maximum capacity for entries
AND The system adds an entry to the segment
THEN:
- • The system checks if the segment capacity limit has been reached
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when database segment with defined capacity limits.
Trigger Criteria:
- Context: A database segment with defined capacity limits
- Applied to: Segment Full?
- Action: The system checks segment capacity after adding an entry
Logic Flow:
IF A database segment with defined capacity limits
AND The system checks segment capacity after adding an entry
THEN:
- • The system returns true if segment is at capacity or false if more entries can be added
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when database segment that has reached its capacity limit.
Trigger Criteria:
- Context: A database segment that has reached its capacity limit
- Applied to: Write Segment to Database
- Action: The system determines the segment is full
Logic Flow:
IF A database segment that has reached its capacity limit
AND The system determines the segment is full
THEN:
- • The complete segment is written to the GCSUSS09 status segments database
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when database segment has been written to storage.
Trigger Criteria:
- Context: A database segment has been written to storage
- Applied to: Initialize New Segment
- Action: More status array entries remain to be processed
Logic Flow:
IF A database segment has been written to storage
AND More status array entries remain to be processed
THEN:
- • A new database segment is initialized with cleared fields and reset counter
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when current status array entry has been processed.
Trigger Criteria:
- Context: The current status array entry has been processed
- Applied to: Continue with Next Entry
- Action: More entries remain in the status array
Logic Flow:
IF The current status array entry has been processed
AND More entries remain in the status array
THEN:
- • The system continues processing with the next available entry
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status array with a finite number of entries.
Trigger Criteria:
- Context: A status array with a finite number of entries
- Applied to: All Entries Processed?
- Action: The system completes processing entries
Logic Flow:
IF A status array with a finite number of entries
AND The system completes processing entries
THEN:
- • The system returns true if all entries are processed or false if entries remain
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all status array entries have been processed and a final segment contains data.
Trigger Criteria:
- Context: All status array entries have been processed and a final segment contains data
- Applied to: Write Final Segment to Database
- Action: No more entries remain to be processed
Logic Flow:
IF All status array entries have been processed and a final segment contains data
AND No more entries remain to be processed
THEN:
- • The final database segment is written to the GCSUSS09 status segments database
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when database segments have been written for a cargo's status information.
Trigger Criteria:
- Context: Database segments have been written for a cargo's status information
- Applied to: Update Cargo Record with Segment Count
- Action: The conversion process is complete
Logic Flow:
IF Database segments have been written for a cargo's status information
AND The conversion process is complete
THEN:
- • The cargo record is updated with the total count of database segments created
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all status array entries have been converted and written to database segments.
Trigger Criteria:
- Context: All status array entries have been converted and written to database segments
- Applied to: Complete Conversion Process
- Action: The cargo record has been updated with segment information
Logic Flow:
IF All status array entries have been converted and written to database segments
AND The cargo record has been updated with segment information
THEN:
- • The conversion process is marked as complete and control returns to calling process
R-GCX016E-cbl-02018 (+12) File: GCX016E.cbl Business Rule: Disposition Code Table Validation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when x4 segment is being processed.
Trigger Criteria:
- Context: An X4 segment is being processed
- Applied to: Extract Disposition Code from X4 Segment
- Action: The system needs to validate the disposition code
Logic Flow:
IF An X4 segment is being processed
AND The system needs to validate the disposition code
THEN:
- • The disposition code is extracted from the X4 segment for table lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code needs to be validated. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A disposition code needs to be validated
- Applied to: Call GCCTBIO to Access DC Table
- Action: The system calls the table access function
Logic Flow:
IF A disposition code needs to be validated
AND The system calls the table access function
THEN:
- • The DC table is accessed through GCCTBIO to retrieve disposition code information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code has been extracted from the x4 segment.
Trigger Criteria:
- Context: A disposition code has been extracted from the X4 segment
- Applied to: Disposition Code Found in Table?
- Action: The system searches the DC table for the code
Logic Flow:
IF A disposition code has been extracted from the X4 segment
AND The system searches the DC table for the code
THEN:
- • The system determines if the disposition code is valid and authorized for use
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code is found to be valid in the dc table.
Trigger Criteria:
- Context: A disposition code is found to be valid in the DC table
- Applied to: Retrieve Processing Rules and Attributes
- Action: The system needs to process the disposition code
Logic Flow:
IF A disposition code is found to be valid in the DC table
AND The system needs to process the disposition code
THEN:
- • All associated processing rules, attributes, and configuration parameters are retrieved from the table
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code has been successfully validated against the dc table.
Trigger Criteria:
- Context: A disposition code has been successfully validated against the DC table
- Applied to: Set Disposition Code Valid Flag
- Action: The validation process completes successfully
Logic Flow:
IF A disposition code has been successfully validated against the DC table
AND The validation process completes successfully
THEN:
- • The system sets the disposition code valid flag to enable further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid disposition code with associated processing rules.
Trigger Criteria:
- Context: A valid disposition code with associated processing rules
- Applied to: Extract Action Code for Release Quantity
- Action: The system needs to determine quantity impact
Logic Flow:
IF A valid disposition code with associated processing rules
AND The system needs to determine quantity impact
THEN:
- • The action code for release quantity processing is extracted from the disposition code attributes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid disposition code with processing attributes.
Trigger Criteria:
- Context: A valid disposition code with processing attributes
- Applied to: Extract Hold/Release Indicator
- Action: The system needs to determine the hold or release nature of the code
Logic Flow:
IF A valid disposition code with processing attributes
AND The system needs to determine the hold or release nature of the code
THEN:
- • The hold/release indicator is extracted to determine the appropriate cargo status action
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid disposition code with complete attributes.
Trigger Criteria:
- Context: A valid disposition code with complete attributes
- Applied to: Extract Status Information Flag
- Action: The system needs to determine if the code is informational
Logic Flow:
IF A valid disposition code with complete attributes
AND The system needs to determine if the code is informational
THEN:
- • The status information flag is extracted to determine if the code affects cargo status or is informational only
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code is not found in the dc table.
Trigger Criteria:
- Context: A disposition code is not found in the DC table
- Applied to: Set Disposition Code Invalid Flag
- Action: The validation process fails
Logic Flow:
IF A disposition code is not found in the DC table
AND The validation process fails
THEN:
- • The system sets the disposition code invalid flag to prevent further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when invalid disposition code has been identified.
Trigger Criteria:
- Context: An invalid disposition code has been identified
- Applied to: Generate Merlin Error Message
- Action: Error handling is required
Logic Flow:
IF An invalid disposition code has been identified
AND Error handling is required
THEN:
- • An error message is generated and sent to the Merlin messaging system to notify users of the invalid code
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code is determined to be invalid or unknown.
Trigger Criteria:
- Context: A disposition code is determined to be invalid or unknown
- Applied to: Log Unknown Disposition Code
- Action: Logging is required for audit purposes
Logic Flow:
IF A disposition code is determined to be invalid or unknown
AND Logging is required for audit purposes
THEN:
- • The unknown disposition code is logged with relevant context information for system administrators
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code has been validated and processing rules retrieved.
Trigger Criteria:
- Context: A disposition code has been validated and processing rules retrieved
- Applied to: Continue Processing with Retrieved Rules
- Action: All validation checks pass successfully
Logic Flow:
IF A disposition code has been validated and processing rules retrieved
AND All validation checks pass successfully
THEN:
- • The system continues with cargo processing using the retrieved disposition code rules and attributes
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code has failed validation.
Trigger Criteria:
- Context: A disposition code has failed validation
- Applied to: Skip Processing Due to Invalid Code
- Action: The code is determined to be invalid or unauthorized
Logic Flow:
IF A disposition code has failed validation
AND The code is determined to be invalid or unauthorized
THEN:
- • The system skips further processing of the cargo to prevent incorrect status updates
R-GCX016E-cbl-02031 (+11) File: GCX016E.cbl Business Rule: Duplicate Disposition Code Detection and Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when new disposition code needs to be processed for a cargo.
Trigger Criteria:
- Context: A new disposition code needs to be processed for a cargo
- Applied to: Search Existing S09A Status Arrays
- Action: The system searches through all existing S09A status array entries
Logic Flow:
IF A new disposition code needs to be processed for a cargo
AND The system searches through all existing S09A status array entries
THEN:
- • The system identifies whether the disposition code already exists in the status arrays
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when system has searched through existing s09a status arrays.
Trigger Criteria:
- Context: The system has searched through existing S09A status arrays
- Applied to: Duplicate Code Found?
- Action: A matching disposition code is found in the existing status entries
Logic Flow:
IF The system has searched through existing S09A status arrays
AND A matching disposition code is found in the existing status entries
THEN:
- • The system flags the code as a duplicate and proceeds with duplicate handling logic
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when duplicate disposition code has been detected.
Trigger Criteria:
- Context: A duplicate disposition code has been detected
- Applied to: Code Type Analysis
- Action: The system analyzes the disposition code characteristics from the DC table
Logic Flow:
IF A duplicate disposition code has been detected
AND The system analyzes the disposition code characteristics from the DC table
THEN:
- • The system categorizes the code as Hold Code, Release Code, Status Info Code, or Removal Code based on its processing requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when duplicate disposition code is identified as a hold code type.
Trigger Criteria:
- Context: A duplicate disposition code is identified as a Hold Code type
- Applied to: Handle Hold Code Duplicate
- Action: The system processes the duplicate hold code
Logic Flow:
IF A duplicate disposition code is identified as a Hold Code type
AND The system processes the duplicate hold code
THEN:
- • The system updates the existing entry's date and time information with the most recent values
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when duplicate disposition code is identified as a release code type.
Trigger Criteria:
- Context: A duplicate disposition code is identified as a Release Code type
- Applied to: Handle Release Code Duplicate
- Action: The system processes the duplicate release code
Logic Flow:
IF A duplicate disposition code is identified as a Release Code type
AND The system processes the duplicate release code
THEN:
- • The system updates the existing entry's date and time information with the most recent values
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when duplicate disposition code is identified as a status info code type.
Trigger Criteria:
- Context: A duplicate disposition code is identified as a Status Info Code type
- Applied to: Handle Status Info Code Duplicate
- Action: The system processes the duplicate status info code
Logic Flow:
IF A duplicate disposition code is identified as a Status Info Code type
AND The system processes the duplicate status info code
THEN:
- • The system keeps the most recent entry and maintains the status information without creating additional duplicates
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when duplicate disposition code is identified as a removal code type.
Trigger Criteria:
- Context: A duplicate disposition code is identified as a Removal Code type
- Applied to: Handle Removal Code Duplicate
- Action: The system processes the duplicate removal code
Logic Flow:
IF A duplicate disposition code is identified as a Removal Code type
AND The system processes the duplicate removal code
THEN:
- • The system removes the older duplicate entry from the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when duplicate hold or release code requires timestamp updates.
Trigger Criteria:
- Context: A duplicate hold or release code requires timestamp updates
- Applied to: Update Existing Entry Date/Time
- Action: The system processes the duplicate entry
Logic Flow:
IF A duplicate hold or release code requires timestamp updates
AND The system processes the duplicate entry
THEN:
- • The system updates the existing entry's date and time fields with the current processing timestamp
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when duplicate status info code is being processed.
Trigger Criteria:
- Context: A duplicate status info code is being processed
- Applied to: Keep Most Recent Entry
- Action: The system compares entry timestamps
Logic Flow:
IF A duplicate status info code is being processed
AND The system compares entry timestamps
THEN:
- • The system keeps the entry with the most recent timestamp and discards older duplicate information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when duplicate removal code is being processed.
Trigger Criteria:
- Context: A duplicate removal code is being processed
- Applied to: Remove Older Duplicate
- Action: The system identifies older duplicate entries in the status array
Logic Flow:
IF A duplicate removal code is being processed
AND The system identifies older duplicate entries in the status array
THEN:
- • The system removes the older duplicate entries and keeps only the most recent removal code
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code is not found as a duplicate in existing status arrays.
Trigger Criteria:
- Context: A disposition code is not found as a duplicate in existing status arrays
- Applied to: Add New Code to Array
- Action: The system processes the new disposition code
Logic Flow:
IF A disposition code is not found as a duplicate in existing status arrays
AND The system processes the new disposition code
THEN:
- • The system adds the new disposition code to the appropriate status array with all required information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when any duplicate disposition code processing action has been completed.
Trigger Criteria:
- Context: Any duplicate disposition code processing action has been completed
- Applied to: Log Duplicate Processing Action
- Action: The system finishes handling the duplicate or new code
Logic Flow:
IF Any duplicate disposition code processing action has been completed
AND The system finishes handling the duplicate or new code
THEN:
- • The system logs the processing action taken including code type, action performed, and timestamp information
R-GCX016E-cbl-02051 (+11) File: GCX016E.cbl Business Rule: Status Information Code Processing Logic
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status information code is received for processing.
Trigger Criteria:
- Context: A status information code is received for processing
- Applied to: Status Info Code Valid?
- Action: The system validates the code against the DC table
Logic Flow:
IF A status information code is received for processing
AND The system validates the code against the DC table
THEN:
- • The code is accepted if it exists in the DC table,
otherwise it is rejected as invalid
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status information code needs validation.
Trigger Criteria:
- Context: A status information code needs validation
- Applied to: Validate Against DC Table
- Action: The system searches the DC table for the code
Logic Flow:
IF A status information code needs validation
AND The system searches the DC table for the code
THEN:
- • The lookup returns success if code exists or failure if code is not found
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when validated status information code and existing status arrays.
Trigger Criteria:
- Context: A validated status information code and existing status arrays
- Applied to: Code Already Exists?
- Action: The system searches all status arrays for the code
Logic Flow:
IF A validated status information code and existing status arrays
AND The system searches all status arrays for the code
THEN:
- • The search returns true if code exists in any array, false if code is not found
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status array and a new status information code to be added.
Trigger Criteria:
- Context: A status array and a new status information code to be added
- Applied to: Array Full?
- Action: The system checks the current array size against maximum capacity
Logic Flow:
IF A status array and a new status information code to be added
AND The system checks the current array size against maximum capacity
THEN:
- • The check returns true if array is at maximum capacity, false if space is available
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status array with available capacity and a new status information code.
Trigger Criteria:
- Context: A status array with available capacity and a new status information code
- Applied to: Find Insertion Position
- Action: The system determines the insertion position based on array sequence rules
Logic Flow:
IF A status array with available capacity and a new status information code
AND The system determines the insertion position based on array sequence rules
THEN:
- • The position is identified where the code should be inserted to maintain proper array order
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when validated status information code and determined insertion position.
Trigger Criteria:
- Context: A validated status information code and determined insertion position
- Applied to: Insert Status Info Code
- Action: The system inserts the code into the status array
Logic Flow:
IF A validated status information code and determined insertion position
AND The system inserts the code into the status array
THEN:
- • The code is successfully added to the array at the specified position
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status array with a newly inserted status information code.
Trigger Criteria:
- Context: A status array with a newly inserted status information code
- Applied to: Update Array Sequence
- Action: The system updates the array sequence numbers
Logic Flow:
IF A status array with a newly inserted status information code
AND The system updates the array sequence numbers
THEN:
- • All sequence numbers are properly maintained to reflect the current array state
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when successfully inserted status information code.
Trigger Criteria:
- Context: A successfully inserted status information code
- Applied to: Set Status Info Flag
- Action: The system sets the status information flag
Logic Flow:
IF A successfully inserted status information code
AND The system sets the status information flag
THEN:
- • The flag is set to indicate status information processing has occurred
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when successfully processed status information code.
Trigger Criteria:
- Context: A successfully processed status information code
- Applied to: Log Status Addition
- Action: The system logs the status addition activity
Logic Flow:
IF A successfully processed status information code
AND The system logs the status addition activity
THEN:
- • The activity is recorded with relevant details for audit trail
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status information code that already exists in the status arrays.
Trigger Criteria:
- Context: A status information code that already exists in the status arrays
- Applied to: Skip Duplicate Code
- Action: The system detects the duplicate code
Logic Flow:
IF A status information code that already exists in the status arrays
AND The system detects the duplicate code
THEN:
- • The processing is skipped and no duplicate entry is created
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status information code that fails validation.
Trigger Criteria:
- Context: A status information code that fails validation
- Applied to: Generate Error Message
- Action: The system processes the invalid code
Logic Flow:
IF A status information code that fails validation
AND The system processes the invalid code
THEN:
- • An appropriate error message is generated indicating the code is invalid
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status array at maximum capacity and a new status information code to add.
Trigger Criteria:
- Context: A status array at maximum capacity and a new status information code to add
- Applied to: Array Capacity Error
- Action: The system attempts to add the code to the full array
Logic Flow:
IF A status array at maximum capacity and a new status information code to add
AND The system attempts to add the code to the full array
THEN:
- • An array capacity error is generated and processing is terminated
R-GCX016E-cbl-02063 (+11) File: GCX016E.cbl Business Rule: Disposition Code Removal Processing Logic
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code removal request is received.
Trigger Criteria:
- Context: A disposition code removal request is received
- Applied to: Validate Disposition Code Format
- Action: The system validates the disposition code format
Logic Flow:
IF A disposition code removal request is received
AND The system validates the disposition code format
THEN:
- • The disposition code must meet format requirements to proceed with removal processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code removal request is received.
Trigger Criteria:
- Context: A disposition code removal request is received
- Applied to: Generate Error - Invalid Code Format
- Action: The disposition code format validation fails
Logic Flow:
IF A disposition code removal request is received
AND The disposition code format validation fails
THEN:
- • An error message must be generated indicating invalid code format and processing must terminate
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid disposition code is provided for removal.
Trigger Criteria:
- Context: A valid disposition code is provided for removal
- Applied to: Search Status Array for Matching Code
- Action: The system searches the status array for the matching disposition code
Logic Flow:
IF A valid disposition code is provided for removal
AND The system searches the status array for the matching disposition code
THEN:
- • The disposition code must exist in the status array to proceed with removal
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code exists in the status array.
Trigger Criteria:
- Context: A disposition code exists in the status array
- Applied to: Validate Removal Authority
- Action: The system checks removal authorization for the requesting entity
Logic Flow:
IF A disposition code exists in the status array
AND The system checks removal authorization for the requesting entity
THEN:
- • The requesting entity must have proper authorization to remove the disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code exists in the status array.
Trigger Criteria:
- Context: A disposition code exists in the status array
- Applied to: Generate Error - Unauthorized Removal
- Action: The requesting entity lacks proper removal authorization
Logic Flow:
IF A disposition code exists in the status array
AND The requesting entity lacks proper removal authorization
THEN:
- • An error message must be generated indicating unauthorized removal attempt and processing must terminate
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when authorization is confirmed for disposition code removal.
Trigger Criteria:
- Context: Authorization is confirmed for disposition code removal
- Applied to: Mark Disposition Code for Removal
- Action: The system removes the disposition code from the status array
Logic Flow:
IF Authorization is confirmed for disposition code removal
AND The system removes the disposition code from the status array
THEN:
- • The disposition code is marked for removal and remaining array elements are shifted to fill the gap
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code has been removed from the status array.
Trigger Criteria:
- Context: A disposition code has been removed from the status array
- Applied to: Update Array Sequence Numbers
- Action: The system updates the array structure
Logic Flow:
IF A disposition code has been removed from the status array
AND The system updates the array structure
THEN:
- • All remaining disposition codes must have their sequence numbers updated to maintain proper ordering
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code has been successfully removed from the status array.
Trigger Criteria:
- Context: A disposition code has been successfully removed from the status array
- Applied to: Log Removal Action
- Action: The system logs the removal action
Logic Flow:
IF A disposition code has been successfully removed from the status array
AND The system logs the removal action
THEN:
- • An audit log entry must be created with removal details including code, timestamp, and requesting entity
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code removal has been logged.
Trigger Criteria:
- Context: A disposition code removal has been logged
- Applied to: Generate Removal Confirmation
- Action: The system generates removal confirmation
Logic Flow:
IF A disposition code removal has been logged
AND The system generates removal confirmation
THEN:
- • A confirmation message must be created and sent to appropriate recipients confirming the successful removal
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code has been removed and confirmation generated.
Trigger Criteria:
- Context: A disposition code has been removed and confirmation generated
- Applied to: Update Cargo Status
- Action: The system updates the cargo status
Logic Flow:
IF A disposition code has been removed and confirmation generated
AND The system updates the cargo status
THEN:
- • The cargo status must be recalculated based on the remaining disposition codes in the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo status has been updated after disposition code removal.
Trigger Criteria:
- Context: The cargo status has been updated after disposition code removal
- Applied to: Send Status Change Notification
- Action: The system sends status change notifications
Logic Flow:
IF The cargo status has been updated after disposition code removal
AND The system sends status change notifications
THEN:
- • Notifications must be sent to all relevant parties including brokers, freight forwarders, and customs officials
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid format disposition code is provided for removal.
Trigger Criteria:
- Context: A valid format disposition code is provided for removal
- Applied to: Generate Error - Code Not Found
- Action: The disposition code is not found in the status array
Logic Flow:
IF A valid format disposition code is provided for removal
AND The disposition code is not found in the status array
THEN:
- • An error message must be generated indicating code not found and processing must terminate
R-GCX016E-cbl-02075 (+13) File: GCX016E.cbl Business Rule: Release Request Processing Logic
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when release request has been received for a cargo.
Trigger Criteria:
- Context: A release request has been received for a cargo
- Applied to: Check Current Status Array
- Action: The system needs to process the release request
Logic Flow:
IF A release request has been received for a cargo
AND The system needs to process the release request
THEN:
- • The system must retrieve and examine the current status array from cargo status segments to identify existing disposition codes
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when current status array has been retrieved for a cargo.
Trigger Criteria:
- Context: The current status array has been retrieved for a cargo
- Applied to: Search for Existing Release Codes
- Action: Processing a new release request
Logic Flow:
IF The current status array has been retrieved for a cargo
AND Processing a new release request
THEN:
- • The system must search through all disposition codes in the status array to identify existing release codes
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when existing release codes have been found in the status array.
Trigger Criteria:
- Context: Existing release codes have been found in the status array
- Applied to: Remove Existing Release Codes
- Action: Processing a new release request
Logic Flow:
IF Existing release codes have been found in the status array
AND Processing a new release request
THEN:
- • The system must remove all existing release disposition codes from the status array before adding the new release code
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when release request is being processed.
Trigger Criteria:
- Context: A release request is being processed
- Applied to: Search for Conflicting Hold Codes
- Action: The system has processed existing release codes
Logic Flow:
IF A release request is being processed
AND The system has processed existing release codes
THEN:
- • The system must search the status array for hold disposition codes that conflict with the release action
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when conflicting hold codes have been identified in the status array.
Trigger Criteria:
- Context: Conflicting hold codes have been identified in the status array
- Applied to: Remove Conflicting Hold Codes
- Action: Processing a release request
Logic Flow:
IF Conflicting hold codes have been identified in the status array
AND Processing a release request
THEN:
- • The system must remove all conflicting hold disposition codes from the status array to allow the release to proceed
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when new release disposition code needs to be added.
Trigger Criteria:
- Context: A new release disposition code needs to be added
- Applied to: Validate New Release Disposition Code
- Action: The system has cleared conflicting codes from the status array
Logic Flow:
IF A new release disposition code needs to be added
AND The system has cleared conflicting codes from the status array
THEN:
- • The system must validate the new release disposition code exists in the disposition code table and is classified as a valid release code
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when new release disposition code has been validated as correct.
Trigger Criteria:
- Context: The new release disposition code has been validated as correct
- Applied to: Add New Release Disposition Code to Status Array
- Action: The status array has been cleared of conflicting codes
Logic Flow:
IF The new release disposition code has been validated as correct
AND The status array has been cleared of conflicting codes
THEN:
- • The system must add the new release disposition code to the status array with appropriate sequence number and occurrence data
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when new release disposition code has been added to the status array.
Trigger Criteria:
- Context: A new release disposition code has been added to the status array
- Applied to: Update Status Array Sequence
- Action: The status array structure needs to be maintained
Logic Flow:
IF A new release disposition code has been added to the status array
AND The status array structure needs to be maintained
THEN:
- • The system must update sequence numbers and occurrence counts to maintain proper status array integrity
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when release disposition code has been added to the status array.
Trigger Criteria:
- Context: A release disposition code has been added to the status array
- Applied to: Calculate Release Quantity Impact
- Action: The release quantity needs to be determined
Logic Flow:
IF A release disposition code has been added to the status array
AND The release quantity needs to be determined
THEN:
- • The system must calculate the quantity impact of the release code on the total cargo release amount
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when release quantity impact has been calculated.
Trigger Criteria:
- Context: Release quantity impact has been calculated
- Applied to: Set Release Status Flags
- Action: The cargo status needs to be updated
Logic Flow:
IF Release quantity impact has been calculated
AND The cargo status needs to be updated
THEN:
- • The system must set appropriate release status flags to reflect the current release state of the cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when release status flags have been set successfully.
Trigger Criteria:
- Context: Release status flags have been set successfully
- Applied to: Generate Release Notification
- Action: Stakeholders need to be notified of the release
Logic Flow:
IF Release status flags have been set successfully
AND Stakeholders need to be notified of the release
THEN:
- • The system must generate release notifications to appropriate parties including brokers and freight forwarders
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when release notifications have been generated.
Trigger Criteria:
- Context: Release notifications have been generated
- Applied to: Log Release Request Action
- Action: The release request processing is complete
Logic Flow:
IF Release notifications have been generated
AND The release request processing is complete
THEN:
- • The system must log the release request action with timestamp and details for audit trail purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when release disposition code has failed validation.
Trigger Criteria:
- Context: A release disposition code has failed validation
- Applied to: Generate Error Message
- Action: The code is not found in the disposition code table or is not a valid release code
Logic Flow:
IF A release disposition code has failed validation
AND The code is not found in the disposition code table or is not a valid release code
THEN:
- • The system must generate an error message indicating the invalid release disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when error message has been generated for invalid release code.
Trigger Criteria:
- Context: An error message has been generated for invalid release code
- Applied to: Reject Release Request
- Action: The release request cannot be processed due to validation failure
Logic Flow:
IF An error message has been generated for invalid release code
AND The release request cannot be processed due to validation failure
THEN:
- • The system must reject the release request and maintain the original cargo status without any changes
R-GCX016E-cbl-02089 (+12) File: GCX016E.cbl Business Rule: Manual Release Processing Logic
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when manual release request is received for a cargo.
Trigger Criteria:
- Context: A manual release request is received for a cargo
- Applied to: Validate Manual Release Request
- Action: The system validates the request parameters including disposition code format, cargo identification, and request authorization
Logic Flow:
IF A manual release request is received for a cargo
AND The system validates the request parameters including disposition code format, cargo identification, and request authorization
THEN:
- • The system determines if the request is valid and can proceed with manual release processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has an existing status array with disposition codes.
Trigger Criteria:
- Context: A cargo has an existing status array with disposition codes
- Applied to: Conflicting Codes Found?
- Action: A manual release request is processed and the system searches for conflicting hold or restriction codes
Logic Flow:
IF A cargo has an existing status array with disposition codes
AND A manual release request is processed and the system searches for conflicting hold or restriction codes
THEN:
- • The system identifies any existing codes that must be removed before applying the manual release
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when conflicting hold or restriction codes exist in the cargo status array.
Trigger Criteria:
- Context: Conflicting hold or restriction codes exist in the cargo status array
- Applied to: Remove Existing Hold/Restriction Codes
- Action: A manual release is being processed
Logic Flow:
IF Conflicting hold or restriction codes exist in the cargo status array
AND A manual release is being processed
THEN:
- • The system removes all conflicting disposition codes from the status array to clear the path for manual release
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status array has been cleared of conflicting codes.
Trigger Criteria:
- Context: The cargo status array has been cleared of conflicting codes
- Applied to: Add Manual Release Disposition Code
- Action: A manual release is being applied
Logic Flow:
IF The cargo status array has been cleared of conflicting codes
AND A manual release is being applied
THEN:
- • The system adds the manual release disposition code (MRL) to the status array with appropriate sequence number and metadata
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition codes have been added or removed from the cargo status array.
Trigger Criteria:
- Context: Disposition codes have been added or removed from the cargo status array
- Applied to: Update Status Array Sequence
- Action: The manual release processing updates the array
Logic Flow:
IF Disposition codes have been added or removed from the cargo status array
AND The manual release processing updates the array
THEN:
- • The system updates sequence numbers to maintain proper ordering and removes any gaps in the sequence
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when manual release has been successfully applied to a cargo.
Trigger Criteria:
- Context: A manual release has been successfully applied to a cargo
- Applied to: Log Manual Release Action
- Action: The system completes the manual release processing
Logic Flow:
IF A manual release has been successfully applied to a cargo
AND The system completes the manual release processing
THEN:
- • The system logs the manual release action with timestamp, user information, and cargo details for audit purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo status array has been updated with manual release disposition code.
Trigger Criteria:
- Context: The cargo status array has been updated with manual release disposition code
- Applied to: Cargo Fully Released?
- Action: The system evaluates the final status of the cargo
Logic Flow:
IF The cargo status array has been updated with manual release disposition code
AND The system evaluates the final status of the cargo
THEN:
- • The system determines if the cargo is fully released by checking for any remaining hold or restriction codes and validating release quantities
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo status evaluation determines the cargo is fully released.
Trigger Criteria:
- Context: The cargo status evaluation determines the cargo is fully released
- Applied to: Set Cargo Release Status
- Action: Manual release processing is completed
Logic Flow:
IF The cargo status evaluation determines the cargo is fully released
AND Manual release processing is completed
THEN:
- • The system sets the cargo status to 'RELSD' (Released) and updates all related status flags
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has been set to released status through manual release.
Trigger Criteria:
- Context: A cargo has been set to released status through manual release
- Applied to: Calculate Release Quantities
- Action: The system processes the release quantities
Logic Flow:
IF A cargo has been set to released status through manual release
AND The system processes the release quantities
THEN:
- • The system calculates the total released quantity based on the manual release disposition and updates the cargo record with the new released amount
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has been successfully manually released with updated quantities.
Trigger Criteria:
- Context: A cargo has been successfully manually released with updated quantities
- Applied to: Generate Release Notification
- Action: The system completes the release processing
Logic Flow:
IF A cargo has been successfully manually released with updated quantities
AND The system completes the release processing
THEN:
- • The system generates and sends release notifications to brokers, freight forwarders, and other stakeholders via Merlin messaging system
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when manual release processing has been completed for a cargo.
Trigger Criteria:
- Context: Manual release processing has been completed for a cargo
- Applied to: Update Cargo Status Flags
- Action: The system finalizes the cargo status changes
Logic Flow:
IF Manual release processing has been completed for a cargo
AND The system finalizes the cargo status changes
THEN:
- • The system updates all cargo status flags including hold indicators, release flags, and processing status markers to reflect the current state
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when manual release processing has been successfully completed.
Trigger Criteria:
- Context: Manual release processing has been successfully completed
- Applied to: Create Audit Trail Entry
- Action: The system finalizes all cargo updates
Logic Flow:
IF Manual release processing has been successfully completed
AND The system finalizes all cargo updates
THEN:
- • The system creates detailed audit trail entries including before/after status, user identification, timestamp, and transaction details for compliance and tracking purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when manual release request fails validation or processing.
Trigger Criteria:
- Context: A manual release request fails validation or processing
- Applied to: Generate Error Message
- Action: The system encounters an error condition
Logic Flow:
IF A manual release request fails validation or processing
AND The system encounters an error condition
THEN:
- • The system generates a specific error message describing the failure reason and routes it to the appropriate error handling system
R-GCX016E-cbl-02102 (+14) File: GCX016E.cbl Business Rule: Auto Release Processing Logic
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when auto release request is received with a disposition code.
Trigger Criteria:
- Context: An auto release request is received with a disposition code
- Applied to: Validate Auto Release Disposition Code
- Action: The system validates the disposition code against the disposition code table
Logic Flow:
IF An auto release request is received with a disposition code
AND The system validates the disposition code against the disposition code table
THEN:
- • The system confirms the code is valid for auto release processing or rejects invalid codes
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid auto release disposition code is being processed.
Trigger Criteria:
- Context: A valid auto release disposition code is being processed
- Applied to: Duplicate Auto Release Found?
- Action: The system searches the existing status arrays for the same auto release code
Logic Flow:
IF A valid auto release disposition code is being processed
AND The system searches the existing status arrays for the same auto release code
THEN:
- • The system identifies if a duplicate auto release code exists and flags it for removal
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when duplicate auto release code is found in the status array.
Trigger Criteria:
- Context: A duplicate auto release code is found in the status array
- Applied to: Remove Existing Auto Release Code
- Action: The system processes the new auto release request
Logic Flow:
IF A duplicate auto release code is found in the status array
AND The system processes the new auto release request
THEN:
- • The system removes the existing auto release code from the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when any existing duplicate auto release codes have been removed.
Trigger Criteria:
- Context: Any existing duplicate auto release codes have been removed
- Applied to: Add New Auto Release Code to Status Array
- Action: The system processes a valid auto release request
Logic Flow:
IF Any existing duplicate auto release codes have been removed
AND The system processes a valid auto release request
THEN:
- • The system adds the new auto release code to the cargo's status array with appropriate sequence and occurrence data
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when auto release code has been added to the status array.
Trigger Criteria:
- Context: An auto release code has been added to the status array
- Applied to: Cargo Currently Held?
- Action: The system evaluates the current cargo status including all active holds
Logic Flow:
IF An auto release code has been added to the status array
AND The system evaluates the current cargo status including all active holds
THEN:
- • The system determines if the cargo is currently held and requires release processing or if no release action is needed
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo is currently held and eligible for auto release.
Trigger Criteria:
- Context: Cargo is currently held and eligible for auto release
- Applied to: Calculate Release Impact on Quantities
- Action: The system calculates the impact on release quantities based on current held amounts and requested release quantities
Logic Flow:
IF Cargo is currently held and eligible for auto release
AND The system calculates the impact on release quantities based on current held amounts and requested release quantities
THEN:
- • The system determines the quantity impact and whether full or partial release is possible
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when release quantity impact has been calculated.
Trigger Criteria:
- Context: Release quantity impact has been calculated
- Applied to: Full Release Possible?
- Action: The system evaluates if all cargo quantities can be fully released without restrictions
Logic Flow:
IF Release quantity impact has been calculated
AND The system evaluates if all cargo quantities can be fully released without restrictions
THEN:
- • The system determines if full release is feasible or if partial release processing is required
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when full release is determined to be possible.
Trigger Criteria:
- Context: Full release is determined to be possible
- Applied to: Set Cargo Status to Released
- Action: The system processes the auto release request
Logic Flow:
IF Full release is determined to be possible
AND The system processes the auto release request
THEN:
- • The system sets the cargo status to released and updates all related status indicators
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when auto release processing has determined the release impact.
Trigger Criteria:
- Context: Auto release processing has determined the release impact
- Applied to: Update Release Quantities
- Action: The system updates cargo quantities for either full or partial release
Logic Flow:
IF Auto release processing has determined the release impact
AND The system updates cargo quantities for either full or partial release
THEN:
- • The system updates released quantities, remaining held quantities, and total quantity balances
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when auto release processing has been completed with quantity updates.
Trigger Criteria:
- Context: Auto release processing has been completed with quantity updates
- Applied to: Generate Auto Release Notification
- Action: The system generates notifications for the auto release action
Logic Flow:
IF Auto release processing has been completed with quantity updates
AND The system generates notifications for the auto release action
THEN:
- • The system creates Merlin messages or email notifications to inform relevant parties of the auto release
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when auto release notifications have been generated.
Trigger Criteria:
- Context: Auto release notifications have been generated
- Applied to: Log Auto Release Action
- Action: The system logs the auto release action
Logic Flow:
IF Auto release notifications have been generated
AND The system logs the auto release action
THEN:
- • The system creates audit records with cargo details, release quantities, and timestamp information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when auto release action has been logged.
Trigger Criteria:
- Context: Auto release action has been logged
- Applied to: Update Status Array in Database
- Action: The system updates the database with the modified status array
Logic Flow:
IF Auto release action has been logged
AND The system updates the database with the modified status array
THEN:
- • The system replaces the cargo's S09 status segments with the updated status array information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when status array has been updated in the database.
Trigger Criteria:
- Context: Status array has been updated in the database
- Applied to: Trigger GCCIIS Status Update
- Action: The system triggers GCCIIS integration for status synchronization
Logic Flow:
IF Status array has been updated in the database
AND The system triggers GCCIIS integration for status synchronization
THEN:
- • The system calls GCCIIS with appropriate cargo status information for external system updates
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when auto release request is received with an invalid disposition code.
Trigger Criteria:
- Context: An auto release request is received with an invalid disposition code
- Applied to: Generate Error Message
- Action: The disposition code validation fails
Logic Flow:
IF An auto release request is received with an invalid disposition code
AND The disposition code validation fails
THEN:
- • The system generates an error message indicating invalid disposition code and stops auto release processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when auto release code has been added to status array.
Trigger Criteria:
- Context: Auto release code has been added to status array
- Applied to: Skip Auto Release Processing
- Action: The system determines cargo is not currently held
Logic Flow:
IF Auto release code has been added to status array
AND The system determines cargo is not currently held
THEN:
- • The system skips release quantity processing and proceeds to completion without release actions
R-GCX016E-cbl-02117 (+10) File: GCX016E.cbl Business Rule: Disposition Code Table Lookup and Validation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code needs to be validated. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A disposition code needs to be validated
- Applied to: Call GCCTBIO to Access DC Table
- Action: The system calls GCCTBIO to access the DC table
Logic Flow:
IF A disposition code needs to be validated
AND The system calls GCCTBIO to access the DC table
THEN:
- • The DC table is accessed and made available for code lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code from x4 or v9 segment.
Trigger Criteria:
- Context: A disposition code from X4 or V9 segment
- Applied to: Disposition Code Found in Table?
- Action: The system searches for the code in the DC table
Logic Flow:
IF A disposition code from X4 or V9 segment
AND The system searches for the code in the DC table
THEN:
- • The system determines if the code exists and is valid for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code exists in the dc table.
Trigger Criteria:
- Context: A disposition code exists in the DC table
- Applied to: Retrieve Disposition Code Information
- Action: The code lookup is successful
Logic Flow:
IF A disposition code exists in the DC table
AND The code lookup is successful
THEN:
- • The system retrieves all associated code information including description and processing rules
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code information has been retrieved from the table.
Trigger Criteria:
- Context: Disposition code information has been retrieved from the table
- Applied to: Extract Code Description
- Action: The system processes the code information
Logic Flow:
IF Disposition code information has been retrieved from the table
AND The system processes the code information
THEN:
- • The code description is extracted and made available for use in messages and processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code information has been retrieved and description extracted.
Trigger Criteria:
- Context: Disposition code information has been retrieved and description extracted
- Applied to: Extract Processing Rules
- Action: The system processes the code details
Logic Flow:
IF Disposition code information has been retrieved and description extracted
AND The system processes the code details
THEN:
- • The processing rules and business logic for the code are extracted and prepared for execution
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code has been successfully validated and information extracted.
Trigger Criteria:
- Context: Disposition code has been successfully validated and information extracted
- Applied to: Set Valid Code Flag
- Action: All code validation steps are complete
Logic Flow:
IF Disposition code has been successfully validated and information extracted
AND All code validation steps are complete
THEN:
- • The system sets the valid code flag to allow continued processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code is not found in the dc table.
Trigger Criteria:
- Context: A disposition code is not found in the DC table
- Applied to: Generate Merlin Error Message
- Action: The code validation fails
Logic Flow:
IF A disposition code is not found in the DC table
AND The code validation fails
THEN:
- • The system generates a Merlin error message indicating the unknown disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code is not found in the dc table.
Trigger Criteria:
- Context: A disposition code is not found in the DC table
- Applied to: Set Invalid Code Flag
- Action: The error message has been generated
Logic Flow:
IF A disposition code is not found in the DC table
AND The error message has been generated
THEN:
- • The system sets the invalid code flag to prevent normal processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when invalid disposition code has been identified and flagged.
Trigger Criteria:
- Context: An invalid disposition code has been identified and flagged
- Applied to: Log Unknown Code Error
- Action: The invalid code flag is set
Logic Flow:
IF An invalid disposition code has been identified and flagged
AND The invalid code flag is set
THEN:
- • The system logs the unknown code error with relevant details for audit trail
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code has been validated and marked as valid.
Trigger Criteria:
- Context: A disposition code has been validated and marked as valid
- Applied to: Continue with Code Processing
- Action: The valid code flag is set
Logic Flow:
IF A disposition code has been validated and marked as valid
AND The valid code flag is set
THEN:
- • The system continues with normal disposition code processing using the extracted information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code has been identified as invalid and logged.
Trigger Criteria:
- Context: A disposition code has been identified as invalid and logged
- Applied to: Skip Code Processing
- Action: The invalid code flag is set and error is logged
Logic Flow:
IF A disposition code has been identified as invalid and logged
AND The invalid code flag is set and error is logged
THEN:
- • The system skips normal disposition code processing to prevent further errors
R-GCX016E-cbl-02128 (+11) File: GCX016E.cbl Business Rule: Counterpart Disposition Code Detection and Removal
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when new disposition code is being processed for a cargo and the cargo has an existing status array with disposition codes.
Trigger Criteria:
- Context: A new disposition code is being processed for a cargo AND the cargo has an existing status array with disposition codes
- Applied to: Check for Conflicting Codes?
- Action: The system evaluates the new disposition code against existing codes
Logic Flow:
IF A new disposition code is being processed for a cargo AND the cargo has an existing status array with disposition codes
AND The system evaluates the new disposition code against existing codes
THEN:
- • The system identifies if there are any conflicting or counterpart codes that need to be addressed
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has existing hold disposition codes in its status array and a new release disposition code is being processed.
Trigger Criteria:
- Context: A cargo has existing hold disposition codes in its status array AND a new release disposition code is being processed
- Applied to: Hold vs Release Conflict?
- Action: The system checks for hold vs release conflicts
Logic Flow:
IF A cargo has existing hold disposition codes in its status array AND a new release disposition code is being processed
AND The system checks for hold vs release conflicts
THEN:
- • The system identifies the conflicting hold codes that should be removed when the release code is applied
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo has existing proceed disposition codes in its status array and a new hold disposition code is being processed or a cargo has existing hold codes and a new proceed code is being processed.
Trigger Criteria:
- Context: A cargo has existing proceed disposition codes in its status array AND a new hold disposition code is being processed OR a cargo has existing hold codes AND a new proceed code is being processed
- Applied to: Proceed vs Hold Conflict?
- Action: The system checks for proceed vs hold conflicts
Logic Flow:
IF A cargo has existing proceed disposition codes in its status array AND a new hold disposition code is being processed OR a cargo has existing hold codes AND a new proceed code is being processed
AND The system checks for proceed vs hold conflicts
THEN:
- • The system identifies the conflicting codes that should be removed based on the business precedence rules
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has existing seizure disposition codes in its status array and a new release disposition code is being processed.
Trigger Criteria:
- Context: A cargo has existing seizure disposition codes in its status array AND a new release disposition code is being processed
- Applied to: Seizure vs Release Conflict?
- Action: The system checks for seizure vs release conflicts
Logic Flow:
IF A cargo has existing seizure disposition codes in its status array AND a new release disposition code is being processed
AND The system checks for seizure vs release conflicts
THEN:
- • The system identifies the conflicting seizure codes that should be removed when the release code is applied
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has existing arrival disposition codes in its status array and a new cancellation disposition code is being processed or a cargo has existing cancellation codes and a new arrival code is being processed.
Trigger Criteria:
- Context: A cargo has existing arrival disposition codes in its status array AND a new cancellation disposition code is being processed OR a cargo has existing cancellation codes AND a new arrival code is being processed
- Applied to: Arrival vs Cancel Conflict?
- Action: The system checks for arrival vs cancel conflicts
Logic Flow:
IF A cargo has existing arrival disposition codes in its status array AND a new cancellation disposition code is being processed OR a cargo has existing cancellation codes AND a new arrival code is being processed
AND The system checks for arrival vs cancel conflicts
THEN:
- • The system identifies the conflicting codes that should be removed based on the most recent action
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when conflicting disposition code has been identified in the cargo status array and business rules define the precedence between the codes.
Trigger Criteria:
- Context: A conflicting disposition code has been identified in the cargo status array AND business rules define the precedence between the codes
- Applied to: Code Should Be Removed?
- Action: The system applies business rules to determine code precedence
Logic Flow:
IF A conflicting disposition code has been identified in the cargo status array AND business rules define the precedence between the codes
AND The system applies business rules to determine code precedence
THEN:
- • The system decides whether the existing conflicting code should be removed to allow the new code to be processed
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when conflicting disposition code has been identified for removal and the code exists in the cargo status array.
Trigger Criteria:
- Context: A conflicting disposition code has been identified for removal AND the code exists in the cargo status array
- Applied to: Mark Counterpart Code for Removal
- Action: The system processes the removal decision
Logic Flow:
IF A conflicting disposition code has been identified for removal AND the code exists in the cargo status array
AND The system processes the removal decision
THEN:
- • The system marks the conflicting code for removal while preserving other status array elements
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition codes have been marked for removal from the cargo status array.
Trigger Criteria:
- Context: Disposition codes have been marked for removal from the cargo status array
- Applied to: Remove Conflicting Code from Array
- Action: The system executes the removal process
Logic Flow:
IF Disposition codes have been marked for removal from the cargo status array
AND The system executes the removal process
THEN:
- • The system removes the marked codes from the status array AND maintains the integrity of remaining array elements
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition codes have been removed from the cargo status array creating gaps in the array structure.
Trigger Criteria:
- Context: Disposition codes have been removed from the cargo status array creating gaps in the array structure
- Applied to: Reorganize Status Array
- Action: The system reorganizes the array
Logic Flow:
IF Disposition codes have been removed from the cargo status array creating gaps in the array structure
AND The system reorganizes the array
THEN:
- • The system compacts the array by moving remaining elements to eliminate gaps AND preserves the logical order of disposition codes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status array has been reorganized after removing conflicting codes.
Trigger Criteria:
- Context: The cargo status array has been reorganized after removing conflicting codes
- Applied to: Update Array Sequence Numbers
- Action: The system updates sequence numbers
Logic Flow:
IF The cargo status array has been reorganized after removing conflicting codes
AND The system updates sequence numbers
THEN:
- • The system assigns consecutive sequence numbers to all remaining disposition codes in the array starting from 1
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo status array has been modified through counterpart code removal and reorganization.
Trigger Criteria:
- Context: The cargo status array has been modified through counterpart code removal and reorganization
- Applied to: Validate Array Integrity
- Action: The system validates array integrity
Logic Flow:
IF The cargo status array has been modified through counterpart code removal and reorganization
AND The system validates array integrity
THEN:
- • The system confirms that all remaining disposition codes are valid AND sequence numbers are consecutive AND no business rule conflicts remain in the array
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when conflicting disposition code has been removed from the cargo status array.
Trigger Criteria:
- Context: A conflicting disposition code has been removed from the cargo status array
- Applied to: Log Removal Action
- Action: The system logs the removal action
Logic Flow:
IF A conflicting disposition code has been removed from the cargo status array
AND The system logs the removal action
THEN:
- • The system records the removed disposition code details AND the reason for removal AND the timestamp of the action for audit trail purposes
R-GCX016E-cbl-02140 (+15) File: GCX016E.cbl Business Rule: Status Array Management and Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record exists in the system.
Trigger Criteria:
- Context: A cargo record exists in the system
- Applied to: Retrieve S09 Status Segments from Database
- Action: The system needs to process disposition codes for the cargo
Logic Flow:
IF A cargo record exists in the system
AND The system needs to process disposition codes for the cargo
THEN:
- • The system retrieves all S09 status segments associated with the cargo from the database
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record has no existing s09 status segments in the database.
Trigger Criteria:
- Context: A cargo record has no existing S09 status segments in the database
- Applied to: Initialize Empty Status Array
- Action: The system attempts to retrieve status segments
Logic Flow:
IF A cargo record has no existing S09 status segments in the database
AND The system attempts to retrieve status segments
THEN:
- • The system initializes empty S09A status arrays with zero entries and resets sequence counters
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when s09 status segments exist in the database for a cargo.
Trigger Criteria:
- Context: S09 status segments exist in the database for a cargo
- Applied to: Populate S09A Status Arrays from Database Segments
- Action: The system retrieves the segments successfully
Logic Flow:
IF S09 status segments exist in the database for a cargo
AND The system retrieves the segments successfully
THEN:
- • The system populates S09A status arrays with disposition codes, quantities, entry numbers, and sequence information from the database segments
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status segments are populated from database with various sequence numbers.
Trigger Criteria:
- Context: Status segments are populated from database with various sequence numbers
- Applied to: Track Maximum Sequences Fetched
- Action: The system processes all retrieved segments
Logic Flow:
IF Status segments are populated from database with various sequence numbers
AND The system processes all retrieved segments
THEN:
- • The system identifies and stores the maximum sequence number found across all status arrays for future sequencing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when new disposition code is received for processing and existing status arrays contain disposition codes.
Trigger Criteria:
- Context: A new disposition code is received for processing and existing status arrays contain disposition codes
- Applied to: Search for Duplicate Disposition Codes
- Action: The system processes the new disposition code
Logic Flow:
IF A new disposition code is received for processing and existing status arrays contain disposition codes
AND The system processes the new disposition code
THEN:
- • The system searches all status arrays to determine if the same disposition code with matching entry number and quantity already exists
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when duplicate disposition code is found in the status arrays.
Trigger Criteria:
- Context: A duplicate disposition code is found in the status arrays
- Applied to: Handle Duplicate According to Business Rules
- Action: The duplicate has matching entry number and quantity
Logic Flow:
IF A duplicate disposition code is found in the status arrays
AND The duplicate has matching entry number and quantity
THEN:
- • The system applies business rules such as removal, replacement, or skip processing based on the disposition code type and current cargo status
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when new disposition code needs to be added to status arrays and no duplicates exist.
Trigger Criteria:
- Context: A new disposition code needs to be added to status arrays and no duplicates exist
- Applied to: Find Insertion Point for Proper Sequencing
- Action: The system needs to insert the disposition code
Logic Flow:
IF A new disposition code needs to be added to status arrays and no duplicates exist
AND The system needs to insert the disposition code
THEN:
- • The system finds the appropriate insertion point to maintain proper sequence numbering and array organization
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when insertion point has been determined for a new disposition code.
Trigger Criteria:
- Context: An insertion point has been determined for a new disposition code
- Applied to: Insert New Disposition Code in Array
- Action: The system inserts the disposition code
Logic Flow:
IF An insertion point has been determined for a new disposition code
AND The system inserts the disposition code
THEN:
- • The system adds the disposition code with its associated quantity, entry number, and sequence information to the appropriate status array position
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when new disposition code has been inserted into the status array.
Trigger Criteria:
- Context: A new disposition code has been inserted into the status array
- Applied to: Check for Counterpart Codes to Remove
- Action: The system checks for business rule conflicts
Logic Flow:
IF A new disposition code has been inserted into the status array
AND The system checks for business rule conflicts
THEN:
- • The system identifies any existing disposition codes that are counterparts or conflicts with the newly added code and must be removed
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when counterpart or conflicting disposition codes are identified in the status arrays.
Trigger Criteria:
- Context: Counterpart or conflicting disposition codes are identified in the status arrays
- Applied to: Remove Conflicting Disposition Codes
- Action: Business rules require their removal
Logic Flow:
IF Counterpart or conflicting disposition codes are identified in the status arrays
AND Business rules require their removal
THEN:
- • The system removes the conflicting disposition codes from the status arrays
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition codes have been removed from status arrays creating gaps.
Trigger Criteria:
- Context: Disposition codes have been removed from status arrays creating gaps
- Applied to: Reorganize Array After Removal
- Action: The removal process is complete
Logic Flow:
IF Disposition codes have been removed from status arrays creating gaps
AND The removal process is complete
THEN:
- • The system reorganizes the arrays by moving remaining entries to eliminate gaps and maintain proper array structure
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status arrays have been modified through insertion and removal operations.
Trigger Criteria:
- Context: Status arrays have been modified through insertion and removal operations
- Applied to: Validate Array Sequence Numbers
- Action: The system validates the array integrity
Logic Flow:
IF Status arrays have been modified through insertion and removal operations
AND The system validates the array integrity
THEN:
- • The system verifies that sequence numbers are properly ordered and consistent across all status array entries
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status arrays have been modified and sequence numbers validated.
Trigger Criteria:
- Context: Status arrays have been modified and sequence numbers validated
- Applied to: Update Maximum Sequence Counter
- Action: The system completes array processing
Logic Flow:
IF Status arrays have been modified and sequence numbers validated
AND The system completes array processing
THEN:
- • The system updates the maximum sequence counter to reflect the highest sequence number currently in use
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status arrays have been processed and are ready for database storage.
Trigger Criteria:
- Context: Status arrays have been processed and are ready for database storage
- Applied to: Convert Status Array Back to Database Format
- Action: The system needs to save the updated status information
Logic Flow:
IF Status arrays have been processed and are ready for database storage
AND The system needs to save the updated status information
THEN:
- • The system converts the S09A status arrays back to S09 database segment format with proper structure and sequencing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status arrays have been converted to database format.
Trigger Criteria:
- Context: Status arrays have been converted to database format
- Applied to: Replace Status Segments in Database
- Action: The system updates the cargo record
Logic Flow:
IF Status arrays have been converted to database format
AND The system updates the cargo record
THEN:
- • The system replaces the existing S09 status segments in the database with the updated segments containing current disposition code information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo is not a cprs shipment and car identification information is available from n7 segment processing.
Trigger Criteria:
- Context: A cargo is not a CPRS shipment and car identification information is available from N7 segment processing
- Applied to: Update Car ID Information for Non-CPRS Cargo
- Action: The system completes status array processing
Logic Flow:
IF A cargo is not a CPRS shipment and car identification information is available from N7 segment processing
AND The system completes status array processing
THEN:
- • The system updates the cargo record with the car ID information derived from the equipment initial and number
R-GCX016E-cbl-02156 (+13) File: GCX016E.cbl Business Rule: Release Quantity Calculation Logic
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record exists with release quantity information.
Trigger Criteria:
- Context: A cargo record exists with release quantity information
- Applied to: Retrieve Current Release Quantity
- Action: The system needs to calculate new release quantities
Logic Flow:
IF A cargo record exists with release quantity information
AND The system needs to calculate new release quantities
THEN:
- • The current release quantity is retrieved from the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code is being processed for a cargo.
Trigger Criteria:
- Context: A disposition code is being processed for a cargo
- Applied to: Get Disposition Code Action Type
- Action: The system evaluates the disposition code action requirements
Logic Flow:
IF A disposition code is being processed for a cargo
AND The system evaluates the disposition code action requirements
THEN:
- • The action type is determined as either Add, Subtract, or No Action based on the disposition code characteristics
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code with add action type is being processed.
Trigger Criteria:
- Context: A disposition code with add action type is being processed
- Applied to: Add Quantity Action
- Action: The action type is determined as Add
Logic Flow:
IF A disposition code with add action type is being processed
AND The action type is determined as Add
THEN:
- • The specified quantity is prepared to be added to the current release quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code with subtract action type is being processed.
Trigger Criteria:
- Context: A disposition code with subtract action type is being processed
- Applied to: Subtract Quantity Action
- Action: The action type is determined as Subtract
Logic Flow:
IF A disposition code with subtract action type is being processed
AND The action type is determined as Subtract
THEN:
- • The specified quantity is prepared to be subtracted from the current release quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when current release quantity and action quantity are available.
Trigger Criteria:
- Context: Current release quantity and action quantity are available
- Applied to: Calculate New Release Quantity
- Action: Add or subtract action needs to be applied
Logic Flow:
IF Current release quantity and action quantity are available
AND Add or subtract action needs to be applied
THEN:
- • New release quantity is calculated by adding or subtracting the action quantity from current release quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when new release quantity has been calculated.
Trigger Criteria:
- Context: A new release quantity has been calculated
- Applied to: Quantity Cannot Be Negative
- Action: The calculated quantity is less than zero
Logic Flow:
IF A new release quantity has been calculated
AND The calculated quantity is less than zero
THEN:
- • The quantity calculation is rejected and processing terminates with validation error
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when new release quantity has been calculated and total cargo quantity is known.
Trigger Criteria:
- Context: A new release quantity has been calculated and total cargo quantity is known
- Applied to: Quantity Cannot Exceed Total
- Action: The calculated release quantity exceeds the total cargo quantity
Logic Flow:
IF A new release quantity has been calculated and total cargo quantity is known
AND The calculated release quantity exceeds the total cargo quantity
THEN:
- • The quantity calculation is rejected and processing terminates with validation error
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when new release quantity has passed all validation checks.
Trigger Criteria:
- Context: A new release quantity has passed all validation checks
- Applied to: Update Release Quantity
- Action: The quantity is valid and within acceptable ranges
Logic Flow:
IF A new release quantity has passed all validation checks
AND The quantity is valid and within acceptable ranges
THEN:
- • The cargo record is updated with the new release quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo release quantity has been updated.
Trigger Criteria:
- Context: Cargo release quantity has been updated
- Applied to: Set Release Status Flags
- Action: Release quantity changes require status flag updates
Logic Flow:
IF Cargo release quantity has been updated
AND Release quantity changes require status flag updates
THEN:
- • Appropriate release status flags are set on the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has an updated release quantity and known total quantity.
Trigger Criteria:
- Context: Cargo has an updated release quantity and known total quantity
- Applied to: Full Release?
- Action: The system needs to determine release completion status
Logic Flow:
IF Cargo has an updated release quantity and known total quantity
AND The system needs to determine release completion status
THEN:
- • If release quantity equals total quantity, cargo is fully released;
otherwise cargo is partially released
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo release quantity equals the total cargo quantity.
Trigger Criteria:
- Context: Cargo release quantity equals the total cargo quantity
- Applied to: Mark Cargo as Fully Released
- Action: Full release status is determined
Logic Flow:
IF Cargo release quantity equals the total cargo quantity
AND Full release status is determined
THEN:
- • Cargo is marked with fully released status
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo release quantity is less than the total cargo quantity.
Trigger Criteria:
- Context: Cargo release quantity is less than the total cargo quantity
- Applied to: Mark Cargo as Partially Released
- Action: Partial release status is determined
Logic Flow:
IF Cargo release quantity is less than the total cargo quantity
AND Partial release status is determined
THEN:
- • Cargo is marked with partially released status
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo release quantity has been successfully updated.
Trigger Criteria:
- Context: Cargo release quantity has been successfully updated
- Applied to: Log Quantity Change
- Action: Quantity change needs to be recorded for audit purposes
Logic Flow:
IF Cargo release quantity has been successfully updated
AND Quantity change needs to be recorded for audit purposes
THEN:
- • A log entry is created with old quantity, new quantity, and change details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when release quantity calculation has been completed and logged.
Trigger Criteria:
- Context: Release quantity calculation has been completed and logged
- Applied to: Generate Release Impact Message
- Action: Stakeholders need to be notified of quantity changes
Logic Flow:
IF Release quantity calculation has been completed and logged
AND Stakeholders need to be notified of quantity changes
THEN:
- • A release impact message is generated showing the quantity change and its business impact
R-GCX016E-cbl-02170 (+17) File: GCX016E.cbl Business Rule: Hold Cargo Notification Generation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo has completed status evaluation processing.
Trigger Criteria:
- Context: A cargo has completed status evaluation processing
- Applied to: Cargo Hold Status Detected?
- Action: The system checks the cargo's current status flags
Logic Flow:
IF A cargo has completed status evaluation processing
AND The system checks the cargo's current status flags
THEN:
- • The system identifies if the cargo has any active hold conditions (border hold, destination hold, FDA hold, piece count hold, or general hold) and proceeds with hold notification processing if holds are detected,
otherwise ends the notification process
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo with hold status has been identified for notification.
Trigger Criteria:
- Context: A cargo with hold status has been identified for notification
- Applied to: Retrieve Location Information
- Action: The system needs to create a detailed hold notification
Logic Flow:
IF A cargo with hold status has been identified for notification
AND The system needs to create a detailed hold notification
THEN:
- • The system retrieves location information from location tables (GCSTBRT) including origin, destination, and current location details to provide business context for the hold notification
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when location information has been retrieved for a held cargo.
Trigger Criteria:
- Context: Location information has been retrieved for a held cargo
- Applied to: Gather Disposition Code Details
- Action: The system processes disposition code information
Logic Flow:
IF Location information has been retrieved for a held cargo
AND The system processes disposition code information
THEN:
- • The system gathers disposition code details from status segments (GCSUSS09) and disposition code tables including code descriptions, entry numbers, quantities, and associated business reasons for the hold
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code details have been gathered for a held cargo.
Trigger Criteria:
- Context: Disposition code details have been gathered for a held cargo
- Applied to: Determine Hold Type
- Action: The system evaluates the hold conditions and status flags
Logic Flow:
IF Disposition code details have been gathered for a held cargo
AND The system evaluates the hold conditions and status flags
THEN:
- • The system determines the specific hold type (Border Hold, Destination Hold, FDA Hold, Piece Count Hold, or General Hold) based on the cargo's status flags and disposition codes
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has been classified as having a border hold type.
Trigger Criteria:
- Context: A cargo has been classified as having a border hold type
- Applied to: Border Hold Notification
- Action: The system processes the border hold notification
Logic Flow:
IF A cargo has been classified as having a border hold type
AND The system processes the border hold notification
THEN:
- • The system creates a border-specific hold notification with appropriate border location context, regulatory information, and routes the notification to border processing personnel
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has been classified as having a destination hold type.
Trigger Criteria:
- Context: A cargo has been classified as having a destination hold type
- Applied to: Destination Hold Notification
- Action: The system processes the destination hold notification
Logic Flow:
IF A cargo has been classified as having a destination hold type
AND The system processes the destination hold notification
THEN:
- • The system creates a destination-specific hold notification with destination location details, consignee information, and routes the notification to destination processing personnel
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has been classified as having an fda hold type.
Trigger Criteria:
- Context: A cargo has been classified as having an FDA hold type
- Applied to: FDA Hold Notification
- Action: The system processes the FDA hold notification
Logic Flow:
IF A cargo has been classified as having an FDA hold type
AND The system processes the FDA hold notification
THEN:
- • The system creates an FDA-specific hold notification with regulatory compliance details, FDA examination requirements, and routes the notification to FDA processing personnel and relevant regulatory contacts
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has been classified as having a piece count hold type.
Trigger Criteria:
- Context: A cargo has been classified as having a piece count hold type
- Applied to: Piece Count Hold Notification
- Action: The system processes the piece count hold notification
Logic Flow:
IF A cargo has been classified as having a piece count hold type
AND The system processes the piece count hold notification
THEN:
- • The system creates a piece count-specific hold notification with quantity details, release information, partial hold status, and routes the notification to quantity verification personnel
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has been classified as having a general hold type (not border, destination, fda, or piece count).
Trigger Criteria:
- Context: A cargo has been classified as having a general hold type (not border, destination, FDA, or piece count)
- Applied to: General Hold Notification
- Action: The system processes the general hold notification
Logic Flow:
IF A cargo has been classified as having a general hold type (not border, destination, FDA, or piece count)
AND The system processes the general hold notification
THEN:
- • The system creates a general hold notification with standard hold information, disposition code details, and routes the notification to general processing personnel
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when specific hold type notification has been processed.
Trigger Criteria:
- Context: A specific hold type notification has been processed
- Applied to: Format Hold Details
- Action: The system formats the hold details
Logic Flow:
IF A specific hold type notification has been processed
AND The system formats the hold details
THEN:
- • The system structures the hold information into a standardized format including hold type, reason codes, dates, quantities, and regulatory information for consistent business presentation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when hold details have been formatted for a cargo notification.
Trigger Criteria:
- Context: Hold details have been formatted for a cargo notification
- Applied to: Include Equipment Information
- Action: The system includes equipment information
Logic Flow:
IF Hold details have been formatted for a cargo notification
AND The system includes equipment information
THEN:
- • The system adds equipment details from cargo data (GCSUSRT) including car ID, equipment type, equipment number, and container information to the hold notification
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment information has been included in the hold notification.
Trigger Criteria:
- Context: Equipment information has been included in the hold notification
- Applied to: Include Waybill Information
- Action: The system includes waybill information
Logic Flow:
IF Equipment information has been included in the hold notification
AND The system includes waybill information
THEN:
- • The system adds waybill details from cargo data including waybill number, shipment references, and related shipping documentation information to the hold notification
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when waybill information has been included in the hold notification.
Trigger Criteria:
- Context: Waybill information has been included in the hold notification
- Applied to: Include CCN Information
- Action: The system includes CCN information
Logic Flow:
IF Waybill information has been included in the hold notification
AND The system includes CCN information
THEN:
- • The system adds Cargo Control Number (CCN) details including US CCN, Canadian CCN if applicable, and related manifest information to the hold notification
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn information has been included in the hold notification.
Trigger Criteria:
- Context: CCN information has been included in the hold notification
- Applied to: Add Location Context
- Action: The system adds location context
Logic Flow:
IF CCN information has been included in the hold notification
AND The system adds location context
THEN:
- • The system includes location context from retrieved location information including origin location, destination location, current location, border crossing points, and relevant geographic identifiers
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when location context has been added to the hold notification.
Trigger Criteria:
- Context: Location context has been added to the hold notification
- Applied to: Add Disposition Code Description
- Action: The system adds disposition code descriptions
Logic Flow:
IF Location context has been added to the hold notification
AND The system adds disposition code descriptions
THEN:
- • The system includes disposition code descriptions from disposition code tables providing business-friendly explanations of the codes, regulatory requirements, and action items associated with the hold
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all hold notification components (equipment, waybill, ccn, location, disposition codes) have been gathered.
Trigger Criteria:
- Context: All hold notification components (equipment, waybill, CCN, location, disposition codes) have been gathered
- Applied to: Create Detailed Hold Message
- Action: The system creates the detailed hold message
Logic Flow:
IF All hold notification components (equipment, waybill, CCN, location, disposition codes) have been gathered
AND The system creates the detailed hold message
THEN:
- • The system assembles all information into a structured, comprehensive hold message with proper formatting, business terminology, and complete cargo context for effective business communication
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when detailed hold message has been created.
Trigger Criteria:
- Context: A detailed hold message has been created
- Applied to: Route to Business Users
- Action: The system routes the notification to business users
Logic Flow:
IF A detailed hold message has been created
AND The system routes the notification to business users
THEN:
- • The system determines appropriate recipients based on hold type, location, and business rules,
then routes the notification through appropriate channels (Merlin system, email, or other communication methods) to relevant business personnel
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when hold notification has been routed to business users.
Trigger Criteria:
- Context: A hold notification has been routed to business users
- Applied to: Log Hold Notification
- Action: The system logs the notification activity
Logic Flow:
IF A hold notification has been routed to business users
AND The system logs the notification activity
THEN:
- • The system creates audit records documenting the hold notification including timestamp, recipients, hold details, and notification status for compliance and business tracking purposes
R-GCX016E-cbl-02188 (+23) File: GCX016E.cbl Business Rule: Cargo Status Evaluation and Determination
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record exists with associated status segments.
Trigger Criteria:
- Context: A cargo record exists with associated status segments
- Applied to: Retrieve Complete S09A Status Arrays
- Action: The system needs to evaluate cargo status
Logic Flow:
IF A cargo record exists with associated status segments
AND The system needs to evaluate cargo status
THEN:
- • All S09A status array segments are retrieved and made available for analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when s09a status arrays have been retrieved for a cargo.
Trigger Criteria:
- Context: S09A status arrays have been retrieved for a cargo
- Applied to: Analyze Individual Status Entries
- Action: The system processes the status array
Logic Flow:
IF S09A status arrays have been retrieved for a cargo
AND The system processes the status array
THEN:
- • Each individual status entry is analyzed for disposition code, quantity, and entry number information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when individual status entries have been analyzed.
Trigger Criteria:
- Context: Individual status entries have been analyzed
- Applied to: Hold Disposition Codes Present?
- Action: The system evaluates for hold conditions
Logic Flow:
IF Individual status entries have been analyzed
AND The system evaluates for hold conditions
THEN:
- • Hold disposition codes are identified if present in the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when hold disposition codes are present in the status array.
Trigger Criteria:
- Context: Hold disposition codes are present in the status array
- Applied to: Evaluate Hold Types
- Action: The system evaluates hold types
Logic Flow:
IF Hold disposition codes are present in the status array
AND The system evaluates hold types
THEN:
- • Hold codes are categorized as border hold, destination hold, FDA hold, piece count hold, or customs intensive hold
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when hold evaluation has been completed.
Trigger Criteria:
- Context: Hold evaluation has been completed
- Applied to: Release Disposition Codes Present?
- Action: The system evaluates for release conditions
Logic Flow:
IF Hold evaluation has been completed
AND The system evaluates for release conditions
THEN:
- • Release disposition codes are identified if present in the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when release disposition codes are present in the status array.
Trigger Criteria:
- Context: Release disposition codes are present in the status array
- Applied to: Evaluate Release Conditions
- Action: The system evaluates release conditions
Logic Flow:
IF Release disposition codes are present in the status array
AND The system evaluates release conditions
THEN:
- • Release codes are categorized as full release, partial release, or conditional release based on quantity and conditions
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when release evaluation has been completed.
Trigger Criteria:
- Context: Release evaluation has been completed
- Applied to: Proceed Disposition Codes Present?
- Action: The system evaluates for proceed conditions
Logic Flow:
IF Release evaluation has been completed
AND The system evaluates for proceed conditions
THEN:
- • Proceed disposition codes are identified if present in the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when proceed disposition codes are present in the status array.
Trigger Criteria:
- Context: Proceed disposition codes are present in the status array
- Applied to: Check In-Bond Entry Status
- Action: The system validates in-bond requirements
Logic Flow:
IF Proceed disposition codes are present in the status array
AND The system validates in-bond requirements
THEN:
- • In-bond entry status is verified as valid for proceed processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when proceed evaluation has been completed.
Trigger Criteria:
- Context: Proceed evaluation has been completed
- Applied to: Arrival/Export Codes Present?
- Action: The system evaluates for arrival or export conditions
Logic Flow:
IF Proceed evaluation has been completed
AND The system evaluates for arrival or export conditions
THEN:
- • Arrival or export disposition codes are identified if present in the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when arrival or export disposition codes are present.
Trigger Criteria:
- Context: Arrival or export disposition codes are present
- Applied to: Validate Location and Port
- Action: The system validates location requirements
Logic Flow:
IF Arrival or export disposition codes are present
AND The system validates location requirements
THEN:
- • Location and port information are verified as valid for arrival or export processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when location and port validation has been completed.
Trigger Criteria:
- Context: Location and port validation has been completed
- Applied to: Manual Release Present?
- Action: The system evaluates for manual release override
Logic Flow:
IF Location and port validation has been completed
AND The system evaluates for manual release override
THEN:
- • Manual release disposition codes are identified if present in the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when manual release disposition codes are present in the status array.
Trigger Criteria:
- Context: Manual release disposition codes are present in the status array
- Applied to: Override Hold Status
- Action: The system processes manual release override
Logic Flow:
IF Manual release disposition codes are present in the status array
AND The system processes manual release override
THEN:
- • System-generated hold status is overridden and cargo is marked for release processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when manual release evaluation has been completed.
Trigger Criteria:
- Context: Manual release evaluation has been completed
- Applied to: Multiple Conflicting Codes?
- Action: The system evaluates for conflicting disposition codes
Logic Flow:
IF Manual release evaluation has been completed
AND The system evaluates for conflicting disposition codes
THEN:
- • Multiple conflicting disposition codes are identified if they exist in the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when multiple conflicting disposition codes exist in the status array.
Trigger Criteria:
- Context: Multiple conflicting disposition codes exist in the status array
- Applied to: Apply Business Rule Priority
- Action: The system applies business rule priority
Logic Flow:
IF Multiple conflicting disposition codes exist in the status array
AND The system applies business rule priority
THEN:
- • Disposition codes are prioritized with hold taking priority over release, manual release overriding system hold, proceed requiring valid in-bond, and export requiring port validation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when business rule priority has been applied to conflicting codes.
Trigger Criteria:
- Context: Business rule priority has been applied to conflicting codes
- Applied to: Calculate Final Release Quantity
- Action: The system calculates final release quantity
Logic Flow:
IF Business rule priority has been applied to conflicting codes
AND The system calculates final release quantity
THEN:
- • Final release quantity is computed by summing all release quantities and subtracting hold quantities from the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when final release quantity has been calculated.
Trigger Criteria:
- Context: Final release quantity has been calculated
- Applied to: All Conditions Met for Release?
- Action: The system validates release conditions
Logic Flow:
IF Final release quantity has been calculated
AND The system validates release conditions
THEN:
- • All conditions are verified as met if no active holds exist, release quantity equals or exceeds cargo quantity, and all regulatory requirements are satisfied
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all conditions for release have been met.
Trigger Criteria:
- Context: All conditions for release have been met
- Applied to: RELEASED
- Action: The system sets final cargo status
Logic Flow:
IF All conditions for release have been met
AND The system sets final cargo status
THEN:
- • Cargo status is set to RELEASED and release flags are activated
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when not all conditions for release have been met.
Trigger Criteria:
- Context: Not all conditions for release have been met
- Applied to: HELD
- Action: The system sets final cargo status
Logic Flow:
IF Not all conditions for release have been met
AND The system sets final cargo status
THEN:
- • Cargo status is set to HELD with appropriate hold type designation and hold flags are activated
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo status has been set to either released or held.
Trigger Criteria:
- Context: Cargo status has been set to either RELEASED or HELD
- Applied to: Export Processing Required?
- Action: The system evaluates export processing requirements
Logic Flow:
IF Cargo status has been set to either RELEASED or HELD
AND The system evaluates export processing requirements
THEN:
- • Export processing is required if export disposition codes are present and cargo destination is outside the country
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when export processing is required for the cargo.
Trigger Criteria:
- Context: Export processing is required for the cargo
- Applied to: EXPORTED
- Action: The system processes export status
Logic Flow:
IF Export processing is required for the cargo
AND The system processes export status
THEN:
- • Cargo status is set to EXPORTED and export flags are activated with appropriate export date
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when export processing evaluation has been completed.
Trigger Criteria:
- Context: Export processing evaluation has been completed
- Applied to: Arrival Processing Required?
- Action: The system evaluates arrival processing requirements
Logic Flow:
IF Export processing evaluation has been completed
AND The system evaluates arrival processing requirements
THEN:
- • Arrival processing is required if arrival disposition codes are present and cargo has reached its destination
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when arrival processing is required for the cargo.
Trigger Criteria:
- Context: Arrival processing is required for the cargo
- Applied to: ARRIVED
- Action: The system processes arrival status
Logic Flow:
IF Arrival processing is required for the cargo
AND The system processes arrival status
THEN:
- • Cargo status is set to ARRIVED and arrival flags are activated with appropriate arrival date
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when final cargo status has been determined (released, held, exported, or arrived).
Trigger Criteria:
- Context: Final cargo status has been determined (RELEASED, HELD, EXPORTED, or ARRIVED)
- Applied to: Update Cargo Status Flags
- Action: The system updates cargo status flags
Logic Flow:
IF Final cargo status has been determined (RELEASED, HELD, EXPORTED, or ARRIVED)
AND The system updates cargo status flags
THEN:
- • All relevant status flags are updated including hold flags, release flags, export flags, arrival flags, and processing flags
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo status flags have been updated.
Trigger Criteria:
- Context: Cargo status flags have been updated
- Applied to: Generate Status Change Notification
- Action: The system generates status change notifications
Logic Flow:
IF Cargo status flags have been updated
AND The system generates status change notifications
THEN:
- • Notifications are sent to brokers, freight forwarders, and other relevant parties based on the status change type and notification preferences
R-GCX016E-cbl-02212 (+14) File: GCX016E.cbl Business Rule: Proceed Disposition Code Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when proceed disposition code is being processed for a cargo.
Trigger Criteria:
- Context: A proceed disposition code is being processed for a cargo
- Applied to: Is Cargo In-Bond Entry?
- Action: The system checks the cargo's entry type
Logic Flow:
IF A proceed disposition code is being processed for a cargo
AND The system checks the cargo's entry type
THEN:
- • The cargo is classified as in-bond if it has entry types 61, 62, 63, or 69,
otherwise it is classified as non-in-bond
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has an in-bond entry type and is undergoing proceed disposition processing.
Trigger Criteria:
- Context: A cargo has an in-bond entry type and is undergoing proceed disposition processing
- Applied to: Set Master In-Bond Flag for Entry Types 61,62,63,69
- Action: The entry type is 61, 62, 63, or 69
Logic Flow:
IF A cargo has an in-bond entry type and is undergoing proceed disposition processing
AND The entry type is 61, 62, 63, or 69
THEN:
- • The master in-bond flag is set to indicate this is a master in-bond movement
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo is being processed for proceed disposition with in-bond requirements.
Trigger Criteria:
- Context: A cargo is being processed for proceed disposition with in-bond requirements
- Applied to: Bond Information Available?
- Action: The system checks for existing bond information
Logic Flow:
IF A cargo is being processed for proceed disposition with in-bond requirements
AND The system checks for existing bond information
THEN:
- • Bond processing continues if bond data exists,
otherwise entry number validation is performed
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when bond information is available for a cargo undergoing proceed disposition processing.
Trigger Criteria:
- Context: Bond information is available for a cargo undergoing proceed disposition processing
- Applied to: Clear Existing Bond Data
- Action: The system processes the bond information
Logic Flow:
IF Bond information is available for a cargo undergoing proceed disposition processing
AND The system processes the bond information
THEN:
- • All existing bond data fields are cleared to prepare for new bond information updates
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when existing bond data has been cleared for a cargo.
Trigger Criteria:
- Context: Existing bond data has been cleared for a cargo
- Applied to: Update Bond Number Index
- Action: New bond information is being processed
Logic Flow:
IF Existing bond data has been cleared for a cargo
AND New bond information is being processed
THEN:
- • The bond number index is updated with the new bond number for tracking purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when bond number index has been updated for a cargo.
Trigger Criteria:
- Context: Bond number index has been updated for a cargo
- Applied to: Set Broker QP Information
- Action: Broker information is being processed
Logic Flow:
IF Bond number index has been updated for a cargo
AND Broker information is being processed
THEN:
- • The broker qualifying party information is set to establish broker responsibility for the bond
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when broker qp information has been set for a cargo.
Trigger Criteria:
- Context: Broker QP information has been set for a cargo
- Applied to: Update Bond Owner Details
- Action: Bond owner information is being processed
Logic Flow:
IF Broker QP information has been set for a cargo
AND Bond owner information is being processed
THEN:
- • Bond owner details are updated to reflect the current bond ownership information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when bond processing is complete or no bond information is available.
Trigger Criteria:
- Context: Bond processing is complete or no bond information is available
- Applied to: Validate Entry Number Against Existing Records
- Action: The system validates the entry number
Logic Flow:
IF Bond processing is complete or no bond information is available
AND The system validates the entry number
THEN:
- • The entry number is checked against existing broker entry number records to ensure validity
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when entry number has been validated as valid.
Trigger Criteria:
- Context: The entry number has been validated as valid
- Applied to: Process In-Bond Control Number
- Action: In-bond control number processing is initiated
Logic Flow:
IF The entry number has been validated as valid
AND In-bond control number processing is initiated
THEN:
- • The in-bond control number is processed and associated with the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when in-bond control number has been processed.
Trigger Criteria:
- Context: In-bond control number has been processed
- Applied to: Convert EDI Entry Type Codes to Internal Values
- Action: EDI entry type codes need to be converted
Logic Flow:
IF In-bond control number has been processed
AND EDI entry type codes need to be converted
THEN:
- • EDI entry type codes are converted to corresponding internal system values for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when edi entry type codes have been converted to internal values.
Trigger Criteria:
- Context: EDI entry type codes have been converted to internal values
- Applied to: Set In-Bond Processing Flags
- Action: In-bond processing flags need to be set
Logic Flow:
IF EDI entry type codes have been converted to internal values
AND In-bond processing flags need to be set
THEN:
- • Appropriate flags are set to indicate the cargo is undergoing in-bond processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all in-bond processing flags have been set or the cargo is non-in-bond.
Trigger Criteria:
- Context: All in-bond processing flags have been set or the cargo is non-in-bond
- Applied to: Update Cargo Status to Proceed
- Action: The cargo status needs to be updated
Logic Flow:
IF All in-bond processing flags have been set or the cargo is non-in-bond
AND The cargo status needs to be updated
THEN:
- • The cargo status is updated to proceed to indicate the cargo can move forward in the process
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo status has been updated to proceed.
Trigger Criteria:
- Context: The cargo status has been updated to proceed
- Applied to: Log Proceed Action
- Action: Action logging is performed
Logic Flow:
IF The cargo status has been updated to proceed
AND Action logging is performed
THEN:
- • The proceed action is logged with relevant details for audit trail and tracking purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when proceed action has been logged.
Trigger Criteria:
- Context: The proceed action has been logged
- Applied to: Generate Merlin Notification
- Action: Merlin notification is generated
Logic Flow:
IF The proceed action has been logged
AND Merlin notification is generated
THEN:
- • A notification is sent to the Merlin system to inform stakeholders of the proceed status
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when entry number validation is performed against existing records.
Trigger Criteria:
- Context: Entry number validation is performed against existing records
- Applied to: Generate Error - Invalid Entry Number
- Action: The entry number is found to be invalid or does not exist
Logic Flow:
IF Entry number validation is performed against existing records
AND The entry number is found to be invalid or does not exist
THEN:
- • An error is generated indicating the entry number is invalid and processing cannot continue
R-GCX016E-cbl-02227 (+20) File: GCX016E.cbl Business Rule: Arrival and Export Status Management
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code is being processed for cargo status management.
Trigger Criteria:
- Context: A disposition code is being processed for cargo status management
- Applied to: Check Arrival Disposition Codes
- Action: The system checks if the disposition code is AAD (Actual Arrival Date) or POD (Proof of Delivery)
Logic Flow:
IF A disposition code is being processed for cargo status management
AND The system checks if the disposition code is AAD (Actual Arrival Date) or POD (Proof of Delivery)
THEN:
- • The system identifies the code as an arrival disposition and proceeds with arrival processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code is being processed for cargo status management.
Trigger Criteria:
- Context: A disposition code is being processed for cargo status management
- Applied to: Check Export Disposition Codes
- Action: The system checks if the disposition code indicates export processing
Logic Flow:
IF A disposition code is being processed for cargo status management
AND The system checks if the disposition code indicates export processing
THEN:
- • The system identifies the code as an export disposition and proceeds with export processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code is being processed for cargo status management.
Trigger Criteria:
- Context: A disposition code is being processed for cargo status management
- Applied to: Check Cancel Arrival Codes
- Action: The system checks if the disposition code indicates cancellation of arrival
Logic Flow:
IF A disposition code is being processed for cargo status management
AND The system checks if the disposition code indicates cancellation of arrival
THEN:
- • The system identifies the code as a cancel arrival disposition and proceeds with arrival cancellation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code is being processed for cargo status management.
Trigger Criteria:
- Context: A disposition code is being processed for cargo status management
- Applied to: Check Cancel Export Codes
- Action: The system checks if the disposition code indicates cancellation of export
Logic Flow:
IF A disposition code is being processed for cargo status management
AND The system checks if the disposition code indicates cancellation of export
THEN:
- • The system identifies the code as a cancel export disposition and proceeds with export cancellation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when arrival disposition code (aad or pod) has been identified.
Trigger Criteria:
- Context: An arrival disposition code (AAD or POD) has been identified
- Applied to: Validate Arrival Location
- Action: The system validates the location code against valid arrival locations
Logic Flow:
IF An arrival disposition code (AAD or POD) has been identified
AND The system validates the location code against valid arrival locations
THEN:
- • The system confirms the location is authorized for arrival processing or rejects invalid locations
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid arrival disposition code with valid location has been processed.
Trigger Criteria:
- Context: A valid arrival disposition code with valid location has been processed
- Applied to: Set Cargo Arrival Status Flag
- Action: The system updates cargo status for arrival
Logic Flow:
IF A valid arrival disposition code with valid location has been processed
AND The system updates cargo status for arrival
THEN:
- • The cargo arrival status flag is set to indicate the cargo has arrived
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo arrival status has been set.
Trigger Criteria:
- Context: Cargo arrival status has been set
- Applied to: Clear Bond Start Date
- Action: The system processes the arrival event
Logic Flow:
IF Cargo arrival status has been set
AND The system processes the arrival event
THEN:
- • The bond start date is cleared to reflect that the in-bond movement has ended
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has arrived at a valid location.
Trigger Criteria:
- Context: Cargo has arrived at a valid location
- Applied to: Set Arrival Index
- Action: The system processes the arrival status update
Logic Flow:
IF Cargo has arrived at a valid location
AND The system processes the arrival status update
THEN:
- • An arrival index is set to reference the arrival location for tracking purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has arrived and arrival date is recorded.
Trigger Criteria:
- Context: Cargo has arrived and arrival date is recorded
- Applied to: Calculate Cargo Age
- Action: The system calculates cargo aging metrics
Logic Flow:
IF Cargo has arrived and arrival date is recorded
AND The system calculates cargo aging metrics
THEN:
- • The cargo age is computed as the difference between arrival date and original entry date
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when export disposition code has been identified.
Trigger Criteria:
- Context: An export disposition code has been identified
- Applied to: Validate Export Location
- Action: The system validates the location code against authorized export locations
Logic Flow:
IF An export disposition code has been identified
AND The system validates the location code against authorized export locations
THEN:
- • The system confirms the location is authorized for export processing or rejects invalid locations
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid export disposition code with valid location has been processed.
Trigger Criteria:
- Context: A valid export disposition code with valid location has been processed
- Applied to: Set Cargo Export Status Flag
- Action: The system updates cargo status for export
Logic Flow:
IF A valid export disposition code with valid location has been processed
AND The system updates cargo status for export
THEN:
- • The cargo export status flag is set to indicate the cargo is being exported
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo export status has been set.
Trigger Criteria:
- Context: Cargo export status has been set
- Applied to: Clear Destination Index
- Action: The system processes the export event
Logic Flow:
IF Cargo export status has been set
AND The system processes the export event
THEN:
- • The destination index is cleared since the cargo is leaving the country
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo export status has been set.
Trigger Criteria:
- Context: Cargo export status has been set
- Applied to: Update Export Date
- Action: The system records the export event
Logic Flow:
IF Cargo export status has been set
AND The system records the export event
THEN:
- • The export date is updated to reflect the current processing date and time
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cancel arrival disposition code has been processed.
Trigger Criteria:
- Context: A cancel arrival disposition code has been processed
- Applied to: Reset Arrival Status Flag
- Action: The system cancels the arrival status
Logic Flow:
IF A cancel arrival disposition code has been processed
AND The system cancels the arrival status
THEN:
- • The cargo arrival status flag is reset to indicate the cargo has not arrived
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when arrival status is being cancelled and a previous arrival date exists.
Trigger Criteria:
- Context: Arrival status is being cancelled and a previous arrival date exists
- Applied to: Restore Previous Arrival Date
- Action: The system processes the arrival cancellation
Logic Flow:
IF Arrival status is being cancelled and a previous arrival date exists
AND The system processes the arrival cancellation
THEN:
- • The previous arrival date is restored to maintain historical accuracy
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when arrival status has been cancelled.
Trigger Criteria:
- Context: Arrival status has been cancelled
- Applied to: Recalculate Bond Information
- Action: The system updates bond-related data
Logic Flow:
IF Arrival status has been cancelled
AND The system updates bond-related data
THEN:
- • Bond information is recalculated to reflect the cancelled arrival status
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cancel export disposition code has been processed.
Trigger Criteria:
- Context: A cancel export disposition code has been processed
- Applied to: Reset Export Status Flag
- Action: The system cancels the export status
Logic Flow:
IF A cancel export disposition code has been processed
AND The system cancels the export status
THEN:
- • The cargo export status flag is reset to indicate the cargo is not being exported
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when export status is being cancelled and a previous export date exists.
Trigger Criteria:
- Context: Export status is being cancelled and a previous export date exists
- Applied to: Restore Previous Export Date
- Action: The system processes the export cancellation
Logic Flow:
IF Export status is being cancelled and a previous export date exists
AND The system processes the export cancellation
THEN:
- • The previous export date is restored to maintain historical accuracy
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when export status is being cancelled.
Trigger Criteria:
- Context: Export status is being cancelled
- Applied to: Clear Export Index
- Action: The system processes the export cancellation
Logic Flow:
IF Export status is being cancelled
AND The system processes the export cancellation
THEN:
- • The export index is cleared to remove the export location reference
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo arrival or export status has been updated or cancelled.
Trigger Criteria:
- Context: Cargo arrival or export status has been updated or cancelled
- Applied to: Generate Status Change Notification
- Action: The system completes the status change processing
Logic Flow:
IF Cargo arrival or export status has been updated or cancelled
AND The system completes the status change processing
THEN:
- • A status change notification is generated to inform relevant parties of the status update
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when arrival or export status changes have been processed.
Trigger Criteria:
- Context: Arrival or export status changes have been processed
- Applied to: Update Cargo Status Arrays
- Action: The system finalizes the status management
Logic Flow:
IF Arrival or export status changes have been processed
AND The system finalizes the status management
THEN:
- • The cargo status arrays are updated with the new arrival and export status information
R-GCX016E-cbl-02248 (+15) File: GCX016E.cbl Business Rule: Cancel Arrival and Export Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has an active arrival status and a cancel arrival disposition code is processed.
Trigger Criteria:
- Context: A cargo has an active arrival status and a cancel arrival disposition code is processed
- Applied to: Cancel Arrival Processing
- Action: The system processes the cancel arrival disposition code
Logic Flow:
IF A cargo has an active arrival status and a cancel arrival disposition code is processed
AND The system processes the cancel arrival disposition code
THEN:
- • The system initiates cancel arrival processing workflow
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has an active export status and a cancel export disposition code is processed.
Trigger Criteria:
- Context: A cargo has an active export status and a cancel export disposition code is processed
- Applied to: Cancel Export Processing
- Action: The system processes the cancel export disposition code
Logic Flow:
IF A cargo has an active export status and a cancel export disposition code is processed
AND The system processes the cancel export disposition code
THEN:
- • The system initiates cancel export processing workflow
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cancellation request is being processed for a cargo.
Trigger Criteria:
- Context: A cancellation request is being processed for a cargo
- Applied to: Retrieve Current Cargo Status
- Action: The system needs to process the cancellation
Logic Flow:
IF A cancellation request is being processed for a cargo
AND The system needs to process the cancellation
THEN:
- • The system retrieves the current cargo status from the cargo root record
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo status is about to be changed due to cancellation.
Trigger Criteria:
- Context: A cargo status is about to be changed due to cancellation
- Applied to: Save Previous Status for Audit
- Action: The system processes the status change
Logic Flow:
IF A cargo status is about to be changed due to cancellation
AND The system processes the status change
THEN:
- • The system saves the previous status information to maintain audit trail
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has an active arrival flag set and arrival cancellation is being processed.
Trigger Criteria:
- Context: A cargo has an active arrival flag set and arrival cancellation is being processed
- Applied to: Clear Arrival Flag
- Action: The system processes the arrival cancellation
Logic Flow:
IF A cargo has an active arrival flag set and arrival cancellation is being processed
AND The system processes the arrival cancellation
THEN:
- • The system clears the arrival flag in the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has an active export flag set and export cancellation is being processed.
Trigger Criteria:
- Context: A cargo has an active export flag set and export cancellation is being processed
- Applied to: Clear Export Flag
- Action: The system processes the export cancellation
Logic Flow:
IF A cargo has an active export flag set and export cancellation is being processed
AND The system processes the export cancellation
THEN:
- • The system clears the export flag in the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has an arrival date set and arrival cancellation is being processed.
Trigger Criteria:
- Context: A cargo has an arrival date set and arrival cancellation is being processed
- Applied to: Reset Arrival Date
- Action: The system processes the arrival cancellation
Logic Flow:
IF A cargo has an arrival date set and arrival cancellation is being processed
AND The system processes the arrival cancellation
THEN:
- • The system resets the arrival date to blank or previous value
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo has an export date set and export cancellation is being processed.
Trigger Criteria:
- Context: A cargo has an export date set and export cancellation is being processed
- Applied to: Reset Export Date
- Action: The system processes the export cancellation
Logic Flow:
IF A cargo has an export date set and export cancellation is being processed
AND The system processes the export cancellation
THEN:
- • The system resets the export date to blank or previous value
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo had bond information modified during arrival or export processing and cancellation is being processed.
Trigger Criteria:
- Context: A cargo had bond information modified during arrival or export processing and cancellation is being processed
- Applied to: Restore Bond Information
- Action: The system processes the cancellation
Logic Flow:
IF A cargo had bond information modified during arrival or export processing and cancellation is being processed
AND The system processes the cancellation
THEN:
- • The system restores the bond information to its previous state
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo status has been changed due to cancellation and dates have been updated.
Trigger Criteria:
- Context: A cargo status has been changed due to cancellation and dates have been updated
- Applied to: Recalculate Cargo Age
- Action: The system completes the status change processing
Logic Flow:
IF A cargo status has been changed due to cancellation and dates have been updated
AND The system completes the status change processing
THEN:
- • The system recalculates the cargo age based on the updated information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo cancellation has been processed and status has been updated.
Trigger Criteria:
- Context: A cargo cancellation has been processed and status has been updated
- Applied to: Update Destination Index
- Action: The system completes the cancellation processing
Logic Flow:
IF A cargo cancellation has been processed and status has been updated
AND The system completes the cancellation processing
THEN:
- • The system updates the destination index to reflect the new status
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo cancellation has been successfully processed.
Trigger Criteria:
- Context: A cargo cancellation has been successfully processed
- Applied to: Generate Cancel Notification
- Action: The system completes the cancellation processing
Logic Flow:
IF A cargo cancellation has been successfully processed
AND The system completes the cancellation processing
THEN:
- • The system generates a cancel notification message for relevant parties
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo status has been changed due to cancellation processing.
Trigger Criteria:
- Context: A cargo status has been changed due to cancellation processing
- Applied to: Log Status Change
- Action: The system completes the status change
Logic Flow:
IF A cargo status has been changed due to cancellation processing
AND The system completes the status change
THEN:
- • The system logs the status change with timestamp and details for audit purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo cancellation has been processed and status has been determined.
Trigger Criteria:
- Context: A cargo cancellation has been processed and status has been determined
- Applied to: Update Status Arrays
- Action: The system updates the cargo record
Logic Flow:
IF A cargo cancellation has been processed and status has been determined
AND The system updates the cargo record
THEN:
- • The system updates all relevant status arrays to reflect the cancellation changes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo cancellation has been processed and status arrays have been updated.
Trigger Criteria:
- Context: A cargo cancellation has been processed and status arrays have been updated
- Applied to: Verify Status Restoration
- Action: The system completes the update process
Logic Flow:
IF A cargo cancellation has been processed and status arrays have been updated
AND The system completes the update process
THEN:
- • The system verifies that the status has been properly restored and is consistent
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo cancellation has been verified and processed successfully.
Trigger Criteria:
- Context: A cargo cancellation has been verified and processed successfully
- Applied to: Send Cancellation Message
- Action: The system completes all internal processing
Logic Flow:
IF A cargo cancellation has been verified and processed successfully
AND The system completes all internal processing
THEN:
- • The system sends cancellation message to external systems and interested parties
R-GCX016E-cbl-02264 (+9) File: GCX016E.cbl Business Rule: Status Information Message Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status information disposition code is received for processing.
Trigger Criteria:
- Context: A status information disposition code is received for processing
- Applied to: Validate Disposition Code Against DC Table
- Action: The system validates the disposition code against the DC table
Logic Flow:
IF A status information disposition code is received for processing
AND The system validates the disposition code against the DC table
THEN:
- • The code validation result determines whether processing continues or an error is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code has been validated against the dc table.
Trigger Criteria:
- Context: A disposition code has been validated against the DC table
- Applied to: Generate Error Message for Unknown Code
- Action: The disposition code is not found in the DC table
Logic Flow:
IF A disposition code has been validated against the DC table
AND The disposition code is not found in the DC table
THEN:
- • An error message is generated for the unknown disposition code and processing continues with next code
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid disposition code needs to be added to the status array.
Trigger Criteria:
- Context: A valid disposition code needs to be added to the status array
- Applied to: Check if Code Already Exists in Status Array
- Action: The system checks the S09A status array for existing occurrences of the same code
Logic Flow:
IF A valid disposition code needs to be added to the status array
AND The system checks the S09A status array for existing occurrences of the same code
THEN:
- • The duplicate check result determines whether the code should be added or skipped
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code has been checked against the existing status array.
Trigger Criteria:
- Context: A disposition code has been checked against the existing status array
- Applied to: Skip Processing - Code Already Present
- Action: The same disposition code is already present in the S09A array
Logic Flow:
IF A disposition code has been checked against the existing status array
AND The same disposition code is already present in the S09A array
THEN:
- • Processing is skipped for this code and continues with the next disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid disposition code that doesn't already exist in the status array.
Trigger Criteria:
- Context: A valid disposition code that doesn't already exist in the status array
- Applied to: Insert Status Information Code into S09A Array
- Action: The system processes the status information code for insertion
Logic Flow:
IF A valid disposition code that doesn't already exist in the status array
AND The system processes the status information code for insertion
THEN:
- • The disposition code is inserted into the S09A status array with appropriate sequence positioning
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status information disposition code has been successfully inserted into the s09a array.
Trigger Criteria:
- Context: A status information disposition code has been successfully inserted into the S09A array
- Applied to: Set Status Information Flag
- Action: The system processes the status information addition
Logic Flow:
IF A status information disposition code has been successfully inserted into the S09A array
AND The system processes the status information addition
THEN:
- • The status information flag is set to indicate informational status has been applied to the cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when new status information code has been added to the s09a array.
Trigger Criteria:
- Context: A new status information code has been added to the S09A array
- Applied to: Update Status Array Sequence Counter
- Action: The system updates the status array management counters
Logic Flow:
IF A new status information code has been added to the S09A array
AND The system updates the status array management counters
THEN:
- • The sequence counter is incremented to reflect the new entry and maintain proper array indexing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status information disposition code has been successfully processed and added.
Trigger Criteria:
- Context: A status information disposition code has been successfully processed and added
- Applied to: Log Status Information Addition
- Action: The system performs logging operations for the status change
Logic Flow:
IF A status information disposition code has been successfully processed and added
AND The system performs logging operations for the status change
THEN:
- • The status information addition is logged with relevant details for audit trail purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status information has been logged for a cargo disposition code change.
Trigger Criteria:
- Context: Status information has been logged for a cargo disposition code change
- Applied to: Preserve Status Information for Audit Trail
- Action: The system processes audit trail requirements
Logic Flow:
IF Status information has been logged for a cargo disposition code change
AND The system processes audit trail requirements
THEN:
- • The status information change is preserved in the audit trail with complete context for future reference
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status information has been successfully processed and preserved in audit trail.
Trigger Criteria:
- Context: Status information has been successfully processed and preserved in audit trail
- Applied to: Generate Merlin Notification with Status Context
- Action: The system generates notifications for the status information change
Logic Flow:
IF Status information has been successfully processed and preserved in audit trail
AND The system generates notifications for the status information change
THEN:
- • A Merlin notification is generated with complete status context information for relevant stakeholders
R-GCX016E-cbl-02274 (+8) File: GCX016E.cbl Business Rule: Cargo Status Preservation for Audit
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record exists in the system with current status information.
Trigger Criteria:
- Context: A cargo record exists in the system with current status information
- Applied to: Retrieve Current Cargo Status
- Action: The system needs to preserve cargo status for audit purposes
Logic Flow:
IF A cargo record exists in the system with current status information
AND The system needs to preserve cargo status for audit purposes
THEN:
- • The current cargo status is retrieved from the cargo root record including all status flags and values
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when current cargo status has been retrieved from the cargo record.
Trigger Criteria:
- Context: Current cargo status has been retrieved from the cargo record
- Applied to: Save Current Status to Audit Fields
- Action: Status preservation process is initiated
Logic Flow:
IF Current cargo status has been retrieved from the cargo record
AND Status preservation process is initiated
THEN:
- • Current status values are copied to corresponding audit fields in the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record contains current release quantity information.
Trigger Criteria:
- Context: Cargo record contains current release quantity information
- Applied to: Store Previous Release Quantities
- Action: Release quantities are about to be modified
Logic Flow:
IF Cargo record contains current release quantity information
AND Release quantities are about to be modified
THEN:
- • Previous release quantities are stored in audit fields for historical tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record has current hold status flags set.
Trigger Criteria:
- Context: Cargo record has current hold status flags set
- Applied to: Preserve Hold Status Flags
- Action: Hold status is about to be changed
Logic Flow:
IF Cargo record has current hold status flags set
AND Hold status is about to be changed
THEN:
- • All current hold status flags are preserved in audit fields for comparison purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record contains arrival or export status information.
Trigger Criteria:
- Context: Cargo record contains arrival or export status information
- Applied to: Save Arrival/Export Status
- Action: Arrival or export status is about to be updated
Logic Flow:
IF Cargo record contains arrival or export status information
AND Arrival or export status is about to be updated
THEN:
- • Current arrival and export status values including dates are saved to audit fields
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record has bond information including bond numbers and broker details.
Trigger Criteria:
- Context: Cargo record has bond information including bond numbers and broker details
- Applied to: Store Bond Information
- Action: Bond information is about to be modified
Logic Flow:
IF Cargo record has bond information including bond numbers and broker details
AND Bond information is about to be modified
THEN:
- • Current bond information is stored in audit fields for historical reference
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record contains disposition code arrays with current status codes.
Trigger Criteria:
- Context: Cargo record contains disposition code arrays with current status codes
- Applied to: Save Disposition Code Arrays
- Action: Disposition codes are about to be processed or modified
Logic Flow:
IF Cargo record contains disposition code arrays with current status codes
AND Disposition codes are about to be processed or modified
THEN:
- • Current disposition code arrays are saved to audit fields maintaining sequence and occurrence information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all individual status components have been preserved in audit fields.
Trigger Criteria:
- Context: All individual status components have been preserved in audit fields
- Applied to: Create Status Snapshot
- Action: Complete status preservation is required
Logic Flow:
IF All individual status components have been preserved in audit fields
AND Complete status preservation is required
THEN:
- • A comprehensive status snapshot is created capturing all cargo status elements at the current point in time
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status snapshot has been created with all preserved information.
Trigger Criteria:
- Context: Status snapshot has been created with all preserved information
- Applied to: Mark Audit Trail Entry
- Action: Audit trail entry needs to be finalized
Logic Flow:
IF Status snapshot has been created with all preserved information
AND Audit trail entry needs to be finalized
THEN:
- • The audit trail entry is marked with timestamp and processing context for future reference
R-GCX016E-cbl-02283 (+16) File: GCX016E.cbl Business Rule: Release Cancellation Detection and Notification
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record exists in the system.
Trigger Criteria:
- Context: A cargo record exists in the system
- Applied to: Cargo Status Change Detected
- Action: The cargo processing logic is executed and status arrays are updated
Logic Flow:
IF A cargo record exists in the system
AND The cargo processing logic is executed and status arrays are updated
THEN:
- • The system detects that a cargo status change has occurred and triggers status analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo status change is detected.
Trigger Criteria:
- Context: A cargo status change is detected
- Applied to: Save Previous Cargo Status
- Action: The system begins processing the status change
Logic Flow:
IF A cargo status change is detected
AND The system begins processing the status change
THEN:
- • The previous cargo status and release information is saved for comparison analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when previous cargo status has been saved.
Trigger Criteria:
- Context: Previous cargo status has been saved
- Applied to: Analyze Current Status Arrays
- Action: The system processes the current cargo status arrays
Logic Flow:
IF Previous cargo status has been saved
AND The system processes the current cargo status arrays
THEN:
- • The current cargo status and release information is analyzed and determined
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when previous cargo status is saved and current status is analyzed.
Trigger Criteria:
- Context: Previous cargo status is saved and current status is analyzed
- Applied to: Release Status Changed?
- Action: The system compares the previous and current release status
Logic Flow:
IF Previous cargo status is saved and current status is analyzed
AND The system compares the previous and current release status
THEN:
- • The system determines whether the release status has changed or remained the same
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when release status change has been detected.
Trigger Criteria:
- Context: A release status change has been detected
- Applied to: Compare Previous vs Current Release Status
- Action: The system compares the specific release status values
Logic Flow:
IF A release status change has been detected
AND The system compares the specific release status values
THEN:
- • The system identifies the exact nature of the release status change
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when release status comparison is performed.
Trigger Criteria:
- Context: Release status comparison is performed
- Applied to: Was Previously Released?
- Action: The system evaluates the previous release status
Logic Flow:
IF Release status comparison is performed
AND The system evaluates the previous release status
THEN:
- • The system determines if the cargo was previously in a released state
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo was previously released.
Trigger Criteria:
- Context: The cargo was previously released
- Applied to: Is Currently Released?
- Action: The system evaluates the current release status
Logic Flow:
IF The cargo was previously released
AND The system evaluates the current release status
THEN:
- • The system determines if the cargo is currently in a released state
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo was previously released and is currently not released.
Trigger Criteria:
- Context: The cargo was previously released and is currently not released
- Applied to: Detect Release Cancellation
- Action: The system analyzes the status transition
Logic Flow:
IF The cargo was previously released and is currently not released
AND The system analyzes the status transition
THEN:
- • The system detects that a release cancellation has occurred
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when release cancellation has been detected.
Trigger Criteria:
- Context: A release cancellation has been detected
- Applied to: Generate Release Cancellation Notification
- Action: The system processes the cancellation event
Logic Flow:
IF A release cancellation has been detected
AND The system processes the cancellation event
THEN:
- • The system generates appropriate business notifications for the release cancellation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when release cancellation notification is being generated.
Trigger Criteria:
- Context: A release cancellation notification is being generated
- Applied to: Format Cancellation Message Details
- Action: The system formats the cancellation message
Logic Flow:
IF A release cancellation notification is being generated
AND The system formats the cancellation message
THEN:
- • The message includes cargo identification, cancellation details, and relevant transaction information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cancellation message is being formatted.
Trigger Criteria:
- Context: A cancellation message is being formatted
- Applied to: Include Equipment Information
- Action: The system processes equipment information
Logic Flow:
IF A cancellation message is being formatted
AND The system processes equipment information
THEN:
- • The message includes car ID, equipment type, and other relevant equipment details
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment information is included in the cancellation message.
Trigger Criteria:
- Context: Equipment information is included in the cancellation message
- Applied to: Include Disposition Code Details
- Action: The system processes disposition code information
Logic Flow:
IF Equipment information is included in the cancellation message
AND The system processes disposition code information
THEN:
- • The message includes the disposition code that triggered the release cancellation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code details are included in the cancellation message.
Trigger Criteria:
- Context: Disposition code details are included in the cancellation message
- Applied to: Include Date/Time Information
- Action: The system processes date and time information
Logic Flow:
IF Disposition code details are included in the cancellation message
AND The system processes date and time information
THEN:
- • The message includes transaction date, time, and other relevant temporal information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when complete cancellation message is formatted with all required details.
Trigger Criteria:
- Context: A complete cancellation message is formatted with all required details
- Applied to: Route to Merlin Message System
- Action: The system routes the message to Merlin
Logic Flow:
IF A complete cancellation message is formatted with all required details
AND The system routes the message to Merlin
THEN:
- • The message is successfully submitted to the Merlin messaging system for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cancellation message is routed to merlin messaging system.
Trigger Criteria:
- Context: The cancellation message is routed to Merlin messaging system
- Applied to: Send to Business Users
- Action: The system processes the message delivery
Logic Flow:
IF The cancellation message is routed to Merlin messaging system
AND The system processes the message delivery
THEN:
- • The notification is delivered to the appropriate business users and stakeholders
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cancellation notification is sent to business users.
Trigger Criteria:
- Context: The cancellation notification is sent to business users
- Applied to: Log Cancellation Event
- Action: The system processes the logging requirement
Logic Flow:
IF The cancellation notification is sent to business users
AND The system processes the logging requirement
THEN:
- • The release cancellation event is logged with relevant details for audit and tracking purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status change analysis is complete.
Trigger Criteria:
- Context: The cargo status change analysis is complete
- Applied to: No Cancellation Detected
- Action: No release cancellation is detected
Logic Flow:
IF The cargo status change analysis is complete
AND No release cancellation is detected
THEN:
- • The system continues with normal cargo processing without generating cancellation notifications
R-GCX016E-cbl-02300 (+27) File: GCX016E.cbl Business Rule: Complex Status Logic Evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record requires status evaluation.
Trigger Criteria:
- Context: A cargo record requires status evaluation
- Applied to: Initialize Status Flags
- Action: The complex status logic evaluation process begins
Logic Flow:
IF A cargo record requires status evaluation
AND The complex status logic evaluation process begins
THEN:
- • All status flags (hold, release, proceed, arrival, export) are set to false or initial values
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record exists with associated disposition codes.
Trigger Criteria:
- Context: A cargo record exists with associated disposition codes
- Applied to: Retrieve S09A Status Arrays
- Action: Status evaluation process starts
Logic Flow:
IF A cargo record exists with associated disposition codes
AND Status evaluation process starts
THEN:
- • All S09A status array entries are loaded for analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when s09a status arrays have been retrieved.
Trigger Criteria:
- Context: S09A status arrays have been retrieved
- Applied to: More Status Entries?
- Action: Processing status entries sequentially
Logic Flow:
IF S09A status arrays have been retrieved
AND Processing status entries sequentially
THEN:
- • Continue to next entry if more exist,
otherwise proceed to status analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code is being evaluated.
Trigger Criteria:
- Context: A disposition code is being evaluated
- Applied to: Hold Disposition Code?
- Action: The disposition code indicates a hold condition (border hold, destination hold, FDA hold)
Logic Flow:
IF A disposition code is being evaluated
AND The disposition code indicates a hold condition (border hold, destination hold, FDA hold)
THEN:
- • Set the hold status flag to true
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code is being evaluated.
Trigger Criteria:
- Context: A disposition code is being evaluated
- Applied to: Release Disposition Code?
- Action: The disposition code indicates a release condition (manual release, auto release)
Logic Flow:
IF A disposition code is being evaluated
AND The disposition code indicates a release condition (manual release, auto release)
THEN:
- • Set the release status flag to true
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code is being evaluated.
Trigger Criteria:
- Context: A disposition code is being evaluated
- Applied to: Proceed Disposition Code?
- Action: The disposition code indicates a proceed condition
Logic Flow:
IF A disposition code is being evaluated
AND The disposition code indicates a proceed condition
THEN:
- • Set the proceed status flag to true
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code is being evaluated.
Trigger Criteria:
- Context: A disposition code is being evaluated
- Applied to: Arrival Disposition Code?
- Action: The disposition code indicates an arrival condition
Logic Flow:
IF A disposition code is being evaluated
AND The disposition code indicates an arrival condition
THEN:
- • Set the arrival status flag to true
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code is being evaluated.
Trigger Criteria:
- Context: A disposition code is being evaluated
- Applied to: Export Disposition Code?
- Action: The disposition code indicates an export condition
Logic Flow:
IF A disposition code is being evaluated
AND The disposition code indicates an export condition
THEN:
- • Set the export status flag to true
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when hold disposition code has been identified.
Trigger Criteria:
- Context: A hold disposition code has been identified
- Applied to: Set Hold Status Flag
- Action: Processing the disposition code
Logic Flow:
IF A hold disposition code has been identified
AND Processing the disposition code
THEN:
- • The hold status flag is set to active
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when release disposition code has been identified.
Trigger Criteria:
- Context: A release disposition code has been identified
- Applied to: Set Release Status Flag
- Action: Processing the disposition code
Logic Flow:
IF A release disposition code has been identified
AND Processing the disposition code
THEN:
- • The release status flag is set to active
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when proceed disposition code has been identified.
Trigger Criteria:
- Context: A proceed disposition code has been identified
- Applied to: Set Proceed Status Flag
- Action: Processing the disposition code
Logic Flow:
IF A proceed disposition code has been identified
AND Processing the disposition code
THEN:
- • The proceed status flag is set to active
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when arrival disposition code has been identified.
Trigger Criteria:
- Context: An arrival disposition code has been identified
- Applied to: Set Arrival Status Flag
- Action: Processing the disposition code
Logic Flow:
IF An arrival disposition code has been identified
AND Processing the disposition code
THEN:
- • The arrival status flag is set to active
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when export disposition code has been identified.
Trigger Criteria:
- Context: An export disposition code has been identified
- Applied to: Set Export Status Flag
- Action: Processing the disposition code
Logic Flow:
IF An export disposition code has been identified
AND Processing the disposition code
THEN:
- • The export status flag is set to active
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all disposition codes have been processed and status flags are set.
Trigger Criteria:
- Context: All disposition codes have been processed and status flags are set
- Applied to: Analyze Combined Status Flags
- Action: Determining the final cargo status
Logic Flow:
IF All disposition codes have been processed and status flags are set
AND Determining the final cargo status
THEN:
- • Analyze the combination of status flags according to business priority hierarchy
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status flags have been analyzed.
Trigger Criteria:
- Context: Status flags have been analyzed
- Applied to: Hold Status Active?
- Action: The hold status flag is active
Logic Flow:
IF Status flags have been analyzed
AND The hold status flag is active
THEN:
- • Proceed to check if release status overrides the hold
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when hold status is active.
Trigger Criteria:
- Context: Hold status is active
- Applied to: Release Status Active?
- Action: Release status is also active
Logic Flow:
IF Hold status is active
AND Release status is also active
THEN:
- • Check for manual release to determine final status
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when both hold and release status are active.
Trigger Criteria:
- Context: Both hold and release status are active
- Applied to: Manual Release Present?
- Action: A manual release disposition code is present
Logic Flow:
IF Both hold and release status are active
AND A manual release disposition code is present
THEN:
- • Set final status to RELEASED regardless of hold conditions
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when hold status is active and no manual release is present.
Trigger Criteria:
- Context: Hold status is active and no manual release is present
- Applied to: HELD
- Action: Determining final status
Logic Flow:
IF Hold status is active and no manual release is present
AND Determining final status
THEN:
- • Set the cargo status to HELD
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when no hold status is active.
Trigger Criteria:
- Context: No hold status is active
- Applied to: Proceed Status Active?
- Action: Proceed status flag is active
Logic Flow:
IF No hold status is active
AND Proceed status flag is active
THEN:
- • Check for in-bond entry conditions
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when proceed status is active.
Trigger Criteria:
- Context: Proceed status is active
- Applied to: In-Bond Entry Present?
- Action: In-bond entry information is present and valid
Logic Flow:
IF Proceed status is active
AND In-bond entry information is present and valid
THEN:
- • Set final status to PROCEED
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when proceed status is active and in-bond entry conditions are met.
Trigger Criteria:
- Context: Proceed status is active and in-bond entry conditions are met
- Applied to: PROCEED
- Action: Determining final status
Logic Flow:
IF Proceed status is active and in-bond entry conditions are met
AND Determining final status
THEN:
- • Set the cargo status to PROCEED
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when no hold or proceed status conditions are active.
Trigger Criteria:
- Context: No hold or proceed status conditions are active
- Applied to: Arrival Status Active?
- Action: Arrival status flag is active
Logic Flow:
IF No hold or proceed status conditions are active
AND Arrival status flag is active
THEN:
- • Set final status to ARRIVED
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when arrival status is active and no higher priority conditions exist.
Trigger Criteria:
- Context: Arrival status is active and no higher priority conditions exist
- Applied to: ARRIVED
- Action: Determining final status
Logic Flow:
IF Arrival status is active and no higher priority conditions exist
AND Determining final status
THEN:
- • Set the cargo status to ARRIVED
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when no hold, proceed, or arrival status conditions are active.
Trigger Criteria:
- Context: No hold, proceed, or arrival status conditions are active
- Applied to: Export Status Active?
- Action: Export status flag is active
Logic Flow:
IF No hold, proceed, or arrival status conditions are active
AND Export status flag is active
THEN:
- • Set final status to EXPORTED
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when export status is active and no higher priority conditions exist.
Trigger Criteria:
- Context: Export status is active and no higher priority conditions exist
- Applied to: EXPORTED
- Action: Determining final status
Logic Flow:
IF Export status is active and no higher priority conditions exist
AND Determining final status
THEN:
- • Set the cargo status to EXPORTED
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when no specific status conditions (hold, proceed, arrival, export) are active.
Trigger Criteria:
- Context: No specific status conditions (hold, proceed, arrival, export) are active
- Applied to: RELEASED
- Action: Determining final status
Logic Flow:
IF No specific status conditions (hold, proceed, arrival, export) are active
AND Determining final status
THEN:
- • Set the cargo status to RELEASED as the default
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when final cargo status has been determined.
Trigger Criteria:
- Context: Final cargo status has been determined
- Applied to: Update Cargo Status
- Action: Updating cargo information
Logic Flow:
IF Final cargo status has been determined
AND Updating cargo information
THEN:
- • The cargo record is updated with the new status
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo status has been updated.
Trigger Criteria:
- Context: Cargo status has been updated
- Applied to: Generate Status Change Notification
- Action: Status change processing is complete
Logic Flow:
IF Cargo status has been updated
AND Status change processing is complete
THEN:
- • Generate notifications to relevant parties about the status change
R-GCX016E-cbl-02338 (+7) File: GCX016E.cbl Business Rule: Destination Index Management for Arrival Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo is being processed for arrival and bond information exists in the cargo record.
Trigger Criteria:
- Context: A cargo is being processed for arrival AND bond information exists in the cargo record
- Applied to: Clear Bond Start Dates
- Action: The arrival processing is triggered
Logic Flow:
IF A cargo is being processed for arrival AND bond information exists in the cargo record
AND The arrival processing is triggered
THEN:
- • The bond start date should be reset to zero to clear previous bond timing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo is being processed for arrival and no bond information exists in the cargo record.
Trigger Criteria:
- Context: A cargo is being processed for arrival AND no bond information exists in the cargo record
- Applied to: Clear Bond Start Dates
- Action: The arrival processing is triggered
Logic Flow:
IF A cargo is being processed for arrival AND no bond information exists in the cargo record
AND The arrival processing is triggered
THEN:
- • The existing bond start date should be maintained without modification
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo is being processed for arrival and the current location is determined.
Trigger Criteria:
- Context: A cargo is being processed for arrival AND the current location is determined
- Applied to: Set Arrival Index
- Action: The arrival index needs to be set
Logic Flow:
IF A cargo is being processed for arrival AND the current location is determined
AND The arrival index needs to be set
THEN:
- • The arrival index should be updated with the current location identifier
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has completed arrival index assignment.
Trigger Criteria:
- Context: A cargo has completed arrival index assignment
- Applied to: Set Arrival Index
- Action: The arrival processing procedures are finalized
Logic Flow:
IF A cargo has completed arrival index assignment
AND The arrival processing procedures are finalized
THEN:
- • The arrival processing flag should be set to indicate completion
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has a valid bond start date.
Trigger Criteria:
- Context: A cargo has a valid bond start date
- Applied to: Calculate Cargo Age
- Action: Cargo age calculation is required during arrival processing
Logic Flow:
IF A cargo has a valid bond start date
AND Cargo age calculation is required during arrival processing
THEN:
- • The system should calculate the number of days between the bond start date and current date
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo age has been successfully calculated.
Trigger Criteria:
- Context: The cargo age has been successfully calculated
- Applied to: Calculate Cargo Age
- Action: The age calculation is complete and valid
Logic Flow:
IF The cargo age has been successfully calculated
AND The age calculation is complete and valid
THEN:
- • The cargo age field should be updated with the calculated number of days
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo age has been calculated from bond start date.
Trigger Criteria:
- Context: A cargo age has been calculated from bond start date
- Applied to: Validate Age Calculation
- Action: The calculated age value needs validation
Logic Flow:
IF A cargo age has been calculated from bond start date
AND The calculated age value needs validation
THEN:
- • The system should verify that the age calculation is valid and within acceptable ranges
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo age calculation has failed validation or produced an invalid result.
Trigger Criteria:
- Context: The cargo age calculation has failed validation OR produced an invalid result
- Applied to: Set Default Age Value
- Action: A default age value is needed
Logic Flow:
IF The cargo age calculation has failed validation OR produced an invalid result
AND A default age value is needed
THEN:
- • The system should set a predefined default age value for the cargo
R-GCX016E-cbl-02346 (+10) File: GCX016E.cbl Business Rule: Destination Index Management for Export Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has an export disposition code.
Trigger Criteria:
- Context: A cargo has an export disposition code
- Applied to: Clear Destination Index
- Action: The export processing is triggered
Logic Flow:
IF A cargo has an export disposition code
AND The export processing is triggered
THEN:
- • The destination index field is cleared to spaces
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo is being processed for export.
Trigger Criteria:
- Context: A cargo is being processed for export
- Applied to: Reset Bond Start Date
- Action: The destination index has been cleared
Logic Flow:
IF A cargo is being processed for export
AND The destination index has been cleared
THEN:
- • The bond start date is reset to zeros
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo is undergoing export processing.
Trigger Criteria:
- Context: A cargo is undergoing export processing
- Applied to: Update Export Flag
- Action: The bond start date has been reset
Logic Flow:
IF A cargo is undergoing export processing
AND The bond start date has been reset
THEN:
- • The export flag is set to 'Y' to indicate export status
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has an arrival date and current processing date.
Trigger Criteria:
- Context: A cargo has an arrival date and current processing date
- Applied to: Calculate Cargo Age
- Action: Export processing is being performed
Logic Flow:
IF A cargo has an arrival date and current processing date
AND Export processing is being performed
THEN:
- • The cargo age is calculated as the difference between current date and arrival date
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo has a specified export location.
Trigger Criteria:
- Context: A cargo has a specified export location
- Applied to: Validate Export Location
- Action: Export processing validation is performed
Logic Flow:
IF A cargo has a specified export location
AND Export processing validation is performed
THEN:
- • The system verifies the export location exists in the valid location table
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has a valid export location.
Trigger Criteria:
- Context: A cargo has a valid export location
- Applied to: Set Export Status to Active
- Action: Export location validation is successful
Logic Flow:
IF A cargo has a valid export location
AND Export location validation is successful
THEN:
- • The cargo export status is set to 'EXPORT' and marked as active
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has been successfully set to export status.
Trigger Criteria:
- Context: A cargo has been successfully set to export status
- Applied to: Generate Export Notification
- Action: Export status is active
Logic Flow:
IF A cargo has been successfully set to export status
AND Export status is active
THEN:
- • An export notification message is generated and sent to appropriate recipients
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has completed export processing steps.
Trigger Criteria:
- Context: A cargo has completed export processing steps
- Applied to: Update Cargo Record
- Action: All export data has been prepared
Logic Flow:
IF A cargo has completed export processing steps
AND All export data has been prepared
THEN:
- • The cargo record is updated in the database with export status, cleared destination index, and reset bond date
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has been processed for export.
Trigger Criteria:
- Context: A cargo has been processed for export
- Applied to: Log Export Action
- Action: The cargo record has been updated
Logic Flow:
IF A cargo has been processed for export
AND The cargo record has been updated
THEN:
- • An audit log entry is created recording the export action with timestamp and cargo details
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has an invalid export location.
Trigger Criteria:
- Context: A cargo has an invalid export location
- Applied to: Generate Error Message
- Action: Export location validation fails
Logic Flow:
IF A cargo has an invalid export location
AND Export location validation fails
THEN:
- • An error message is generated indicating invalid export location and export processing is not completed
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when export processing has encountered an error.
Trigger Criteria:
- Context: Export processing has encountered an error
- Applied to: Maintain Previous Status
- Action: An error message has been generated
Logic Flow:
IF Export processing has encountered an error
AND An error message has been generated
THEN:
- • The cargo retains its previous status and no export changes are applied
R-GCX016E-cbl-02357 (+12) File: GCX016E.cbl Business Rule: Destination Index Management for Bond Restoration
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo status change has been detected.
Trigger Criteria:
- Context: A cargo status change has been detected
- Applied to: Bond Information Available?
- Action: The system checks for existing bond information
Logic Flow:
IF A cargo status change has been detected
AND The system checks for existing bond information
THEN:
- • The system determines if bond data is available and routes processing accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when bond information is available for the cargo.
Trigger Criteria:
- Context: Bond information is available for the cargo
- Applied to: Retrieve Previous Bond Data
- Action: The system needs to restore bond information
Logic Flow:
IF Bond information is available for the cargo
AND The system needs to restore bond information
THEN:
- • The system retrieves the previous bond data from the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when previous bond data has been retrieved.
Trigger Criteria:
- Context: Previous bond data has been retrieved
- Applied to: Clear Current Destination Index
- Action: The system begins bond restoration
Logic Flow:
IF Previous bond data has been retrieved
AND The system begins bond restoration
THEN:
- • The system clears the current destination index field
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when destination index has been cleared.
Trigger Criteria:
- Context: The destination index has been cleared
- Applied to: Restore Bond Start Date
- Action: The system processes bond restoration
Logic Flow:
IF The destination index has been cleared
AND The system processes bond restoration
THEN:
- • The system restores the bond start date from previous bond data
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when bond start date has been restored.
Trigger Criteria:
- Context: The bond start date has been restored
- Applied to: Set Bond Number Index
- Action: The system continues bond restoration
Logic Flow:
IF The bond start date has been restored
AND The system continues bond restoration
THEN:
- • The system sets the bond number index from the restored bond data
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when bond number index has been set.
Trigger Criteria:
- Context: The bond number index has been set
- Applied to: Restore Broker QP Information
- Action: The system processes broker information restoration
Logic Flow:
IF The bond number index has been set
AND The system processes broker information restoration
THEN:
- • The system restores the broker QP information from bond data
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when broker qp information has been restored.
Trigger Criteria:
- Context: Broker QP information has been restored
- Applied to: Calculate Current Date
- Action: The system needs to calculate cargo age
Logic Flow:
IF Broker QP information has been restored
AND The system needs to calculate cargo age
THEN:
- • The system calculates the current system date
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when current date has been calculated and bond start date is available.
Trigger Criteria:
- Context: The current date has been calculated and bond start date is available
- Applied to: Calculate Cargo Age in Days
- Action: The system calculates cargo age
Logic Flow:
IF The current date has been calculated and bond start date is available
AND The system calculates cargo age
THEN:
- • The system computes the difference in days between current date and bond start date
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo age has been calculated in days.
Trigger Criteria:
- Context: Cargo age has been calculated in days
- Applied to: Age Calculation Valid?
- Action: The system validates the age calculation
Logic Flow:
IF Cargo age has been calculated in days
AND The system validates the age calculation
THEN:
- • The system determines if the calculated age is valid and within business rules
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when age calculation is valid.
Trigger Criteria:
- Context: The age calculation is valid
- Applied to: Update Cargo Age Field
- Action: The system updates cargo information
Logic Flow:
IF The age calculation is valid
AND The system updates cargo information
THEN:
- • The system updates the cargo age field with the calculated age in days
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo age has been updated or age calculation was invalid.
Trigger Criteria:
- Context: Cargo age has been updated or age calculation was invalid
- Applied to: Set Bond Restoration Flag
- Action: The system completes bond restoration processing
Logic Flow:
IF Cargo age has been updated or age calculation was invalid
AND The system completes bond restoration processing
THEN:
- • The system sets the bond restoration completion flag
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when bond restoration flag has been set.
Trigger Criteria:
- Context: The bond restoration flag has been set
- Applied to: Log Bond Restoration Action
- Action: The system performs audit logging
Logic Flow:
IF The bond restoration flag has been set
AND The system performs audit logging
THEN:
- • The system logs the bond restoration action with relevant details
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when bond restoration action has been logged.
Trigger Criteria:
- Context: Bond restoration action has been logged
- Applied to: Update Cargo Record
- Action: The system finalizes the restoration process
Logic Flow:
IF Bond restoration action has been logged
AND The system finalizes the restoration process
THEN:
- • The system updates the cargo record with all restored bond information, age calculation, and restoration flags
R-GCX016E-cbl-02384 (+19) File: GCX016E.cbl Business Rule: Cargo Release Verification and Notification
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record exists with a specific car id and waybill number.
Trigger Criteria:
- Context: A cargo record exists with a specific car ID and waybill number
- Applied to: Retrieve All Cargo Records with Same Car ID and Waybill
- Action: The system initiates cargo release verification process
Logic Flow:
IF A cargo record exists with a specific car ID and waybill number
AND The system initiates cargo release verification process
THEN:
- • All cargo records matching the same car ID and waybill combination are retrieved for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when collection of cargo records has been retrieved for processing.
Trigger Criteria:
- Context: A collection of cargo records has been retrieved for processing
- Applied to: More Cargo Records?
- Action: The system evaluates the collection status
Logic Flow:
IF A collection of cargo records has been retrieved for processing
AND The system evaluates the collection status
THEN:
- • The system returns true if more records exist to process, false if all records have been processed
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when individual cargo record from the collection.
Trigger Criteria:
- Context: An individual cargo record from the collection
- Applied to: Analyze Individual Cargo Record
- Action: The system processes the cargo record
Logic Flow:
IF An individual cargo record from the collection
AND The system processes the cargo record
THEN:
- • The cargo record's status, hold conditions, and release eligibility are evaluated
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record under analysis.
Trigger Criteria:
- Context: A cargo record under analysis
- Applied to: Check Hold Status
- Action: The system checks for hold conditions
Logic Flow:
IF A cargo record under analysis
AND The system checks for hold conditions
THEN:
- • The system identifies any active holds including border holds, destination holds, FDA holds, or other regulatory holds
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when hold status check has been completed on a cargo record.
Trigger Criteria:
- Context: Hold status check has been completed on a cargo record
- Applied to: Hold Status Found?
- Action: The system evaluates the hold check results
Logic Flow:
IF Hold status check has been completed on a cargo record
AND The system evaluates the hold check results
THEN:
- • If any hold status is found, proceed to manual release check; if no holds found, proceed to release eligibility evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record with identified hold status.
Trigger Criteria:
- Context: A cargo record with identified hold status
- Applied to: Check Manual Release Status
- Action: The system checks for manual release authorization
Logic Flow:
IF A cargo record with identified hold status
AND The system checks for manual release authorization
THEN:
- • The system determines if manual release disposition codes or authorizations have been applied to the cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when manual release status check has been completed.
Trigger Criteria:
- Context: Manual release status check has been completed
- Applied to: Manual Release Applied?
- Action: The system evaluates manual release results
Logic Flow:
IF Manual release status check has been completed
AND The system evaluates manual release results
THEN:
- • If manual release is applied, proceed to piece count hold check; if not applied, proceed to other hold type checks
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record with manual release applied.
Trigger Criteria:
- Context: A cargo record with manual release applied
- Applied to: Check Piece Count Holds
- Action: The system checks piece count status
Logic Flow:
IF A cargo record with manual release applied
AND The system checks piece count status
THEN:
- • The system identifies any piece count holds, partial release conditions, or quantity discrepancies
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when piece count hold check has been completed.
Trigger Criteria:
- Context: Piece count hold check has been completed
- Applied to: Piece Count Issues?
- Action: The system evaluates piece count results
Logic Flow:
IF Piece count hold check has been completed
AND The system evaluates piece count results
THEN:
- • If piece count issues exist, proceed to other hold type checks; if no issues, proceed to release eligibility evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record requiring comprehensive hold analysis.
Trigger Criteria:
- Context: A cargo record requiring comprehensive hold analysis
- Applied to: Check Various Hold Types
- Action: The system checks for various hold types
Logic Flow:
IF A cargo record requiring comprehensive hold analysis
AND The system checks for various hold types
THEN:
- • The system identifies examination holds, regulatory holds, security holds, or other specialized hold conditions
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when various hold types check has been completed.
Trigger Criteria:
- Context: Various hold types check has been completed
- Applied to: Other Hold Types?
- Action: The system evaluates additional hold results
Logic Flow:
IF Various hold types check has been completed
AND The system evaluates additional hold results
THEN:
- • Regardless of other hold type results, proceed to release eligibility evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record with completed hold status analysis.
Trigger Criteria:
- Context: A cargo record with completed hold status analysis
- Applied to: Evaluate Release Eligibility
- Action: The system evaluates overall release eligibility
Logic Flow:
IF A cargo record with completed hold status analysis
AND The system evaluates overall release eligibility
THEN:
- • The cargo is marked as release-eligible if no blocking holds exist, or marked as held if blocking conditions remain
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all cargo records in the car/waybill group have been individually analyzed.
Trigger Criteria:
- Context: All cargo records in the car/waybill group have been individually analyzed
- Applied to: All Records Released?
- Action: The system evaluates the collective release status
Logic Flow:
IF All cargo records in the car/waybill group have been individually analyzed
AND The system evaluates the collective release status
THEN:
- • If all records are released, proceed to generate comprehensive release notification; if any records remain held, end the release verification process
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when all cargo records with the same car id and waybill are confirmed as released.
Trigger Criteria:
- Context: All cargo records with the same car ID and waybill are confirmed as released
- Applied to: Generate Comprehensive Release Notification
- Action: The system generates release notification
Logic Flow:
IF All cargo records with the same car ID and waybill are confirmed as released
AND The system generates release notification
THEN:
- • A comprehensive release notification is created containing all relevant cargo and release information
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when comprehensive release notification is being created.
Trigger Criteria:
- Context: A comprehensive release notification is being created
- Applied to: Format Release Message with Equipment Details
- Action: The system formats the release message
Logic Flow:
IF A comprehensive release notification is being created
AND The system formats the release message
THEN:
- • The message includes car ID, waybill number, equipment type, and other relevant equipment identification details
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when release message with equipment details.
Trigger Criteria:
- Context: A release message with equipment details
- Applied to: Include Disposition Code Information
- Action: The system includes disposition code information
Logic Flow:
IF A release message with equipment details
AND The system includes disposition code information
THEN:
- • The message contains relevant disposition codes, processing actions, and regulatory compliance information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when release message with disposition code information.
Trigger Criteria:
- Context: A release message with disposition code information
- Applied to: Add Quantity Impact Analysis
- Action: The system adds quantity impact analysis
Logic Flow:
IF A release message with disposition code information
AND The system adds quantity impact analysis
THEN:
- • The message shows released quantities, remaining quantities, and impact on total cargo counts
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when complete release notification message.
Trigger Criteria:
- Context: A complete release notification message
- Applied to: Send Release Notification to Recipients
- Action: The system sends the notification
Logic Flow:
IF A complete release notification message
AND The system sends the notification
THEN:
- • The notification is delivered to brokers, freight forwarders, and other authorized recipients based on cargo ownership and processing requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when release notification has been sent successfully.
Trigger Criteria:
- Context: Release notification has been sent successfully
- Applied to: Update Cargo Status Arrays
- Action: The system updates cargo status arrays
Logic Flow:
IF Release notification has been sent successfully
AND The system updates cargo status arrays
THEN:
- • All cargo records in the group have their status arrays updated to reflect released status and notification completion
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo status arrays have been updated.
Trigger Criteria:
- Context: Cargo status arrays have been updated
- Applied to: Log Release Verification Action
- Action: The system logs the release verification action
Logic Flow:
IF Cargo status arrays have been updated
AND The system logs the release verification action
THEN:
- • An audit record is created with timestamp, cargo details, release status, and notification recipients for compliance tracking
R-GCX016E-cbl-02404 (+14) File: GCX016E.cbl Business Rule: Cargo Hold Status Analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record with status array containing disposition codes.
Trigger Criteria:
- Context: A cargo record with status array containing disposition codes
- Applied to: Check Manual Release Flag
- Action: The system analyzes the cargo status for manual release indicators
Logic Flow:
IF A cargo record with status array containing disposition codes
AND The system analyzes the cargo status for manual release indicators
THEN:
- • The manual release flag is set if manual release disposition codes are present in the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record with status array containing disposition codes.
Trigger Criteria:
- Context: A cargo record with status array containing disposition codes
- Applied to: Process Border Hold Status
- Action: The system checks for border hold indicators in the status array
Logic Flow:
IF A cargo record with status array containing disposition codes
AND The system checks for border hold indicators in the status array
THEN:
- • The border hold flag is set if border hold disposition codes are present
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record with status array containing disposition codes.
Trigger Criteria:
- Context: A cargo record with status array containing disposition codes
- Applied to: Process Destination Hold Status
- Action: The system checks for destination hold indicators in the status array
Logic Flow:
IF A cargo record with status array containing disposition codes
AND The system checks for destination hold indicators in the status array
THEN:
- • The destination hold flag is set if destination hold disposition codes are present
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record with status array containing disposition codes.
Trigger Criteria:
- Context: A cargo record with status array containing disposition codes
- Applied to: Process FDA Hold Status
- Action: The system checks for FDA hold indicators in the status array
Logic Flow:
IF A cargo record with status array containing disposition codes
AND The system checks for FDA hold indicators in the status array
THEN:
- • The FDA hold flag is set and cargo status is set to 'HOLDFDA' if FDA hold disposition codes are present
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record with status array containing disposition codes.
Trigger Criteria:
- Context: A cargo record with status array containing disposition codes
- Applied to: Process Piece Count Hold Status
- Action: The system checks for piece count hold indicators in the status array
Logic Flow:
IF A cargo record with status array containing disposition codes
AND The system checks for piece count hold indicators in the status array
THEN:
- • The piece count hold flag is set if piece count hold disposition codes are present
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo with manual release flag set to true.
Trigger Criteria:
- Context: A cargo with manual release flag set to true
- Applied to: Set Manual Release Status
- Action: The system processes the cargo status determination
Logic Flow:
IF A cargo with manual release flag set to true
AND The system processes the cargo status determination
THEN:
- • The cargo status is set to 'RELSD' (Released) and manual release processing is applied
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record with total quantity and released quantity values.
Trigger Criteria:
- Context: A cargo record with total quantity and released quantity values
- Applied to: Evaluate Release Quantities
- Action: The system evaluates the release quantities for completeness
Logic Flow:
IF A cargo record with total quantity and released quantity values
AND The system evaluates the release quantities for completeness
THEN:
- • The system determines if the cargo is fully released, partially released, or not released based on quantity comparison
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo with released quantity equal to total quantity.
Trigger Criteria:
- Context: A cargo with released quantity equal to total quantity
- Applied to: Set Full Release Eligible
- Action: The system evaluates release eligibility
Logic Flow:
IF A cargo with released quantity equal to total quantity
AND The system evaluates release eligibility
THEN:
- • The cargo is marked as fully released and eligible for complete release processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo with released quantity less than total quantity.
Trigger Criteria:
- Context: A cargo with released quantity less than total quantity
- Applied to: Set Partial Release Status
- Action: The system evaluates release status
Logic Flow:
IF A cargo with released quantity less than total quantity
AND The system evaluates release status
THEN:
- • The cargo is marked with partial release status and appropriate hold status is maintained
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo with multiple active hold conditions (border, destination, fda, piece count).
Trigger Criteria:
- Context: A cargo with multiple active hold conditions (border, destination, FDA, piece count)
- Applied to: Determine Highest Priority Hold
- Action: The system evaluates hold priority hierarchy
Logic Flow:
IF A cargo with multiple active hold conditions (border, destination, FDA, piece count)
AND The system evaluates hold priority hierarchy
THEN:
- • The highest priority hold status is determined based on predefined hold precedence rules
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo with determined highest priority hold type.
Trigger Criteria:
- Context: A cargo with determined highest priority hold type
- Applied to: Set Final Hold Status
- Action: The system sets the final cargo status
Logic Flow:
IF A cargo with determined highest priority hold type
AND The system sets the final cargo status
THEN:
- • The cargo status is set to the appropriate hold status (HOLD, HOLD-B, HOLD-D, HOLDFDA, HOLDPCS) based on the priority determination
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo with analyzed hold conditions and quantity comparisons.
Trigger Criteria:
- Context: A cargo with analyzed hold conditions and quantity comparisons
- Applied to: Determine Release Eligibility
- Action: The system performs final release eligibility assessment
Logic Flow:
IF A cargo with analyzed hold conditions and quantity comparisons
AND The system performs final release eligibility assessment
THEN:
- • The cargo is determined to be either release eligible or hold eligible based on the comprehensive analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo determined to be release eligible.
Trigger Criteria:
- Context: A cargo determined to be release eligible
- Applied to: Set Cargo Release Status
- Action: The system assigns final cargo status
Logic Flow:
IF A cargo determined to be release eligible
AND The system assigns final cargo status
THEN:
- • The cargo status is set to 'RELSD' (Released) or 'HOLDPCS' (Hold Pieces) based on quantity analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo determined to have active hold conditions.
Trigger Criteria:
- Context: A cargo determined to have active hold conditions
- Applied to: Set Cargo Hold Status
- Action: The system assigns final cargo status
Logic Flow:
IF A cargo determined to have active hold conditions
AND The system assigns final cargo status
THEN:
- • The cargo status is set to the appropriate hold status based on the type and priority of active holds
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo with final status determination completed.
Trigger Criteria:
- Context: A cargo with final status determination completed
- Applied to: Update Cargo Status Flags
- Action: The system updates cargo status flags
Logic Flow:
IF A cargo with final status determination completed
AND The system updates cargo status flags
THEN:
- • All relevant status flags (hold flags, release flags, processing flags) are updated to reflect the final cargo status
R-GCX016E-cbl-02419 (+15) File: GCX016E.cbl Business Rule: New Foreign Cargo Record Creation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when foreign bill of lading number is being processed.
Trigger Criteria:
- Context: A foreign bill of lading number is being processed
- Applied to: Foreign Bill Not Found in System
- Action: The system searches for the bill and it is not found in the existing cargo database
Logic Flow:
IF A foreign bill of lading number is being processed
AND The system searches for the bill and it is not found in the existing cargo database
THEN:
- • The system should trigger the new cargo record creation process
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when new cargo record needs to be created for a foreign bill.
Trigger Criteria:
- Context: A new cargo record needs to be created for a foreign bill
- Applied to: Initialize New Cargo Record
- Action: The initialization process begins
Logic Flow:
IF A new cargo record needs to be created for a foreign bill
AND The initialization process begins
THEN:
- • The system should clear all cargo record fields and set default values for status, dates, and counters
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when new cargo record is being created and x4 segment data is available.
Trigger Criteria:
- Context: A new cargo record is being created and X4 segment data is available
- Applied to: Set Up Cargo Record with X4 Segment Data
- Action: The system processes the X4 segment information
Logic Flow:
IF A new cargo record is being created and X4 segment data is available
AND The system processes the X4 segment information
THEN:
- • The cargo record should be populated with disposition code, entry number, quantity, and related X4 segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when new cargo record is being created and n7 segment data is available.
Trigger Criteria:
- Context: A new cargo record is being created and N7 segment data is available
- Applied to: Set Up Cargo Record with N7 Segment Data
- Action: The system processes the N7 segment information
Logic Flow:
IF A new cargo record is being created and N7 segment data is available
AND The system processes the N7 segment information
THEN:
- • The cargo record should be populated with equipment initial, equipment number, and formatted car ID information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when new foreign cargo record is being created and m10 segment data is available.
Trigger Criteria:
- Context: A new foreign cargo record is being created and M10 segment data is available
- Applied to: Build Foreign Manifest from M10 Segment
- Action: The system processes the M10 segment information
Logic Flow:
IF A new foreign cargo record is being created and M10 segment data is available
AND The system processes the M10 segment information
THEN:
- • The system should create a foreign manifest record with vessel name, manifest number, and related M10 segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when manifest data is available for a new foreign cargo record.
Trigger Criteria:
- Context: Manifest data is available for a new foreign cargo record
- Applied to: Extract SCAC Code
- Action: The system processes the manifest information
Logic Flow:
IF Manifest data is available for a new foreign cargo record
AND The system processes the manifest information
THEN:
- • The system should extract and validate the SCAC code from the manifest data
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when manifest data is available for a new foreign cargo record.
Trigger Criteria:
- Context: Manifest data is available for a new foreign cargo record
- Applied to: Extract Transport Type
- Action: The system processes the transportation information
Logic Flow:
IF Manifest data is available for a new foreign cargo record
AND The system processes the transportation information
THEN:
- • The system should extract and set the appropriate transport type code
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when manifest data is available for a new foreign cargo record.
Trigger Criteria:
- Context: Manifest data is available for a new foreign cargo record
- Applied to: Extract Country Code
- Action: The system processes the origin information
Logic Flow:
IF Manifest data is available for a new foreign cargo record
AND The system processes the origin information
THEN:
- • The system should extract and validate the country code from the manifest data
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when m10 segment data is available for a new foreign cargo record.
Trigger Criteria:
- Context: M10 segment data is available for a new foreign cargo record
- Applied to: Extract Vessel Details
- Action: The system processes the vessel information
Logic Flow:
IF M10 segment data is available for a new foreign cargo record
AND The system processes the vessel information
THEN:
- • The system should extract vessel name, voyage number, and other vessel identification details
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when equipment initial and equipment number are available from n7 segment.
Trigger Criteria:
- Context: Equipment initial and equipment number are available from N7 segment
- Applied to: Format Car ID for Database
- Action: The system formats the car identification for database storage
Logic Flow:
IF Equipment initial and equipment number are available from N7 segment
AND The system formats the car identification for database storage
THEN:
- • The system should concatenate equipment initial and number with proper formatting and padding
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when new cargo record has been populated with segment data.
Trigger Criteria:
- Context: A new cargo record has been populated with segment data
- Applied to: Validate Cargo Record Data
- Action: The system validates the cargo record before insertion
Logic Flow:
IF A new cargo record has been populated with segment data
AND The system validates the cargo record before insertion
THEN:
- • The system should verify all required fields are present and data formats are correct
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when validated new cargo record is ready for insertion.
Trigger Criteria:
- Context: A validated new cargo record is ready for insertion
- Applied to: Insert New Cargo Record into Database
- Action: The system attempts to insert the record into the database
Logic Flow:
IF A validated new cargo record is ready for insertion
AND The system attempts to insert the record into the database
THEN:
- • The system should successfully add the new cargo record to the database
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when new cargo record insertion has been attempted.
Trigger Criteria:
- Context: A new cargo record insertion has been attempted
- Applied to: Database Insert Successful?
- Action: The database operation completes
Logic Flow:
IF A new cargo record insertion has been attempted
AND The database operation completes
THEN:
- • The system should check the operation status and determine if the insertion was successful
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when new cargo record has been successfully inserted into the database.
Trigger Criteria:
- Context: A new cargo record has been successfully inserted into the database
- Applied to: Log Cargo Creation Action
- Action: The insertion operation completes successfully
Logic Flow:
IF A new cargo record has been successfully inserted into the database
AND The insertion operation completes successfully
THEN:
- • The system should log the cargo creation action with relevant details and timestamps
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when new cargo record insertion has failed.
Trigger Criteria:
- Context: A new cargo record insertion has failed
- Applied to: Generate Error Message
- Action: The database operation returns an error status
Logic Flow:
IF A new cargo record insertion has failed
AND The database operation returns an error status
THEN:
- • The system should generate an error message indicating the insertion failure
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record creation process has completed (either successfully or with error).
Trigger Criteria:
- Context: Cargo record creation process has completed (either successfully or with error)
- Applied to: Continue Processing
- Action: The creation process finishes
Logic Flow:
IF Cargo record creation process has completed (either successfully or with error)
AND The creation process finishes
THEN:
- • The system should continue with the next step in the message processing workflow
R-GCX016E-cbl-02435 (+13) File: GCX016E.cbl Business Rule: Foreign Manifest Building from M10 Segments
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when m10 segment containing carrier information is received.
Trigger Criteria:
- Context: An M10 segment containing carrier information is received
- Applied to: Extract SCAC Code from M10
- Action: The system processes the M10 segment for foreign manifest building
Logic Flow:
IF An M10 segment containing carrier information is received
AND The system processes the M10 segment for foreign manifest building
THEN:
- • The SCAC code is extracted from the M10 segment and stored for manifest construction
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when m10 segment containing transport information is received.
Trigger Criteria:
- Context: An M10 segment containing transport information is received
- Applied to: Extract Transport Type from M10
- Action: The system processes the M10 segment for foreign manifest building
Logic Flow:
IF An M10 segment containing transport information is received
AND The system processes the M10 segment for foreign manifest building
THEN:
- • The transport type is extracted from the M10 segment and stored for manifest construction
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when m10 segment containing country information is received.
Trigger Criteria:
- Context: An M10 segment containing country information is received
- Applied to: Extract Country Code from M10
- Action: The system processes the M10 segment for foreign manifest building
Logic Flow:
IF An M10 segment containing country information is received
AND The system processes the M10 segment for foreign manifest building
THEN:
- • The country code is extracted from the M10 segment and stored for manifest construction
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when m10 segment containing vessel information is received.
Trigger Criteria:
- Context: An M10 segment containing vessel information is received
- Applied to: Extract Vessel Details from M10
- Action: The system processes the M10 segment for foreign manifest building
Logic Flow:
IF An M10 segment containing vessel information is received
AND The system processes the M10 segment for foreign manifest building
THEN:
- • The vessel details including name and identification are extracted from the M10 segment and stored for manifest construction
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when scac code has been extracted from the m10 segment.
Trigger Criteria:
- Context: A SCAC code has been extracted from the M10 segment
- Applied to: Validate SCAC Information
- Action: The system validates the SCAC information for foreign manifest building
Logic Flow:
IF A SCAC code has been extracted from the M10 segment
AND The system validates the SCAC information for foreign manifest building
THEN:
- • The SCAC code is checked for validity and completeness according to business rules
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when scac code has been validated and found to be invalid or missing.
Trigger Criteria:
- Context: A SCAC code has been validated and found to be invalid or missing
- Applied to: Set Default SCAC Values
- Action: The SCAC validation fails during foreign manifest building
Logic Flow:
IF A SCAC code has been validated and found to be invalid or missing
AND The SCAC validation fails during foreign manifest building
THEN:
- • Default SCAC values are applied to ensure manifest can be constructed
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when vessel details have been extracted from the m10 segment.
Trigger Criteria:
- Context: Vessel details have been extracted from the M10 segment
- Applied to: Extract Vessel Name/ID
- Action: The system processes vessel information for foreign manifest building
Logic Flow:
IF Vessel details have been extracted from the M10 segment
AND The system processes vessel information for foreign manifest building
THEN:
- • The vessel name and identification are extracted and prepared for manifest structure
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when vessel information has been processed from the m10 segment.
Trigger Criteria:
- Context: Vessel information has been processed from the M10 segment
- Applied to: Extract Voyage Information
- Action: The system extracts voyage details for foreign manifest building
Logic Flow:
IF Vessel information has been processed from the M10 segment
AND The system extracts voyage details for foreign manifest building
THEN:
- • Voyage information is extracted and prepared for inclusion in the manifest structure
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all required information has been extracted from the m10 segment including scac, transport type, country code, and vessel details.
Trigger Criteria:
- Context: All required information has been extracted from the M10 segment including SCAC, transport type, country code, and vessel details
- Applied to: Build Foreign Manifest Structure
- Action: The system builds the foreign manifest structure
Logic Flow:
IF All required information has been extracted from the M10 segment including SCAC, transport type, country code, and vessel details
AND The system builds the foreign manifest structure
THEN:
- • A complete foreign manifest structure is constructed with all extracted information properly organized
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when transport type has been extracted from the m10 segment and foreign manifest structure is being built.
Trigger Criteria:
- Context: Transport type has been extracted from the M10 segment and foreign manifest structure is being built
- Applied to: Set Transport Mode Information
- Action: The system sets transport mode information in the manifest
Logic Flow:
IF Transport type has been extracted from the M10 segment and foreign manifest structure is being built
AND The system sets transport mode information in the manifest
THEN:
- • Transport mode information is properly configured in the foreign manifest structure
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when country code has been extracted from the m10 segment and foreign manifest structure is being built.
Trigger Criteria:
- Context: Country code has been extracted from the M10 segment and foreign manifest structure is being built
- Applied to: Set Country of Origin
- Action: The system sets country of origin in the manifest
Logic Flow:
IF Country code has been extracted from the M10 segment and foreign manifest structure is being built
AND The system sets country of origin in the manifest
THEN:
- • Country of origin information is properly configured in the foreign manifest structure
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when foreign manifest structure has been built with extracted m10 segment information.
Trigger Criteria:
- Context: A foreign manifest structure has been built with extracted M10 segment information
- Applied to: Validate Manifest Completeness
- Action: The system validates manifest completeness
Logic Flow:
IF A foreign manifest structure has been built with extracted M10 segment information
AND The system validates manifest completeness
THEN:
- • All required manifest fields are checked for presence and validity
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when foreign manifest has been validated and found to be incomplete.
Trigger Criteria:
- Context: A foreign manifest has been validated and found to be incomplete
- Applied to: Log Missing Information Warning
- Action: Required information is missing from the manifest
Logic Flow:
IF A foreign manifest has been validated and found to be incomplete
AND Required information is missing from the manifest
THEN:
- • A warning is logged indicating the missing information details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when foreign manifest structure has been built and validated (either complete or with logged warnings).
Trigger Criteria:
- Context: A foreign manifest structure has been built and validated (either complete or with logged warnings)
- Applied to: Finalize Foreign Manifest
- Action: The system finalizes the foreign manifest
Logic Flow:
IF A foreign manifest structure has been built and validated (either complete or with logged warnings)
AND The system finalizes the foreign manifest
THEN:
- • The foreign manifest is prepared for return to the cargo creation process
R-GCX016E-cbl-02449 (+11) File: GCX016E.cbl Business Rule: Station Data Lookup and Validation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when station data lookup request is initiated.
Trigger Criteria:
- Context: A station data lookup request is initiated
- Applied to: Station Type Required?
- Action: The system evaluates the station type requirement
Logic Flow:
IF A station data lookup request is initiated
AND The system evaluates the station type requirement
THEN:
- • The system routes to either destination station retrieval or key station retrieval based on the station type needed
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when destination station lookup is required.
Trigger Criteria:
- Context: A destination station lookup is required
- Applied to: Retrieve Destination Station Information
- Action: The system processes the destination station request
Logic Flow:
IF A destination station lookup is required
AND The system processes the destination station request
THEN:
- • The system accesses the DS table via GCCTBIO to retrieve destination station information
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when key station lookup is required.
Trigger Criteria:
- Context: A key station lookup is required
- Applied to: Retrieve Key Station Information
- Action: The system processes the key station request
Logic Flow:
IF A key station lookup is required
AND The system processes the key station request
THEN:
- • The system accesses the KS table via GCCTBIO to retrieve key station information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when destination station information is needed.
Trigger Criteria:
- Context: Destination station information is needed
- Applied to: Access DS Table via GCCTBIO
- Action: The system calls GCCTBIO to access the DS table
Logic Flow:
IF Destination station information is needed
AND The system calls GCCTBIO to access the DS table
THEN:
- • The system retrieves station data from the DS table using the GCCTBIO interface
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when key station information is needed.
Trigger Criteria:
- Context: Key station information is needed
- Applied to: Access KS Table via GCCTBIO
- Action: The system calls GCCTBIO to access the KS table
Logic Flow:
IF Key station information is needed
AND The system calls GCCTBIO to access the KS table
THEN:
- • The system retrieves station data from the KS table using the GCCTBIO interface
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when station lookup has been performed in either ds or ks table.
Trigger Criteria:
- Context: A station lookup has been performed in either DS or KS table
- Applied to: Station Found?
- Action: The system evaluates the lookup results
Logic Flow:
IF A station lookup has been performed in either DS or KS table
AND The system evaluates the lookup results
THEN:
- • The system determines if the station was found and routes to either location validation or station not found error processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when station has been found in the station table.
Trigger Criteria:
- Context: A station has been found in the station table
- Applied to: Validate Location Identifier
- Action: The system validates the location identifier for the station
Logic Flow:
IF A station has been found in the station table
AND The system validates the location identifier for the station
THEN:
- • The system determines if the location identifier is valid for cargo routing purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when location identifier has been validated.
Trigger Criteria:
- Context: A location identifier has been validated
- Applied to: Location Valid?
- Action: The system checks the validation results
Logic Flow:
IF A location identifier has been validated
AND The system checks the validation results
THEN:
- • The system routes to either station information setup for cargo routing or invalid location error processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when station has been found and its location identifier is valid.
Trigger Criteria:
- Context: A station has been found and its location identifier is valid
- Applied to: Set Station Information for Cargo Routing
- Action: The system sets up station information
Logic Flow:
IF A station has been found and its location identifier is valid
AND The system sets up station information
THEN:
- • The system configures the station data for cargo routing operations and completes the station lookup process
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when station lookup has been performed.
Trigger Criteria:
- Context: A station lookup has been performed
- Applied to: Generate Station Not Found Error
- Action: The requested station is not found in either DS or KS table
Logic Flow:
IF A station lookup has been performed
AND The requested station is not found in either DS or KS table
THEN:
- • The system generates a station not found error and completes the station lookup process
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when station has been found but its location identifier has been validated.
Trigger Criteria:
- Context: A station has been found but its location identifier has been validated
- Applied to: Generate Invalid Location Error
- Action: The location identifier fails validation criteria
Logic Flow:
IF A station has been found but its location identifier has been validated
AND The location identifier fails validation criteria
THEN:
- • The system generates an invalid location error and completes the station lookup process
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when station lookup processing has been performed with either successful station setup or error generation.
Trigger Criteria:
- Context: Station lookup processing has been performed with either successful station setup or error generation
- Applied to: Station Lookup Complete
- Action: The station lookup process reaches completion
Logic Flow:
IF Station lookup processing has been performed with either successful station setup or error generation
AND The station lookup process reaches completion
THEN:
- • The system finalizes the station lookup operation and returns control to the calling process
R-GCX016E-cbl-02461 (+27) File: GCX016E.cbl Business Rule: Comprehensive Merlin Message Formatting with Quantity Impact
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo disposition code processing event requires merlin notification.
Trigger Criteria:
- Context: A cargo disposition code processing event requires Merlin notification
- Applied to: Initialize Merlin Message Structure
- Action: The system begins formatting a comprehensive Merlin message
Logic Flow:
IF A cargo disposition code processing event requires Merlin notification
AND The system begins formatting a comprehensive Merlin message
THEN:
- • The Merlin message structure is initialized with default values and prepared for content population
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when merlin message is being formatted for cargo processing.
Trigger Criteria:
- Context: A Merlin message is being formatted for cargo processing
- Applied to: Format Equipment Information
- Action: Equipment information needs to be included in the message
Logic Flow:
IF A Merlin message is being formatted for cargo processing
AND Equipment information needs to be included in the message
THEN:
- • The system formats equipment initial, number, and type into the message structure
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment information has been formatted in the merlin message.
Trigger Criteria:
- Context: Equipment information has been formatted in the Merlin message
- Applied to: Add Car ID and Waybill Details
- Action: Car ID and waybill details are available for the cargo
Logic Flow:
IF Equipment information has been formatted in the Merlin message
AND Car ID and waybill details are available for the cargo
THEN:
- • The system adds the car ID and waybill number to the message content
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when car id and waybill details have been added to the message.
Trigger Criteria:
- Context: Car ID and waybill details have been added to the message
- Applied to: Include US-CCN Information
- Action: US-CCN information is available for the cargo
Logic Flow:
IF Car ID and waybill details have been added to the message
AND US-CCN information is available for the cargo
THEN:
- • The system includes the US-CCN in the message for customs tracking purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when us-ccn information has been included in the message.
Trigger Criteria:
- Context: US-CCN information has been included in the message
- Applied to: Format Disposition Code Details
- Action: A disposition code has been processed for the cargo
Logic Flow:
IF US-CCN information has been included in the message
AND A disposition code has been processed for the cargo
THEN:
- • The system formats the disposition code and related details into the message
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code details have been formatted.
Trigger Criteria:
- Context: Disposition code details have been formatted
- Applied to: Add Disposition Code Description
- Action: A disposition code description is available in the system
Logic Flow:
IF Disposition code details have been formatted
AND A disposition code description is available in the system
THEN:
- • The system adds the descriptive text explaining the disposition code action to the message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code has been processed for cargo.
Trigger Criteria:
- Context: A disposition code has been processed for cargo
- Applied to: Calculate Release Quantity Impact
- Action: The disposition code affects release quantities
Logic Flow:
IF A disposition code has been processed for cargo
AND The disposition code affects release quantities
THEN:
- • The system calculates the before and after quantities to determine the impact
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when release quantity impact has been calculated.
Trigger Criteria:
- Context: Release quantity impact has been calculated
- Applied to: Before/After Quantities Different?
- Action: Before and after quantities are compared
Logic Flow:
IF Release quantity impact has been calculated
AND Before and after quantities are compared
THEN:
- • The system determines if there is a significant difference requiring quantity impact messaging
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when before and after quantities are different.
Trigger Criteria:
- Context: Before and after quantities are different
- Applied to: Format Quantity Impact Message
- Action: Quantity impact messaging is required
Logic Flow:
IF Before and after quantities are different
AND Quantity impact messaging is required
THEN:
- • The system formats a detailed message showing the quantity changes
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when quantity impact message is being formatted.
Trigger Criteria:
- Context: Quantity impact message is being formatted
- Applied to: Show Before Quantity
- Action: Before quantity information is available
Logic Flow:
IF Quantity impact message is being formatted
AND Before quantity information is available
THEN:
- • The system includes the original quantity value in the impact message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when before quantity has been shown in the impact message.
Trigger Criteria:
- Context: Before quantity has been shown in the impact message
- Applied to: Show After Quantity
- Action: After quantity information is available
Logic Flow:
IF Before quantity has been shown in the impact message
AND After quantity information is available
THEN:
- • The system includes the resulting quantity value in the impact message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when before and after quantities have been shown.
Trigger Criteria:
- Context: Before and after quantities have been shown
- Applied to: Add Impact Description
- Action: Impact description is needed for clarity
Logic Flow:
IF Before and after quantities have been shown
AND Impact description is needed for clarity
THEN:
- • The system adds explanatory text describing whether quantities increased, decreased, or were modified
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when quantity impact processing is complete or not applicable.
Trigger Criteria:
- Context: Quantity impact processing is complete or not applicable
- Applied to: Include Cargo Status Information
- Action: Cargo status information is available
Logic Flow:
IF Quantity impact processing is complete or not applicable
AND Cargo status information is available
THEN:
- • The system includes current cargo status details in the message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo status information is being included.
Trigger Criteria:
- Context: Cargo status information is being included
- Applied to: Add Current Cargo Status
- Action: Current cargo status is available in the system
Logic Flow:
IF Cargo status information is being included
AND Current cargo status is available in the system
THEN:
- • The system adds the current status code and description to the message
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when current cargo status has been added to the message.
Trigger Criteria:
- Context: Current cargo status has been added to the message
- Applied to: Include Hold/Release Flags
- Action: Hold or release flags are set for the cargo
Logic Flow:
IF Current cargo status has been added to the message
AND Hold or release flags are set for the cargo
THEN:
- • The system includes the relevant hold/release flag information in the message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when hold/release flags have been included in the message.
Trigger Criteria:
- Context: Hold/release flags have been included in the message
- Applied to: Process K1 Comments
- Action: K1 comments processing is initiated
Logic Flow:
IF Hold/release flags have been included in the message
AND K1 comments processing is initiated
THEN:
- • The system evaluates available K1 comments for potential inclusion
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when k1 comments processing has been initiated.
Trigger Criteria:
- Context: K1 comments processing has been initiated
- Applied to: K1 Comments Available?
- Action: The system evaluates K1 comment availability
Logic Flow:
IF K1 comments processing has been initiated
AND The system evaluates K1 comment availability
THEN:
- • The system determines if valid K1 comments exist for message inclusion
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when k1 comments are available for inclusion.
Trigger Criteria:
- Context: K1 comments are available for inclusion
- Applied to: Add Free-Form Text Messages
- Action: Free-form text messages need to be added
Logic Flow:
IF K1 comments are available for inclusion
AND Free-form text messages need to be added
THEN:
- • The system formats and includes the K1 comment text in the message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when free-form text messages have been added or k1 comments are not available.
Trigger Criteria:
- Context: Free-form text messages have been added or K1 comments are not available
- Applied to: Include Processing Details
- Action: Processing details need to be included
Logic Flow:
IF Free-form text messages have been added or K1 comments are not available
AND Processing details need to be included
THEN:
- • The system adds relevant processing details and context information to the message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when processing details have been included in the message.
Trigger Criteria:
- Context: Processing details have been included in the message
- Applied to: Add Special Comments
- Action: Special comments are available for the cargo or processing event
Logic Flow:
IF Processing details have been included in the message
AND Special comments are available for the cargo or processing event
THEN:
- • The system adds the special comments to enhance message content
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when special comments have been processed.
Trigger Criteria:
- Context: Special comments have been processed
- Applied to: Canadian Pacific Railway Bond?
- Action: The system evaluates bond creation requirements
Logic Flow:
IF Special comments have been processed
AND The system evaluates bond creation requirements
THEN:
- • The system determines if Canadian Pacific Railway bond processing is involved
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when canadian pacific railway bond processing is identified.
Trigger Criteria:
- Context: Canadian Pacific Railway bond processing is identified
- Applied to: Add CPR Bond Creation Notice
- Action: Bond creation notice is required
Logic Flow:
IF Canadian Pacific Railway bond processing is identified
AND Bond creation notice is required
THEN:
- • The system adds CPR bond creation notification text to the message
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cpr bond notice has been added or is not applicable.
Trigger Criteria:
- Context: CPR bond notice has been added or is not applicable
- Applied to: Format Date/Time Information
- Action: Date and time information needs to be formatted
Logic Flow:
IF CPR bond notice has been added or is not applicable
AND Date and time information needs to be formatted
THEN:
- • The system formats relevant dates and times for inclusion in the message
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when date/time information formatting has been initiated.
Trigger Criteria:
- Context: Date/time information formatting has been initiated
- Applied to: Add USCS Processing Time
- Action: USCS processing time is available
Logic Flow:
IF Date/time information formatting has been initiated
AND USCS processing time is available
THEN:
- • The system adds the USCS processing timestamp to the message
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when uscs processing time has been added.
Trigger Criteria:
- Context: USCS processing time has been added
- Applied to: Add System Processing Time
- Action: System processing time needs to be recorded
Logic Flow:
IF USCS processing time has been added
AND System processing time needs to be recorded
THEN:
- • The system adds the internal processing timestamp to the message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when system processing time has been added.
Trigger Criteria:
- Context: System processing time has been added
- Applied to: Finalize Message Content
- Action: Message content assembly is complete
Logic Flow:
IF System processing time has been added
AND Message content assembly is complete
THEN:
- • The system finalizes the message content structure and prepares for message attributes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when message content has been finalized.
Trigger Criteria:
- Context: Message content has been finalized
- Applied to: Set Message Type and Priority
- Action: Message attributes need to be set
Logic Flow:
IF Message content has been finalized
AND Message attributes need to be set
THEN:
- • The system assigns the appropriate message type and priority level for proper routing and handling
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when message type and priority have been set.
Trigger Criteria:
- Context: Message type and priority have been set
- Applied to: Complete Merlin Message
- Action: Final message assembly is required
Logic Flow:
IF Message type and priority have been set
AND Final message assembly is required
THEN:
- • The system completes the Merlin message with all formatted content, ready for transmission
R-GCX016E-cbl-02489 (+9) File: GCX016E.cbl Business Rule: Broker Bond Creation Notification Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when k1 free-form text segment is received.
Trigger Criteria:
- Context: A K1 free-form text segment is received
- Applied to: Identify Canadian Pacific Railway Bond Creation
- Action: The K1 segment contains 'DIRECTOR OF CUSTOMS, CP RAIL' OR 'CANADIAN PACIFIC LIMITED' OR 'CANADIAN PACIFIC RAILWAY CO'
Logic Flow:
IF A K1 free-form text segment is received
AND The K1 segment contains 'DIRECTOR OF CUSTOMS, CP RAIL' OR 'CANADIAN PACIFIC LIMITED' OR 'CANADIAN PACIFIC RAILWAY CO'
THEN:
- • The message is identified as a Canadian Pacific Railway bond creation request
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when k1 segment is identified as canadian pacific railway bond creation.
Trigger Criteria:
- Context: A K1 segment is identified as Canadian Pacific Railway bond creation
- Applied to: Extract Bond Information from K1 Segment
- Action: The system processes the K1 segment content
Logic Flow:
IF A K1 segment is identified as Canadian Pacific Railway bond creation
AND The system processes the K1 segment content
THEN:
- • Bond information including bond number, broker details, and creation request data is extracted from the free-form text
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when bond information has been extracted from k1 segment.
Trigger Criteria:
- Context: Bond information has been extracted from K1 segment
- Applied to: Validate Bond Creation Request
- Action: The system validates the bond creation request
Logic Flow:
IF Bond information has been extracted from K1 segment
AND The system validates the bond creation request
THEN:
- • The bond information is verified for completeness and business rule compliance
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when bond information has been extracted from k1 segment.
Trigger Criteria:
- Context: Bond information has been extracted from K1 segment
- Applied to: Generate Error Message for Invalid Bond
- Action: Bond validation fails due to incomplete or invalid information
Logic Flow:
IF Bond information has been extracted from K1 segment
AND Bond validation fails due to incomplete or invalid information
THEN:
- • An error message is generated indicating the specific validation failure and the bond creation request is rejected
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid bond information has been extracted and validated.
Trigger Criteria:
- Context: Valid bond information has been extracted and validated
- Applied to: Format Bond Creation Notification
- Action: The system formats the bond creation notification
Logic Flow:
IF Valid bond information has been extracted and validated
AND The system formats the bond creation notification
THEN:
- • A structured notification message is created containing bond details, broker information, and creation timestamp
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when bond creation notification is being formatted for canadian pacific railway.
Trigger Criteria:
- Context: A bond creation notification is being formatted for Canadian Pacific Railway
- Applied to: Add Special Comments for CPR Bond
- Action: Special comments are added to the message
Logic Flow:
IF A bond creation notification is being formatted for Canadian Pacific Railway
AND Special comments are added to the message
THEN:
- • CPR-specific identifiers and comments are included in the notification message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when bond creation notification message is being prepared.
Trigger Criteria:
- Context: A bond creation notification message is being prepared
- Applied to: Include Bond Details in Message
- Action: Bond details are included in the message
Logic Flow:
IF A bond creation notification message is being prepared
AND Bond details are included in the message
THEN:
- • Complete bond information including bond number, broker details, and creation context is added to the Merlin message
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when bond details and special comments have been prepared.
Trigger Criteria:
- Context: Bond details and special comments have been prepared
- Applied to: Create Comprehensive Merlin Notification
- Action: The comprehensive Merlin notification is created
Logic Flow:
IF Bond details and special comments have been prepared
AND The comprehensive Merlin notification is created
THEN:
- • A complete notification message is generated with all bond creation information formatted for business user consumption
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when comprehensive merlin notification has been created.
Trigger Criteria:
- Context: A comprehensive Merlin notification has been created
- Applied to: Route to Appropriate Recipients
- Action: The notification is routed to recipients
Logic Flow:
IF A comprehensive Merlin notification has been created
AND The notification is routed to recipients
THEN:
- • The message is sent to appropriate business users, brokers, and systems based on established routing rules
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when bond creation notification has been routed to recipients.
Trigger Criteria:
- Context: A bond creation notification has been routed to recipients
- Applied to: Log Bond Creation Action
- Action: The action is logged
Logic Flow:
IF A bond creation notification has been routed to recipients
AND The action is logged
THEN:
- • Bond creation notification details are recorded in the system log for audit and tracking purposes
R-GCX016E-cbl-02499 (+10) File: GCX016E.cbl Business Rule: Release Quantity Impact Analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record exists with release quantity information.
Trigger Criteria:
- Context: A cargo record exists with release quantity information
- Applied to: Retrieve Current Cargo Release Quantity
- Action: Release quantity impact analysis is initiated
Logic Flow:
IF A cargo record exists with release quantity information
AND Release quantity impact analysis is initiated
THEN:
- • The current cargo release quantity is retrieved and stored for comparison calculations
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is being processed for cargo.
Trigger Criteria:
- Context: A disposition code is being processed for cargo
- Applied to: Identify Disposition Code Action Type
- Action: The system evaluates the disposition code's quantity impact characteristics
Logic Flow:
IF A disposition code is being processed for cargo
AND The system evaluates the disposition code's quantity impact characteristics
THEN:
- • The action type is classified as Add Action, Subtract Action, or Status Info Only based on the disposition code properties
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code with add action type is being processed.
Trigger Criteria:
- Context: A disposition code with Add Action type is being processed
- Applied to: Add to Release Quantity
- Action: The quantity impact calculation is performed
Logic Flow:
IF A disposition code with Add Action type is being processed
AND The quantity impact calculation is performed
THEN:
- • The disposition code quantity is added to the current cargo release quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code with subtract action type is being processed.
Trigger Criteria:
- Context: A disposition code with Subtract Action type is being processed
- Applied to: Subtract from Release Quantity
- Action: The quantity impact calculation is performed
Logic Flow:
IF A disposition code with Subtract Action type is being processed
AND The quantity impact calculation is performed
THEN:
- • The disposition code quantity is subtracted from the current cargo release quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code with status info only type is being processed.
Trigger Criteria:
- Context: A disposition code with Status Info Only type is being processed
- Applied to: No Quantity Impact
- Action: The quantity impact evaluation is performed
Logic Flow:
IF A disposition code with Status Info Only type is being processed
AND The quantity impact evaluation is performed
THEN:
- • No quantity calculations are performed and the release quantity remains unchanged
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code with quantity impact has been processed.
Trigger Criteria:
- Context: A disposition code with quantity impact has been processed
- Applied to: Calculate Before/After Quantities
- Action: Before and after quantity calculation is performed
Logic Flow:
IF A disposition code with quantity impact has been processed
AND Before and after quantity calculation is performed
THEN:
- • The system calculates and stores both the original quantity and the new quantity after disposition code impact
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when before and after quantities have been calculated for a disposition code.
Trigger Criteria:
- Context: Before and after quantities have been calculated for a disposition code
- Applied to: Format Quantity Impact Message
- Action: Quantity impact message formatting is initiated
Logic Flow:
IF Before and after quantities have been calculated for a disposition code
AND Quantity impact message formatting is initiated
THEN:
- • A formatted message is created showing the quantity change details in business-friendly format
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when before and after release quantities are available.
Trigger Criteria:
- Context: Before and after release quantities are available
- Applied to: Release Quantity Changed?
- Action: The system compares the quantities for changes
Logic Flow:
IF Before and after release quantities are available
AND The system compares the quantities for changes
THEN:
- • If the before and after quantities are different, the system identifies that release quantity has changed,
otherwise no change is detected
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when release quantity change has been detected.
Trigger Criteria:
- Context: A release quantity change has been detected
- Applied to: Create Impact Description
- Action: Impact description creation is initiated
Logic Flow:
IF A release quantity change has been detected
AND Impact description creation is initiated
THEN:
- • A detailed description is created showing the specific quantity change amount and direction (increase/decrease)
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when quantity impact description has been created.
Trigger Criteria:
- Context: A quantity impact description has been created
- Applied to: Add to Merlin Message
- Action: Merlin message composition is in progress
Logic Flow:
IF A quantity impact description has been created
AND Merlin message composition is in progress
THEN:
- • The quantity impact information is added to the Merlin message content for business user notification
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when no release quantity change was detected or disposition code has no quantity impact.
Trigger Criteria:
- Context: No release quantity change was detected or disposition code has no quantity impact
- Applied to: Skip Quantity Impact Reporting
- Action: Quantity impact reporting evaluation is performed
Logic Flow:
IF No release quantity change was detected or disposition code has no quantity impact
AND Quantity impact reporting evaluation is performed
THEN:
- • The system skips creating impact descriptions and does not add quantity information to notifications
R-GCX016E-cbl-02510 (+11) File: GCX016E.cbl Business Rule: New Cargo Record Insertion
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when new cargo record needs to be created in the system.
Trigger Criteria:
- Context: A new cargo record needs to be created in the system
- Applied to: Initialize New Cargo Record
- Action: The cargo record initialization process is triggered
Logic Flow:
IF A new cargo record needs to be created in the system
AND The cargo record initialization process is triggered
THEN:
- • A new cargo record structure is created with all fields initialized to default values and ready for data population
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record exists and x4 segment data is available with disposition codes and quantities.
Trigger Criteria:
- Context: A cargo record exists and X4 segment data is available with disposition codes and quantities
- Applied to: Set Up Cargo Record with X4 Segment Data
- Action: X4 segment data is processed for cargo record setup
Logic Flow:
IF A cargo record exists and X4 segment data is available with disposition codes and quantities
AND X4 segment data is processed for cargo record setup
THEN:
- • The cargo record is populated with disposition code, entry number, quantity information, and processing flags from the X4 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record exists and n7 segment data is available with equipment details.
Trigger Criteria:
- Context: A cargo record exists and N7 segment data is available with equipment details
- Applied to: Set Up Cargo Record with N7 Segment Data
- Action: N7 segment data is processed for cargo record setup
Logic Flow:
IF A cargo record exists and N7 segment data is available with equipment details
AND N7 segment data is processed for cargo record setup
THEN:
- • The cargo record is populated with equipment initial, equipment number, car ID, and equipment type information from the N7 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record with equipment and routing information is being processed.
Trigger Criteria:
- Context: A cargo record with equipment and routing information is being processed
- Applied to: CPRS Traffic?
- Action: The system evaluates the cargo type for CPRS classification
Logic Flow:
IF A cargo record with equipment and routing information is being processed
AND The system evaluates the cargo type for CPRS classification
THEN:
- • The system identifies whether the cargo is CPRS traffic or standard traffic based on predefined CPRS indicators
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record is identified as cprs traffic.
Trigger Criteria:
- Context: A cargo record is identified as CPRS traffic
- Applied to: Apply CPRS Special Handling
- Action: CPRS special handling is applied to the cargo record
Logic Flow:
IF A cargo record is identified as CPRS traffic
AND CPRS special handling is applied to the cargo record
THEN:
- • The car ID information is cleared and CPRS-specific processing rules are applied to the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record is identified as non-cprs traffic with equipment initial and number available.
Trigger Criteria:
- Context: A cargo record is identified as non-CPRS traffic with equipment initial and number available
- Applied to: Apply Standard Car ID Formatting
- Action: Standard car ID formatting is applied
Logic Flow:
IF A cargo record is identified as non-CPRS traffic with equipment initial and number available
AND Standard car ID formatting is applied
THEN:
- • The car ID is formatted according to standard rules combining equipment initial and equipment number
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record has car id information that needs formatting.
Trigger Criteria:
- Context: A cargo record has car ID information that needs formatting
- Applied to: Format Car ID According to Standards
- Action: Car ID formatting standards are applied
Logic Flow:
IF A cargo record has car ID information that needs formatting
AND Car ID formatting standards are applied
THEN:
- • The car ID is formatted according to system standards with proper spacing, character positioning, and validation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record is populated with x4 and n7 segment data and formatted car id.
Trigger Criteria:
- Context: A cargo record is populated with X4 and N7 segment data and formatted car ID
- Applied to: Validate Cargo Record Data
- Action: Cargo record validation is performed
Logic Flow:
IF A cargo record is populated with X4 and N7 segment data and formatted car ID
AND Cargo record validation is performed
THEN:
- • All required fields are validated for completeness, data integrity, and business rule compliance, and any validation errors are identified
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when validated cargo record is ready for database insertion.
Trigger Criteria:
- Context: A validated cargo record is ready for database insertion
- Applied to: Insert Cargo Record into Database
- Action: The database insertion operation is executed
Logic Flow:
IF A validated cargo record is ready for database insertion
AND The database insertion operation is executed
THEN:
- • The cargo record is inserted into the GCSUSRT database table and the operation result is captured
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record insertion operation has been attempted.
Trigger Criteria:
- Context: A cargo record insertion operation has been attempted
- Applied to: Database Insert Successful?
- Action: The database insertion result is evaluated
Logic Flow:
IF A cargo record insertion operation has been attempted
AND The database insertion result is evaluated
THEN:
- • The system determines whether the insertion was successful or failed based on database response codes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record has been successfully inserted into the database.
Trigger Criteria:
- Context: A cargo record has been successfully inserted into the database
- Applied to: Log Successful Insertion
- Action: Success logging is performed
Logic Flow:
IF A cargo record has been successfully inserted into the database
AND Success logging is performed
THEN:
- • The successful insertion is logged with cargo record details, timestamp, and confirmation of database update
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record insertion operation has failed.
Trigger Criteria:
- Context: A cargo record insertion operation has failed
- Applied to: Handle Database Insert Error
- Action: Database insert error handling is triggered
Logic Flow:
IF A cargo record insertion operation has failed
AND Database insert error handling is triggered
THEN:
- • The insertion failure is logged with error details and appropriate error recovery or notification procedures are initiated
R-GCX016E-cbl-02522 (+9) File: GCX016E.cbl Business Rule: Station Data Retrieval for Transit Traffic
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when transit traffic request is received with m1203 segment data.
Trigger Criteria:
- Context: A transit traffic request is received with M1203 segment data
- Applied to: Extract Location Identifier from M1203 Segment
- Action: The system processes the M1203 segment
Logic Flow:
IF A transit traffic request is received with M1203 segment data
AND The system processes the M1203 segment
THEN:
- • The location identifier is extracted from the M1203 segment for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when location identifier has been extracted from m1203 segment.
Trigger Criteria:
- Context: A location identifier has been extracted from M1203 segment
- Applied to: Validate Location Identifier Format
- Action: The system validates the location identifier format
Logic Flow:
IF A location identifier has been extracted from M1203 segment
AND The system validates the location identifier format
THEN:
- • The location identifier is confirmed as valid or invalid based on format requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when location identifier has been validated for format compliance. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A location identifier has been validated for format compliance
- Applied to: Location Identifier Valid?
- Action: The system checks if the location identifier is valid
Logic Flow:
IF A location identifier has been validated for format compliance
AND The system checks if the location identifier is valid
THEN:
- • If valid, proceed to call generic table interface; if invalid, log error and return error to calling process
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid location identifier is available for processing. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A valid location identifier is available for processing
- Applied to: Call Generic Table I/O Interface
- Action: The system needs to retrieve station information
Logic Flow:
IF A valid location identifier is available for processing
AND The system needs to retrieve station information
THEN:
- • The generic table I/O interface is called to access the station data repository
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when generic table i/o interface has been called with a valid location identifier.
Trigger Criteria:
- Context: The generic table I/O interface has been called with a valid location identifier
- Applied to: Retrieve Station Information from DS Table
- Action: The system searches the DS table for matching station data
Logic Flow:
IF The generic table I/O interface has been called with a valid location identifier
AND The system searches the DS table for matching station data
THEN:
- • Station information is retrieved from the DS table based on the location identifier
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when search for station information has been performed in the ds table.
Trigger Criteria:
- Context: A search for station information has been performed in the DS table
- Applied to: Station Data Found?
- Action: The system checks if station data was found
Logic Flow:
IF A search for station information has been performed in the DS table
AND The system checks if station data was found
THEN:
- • If station data is found, format it for transit routing; if not found, generate station not found error
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when station data has been successfully retrieved from the ds table.
Trigger Criteria:
- Context: Station data has been successfully retrieved from the DS table
- Applied to: Format Station Information for Transit Routing
- Action: The system formats the station information
Logic Flow:
IF Station data has been successfully retrieved from the DS table
AND The system formats the station information
THEN:
- • Station information is formatted in the required structure for transit routing operations
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when station information has been successfully formatted for transit routing.
Trigger Criteria:
- Context: Station information has been successfully formatted for transit routing
- Applied to: Return Station Data to Calling Process
- Action: The processing is complete
Logic Flow:
IF Station information has been successfully formatted for transit routing
AND The processing is complete
THEN:
- • The formatted station data is returned to the calling process
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when search for station information in the ds table has been performed.
Trigger Criteria:
- Context: A search for station information in the DS table has been performed
- Applied to: Generate Station Not Found Error
- Action: No station data is found for the location identifier
Logic Flow:
IF A search for station information in the DS table has been performed
AND No station data is found for the location identifier
THEN:
- • A station not found error is generated and returned to the calling process
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when location identifier has failed format validation.
Trigger Criteria:
- Context: A location identifier has failed format validation
- Applied to: Log Invalid Location Identifier
- Action: The system processes the invalid location identifier
Logic Flow:
IF A location identifier has failed format validation
AND The system processes the invalid location identifier
THEN:
- • An invalid location identifier error is logged and error is returned to calling process
R-GCX016E-cbl-02532 (+9) File: GCX016E.cbl Business Rule: Destination Station Table Lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when x4 segment containing location data is available for processing.
Trigger Criteria:
- Context: An X4 segment containing location data is available for processing
- Applied to: Extract Location Identifier from X4 Segment
- Action: The system processes the X4 segment for station lookup
Logic Flow:
IF An X4 segment containing location data is available for processing
AND The system processes the X4 segment for station lookup
THEN:
- • The location identifier is extracted from the X4 segment and made available for table lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when system has extracted location data from the x4 segment.
Trigger Criteria:
- Context: The system has extracted location data from the X4 segment
- Applied to: Location Identifier Present?
- Action: The system checks for the presence of a location identifier
Logic Flow:
IF The system has extracted location data from the X4 segment
AND The system checks for the presence of a location identifier
THEN:
- • If location identifier is present, proceed with station lookup; if not present, continue with default routing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid location identifier is available for station lookup.
Trigger Criteria:
- Context: A valid location identifier is available for station lookup
- Applied to: Set DS Table Type for Lookup
- Action: The system prepares to access the DS table
Logic Flow:
IF A valid location identifier is available for station lookup
AND The system prepares to access the DS table
THEN:
- • The DS table type is set for the lookup operation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when ds table type is configured and location identifier is available. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: The DS table type is configured and location identifier is available
- Applied to: Call GCCTBIO Table I/O Interface
- Action: The system needs to retrieve station information
Logic Flow:
IF The DS table type is configured and location identifier is available
AND The system needs to retrieve station information
THEN:
- • The GCCTBIO table I/O interface is invoked to access the DS table
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when gcctbio interface has been called with a location identifier.
Trigger Criteria:
- Context: The GCCTBIO interface has been called with a location identifier
- Applied to: Station Record Found?
- Action: The system checks the lookup result
Logic Flow:
IF The GCCTBIO interface has been called with a location identifier
AND The system checks the lookup result
THEN:
- • If station record is found, proceed with data retrieval; if not found, log error and continue with default routing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when matching station record exists in the ds table.
Trigger Criteria:
- Context: A matching station record exists in the DS table
- Applied to: Retrieve Station Information
- Action: The system processes the successful lookup result
Logic Flow:
IF A matching station record exists in the DS table
AND The system processes the successful lookup result
THEN:
- • The complete station information is retrieved from the DS table
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when station information has been successfully retrieved from the ds table.
Trigger Criteria:
- Context: Station information has been successfully retrieved from the DS table
- Applied to: Extract Station Name and Details
- Action: The system processes the retrieved station record
Logic Flow:
IF Station information has been successfully retrieved from the DS table
AND The system processes the retrieved station record
THEN:
- • Station name and relevant details are extracted from the record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when station name and details have been extracted from the ds table record.
Trigger Criteria:
- Context: Station name and details have been extracted from the DS table record
- Applied to: Set Station Data for Cargo Routing
- Action: The system prepares cargo routing information
Logic Flow:
IF Station name and details have been extracted from the DS table record
AND The system prepares cargo routing information
THEN:
- • The station data is set and made available for cargo routing purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when station lookup has been performed with a valid location identifier.
Trigger Criteria:
- Context: A station lookup has been performed with a valid location identifier
- Applied to: Log Station Not Found Error
- Action: No matching station record is found in the DS table
Logic Flow:
IF A station lookup has been performed with a valid location identifier
AND No matching station record is found in the DS table
THEN:
- • A station not found error is logged for tracking and audit purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when either no location identifier is present or station record is not found.
Trigger Criteria:
- Context: Either no location identifier is present or station record is not found
- Applied to: Continue with Default Routing
- Action: The system cannot obtain specific station information
Logic Flow:
IF Either no location identifier is present or station record is not found
AND The system cannot obtain specific station information
THEN:
- • Processing continues with default routing configuration
R-GCX016E-cbl-02542 (+10) File: GCX016E.cbl Business Rule: Key Station Table Lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when x4 segment contains location information.
Trigger Criteria:
- Context: An X4 segment contains location information
- Applied to: Extract Location Code from X4 Segment
- Action: The system processes the X4 segment for location validation
Logic Flow:
IF An X4 segment contains location information
AND The system processes the X4 segment for location validation
THEN:
- • The location code is extracted and prepared for key station lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when location code needs to be validated against key station data.
Trigger Criteria:
- Context: A location code needs to be validated against key station data
- Applied to: Set Table Type to KS - Key Station
- Action: The system prepares for table lookup operation
Logic Flow:
IF A location code needs to be validated against key station data
AND The system prepares for table lookup operation
THEN:
- • The table type is set to KS for Key Station table access
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when location code and table type ks are configured. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Location code and table type KS are configured
- Applied to: Call GCCTBIO Table Lookup Interface
- Action: The system needs to validate location against key station data
Logic Flow:
IF Location code and table type KS are configured
AND The system needs to validate location against key station data
THEN:
- • GCCTBIO table lookup interface is called to retrieve station information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when table lookup has been performed for a location code in ks table.
Trigger Criteria:
- Context: A table lookup has been performed for a location code in KS table
- Applied to: Key Station Found?
- Action: The system evaluates the lookup results
Logic Flow:
IF A table lookup has been performed for a location code in KS table
AND The system evaluates the lookup results
THEN:
- • The system determines whether a valid key station record was found or not
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid key station record exists for the location code.
Trigger Criteria:
- Context: A valid key station record exists for the location code
- Applied to: Retrieve Key Station Information
- Action: The table lookup successfully finds the station
Logic Flow:
IF A valid key station record exists for the location code
AND The table lookup successfully finds the station
THEN:
- • Key station information is retrieved from the KS table data
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when key station information has been retrieved from the table.
Trigger Criteria:
- Context: Key station information has been retrieved from the table
- Applied to: Validate Location Identifier
- Action: The system validates the location identifier
Logic Flow:
IF Key station information has been retrieved from the table
AND The system validates the location identifier
THEN:
- • The location identifier is confirmed as valid based on station data
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when location identifier has been successfully validated.
Trigger Criteria:
- Context: Location identifier has been successfully validated
- Applied to: Set Station Data Fields
- Action: The system processes the validated station information
Logic Flow:
IF Location identifier has been successfully validated
AND The system processes the validated station information
THEN:
- • Station data fields are populated with the retrieved key station details
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when station data fields have been populated with valid information.
Trigger Criteria:
- Context: Station data fields have been populated with valid information
- Applied to: Return Validated Location Information
- Action: The location validation process completes successfully
Logic Flow:
IF Station data fields have been populated with valid information
AND The location validation process completes successfully
THEN:
- • Validated location information is returned to the requesting process
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when location code does not exist in the ks key station table.
Trigger Criteria:
- Context: A location code does not exist in the KS key station table
- Applied to: Generate Location Validation Error
- Action: The table lookup fails to find a matching station record
Logic Flow:
IF A location code does not exist in the KS key station table
AND The table lookup fails to find a matching station record
THEN:
- • A location validation error is generated for the invalid location
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when location validation error has been generated.
Trigger Criteria:
- Context: A location validation error has been generated
- Applied to: Set Error Flag for Invalid Location
- Action: The system handles the invalid location condition
Logic Flow:
IF A location validation error has been generated
AND The system handles the invalid location condition
THEN:
- • An error flag is set to indicate invalid location status
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when error flag has been set for invalid location.
Trigger Criteria:
- Context: An error flag has been set for invalid location
- Applied to: Continue Processing with Error Status
- Action: The system continues with subsequent processing steps
Logic Flow:
IF An error flag has been set for invalid location
AND The system continues with subsequent processing steps
THEN:
- • Processing continues with error status maintained for downstream handling
R-GCX016E-cbl-02553 (+14) File: GCX016E.cbl Business Rule: Generic Table I/O Interface
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when request is made for table data retrieval.
Trigger Criteria:
- Context: A request is made for table data retrieval
- Applied to: Generic Table I/O Request
- Action: The generic table I/O interface is invoked
Logic Flow:
IF A request is made for table data retrieval
AND The generic table I/O interface is invoked
THEN:
- • The system should route the request to the appropriate table lookup service
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when table data request is received.
Trigger Criteria:
- Context: A table data request is received
- Applied to: Table Type?
- Action: The system evaluates the table type parameter
Logic Flow:
IF A table data request is received
AND The system evaluates the table type parameter
THEN:
- • The request should be classified as either station data, broker information, or other table type
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when request is classified as station data lookup.
Trigger Criteria:
- Context: A request is classified as station data lookup
- Applied to: Station Data Lookup Request
- Action: The station data processing is initiated
Logic Flow:
IF A request is classified as station data lookup
AND The station data processing is initiated
THEN:
- • The system should prepare to retrieve station-specific information from the table interface
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when request is classified as broker information lookup.
Trigger Criteria:
- Context: A request is classified as broker information lookup
- Applied to: Broker Information Request
- Action: The broker data processing is initiated
Logic Flow:
IF A request is classified as broker information lookup
AND The broker data processing is initiated
THEN:
- • The system should prepare to retrieve broker-specific information from the table interface
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when request is classified as other table type.
Trigger Criteria:
- Context: A request is classified as other table type
- Applied to: Other Table Type Request
- Action: The other table type processing is initiated
Logic Flow:
IF A request is classified as other table type
AND The other table type processing is initiated
THEN:
- • The system should prepare to retrieve the specified table information from the generic interface
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when table lookup request has been classified and prepared. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A table lookup request has been classified and prepared
- Applied to: Call GCCTBIO Interface
- Action: The GCCTBIO interface is called
Logic Flow:
IF A table lookup request has been classified and prepared
AND The GCCTBIO interface is called
THEN:
- • The system should execute the table lookup operation through the external interface
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when destination station data request is processed through gcctbio.
Trigger Criteria:
- Context: A destination station data request is processed through GCCTBIO
- Applied to: Retrieve Destination Station Data
- Action: The destination station lookup is executed
Logic Flow:
IF A destination station data request is processed through GCCTBIO
AND The destination station lookup is executed
THEN:
- • The system should retrieve destination station details from the GCSTBRT table segments
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when key station data request is processed through gcctbio.
Trigger Criteria:
- Context: A key station data request is processed through GCCTBIO
- Applied to: Retrieve Key Station Data
- Action: The key station lookup is executed
Logic Flow:
IF A key station data request is processed through GCCTBIO
AND The key station lookup is executed
THEN:
- • The system should retrieve key station details from the GCSTBRT table segments
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when broker name data request is processed through gcctbio.
Trigger Criteria:
- Context: A broker name data request is processed through GCCTBIO
- Applied to: Retrieve Broker Name Data
- Action: The broker name lookup is executed
Logic Flow:
IF A broker name data request is processed through GCCTBIO
AND The broker name lookup is executed
THEN:
- • The system should retrieve broker name details from the GCSTBRT table segments
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when broker contact data request is processed through gcctbio.
Trigger Criteria:
- Context: A broker contact data request is processed through GCCTBIO
- Applied to: Retrieve Broker Contact Data
- Action: The broker contact lookup is executed
Logic Flow:
IF A broker contact data request is processed through GCCTBIO
AND The broker contact lookup is executed
THEN:
- • The system should retrieve broker contact details from the GCSTBRT table segments
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when other table type request is processed through gcctbio.
Trigger Criteria:
- Context: An other table type request is processed through GCCTBIO
- Applied to: Retrieve Other Table Data
- Action: The other table lookup is executed
Logic Flow:
IF An other table type request is processed through GCCTBIO
AND The other table lookup is executed
THEN:
- • The system should retrieve the requested table data from the appropriate table segments
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when table lookup operation has been completed.
Trigger Criteria:
- Context: A table lookup operation has been completed
- Applied to: Data Found?
- Action: The system checks the retrieval results
Logic Flow:
IF A table lookup operation has been completed
AND The system checks the retrieval results
THEN:
- • The system should determine if the requested data was found or not found
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when table data was successfully found during lookup.
Trigger Criteria:
- Context: Table data was successfully found during lookup
- Applied to: Return Table Data
- Action: The data return process is executed
Logic Flow:
IF Table data was successfully found during lookup
AND The data return process is executed
THEN:
- • The system should return the retrieved table data to the caller
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when table data was not found during lookup.
Trigger Criteria:
- Context: Table data was not found during lookup
- Applied to: Return Not Found Status
- Action: The not found response process is executed
Logic Flow:
IF Table data was not found during lookup
AND The not found response process is executed
THEN:
- • The system should return a not found status to the caller
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when table lookup operation has completed with either data found or not found status.
Trigger Criteria:
- Context: A table lookup operation has completed with either data found or not found status
- Applied to: Process Retrieved Information
- Action: The information processing is initiated
Logic Flow:
IF A table lookup operation has completed with either data found or not found status
AND The information processing is initiated
THEN:
- • The system should process the lookup results appropriately for the requesting operation
R-GCX016E-cbl-02568 (+20) File: GCX016E.cbl Business Rule: Comprehensive Merlin Message Creation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo processing event requires merlin notification.
Trigger Criteria:
- Context: A cargo processing event requires Merlin notification
- Applied to: Initialize Message Fields
- Action: The system begins message creation process
Logic Flow:
IF A cargo processing event requires Merlin notification
AND The system begins message creation process
THEN:
- • All message fields, counters, and data structures are reset to initial state
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment information exists in the cargo record.
Trigger Criteria:
- Context: Equipment information exists in the cargo record
- Applied to: Format Equipment Information
- Action: Creating a Merlin message for cargo disposition
Logic Flow:
IF Equipment information exists in the cargo record
AND Creating a Merlin message for cargo disposition
THEN:
- • Equipment type, identification number, and related cargo details are formatted and included in the message
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when car id and waybill information are available in the cargo record.
Trigger Criteria:
- Context: Car ID and waybill information are available in the cargo record
- Applied to: Add Car ID and Waybill Details
- Action: Building comprehensive Merlin message content
Logic Flow:
IF Car ID and waybill information are available in the cargo record
AND Building comprehensive Merlin message content
THEN:
- • Car ID and waybill details are added to the message with proper formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when us-ccn exists for the cargo being processed.
Trigger Criteria:
- Context: US-CCN exists for the cargo being processed
- Applied to: Include US-CCN Information
- Action: Creating Merlin notification message
Logic Flow:
IF US-CCN exists for the cargo being processed
AND Creating Merlin notification message
THEN:
- • US-CCN information is included in the message for cargo identification purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is being processed for cargo.
Trigger Criteria:
- Context: A disposition code is being processed for cargo
- Applied to: Format Disposition Code Details
- Action: Creating comprehensive Merlin message
Logic Flow:
IF A disposition code is being processed for cargo
AND Creating comprehensive Merlin message
THEN:
- • Disposition code details are formatted with proper context and included in the message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code has an associated description in the system.
Trigger Criteria:
- Context: Disposition code has an associated description in the system
- Applied to: Add Disposition Description
- Action: Building Merlin message content
Logic Flow:
IF Disposition code has an associated description in the system
AND Building Merlin message content
THEN:
- • Disposition description is added to provide clear understanding of the action being taken
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has existing release quantities and a new disposition is being applied.
Trigger Criteria:
- Context: Cargo has existing release quantities and a new disposition is being applied
- Applied to: Calculate Release Quantity Impact
- Action: Processing disposition code that affects quantities
Logic Flow:
IF Cargo has existing release quantities and a new disposition is being applied
AND Processing disposition code that affects quantities
THEN:
- • System calculates the impact on release quantities (increase, decrease, or no change)
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when before and after quantity values have been calculated.
Trigger Criteria:
- Context: Before and after quantity values have been calculated
- Applied to: Before/After Quantities Different?
- Action: Determining message content requirements
Logic Flow:
IF Before and after quantity values have been calculated
AND Determining message content requirements
THEN:
- • If quantities differ, quantity impact analysis is included;
otherwise, it is omitted from the message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition processing results in quantity changes.
Trigger Criteria:
- Context: Disposition processing results in quantity changes
- Applied to: Add Quantity Impact Analysis
- Action: Before and after quantities are different
Logic Flow:
IF Disposition processing results in quantity changes
AND Before and after quantities are different
THEN:
- • Detailed quantity impact analysis showing the change is added to the Merlin message
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo processing events have occurred with recorded timestamps.
Trigger Criteria:
- Context: Cargo processing events have occurred with recorded timestamps
- Applied to: Include Processing Timestamps
- Action: Creating comprehensive Merlin message
Logic Flow:
IF Cargo processing events have occurred with recorded timestamps
AND Creating comprehensive Merlin message
THEN:
- • Processing timestamps are included to provide audit trail information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when uscs processing time is available for the cargo event.
Trigger Criteria:
- Context: USCS processing time is available for the cargo event
- Applied to: Add USCS Processing Time
- Action: Building comprehensive message content
Logic Flow:
IF USCS processing time is available for the cargo event
AND Building comprehensive message content
THEN:
- • USCS processing time is added to the message for tracking purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when system processing time is recorded for the cargo event.
Trigger Criteria:
- Context: System processing time is recorded for the cargo event
- Applied to: Add System Processing Time
- Action: Creating Merlin notification message
Logic Flow:
IF System processing time is recorded for the cargo event
AND Creating Merlin notification message
THEN:
- • System processing time is included in the message for complete audit trail
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when k1 segment data exists for the cargo.
Trigger Criteria:
- Context: K1 segment data exists for the cargo
- Applied to: Process K1 Comments
- Action: Building comprehensive Merlin message
Logic Flow:
IF K1 segment data exists for the cargo
AND Building comprehensive Merlin message
THEN:
- • K1 comments are processed and evaluated for inclusion in the message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when k1 segment processing has been completed.
Trigger Criteria:
- Context: K1 segment processing has been completed
- Applied to: K1 Comments Available?
- Action: Determining message content components
Logic Flow:
IF K1 segment processing has been completed
AND Determining message content components
THEN:
- • If K1 comments are available and relevant, they are included;
otherwise, processing continues without them
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when k1 comments are available and contain free-form text.
Trigger Criteria:
- Context: K1 comments are available and contain free-form text
- Applied to: Include Free-Form Text Messages
- Action: K1 comments are determined to be relevant for the message
Logic Flow:
IF K1 comments are available and contain free-form text
AND K1 comments are determined to be relevant for the message
THEN:
- • Free-form text messages from K1 segments are included in the Merlin message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when special comments exist for the cargo or processing event.
Trigger Criteria:
- Context: Special comments exist for the cargo or processing event
- Applied to: Add Special Comments
- Action: Building comprehensive message content
Logic Flow:
IF Special comments exist for the cargo or processing event
AND Building comprehensive message content
THEN:
- • Special comments are added to provide additional context and information
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo processing involves bond-related activities.
Trigger Criteria:
- Context: Cargo processing involves bond-related activities
- Applied to: Canadian Pacific Railway Bond?
- Action: Evaluating special processing requirements
Logic Flow:
IF Cargo processing involves bond-related activities
AND Evaluating special processing requirements
THEN:
- • If Canadian Pacific Railway bond processing is detected, special bond notification is added;
otherwise, standard processing continues
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when canadian pacific railway bond processing is identified.
Trigger Criteria:
- Context: Canadian Pacific Railway bond processing is identified
- Applied to: Add Bond Creation Notification
- Action: Special bond processing requirements are detected
Logic Flow:
IF Canadian Pacific Railway bond processing is identified
AND Special bond processing requirements are detected
THEN:
- • Bond creation notification is added to the Merlin message for CP Railway processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all message components have been prepared and validated.
Trigger Criteria:
- Context: All message components have been prepared and validated
- Applied to: Format Complete Message
- Action: Finalizing message creation process
Logic Flow:
IF All message components have been prepared and validated
AND Finalizing message creation process
THEN:
- • Complete Merlin message is formatted with all required components in proper structure
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when complete message content has been formatted.
Trigger Criteria:
- Context: Complete message content has been formatted
- Applied to: Set Message Type and Priority
- Action: Preparing message for distribution
Logic Flow:
IF Complete message content has been formatted
AND Preparing message for distribution
THEN:
- • Message type and priority are set based on disposition code and processing context
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when message type and priority have been set.
Trigger Criteria:
- Context: Message type and priority have been set
- Applied to: Prepare for Distribution
- Action: Finalizing message preparation
Logic Flow:
IF Message type and priority have been set
AND Finalizing message preparation
THEN:
- • Message is prepared for distribution with proper routing and delivery information
R-GCX016E-cbl-02589 (+11) File: GCX016E.cbl Business Rule: Canadian Pacific Railway Bond Creation Notification
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when k1 segment message has been received.
Trigger Criteria:
- Context: A K1 segment message has been received
- Applied to: Message Type Check
- Action: The system checks the message content for CPR identifiers including 'DIRECTOR OF CUSTOMS, CP RAIL', 'CANADIAN PACIFIC LIMITED', or 'CANADIAN PACIFIC RAILWAY CO'
Logic Flow:
IF A K1 segment message has been received
AND The system checks the message content for CPR identifiers including 'DIRECTOR OF CUSTOMS, CP RAIL', 'CANADIAN PACIFIC LIMITED', or 'CANADIAN PACIFIC RAILWAY CO'
THEN:
- • The message is classified as CPR bond creation if any CPR identifier is found,
otherwise it is processed as a regular K1 message
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when k1 segment message contains canadian pacific railway identifiers.
Trigger Criteria:
- Context: A K1 segment message contains Canadian Pacific Railway identifiers
- Applied to: Identify CPR Bond Creation
- Action: The system identifies the message as CPR bond creation type
Logic Flow:
IF A K1 segment message contains Canadian Pacific Railway identifiers
AND The system identifies the message as CPR bond creation type
THEN:
- • The system initiates CPR-specific bond creation processing workflow
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cpr bond creation message has been identified.
Trigger Criteria:
- Context: A CPR bond creation message has been identified
- Applied to: Extract Bond Information
- Action: The system processes the K1 segment content
Logic Flow:
IF A CPR bond creation message has been identified
AND The system processes the K1 segment content
THEN:
- • Bond-related information including bond numbers, amounts, and related cargo details are extracted from the message
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when bond information has been extracted from a cpr message.
Trigger Criteria:
- Context: Bond information has been extracted from a CPR message
- Applied to: Validate Bond Data
- Action: The system validates the bond data for completeness and format compliance
Logic Flow:
IF Bond information has been extracted from a CPR message
AND The system validates the bond data for completeness and format compliance
THEN:
- • The bond data is marked as valid if all required fields are present and properly formatted,
otherwise validation fails
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when bond data validation has been completed.
Trigger Criteria:
- Context: Bond data validation has been completed
- Applied to: Bond Creation Valid?
- Action: The system evaluates if the bond creation meets all business requirements
Logic Flow:
IF Bond data validation has been completed
AND The system evaluates if the bond creation meets all business requirements
THEN:
- • Bond creation is approved if validation passes and all business rules are satisfied,
otherwise an error is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cpr bond creation has been validated and approved.
Trigger Criteria:
- Context: CPR bond creation has been validated and approved
- Applied to: Format CPR Bond Notification
- Action: The system formats the bond notification message
Logic Flow:
IF CPR bond creation has been validated and approved
AND The system formats the bond notification message
THEN:
- • A structured notification message is created containing bond details, cargo information, and CPR-specific formatting requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cpr bond notification message has been formatted.
Trigger Criteria:
- Context: A CPR bond notification message has been formatted
- Applied to: Add Special Comments
- Action: The system processes special comments from K1 segments and other relevant sources
Logic Flow:
IF A CPR bond notification message has been formatted
AND The system processes special comments from K1 segments and other relevant sources
THEN:
- • Up to 3 lines of special comments and up to 4 lines of K1 comments are added to the notification message if available
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cpr bond notification content has been prepared with special comments.
Trigger Criteria:
- Context: CPR bond notification content has been prepared with special comments
- Applied to: Create Merlin Message
- Action: The system creates a Merlin message for the bond notification
Logic Flow:
IF CPR bond notification content has been prepared with special comments
AND The system creates a Merlin message for the bond notification
THEN:
- • A properly formatted Merlin message is created with CPR bond information, comments, and appropriate message headers
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when merlin message for cpr bond notification has been created.
Trigger Criteria:
- Context: A Merlin message for CPR bond notification has been created
- Applied to: Route to Recipients
- Action: The system determines routing based on freight forwarder setup and notification preferences
Logic Flow:
IF A Merlin message for CPR bond notification has been created
AND The system determines routing based on freight forwarder setup and notification preferences
THEN:
- • The message is routed to appropriate recipients including freight forwarders with internet capability or default Merlin IDs
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cpr bond notification routing has been determined.
Trigger Criteria:
- Context: CPR bond notification routing has been determined
- Applied to: Log Bond Creation Event
- Action: The system logs the bond creation event
Logic Flow:
IF CPR bond notification routing has been determined
AND The system logs the bond creation event
THEN:
- • An audit record is created capturing the bond creation details, timestamp, and processing status for tracking and compliance purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cpr bond notification has been logged and routed.
Trigger Criteria:
- Context: CPR bond notification has been logged and routed
- Applied to: Send Notification
- Action: The system attempts to deliver the notification
Logic Flow:
IF CPR bond notification has been logged and routed
AND The system attempts to deliver the notification
THEN:
- • The notification is sent via email if freight forwarder has internet capability,
otherwise sent to Merlin system, with fallback to backup recipients if delivery fails
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cpr bond creation validation has failed or processing errors occurred.
Trigger Criteria:
- Context: CPR bond creation validation has failed or processing errors occurred
- Applied to: Generate Error Message
- Action: The system generates an error response
Logic Flow:
IF CPR bond creation validation has failed or processing errors occurred
AND The system generates an error response
THEN:
- • An appropriate error message is created indicating the specific validation failure or processing issue for troubleshooting and correction
R-GCX016E-cbl-02615 (+15) File: GCX016E.cbl Business Rule: GCCIIS System Integration
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo processing transaction is being executed.
Trigger Criteria:
- Context: A cargo processing transaction is being executed
- Applied to: Cargo Status Changed?
- Action: The system evaluates whether cargo status has been modified during processing
Logic Flow:
IF A cargo processing transaction is being executed
AND The system evaluates whether cargo status has been modified during processing
THEN:
- • The system proceeds with GCCIIS integration if status changed,
otherwise skips integration
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has an internal status that needs to be communicated to gcciis.
Trigger Criteria:
- Context: A cargo has an internal status that needs to be communicated to GCCIIS
- Applied to: Map Internal Status to GCCIIS Status
- Action: The system processes the status mapping transformation
Logic Flow:
IF A cargo has an internal status that needs to be communicated to GCCIIS
AND The system processes the status mapping transformation
THEN:
- • The internal status is converted to the appropriate GCCIIS status format
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo has associated equipment information.
Trigger Criteria:
- Context: A cargo has associated equipment information
- Applied to: Equipment Type Valid?
- Action: The system checks if the equipment type is valid for GCCIIS processing
Logic Flow:
IF A cargo has associated equipment information
AND The system checks if the equipment type is valid for GCCIIS processing
THEN:
- • The system continues processing if equipment type is container, trailer, chassis, or other valid equipment,
otherwise skips GCCIIS integration
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when equipment information is available for a cargo.
Trigger Criteria:
- Context: Equipment information is available for a cargo
- Applied to: Validate Equipment Type
- Action: The system validates the equipment type against acceptable categories
Logic Flow:
IF Equipment information is available for a cargo
AND The system validates the equipment type against acceptable categories
THEN:
- • The equipment is classified as container, trailer, chassis, or other valid equipment type for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has a status that may require quantity validation.
Trigger Criteria:
- Context: A cargo has a status that may require quantity validation
- Applied to: Release Quantity Check
- Action: The system evaluates whether full release validation is needed
Logic Flow:
IF A cargo has a status that may require quantity validation
AND The system evaluates whether full release validation is needed
THEN:
- • The system either requires full release quantity check or allows partial release processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo requires full release validation and has released and total quantity values.
Trigger Criteria:
- Context: A cargo requires full release validation and has released and total quantity values
- Applied to: Check Released vs Total Quantity
- Action: The system compares the released quantity to the total quantity
Logic Flow:
IF A cargo requires full release validation and has released and total quantity values
AND The system compares the released quantity to the total quantity
THEN:
- • The system continues processing if released equals total quantity,
otherwise skips GCCIIS integration
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has passed validation checks and requires gcciis status update.
Trigger Criteria:
- Context: A cargo has passed validation checks and requires GCCIIS status update
- Applied to: Prepare GCCIIS Status Update
- Action: The system prepares the status update message
Logic Flow:
IF A cargo has passed validation checks and requires GCCIIS status update
AND The system prepares the status update message
THEN:
- • The system formats the cargo and equipment information for GCCIIS transmission
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo status update is ready for gcciis transmission.
Trigger Criteria:
- Context: A cargo status update is ready for GCCIIS transmission
- Applied to: Status Type?
- Action: The system evaluates the cargo status to determine GCCIIS status type
Logic Flow:
IF A cargo status update is ready for GCCIIS transmission
AND The system evaluates the cargo status to determine GCCIIS status type
THEN:
- • The system selects HOLD, RELEASE, PTT, or PTT-EX status based on cargo conditions
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has hold conditions that need to be communicated to gcciis.
Trigger Criteria:
- Context: A cargo has hold conditions that need to be communicated to GCCIIS
- Applied to: HOLD
- Action: The system processes hold status assignment
Logic Flow:
IF A cargo has hold conditions that need to be communicated to GCCIIS
AND The system processes hold status assignment
THEN:
- • The system sets GCCIIS status to HOLD for held cargo conditions
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has been fully released and meets release criteria.
Trigger Criteria:
- Context: A cargo has been fully released and meets release criteria
- Applied to: RELEASE
- Action: The system processes release status assignment
Logic Flow:
IF A cargo has been fully released and meets release criteria
AND The system processes release status assignment
THEN:
- • The system sets GCCIIS status to RELEASE for released cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has permit to transfer status that needs to be communicated to gcciis.
Trigger Criteria:
- Context: A cargo has Permit to Transfer status that needs to be communicated to GCCIIS
- Applied to: PTT
- Action: The system processes PTT status assignment
Logic Flow:
IF A cargo has Permit to Transfer status that needs to be communicated to GCCIIS
AND The system processes PTT status assignment
THEN:
- • The system sets GCCIIS status to PTT for cargo with transit permission
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo has permit to transfer with examination requirements that need to be communicated to gcciis.
Trigger Criteria:
- Context: A cargo has Permit to Transfer with examination requirements that need to be communicated to GCCIIS
- Applied to: PTT-EX
- Action: The system processes PTT-EX status assignment
Logic Flow:
IF A cargo has Permit to Transfer with examination requirements that need to be communicated to GCCIIS
AND The system processes PTT-EX status assignment
THEN:
- • The system sets GCCIIS status to PTT-EX for cargo requiring examination
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when gcciis status update is prepared and ready for transmission.
Trigger Criteria:
- Context: A GCCIIS status update is prepared and ready for transmission
- Applied to: Send Status Update to GCCIIS
- Action: The system sends the status update to GCCIIS
Logic Flow:
IF A GCCIIS status update is prepared and ready for transmission
AND The system sends the status update to GCCIIS
THEN:
- • The system transmits the cargo status information to the GCCIIS equipment tracking system
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when status update has been sent to gcciis.
Trigger Criteria:
- Context: A status update has been sent to GCCIIS
- Applied to: Update Successful?
- Action: The system receives response from GCCIIS regarding the update
Logic Flow:
IF A status update has been sent to GCCIIS
AND The system receives response from GCCIIS regarding the update
THEN:
- • The system determines if the update was successful or failed based on GCCIIS response
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when gcciis status update has been successfully processed.
Trigger Criteria:
- Context: A GCCIIS status update has been successfully processed
- Applied to: Log Successful Integration
- Action: The system processes the successful integration
Logic Flow:
IF A GCCIIS status update has been successfully processed
AND The system processes the successful integration
THEN:
- • The system records the successful GCCIIS integration for audit trail
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when gcciis status update has failed or encountered an error.
Trigger Criteria:
- Context: A GCCIIS status update has failed or encountered an error
- Applied to: Handle Integration Error
- Action: The system processes the integration failure
Logic Flow:
IF A GCCIIS status update has failed or encountered an error
AND The system processes the integration failure
THEN:
- • The system handles the error condition and takes appropriate corrective action
R-GCX016E-cbl-02631 (+7) File: GCX016E.cbl Business Rule: Freight Forwarder Disposition Code Database Search
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code is received for processing.
Trigger Criteria:
- Context: A disposition code is received for processing
- Applied to: Search Broker Database for Freight Forwarder Codes
- Action: The system searches the broker database for freight forwarder-specific disposition codes
Logic Flow:
IF A disposition code is received for processing
AND The system searches the broker database for freight forwarder-specific disposition codes
THEN:
- • The system determines if the disposition code requires freight forwarder processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code is identified as freight forwarder-related.
Trigger Criteria:
- Context: A disposition code is identified as freight forwarder-related
- Applied to: Retrieve Cargo Segment Data from GCSUSS03
- Action: The system needs cargo information for freight forwarder processing
Logic Flow:
IF A disposition code is identified as freight forwarder-related
AND The system needs cargo information for freight forwarder processing
THEN:
- • The system retrieves cargo segment data from the primary cargo database
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when primary cargo segment data has been retrieved for freight forwarder processing.
Trigger Criteria:
- Context: Primary cargo segment data has been retrieved for freight forwarder processing
- Applied to: Retrieve Additional Cargo Data from GCSUSS07
- Action: Additional cargo details are needed for complete freight forwarder information
Logic Flow:
IF Primary cargo segment data has been retrieved for freight forwarder processing
AND Additional cargo details are needed for complete freight forwarder information
THEN:
- • The system retrieves supplementary cargo data from the extended cargo database
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo segment data and additional cargo data are available.
Trigger Criteria:
- Context: Cargo segment data and additional cargo data are available
- Applied to: Extract Freight Forwarder Information
- Action: The system processes freight forwarder disposition codes
Logic Flow:
IF Cargo segment data and additional cargo data are available
AND The system processes freight forwarder disposition codes
THEN:
- • The system extracts freight forwarder identification and contact details from the cargo records
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when freight forwarder identification has been extracted from cargo data.
Trigger Criteria:
- Context: Freight forwarder identification has been extracted from cargo data
- Applied to: Lookup Freight Forwarder Name in Broker Tables
- Action: The system needs complete freight forwarder contact information
Logic Flow:
IF Freight forwarder identification has been extracted from cargo data
AND The system needs complete freight forwarder contact information
THEN:
- • The system searches the broker name tables to retrieve freight forwarder name and contact details
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when freight forwarder has been identified in the broker name tables.
Trigger Criteria:
- Context: Freight forwarder has been identified in the broker name tables
- Applied to: Retrieve Freight Forwarder Contact Details
- Action: The system needs to send notifications to the freight forwarder
Logic Flow:
IF Freight forwarder has been identified in the broker name tables
AND The system needs to send notifications to the freight forwarder
THEN:
- • The system retrieves complete contact details including email addresses and notification preferences
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when freight forwarder information has been successfully retrieved and validated.
Trigger Criteria:
- Context: Freight forwarder information has been successfully retrieved and validated
- Applied to: Mark as Freight Forwarder Disposition Code
- Action: The disposition code processing continues
Logic Flow:
IF Freight forwarder information has been successfully retrieved and validated
AND The disposition code processing continues
THEN:
- • The system marks the disposition code as requiring freight forwarder notification processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is not identified as freight forwarder-related or freight forwarder processing is complete.
Trigger Criteria:
- Context: A disposition code is not identified as freight forwarder-related OR freight forwarder processing is complete
- Applied to: Continue with Standard Disposition Processing
- Action: The system continues disposition code processing
Logic Flow:
IF A disposition code is not identified as freight forwarder-related OR freight forwarder processing is complete
AND The system continues disposition code processing
THEN:
- • The system proceeds with standard disposition code processing workflow
R-GCX016E-cbl-02639 (+12) File: GCX016E.cbl Business Rule: Cargo Segment Data Retrieval for Freight Forwarders
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo processing request is initiated for freight forwarder identification.
Trigger Criteria:
- Context: A cargo processing request is initiated for freight forwarder identification
- Applied to: Access Cargo Record
- Action: The system needs to retrieve freight forwarder information
Logic Flow:
IF A cargo processing request is initiated for freight forwarder identification
AND The system needs to retrieve freight forwarder information
THEN:
- • The cargo record is accessed and made available for segment processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record is being processed for freight forwarder identification.
Trigger Criteria:
- Context: A cargo record is being processed for freight forwarder identification
- Applied to: Retrieve GCSUSS03 Segment
- Action: The system attempts to retrieve the GCSUSS03 segment from the cargo record
Logic Flow:
IF A cargo record is being processed for freight forwarder identification
AND The system attempts to retrieve the GCSUSS03 segment from the cargo record
THEN:
- • The GCSUSS03 segment is retrieved from the cargo segments data source
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when system has attempted to retrieve the gcsuss03 segment.
Trigger Criteria:
- Context: The system has attempted to retrieve the GCSUSS03 segment
- Applied to: GCSUSS03 Found?
- Action: The retrieval operation is completed
Logic Flow:
IF The system has attempted to retrieve the GCSUSS03 segment
AND The retrieval operation is completed
THEN:
- • The system determines if the GCSUSS03 segment was found and proceeds accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when gcsuss03 segment has been successfully retrieved.
Trigger Criteria:
- Context: The GCSUSS03 segment has been successfully retrieved
- Applied to: Extract Freight Forwarder Code from GCSUSS03
- Action: The system processes the GCSUSS03 segment data
Logic Flow:
IF The GCSUSS03 segment has been successfully retrieved
AND The system processes the GCSUSS03 segment data
THEN:
- • The freight forwarder code is extracted from the GCSUSS03 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when system is processing freight forwarder identification regardless of gcsuss03 availability.
Trigger Criteria:
- Context: The system is processing freight forwarder identification regardless of GCSUSS03 availability
- Applied to: Retrieve GCSUSS07 Segment
- Action: The system attempts to retrieve the GCSUSS07 segment from the cargo record
Logic Flow:
IF The system is processing freight forwarder identification regardless of GCSUSS03 availability
AND The system attempts to retrieve the GCSUSS07 segment from the cargo record
THEN:
- • The GCSUSS07 segment is retrieved from the cargo segments data source
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when system has attempted to retrieve the gcsuss07 segment.
Trigger Criteria:
- Context: The system has attempted to retrieve the GCSUSS07 segment
- Applied to: GCSUSS07 Found?
- Action: The retrieval operation is completed
Logic Flow:
IF The system has attempted to retrieve the GCSUSS07 segment
AND The retrieval operation is completed
THEN:
- • The system determines if the GCSUSS07 segment was found and proceeds accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when gcsuss07 segment has been successfully retrieved.
Trigger Criteria:
- Context: The GCSUSS07 segment has been successfully retrieved
- Applied to: Extract Additional Freight Forwarder Data from GCSUSS07
- Action: The system processes the GCSUSS07 segment data
Logic Flow:
IF The GCSUSS07 segment has been successfully retrieved
AND The system processes the GCSUSS07 segment data
THEN:
- • Additional freight forwarder data is extracted from the GCSUSS07 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when freight forwarder data has been extracted from available segments (gcsuss03 and/or gcsuss07).
Trigger Criteria:
- Context: Freight forwarder data has been extracted from available segments (GCSUSS03 and/or GCSUSS07)
- Applied to: Compile Freight Forwarder Information
- Action: The system processes the extracted data
Logic Flow:
IF Freight forwarder data has been extracted from available segments (GCSUSS03 and/or GCSUSS07)
AND The system processes the extracted data
THEN:
- • All available freight forwarder information is compiled into a consolidated format
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when freight forwarder information has been compiled from cargo segments.
Trigger Criteria:
- Context: Freight forwarder information has been compiled from cargo segments
- Applied to: Validate Freight Forwarder Data
- Action: The system validates the compiled data
Logic Flow:
IF Freight forwarder information has been compiled from cargo segments
AND The system validates the compiled data
THEN:
- • The freight forwarder data is checked for validity and completeness
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when freight forwarder data has been validated.
Trigger Criteria:
- Context: Freight forwarder data has been validated
- Applied to: Valid Freight Forwarder?
- Action: The validation process is completed
Logic Flow:
IF Freight forwarder data has been validated
AND The validation process is completed
THEN:
- • The system determines if the freight forwarder information is valid and complete
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when freight forwarder information has been validated as complete and accurate.
Trigger Criteria:
- Context: The freight forwarder information has been validated as complete and accurate
- Applied to: Set Freight Forwarder Identified Flag
- Action: The system processes the validation result
Logic Flow:
IF The freight forwarder information has been validated as complete and accurate
AND The system processes the validation result
THEN:
- • A freight forwarder identified flag is set to indicate successful identification
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when freight forwarder information has been validated as incomplete or invalid.
Trigger Criteria:
- Context: The freight forwarder information has been validated as incomplete or invalid
- Applied to: Log Freight Forwarder Not Found
- Action: The system processes the validation result
Logic Flow:
IF The freight forwarder information has been validated as incomplete or invalid
AND The system processes the validation result
THEN:
- • A log entry is created indicating that freight forwarder information was not found or is invalid
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when freight forwarder processing has been completed with either successful identification or logging of not found status.
Trigger Criteria:
- Context: Freight forwarder processing has been completed with either successful identification or logging of not found status
- Applied to: Return Freight Forwarder Information
- Action: The system completes the freight forwarder data retrieval process
Logic Flow:
IF Freight forwarder processing has been completed with either successful identification or logging of not found status
AND The system completes the freight forwarder data retrieval process
THEN:
- • The freight forwarder information (or indication of not found) is returned to the calling process
R-GCX016E-cbl-02652 (+11) File: GCX016E.cbl Business Rule: Freight Forwarder Broker Information Lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record exists with segment data.
Trigger Criteria:
- Context: A cargo record exists with segment data
- Applied to: Retrieve Cargo Segment Data
- Action: The system processes freight forwarder broker lookup request
Logic Flow:
IF A cargo record exists with segment data
AND The system processes freight forwarder broker lookup request
THEN:
- • The freight forwarder code is extracted from the cargo segment data for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo segment data has been retrieved.
Trigger Criteria:
- Context: Cargo segment data has been retrieved
- Applied to: Freight Forwarder Code Found?
- Action: The system checks for freight forwarder code presence
Logic Flow:
IF Cargo segment data has been retrieved
AND The system checks for freight forwarder code presence
THEN:
- • If freight forwarder code exists, proceed to broker database search;
otherwise set lookup failed flag
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid freight forwarder code exists.
Trigger Criteria:
- Context: A valid freight forwarder code exists
- Applied to: Search Broker Database by FF Code
- Action: The system searches the broker database using the freight forwarder code
Logic Flow:
IF A valid freight forwarder code exists
AND The system searches the broker database using the freight forwarder code
THEN:
- • The system queries the broker database tables to find matching broker records
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when broker database search has been performed using freight forwarder code.
Trigger Criteria:
- Context: Broker database search has been performed using freight forwarder code
- Applied to: Broker Record Found?
- Action: The system evaluates search results
Logic Flow:
IF Broker database search has been performed using freight forwarder code
AND The system evaluates search results
THEN:
- • If broker record is found, proceed to retrieve broker name;
otherwise log broker information not found
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid broker record has been found in the database.
Trigger Criteria:
- Context: A valid broker record has been found in the database
- Applied to: Retrieve Broker Name from GCST2RT
- Action: The system accesses GCST2RT table
Logic Flow:
IF A valid broker record has been found in the database
AND The system accesses GCST2RT table
THEN:
- • The broker name is retrieved from the GCST2RT broker name segments
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when broker name has been successfully retrieved from gcst2rt.
Trigger Criteria:
- Context: Broker name has been successfully retrieved from GCST2RT
- Applied to: Retrieve Associated Broker Information
- Action: The system accesses GCSTBRT broker information tables
Logic Flow:
IF Broker name has been successfully retrieved from GCST2RT
AND The system accesses GCSTBRT broker information tables
THEN:
- • Associated broker information including contact details is retrieved
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when associated broker information has been retrieved.
Trigger Criteria:
- Context: Associated broker information has been retrieved
- Applied to: Extract Freight Forwarder Name
- Action: The system processes the broker information data
Logic Flow:
IF Associated broker information has been retrieved
AND The system processes the broker information data
THEN:
- • The freight forwarder name is extracted from the broker information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when freight forwarder name has been extracted.
Trigger Criteria:
- Context: Freight forwarder name has been extracted
- Applied to: Extract Broker Contact Details
- Action: The system continues processing broker information
Logic Flow:
IF Freight forwarder name has been extracted
AND The system continues processing broker information
THEN:
- • Broker contact details are extracted from the broker information data
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when freight forwarder name and broker contact details have been extracted.
Trigger Criteria:
- Context: Freight forwarder name and broker contact details have been extracted
- Applied to: Store FF Name and Broker Info
- Action: The system completes information extraction
Logic Flow:
IF Freight forwarder name and broker contact details have been extracted
AND The system completes information extraction
THEN:
- • The freight forwarder name and broker information are stored in system variables
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when freight forwarder name and broker information have been successfully stored.
Trigger Criteria:
- Context: Freight forwarder name and broker information have been successfully stored
- Applied to: Set Lookup Success Flag
- Action: The lookup process completes successfully
Logic Flow:
IF Freight forwarder name and broker information have been successfully stored
AND The lookup process completes successfully
THEN:
- • The system sets the lookup success flag to indicate successful completion
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when either freight forwarder code is not found or broker information lookup fails.
Trigger Criteria:
- Context: Either freight forwarder code is not found or broker information lookup fails
- Applied to: Set Lookup Failed Flag
- Action: The lookup process cannot be completed successfully
Logic Flow:
IF Either freight forwarder code is not found or broker information lookup fails
AND The lookup process cannot be completed successfully
THEN:
- • The system sets the lookup failed flag to indicate unsuccessful completion
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when broker database search has been performed but no matching broker record was found.
Trigger Criteria:
- Context: Broker database search has been performed but no matching broker record was found
- Applied to: Log Broker Information Not Found
- Action: The system determines that broker information is not available
Logic Flow:
IF Broker database search has been performed but no matching broker record was found
AND The system determines that broker information is not available
THEN:
- • The system logs that broker information was not found for the freight forwarder code
R-GCX016E-cbl-02664 (+10) File: GCX016E.cbl Business Rule: Freight Forwarder Contact Information Retrieval
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record exists with segment data.
Trigger Criteria:
- Context: A cargo record exists with segment data
- Applied to: Retrieve Cargo Segment Data
- Action: The system needs to process freight forwarder notifications
Logic Flow:
IF A cargo record exists with segment data
AND The system needs to process freight forwarder notifications
THEN:
- • The system retrieves cargo segment data including freight forwarder and consignee information from GCSUSS03 and GCSUSS07 segments
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo segment data has been retrieved.
Trigger Criteria:
- Context: Cargo segment data has been retrieved
- Applied to: Freight Forwarder Information Available?
- Action: The system evaluates freight forwarder information
Logic Flow:
IF Cargo segment data has been retrieved
AND The system evaluates freight forwarder information
THEN:
- • The system determines if freight forwarder information is available and proceeds with lookup or logs missing information warning
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when freight forwarder information is available in cargo segment.
Trigger Criteria:
- Context: Freight forwarder information is available in cargo segment
- Applied to: Look up Freight Forwarder Name from Broker Database
- Action: The system needs to retrieve freight forwarder details
Logic Flow:
IF Freight forwarder information is available in cargo segment
AND The system needs to retrieve freight forwarder details
THEN:
- • The system searches GCST2RT broker name segments table using freight forwarder identifier
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when freight forwarder name has been found in broker database.
Trigger Criteria:
- Context: Freight forwarder name has been found in broker database
- Applied to: Retrieve Associated Broker Information
- Action: The system needs complete broker information
Logic Flow:
IF Freight forwarder name has been found in broker database
AND The system needs complete broker information
THEN:
- • The system retrieves associated broker information including broker codes and identifiers
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when broker information has been retrieved.
Trigger Criteria:
- Context: Broker information has been retrieved
- Applied to: Access Broker Contact Table
- Action: The system needs contact information for notifications
Logic Flow:
IF Broker information has been retrieved
AND The system needs contact information for notifications
THEN:
- • The system accesses GCSTBRT broker contact table using broker identifier
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when broker contact table has been accessed.
Trigger Criteria:
- Context: Broker contact table has been accessed
- Applied to: Extract Email Addresses
- Action: The system processes contact information
Logic Flow:
IF Broker contact table has been accessed
AND The system processes contact information
THEN:
- • The system extracts email addresses from the contact table records for notification purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when email addresses have been extracted from contact table.
Trigger Criteria:
- Context: Email addresses have been extracted from contact table
- Applied to: Retrieve Additional Contact Information
- Action: The system needs complete contact information
Logic Flow:
IF Email addresses have been extracted from contact table
AND The system needs complete contact information
THEN:
- • The system retrieves additional contact information such as phone numbers and addresses from the contact table
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when contact information has been retrieved from broker contact table.
Trigger Criteria:
- Context: Contact information has been retrieved from broker contact table
- Applied to: Validate Contact Information
- Action: The system validates contact information
Logic Flow:
IF Contact information has been retrieved from broker contact table
AND The system validates contact information
THEN:
- • The system checks that required contact fields are present and properly formatted
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when contact information has been validated.
Trigger Criteria:
- Context: Contact information has been validated
- Applied to: Contact Information Complete?
- Action: The system evaluates information completeness
Logic Flow:
IF Contact information has been validated
AND The system evaluates information completeness
THEN:
- • The system determines if contact information is complete and routes to storage or warning logging accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when contact information is complete and validated.
Trigger Criteria:
- Context: Contact information is complete and validated
- Applied to: Store Contact Information for Notifications
- Action: The system needs to store contact information
Logic Flow:
IF Contact information is complete and validated
AND The system needs to store contact information
THEN:
- • The system stores the contact information including email addresses for use in freight forwarder notifications
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when freight forwarder information is not available or contact information is incomplete.
Trigger Criteria:
- Context: Freight forwarder information is not available OR contact information is incomplete
- Applied to: Log Missing Contact Information Warning
- Action: The system cannot retrieve complete contact information
Logic Flow:
IF Freight forwarder information is not available OR contact information is incomplete
AND The system cannot retrieve complete contact information
THEN:
- • The system logs a warning message indicating missing or incomplete freight forwarder contact information
R-GCX016E-cbl-02675 (+21) File: GCX016E.cbl Business Rule: CIH Hold Email Notification System
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo disposition code needs to be processed for cih hold notification.
Trigger Criteria:
- Context: A cargo disposition code needs to be processed for CIH hold notification
- Applied to: Search Broker Database for Freight Forwarder Disposition Codes
- Action: The system searches the broker name table for freight forwarder disposition codes
Logic Flow:
IF A cargo disposition code needs to be processed for CIH hold notification
AND The system searches the broker name table for freight forwarder disposition codes
THEN:
- • The system identifies if the disposition code corresponds to a freight forwarder
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when broker database search has been completed.
Trigger Criteria:
- Context: The broker database search has been completed
- Applied to: Freight Forwarder Code Found?
- Action: The system evaluates the search results for freight forwarder codes
Logic Flow:
IF The broker database search has been completed
AND The system evaluates the search results for freight forwarder codes
THEN:
- • The system determines whether to proceed with email notification or terminate the process
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid freight forwarder disposition code has been identified.
Trigger Criteria:
- Context: A valid freight forwarder disposition code has been identified
- Applied to: Retrieve Cargo Segment Data from GCSUSS03/GCSUSS07
- Action: The system accesses GCSUSS03 and GCSUSS07 cargo segments
Logic Flow:
IF A valid freight forwarder disposition code has been identified
AND The system accesses GCSUSS03 and GCSUSS07 cargo segments
THEN:
- • The system retrieves forwarder and consignee information for email content
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo segment data has been successfully retrieved from gcsuss03/gcsuss07.
Trigger Criteria:
- Context: Cargo segment data has been successfully retrieved from GCSUSS03/GCSUSS07
- Applied to: Extract Freight Forwarder Information from Cargo Segments
- Action: The system processes the cargo segments to extract freight forwarder information
Logic Flow:
IF Cargo segment data has been successfully retrieved from GCSUSS03/GCSUSS07
AND The system processes the cargo segments to extract freight forwarder information
THEN:
- • The system obtains freight forwarder identification and contact details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when freight forwarder information has been extracted from cargo segments.
Trigger Criteria:
- Context: Freight forwarder information has been extracted from cargo segments
- Applied to: Lookup Freight Forwarder Name in Broker Database
- Action: The system searches the broker database for the freight forwarder name
Logic Flow:
IF Freight forwarder information has been extracted from cargo segments
AND The system searches the broker database for the freight forwarder name
THEN:
- • The system validates the freight forwarder's existence in the broker database
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when freight forwarder name lookup has been completed.
Trigger Criteria:
- Context: The freight forwarder name lookup has been completed
- Applied to: Freight Forwarder Name Found?
- Action: The system evaluates whether a valid freight forwarder name was found
Logic Flow:
IF The freight forwarder name lookup has been completed
AND The system evaluates whether a valid freight forwarder name was found
THEN:
- • The system determines whether to proceed with email address retrieval or terminate processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid freight forwarder name has been found in the broker database.
Trigger Criteria:
- Context: A valid freight forwarder name has been found in the broker database
- Applied to: Retrieve Email Address from GCSTBRT Table
- Action: The system accesses the GCSTBRT broker table to retrieve email address information
Logic Flow:
IF A valid freight forwarder name has been found in the broker database
AND The system accesses the GCSTBRT broker table to retrieve email address information
THEN:
- • The system obtains the freight forwarder's email address for notification delivery
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when email address retrieval from gcstbrt table has been completed.
Trigger Criteria:
- Context: Email address retrieval from GCSTBRT table has been completed
- Applied to: Valid Email Address?
- Action: The system evaluates the retrieved email address for validity
Logic Flow:
IF Email address retrieval from GCSTBRT table has been completed
AND The system evaluates the retrieved email address for validity
THEN:
- • The system determines whether to proceed with email content building or terminate processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid email address has been confirmed for the freight forwarder.
Trigger Criteria:
- Context: A valid email address has been confirmed for the freight forwarder
- Applied to: Build Comprehensive Email Content
- Action: The system builds the email notification content
Logic Flow:
IF A valid email address has been confirmed for the freight forwarder
AND The system builds the email notification content
THEN:
- • The system creates comprehensive email content with cargo details, equipment information, and hold reasons
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when email content building has been initiated.
Trigger Criteria:
- Context: Email content building has been initiated
- Applied to: Include Equipment Information
- Action: The system processes equipment information for inclusion in the email
Logic Flow:
IF Email content building has been initiated
AND The system processes equipment information for inclusion in the email
THEN:
- • The system adds equipment details including car ID, equipment type, and related information to the email content
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment information has been included in the email content.
Trigger Criteria:
- Context: Equipment information has been included in the email content
- Applied to: Include Waybill and CCN Details
- Action: The system processes waybill and CCN information for email inclusion
Logic Flow:
IF Equipment information has been included in the email content
AND The system processes waybill and CCN information for email inclusion
THEN:
- • The system adds waybill numbers and CCN details to the email notification content
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when waybill and ccn details have been included in the email content.
Trigger Criteria:
- Context: Waybill and CCN details have been included in the email content
- Applied to: Include Content Description
- Action: The system processes cargo content description for email inclusion
Logic Flow:
IF Waybill and CCN details have been included in the email content
AND The system processes cargo content description for email inclusion
THEN:
- • The system adds detailed cargo content description to the email notification
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when content description has been included in the email content.
Trigger Criteria:
- Context: Content description has been included in the email content
- Applied to: Include Origin/Destination Stations
- Action: The system processes origin and destination station information for email inclusion
Logic Flow:
IF Content description has been included in the email content
AND The system processes origin and destination station information for email inclusion
THEN:
- • The system adds origin and destination station details to the email notification content
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when origin and destination station information has been included in the email content.
Trigger Criteria:
- Context: Origin and destination station information has been included in the email content
- Applied to: Include CIH Disposition Information
- Action: The system processes CIH disposition information for email inclusion
Logic Flow:
IF Origin and destination station information has been included in the email content
AND The system processes CIH disposition information for email inclusion
THEN:
- • The system adds CIH disposition code details and related information to the email notification
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cih disposition information has been included in the email content.
Trigger Criteria:
- Context: CIH disposition information has been included in the email content
- Applied to: Include Hold Reason Details
- Action: The system processes hold reason details for email inclusion
Logic Flow:
IF CIH disposition information has been included in the email content
AND The system processes hold reason details for email inclusion
THEN:
- • The system adds comprehensive hold reason details and explanations to complete the email notification content
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when complete email content has been built with all required information.
Trigger Criteria:
- Context: Complete email content has been built with all required information
- Applied to: Send Email Notification
- Action: The system initiates email delivery to the freight forwarder
Logic Flow:
IF Complete email content has been built with all required information
AND The system initiates email delivery to the freight forwarder
THEN:
- • The system sends the CIH hold notification email to the specified recipient
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when email notification has been sent to the freight forwarder.
Trigger Criteria:
- Context: An email notification has been sent to the freight forwarder
- Applied to: Apply Retry Logic for Delivery Failures
- Action: The system encounters email delivery failures or issues
Logic Flow:
IF An email notification has been sent to the freight forwarder
AND The system encounters email delivery failures or issues
THEN:
- • The system applies retry logic to attempt email delivery multiple times before considering it failed
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when email delivery has been attempted with retry logic applied.
Trigger Criteria:
- Context: Email delivery has been attempted with retry logic applied
- Applied to: Email Delivery Successful?
- Action: The system evaluates the final delivery status of the email notification
Logic Flow:
IF Email delivery has been attempted with retry logic applied
AND The system evaluates the final delivery status of the email notification
THEN:
- • The system determines whether the email was successfully delivered or requires alternative handling
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when email notification has been successfully delivered to the freight forwarder.
Trigger Criteria:
- Context: Email notification has been successfully delivered to the freight forwarder
- Applied to: Log Successful Email Delivery
- Action: The system processes the successful delivery confirmation
Logic Flow:
IF Email notification has been successfully delivered to the freight forwarder
AND The system processes the successful delivery confirmation
THEN:
- • The system logs the successful email delivery with timestamp and recipient information for audit purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when email notification delivery has failed after retry attempts.
Trigger Criteria:
- Context: Email notification delivery has failed after retry attempts
- Applied to: Handle Email Delivery Failure
- Action: The system processes the delivery failure
Logic Flow:
IF Email notification delivery has failed after retry attempts
AND The system processes the delivery failure
THEN:
- • The system initiates alternative notification handling procedures
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when email delivery has failed and alternative handling has been initiated.
Trigger Criteria:
- Context: Email delivery has failed and alternative handling has been initiated
- Applied to: Reroute to Default Recipient
- Action: The system implements fallback notification procedures
Logic Flow:
IF Email delivery has failed and alternative handling has been initiated
AND The system implements fallback notification procedures
THEN:
- • The system reroutes the notification to default recipients (AEI9999, OM01247) to ensure notification delivery
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when email processing has been completed either through successful delivery or fallback rerouting.
Trigger Criteria:
- Context: Email processing has been completed either through successful delivery or fallback rerouting
- Applied to: Log Email Processing Complete
- Action: The system finalizes the email notification process
Logic Flow:
IF Email processing has been completed either through successful delivery or fallback rerouting
AND The system finalizes the email notification process
THEN:
- • The system logs the completion of email processing with final status and actions taken
R-GCX016E-cbl-02697 (+13) File: GCX016E.cbl Business Rule: Email Message Distribution with Retry Logic
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when freight forwarder disposition code requires email notification and cargo information is available.
Trigger Criteria:
- Context: A freight forwarder disposition code requires email notification and cargo information is available
- Applied to: Prepare Email Message Content
- Action: The system prepares the email message content
Logic Flow:
IF A freight forwarder disposition code requires email notification and cargo information is available
AND The system prepares the email message content
THEN:
- • The email message includes cargo details (CCN, waybill, car ID), equipment information, origin/destination data, consignee information, and disposition code messages
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when email message content is prepared and ready for delivery.
Trigger Criteria:
- Context: Email message content is prepared and ready for delivery
- Applied to: Set Initial Delivery Attempt
- Action: The system sets up the initial delivery attempt
Logic Flow:
IF Email message content is prepared and ready for delivery
AND The system sets up the initial delivery attempt
THEN:
- • The retry counter is set to zero and delivery parameters are initialized for the first attempt
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when email message is prepared and delivery attempt is initialized.
Trigger Criteria:
- Context: Email message is prepared and delivery attempt is initialized
- Applied to: Attempt Email Delivery
- Action: The system attempts email delivery
Logic Flow:
IF Email message is prepared and delivery attempt is initialized
AND The system attempts email delivery
THEN:
- • The email is transmitted to the freight forwarder's internet address if available,
otherwise to the default Merlin ID
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when email delivery attempt has been made.
Trigger Criteria:
- Context: An email delivery attempt has been made
- Applied to: Delivery Successful?
- Action: The system checks the delivery status
Logic Flow:
IF An email delivery attempt has been made
AND The system checks the delivery status
THEN:
- • If the delivery response indicates success, the process continues to success logging,
otherwise it proceeds to retry logic
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when email delivery has been confirmed as successful.
Trigger Criteria:
- Context: Email delivery has been confirmed as successful
- Applied to: Log Successful Delivery
- Action: The system logs the successful delivery
Logic Flow:
IF Email delivery has been confirmed as successful
AND The system logs the successful delivery
THEN:
- • A delivery success record is created with timestamp and recipient information for audit purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when email delivery has failed.
Trigger Criteria:
- Context: Email delivery has failed
- Applied to: Increment Retry Counter
- Action: The system increments the retry counter
Logic Flow:
IF Email delivery has failed
AND The system increments the retry counter
THEN:
- • The retry counter is increased by one to track the current attempt number
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when email delivery has failed and retry counter has been incremented.
Trigger Criteria:
- Context: Email delivery has failed and retry counter has been incremented
- Applied to: Max Retries Reached?
- Action: The system checks if maximum retries have been reached
Logic Flow:
IF Email delivery has failed and retry counter has been incremented
AND The system checks if maximum retries have been reached
THEN:
- • If retry counter equals or exceeds maximum retry limit, proceed to failure logging,
otherwise continue with retry delay
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when email delivery has failed and maximum retries have not been reached.
Trigger Criteria:
- Context: Email delivery has failed and maximum retries have not been reached
- Applied to: Apply Retry Delay
- Action: The system applies retry delay
Logic Flow:
IF Email delivery has failed and maximum retries have not been reached
AND The system applies retry delay
THEN:
- • A predetermined delay period is applied before the next delivery attempt
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when retry delay has been applied.
Trigger Criteria:
- Context: Retry delay has been applied
- Applied to: Update Delivery Status
- Action: The system updates delivery status
Logic Flow:
IF Retry delay has been applied
AND The system updates delivery status
THEN:
- • The delivery status is updated to indicate retry in progress and the system is ready for the next attempt
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when maximum retry attempts have been reached without successful email delivery.
Trigger Criteria:
- Context: Maximum retry attempts have been reached without successful email delivery
- Applied to: Log Delivery Failure
- Action: The system logs the delivery failure
Logic Flow:
IF Maximum retry attempts have been reached without successful email delivery
AND The system logs the delivery failure
THEN:
- • A delivery failure record is created with error details and retry attempt count for troubleshooting purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when primary email delivery has failed after maximum retry attempts.
Trigger Criteria:
- Context: Primary email delivery has failed after maximum retry attempts
- Applied to: Route to Alternative Recipient
- Action: The system routes to alternative recipient
Logic Flow:
IF Primary email delivery has failed after maximum retry attempts
AND The system routes to alternative recipient
THEN:
- • The email is prepared for delivery to backup recipients (AEI9999, OM01247) as fallback options
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when primary email delivery has failed and alternative routing is initiated.
Trigger Criteria:
- Context: Primary email delivery has failed and alternative routing is initiated
- Applied to: Alternative Available?
- Action: The system checks alternative recipient availability
Logic Flow:
IF Primary email delivery has failed and alternative routing is initiated
AND The system checks alternative recipient availability
THEN:
- • If alternative recipients (AEI9999, OM01247) are available, proceed to send to default recipient,
otherwise log final failure
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when alternative recipients are available for fallback delivery.
Trigger Criteria:
- Context: Alternative recipients are available for fallback delivery
- Applied to: Send to Default Recipient
- Action: The system sends to default recipient
Logic Flow:
IF Alternative recipients are available for fallback delivery
AND The system sends to default recipient
THEN:
- • The email is delivered to the default recipient (OM01247) with notification that original delivery failed
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all email delivery attempts including alternative recipients have failed.
Trigger Criteria:
- Context: All email delivery attempts including alternative recipients have failed
- Applied to: Log Final Failure
- Action: The system logs final failure
Logic Flow:
IF All email delivery attempts including alternative recipients have failed
AND The system logs final failure
THEN:
- • A final failure record is created indicating complete delivery failure with all attempted recipients and error details
R-GCX016E-cbl-02711 (+11) File: GCX016E.cbl Business Rule: Status Array Debug Information Logging
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo status processing event requires debug logging.
Trigger Criteria:
- Context: A cargo status processing event requires debug logging
- Applied to: Create Debug Information Header
- Action: The system initiates debug information capture
Logic Flow:
IF A cargo status processing event requires debug logging
AND The system initiates debug information capture
THEN:
- • A debug header is created with cargo identification details including equipment ID, waybill number, and US-CCN
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo requires status processing and debug logging is enabled.
Trigger Criteria:
- Context: A cargo requires status processing and debug logging is enabled
- Applied to: Log Cargo Status Before Processing
- Action: The system begins cargo status processing
Logic Flow:
IF A cargo requires status processing and debug logging is enabled
AND The system begins cargo status processing
THEN:
- • The current cargo status, quantities, and disposition codes are captured and logged as baseline information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when debug logging is requested for cargo status processing.
Trigger Criteria:
- Context: Debug logging is requested for cargo status processing
- Applied to: Capture Current Status Information
- Action: The system attempts to capture current status information
Logic Flow:
IF Debug logging is requested for cargo status processing
AND The system attempts to capture current status information
THEN:
- • If status information is available, proceed with detailed logging,
otherwise skip to message formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo status information is available for logging.
Trigger Criteria:
- Context: Cargo status information is available for logging
- Applied to: Log RT10/RT11 Cargo Status
- Action: The system processes RT10/RT11 cargo status records
Logic Flow:
IF Cargo status information is available for logging
AND The system processes RT10/RT11 cargo status records
THEN:
- • RT10 and RT11 status details are captured and included in the debug log
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo status processing requires quantity tracking.
Trigger Criteria:
- Context: Cargo status processing requires quantity tracking
- Applied to: Log Cargo Quantities
- Action: The system logs cargo information
Logic Flow:
IF Cargo status processing requires quantity tracking
AND The system logs cargo information
THEN:
- • Current cargo quantities, released quantities, and any pending quantity changes are documented in the debug log
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has associated disposition codes.
Trigger Criteria:
- Context: Cargo has associated disposition codes
- Applied to: Log Disposition Codes
- Action: The system performs debug logging
Logic Flow:
IF Cargo has associated disposition codes
AND The system performs debug logging
THEN:
- • All current disposition codes, their entry numbers, and associated quantities are documented in the debug log
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has an s09a status array with multiple entries.
Trigger Criteria:
- Context: Cargo has an S09A status array with multiple entries
- Applied to: Dump Complete S09A Status Array
- Action: Debug logging requires complete status visibility
Logic Flow:
IF Cargo has an S09A status array with multiple entries
AND Debug logging requires complete status visibility
THEN:
- • The entire S09A status array is dumped showing all status codes, sequences, and occurrence data
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo status processing has been completed.
Trigger Criteria:
- Context: Cargo status processing has been completed
- Applied to: Log Cargo Status After Processing
- Action: The system finalizes debug logging
Logic Flow:
IF Cargo status processing has been completed
AND The system finalizes debug logging
THEN:
- • The final cargo status, updated quantities, and new disposition codes are captured and logged
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when both before and after status information has been captured.
Trigger Criteria:
- Context: Both before and after status information has been captured
- Applied to: Create Before/After Comparison
- Action: The system completes status processing
Logic Flow:
IF Both before and after status information has been captured
AND The system completes status processing
THEN:
- • A comparison is created highlighting status changes, quantity modifications, and disposition code updates
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all debug information has been captured.
Trigger Criteria:
- Context: All debug information has been captured
- Applied to: Format Debug Message Content
- Action: The system prepares debug output
Logic Flow:
IF All debug information has been captured
AND The system prepares debug output
THEN:
- • Debug information is formatted into a structured message containing header, before/after status, and comparison data
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when debug message has been formatted and is ready for distribution.
Trigger Criteria:
- Context: Debug message has been formatted and is ready for distribution
- Applied to: Route Debug Message to Recipients
- Action: The system processes debug message routing
Logic Flow:
IF Debug message has been formatted and is ready for distribution
AND The system processes debug message routing
THEN:
- • Debug messages are routed to designated Merlin recipients for troubleshooting support
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when debug logging has been completed.
Trigger Criteria:
- Context: Debug logging has been completed
- Applied to: Store Debug Log for Audit Trail
- Action: The system finalizes debug processing
Logic Flow:
IF Debug logging has been completed
AND The system finalizes debug processing
THEN:
- • Debug log information is stored in audit trail records with timestamps for compliance and historical reference
R-GCX016E-cbl-02723 (+14) File: GCX016E.cbl Business Rule: Merlin Message Routing and Distribution
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when merlin message is ready for distribution.
Trigger Criteria:
- Context: A Merlin message is ready for distribution
- Applied to: ERROR Message Type
- Action: The message type is determined to be ERROR
Logic Flow:
IF A Merlin message is ready for distribution
AND The message type is determined to be ERROR
THEN:
- • The message should be routed to the IN destination
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when merlin message is ready for distribution and message type is info.
Trigger Criteria:
- Context: A Merlin message is ready for distribution and message type is INFO
- Applied to: INFO Message Type
- Action: The system processes the message routing
Logic Flow:
IF A Merlin message is ready for distribution and message type is INFO
AND The system processes the message routing
THEN:
- • The message should be sent to IN destination and all valid SD segment Merlin IDs
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when merlin message is ready for distribution and message type is release.
Trigger Criteria:
- Context: A Merlin message is ready for distribution and message type is RELEASE
- Applied to: RELEASE Message Type
- Action: The system processes the message routing
Logic Flow:
IF A Merlin message is ready for distribution and message type is RELEASE
AND The system processes the message routing
THEN:
- • The message should be sent only to valid SD segment Merlin IDs and not to IN destination
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when merlin message is ready for distribution and message type is export.
Trigger Criteria:
- Context: A Merlin message is ready for distribution and message type is EXPORT
- Applied to: EXPORT Message Type
- Action: The system evaluates the equipment type for routing decisions
Logic Flow:
IF A Merlin message is ready for distribution and message type is EXPORT
AND The system evaluates the equipment type for routing decisions
THEN:
- • The message should be routed according to equipment-specific routing rules
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when merlin message is ready for distribution and message type is unrlse.
Trigger Criteria:
- Context: A Merlin message is ready for distribution and message type is UNRLSE
- Applied to: UNRLSE Message Type
- Action: The system processes the message routing
Logic Flow:
IF A Merlin message is ready for distribution and message type is UNRLSE
AND The system processes the message routing
THEN:
- • The message should be sent to OM01247 and all valid SD cancel Merlin IDs
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when message type has been determined for a merlin message.
Trigger Criteria:
- Context: A message type has been determined for a Merlin message
- Applied to: Check AD Segment Configuration
- Action: The system needs to identify message recipients
Logic Flow:
IF A message type has been determined for a Merlin message
AND The system needs to identify message recipients
THEN:
- • The AD segment configuration should be checked to find valid recipient Merlin IDs
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when ad segment configuration has been checked for a message.
Trigger Criteria:
- Context: AD segment configuration has been checked for a message
- Applied to: Valid Recipient Found?
- Action: The system evaluates recipient validity
Logic Flow:
IF AD segment configuration has been checked for a message
AND The system evaluates recipient validity
THEN:
- • If valid recipients are found, proceed with configured routing; if no valid recipients exist, use default routing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid recipients have been found in the ad segment configuration.
Trigger Criteria:
- Context: Valid recipients have been found in the AD segment configuration
- Applied to: Route to Configured Recipient
- Action: The system processes message routing
Logic Flow:
IF Valid recipients have been found in the AD segment configuration
AND The system processes message routing
THEN:
- • The message should be delivered to all configured valid recipients
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when no valid recipients were found in the ad segment configuration.
Trigger Criteria:
- Context: No valid recipients were found in the AD segment configuration
- Applied to: Route to Default Recipient OM01247
- Action: The system needs to deliver the message
Logic Flow:
IF No valid recipients were found in the AD segment configuration
AND The system needs to deliver the message
THEN:
- • The message should be routed to the default recipient OM01247
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when invalid recipient is detected in the routing configuration.
Trigger Criteria:
- Context: An invalid recipient is detected in the routing configuration
- Applied to: Generate Invalid Recipient Error
- Action: The system validates recipient information
Logic Flow:
IF An invalid recipient is detected in the routing configuration
AND The system validates recipient information
THEN:
- • An invalid recipient error should be generated for tracking and correction
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when invalid recipient error has been generated.
Trigger Criteria:
- Context: An invalid recipient error has been generated
- Applied to: Reroute Message with Error Notification
- Action: The system needs to handle the failed routing
Logic Flow:
IF An invalid recipient error has been generated
AND The system needs to handle the failed routing
THEN:
- • The message should be rerouted with an error notification indicating the routing failure
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when message has been successfully distributed to recipients.
Trigger Criteria:
- Context: A message has been successfully distributed to recipients
- Applied to: Log Distribution Action
- Action: The distribution process completes
Logic Flow:
IF A message has been successfully distributed to recipients
AND The distribution process completes
THEN:
- • The distribution action should be logged with relevant details for audit purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when message distribution has been attempted.
Trigger Criteria:
- Context: A message distribution has been attempted
- Applied to: Handle Delivery Failure
- Action: The delivery fails for any reason
Logic Flow:
IF A message distribution has been attempted
AND The delivery fails for any reason
THEN:
- • The system should handle the delivery failure and determine if retry is required
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when message delivery failure has been detected.
Trigger Criteria:
- Context: A message delivery failure has been detected
- Applied to: Retry Required?
- Action: The system evaluates the failure conditions
Logic Flow:
IF A message delivery failure has been detected
AND The system evaluates the failure conditions
THEN:
- • If retry is required, reroute to default recipient; if no retry is needed, complete the distribution process
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when delivery failure has occurred and retry is required.
Trigger Criteria:
- Context: A delivery failure has occurred and retry is required
- Applied to: Reroute to Default Recipient
- Action: The system initiates the retry process
Logic Flow:
IF A delivery failure has occurred and retry is required
AND The system initiates the retry process
THEN:
- • The message should be rerouted to the default recipient as a fallback delivery method
R-GCX016E-cbl-02738 (+11) File: GCX016E.cbl Business Rule: Merlin Message Delivery with Error Handling
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when merlin message needs to be delivered.
Trigger Criteria:
- Context: A Merlin message needs to be delivered
- Applied to: Route ERROR Message
- Action: The message type is ERROR
Logic Flow:
IF A Merlin message needs to be delivered
AND The message type is ERROR
THEN:
- • The message should be routed to the 'IN' destination
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when merlin message needs to be delivered.
Trigger Criteria:
- Context: A Merlin message needs to be delivered
- Applied to: Route INFO Message
- Action: The message type is INFO
Logic Flow:
IF A Merlin message needs to be delivered
AND The message type is INFO
THEN:
- • The message should be routed to 'IN' destination plus SD segment Merlin IDs
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when merlin message needs to be delivered.
Trigger Criteria:
- Context: A Merlin message needs to be delivered
- Applied to: Route RELEASE Message
- Action: The message type is RELEASE
Logic Flow:
IF A Merlin message needs to be delivered
AND The message type is RELEASE
THEN:
- • The message should be routed to SD segment Merlin IDs only
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when merlin message needs to be delivered.
Trigger Criteria:
- Context: A Merlin message needs to be delivered
- Applied to: Route EXPORT Message
- Action: The message type is EXPORT
Logic Flow:
IF A Merlin message needs to be delivered
AND The message type is EXPORT
THEN:
- • The message should be routed based on equipment type settings
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when merlin message needs to be delivered.
Trigger Criteria:
- Context: A Merlin message needs to be delivered
- Applied to: Route UNRLSE Message
- Action: The message type is UNRLSE
Logic Flow:
IF A Merlin message needs to be delivered
AND The message type is UNRLSE
THEN:
- • The message should be routed to OM01247 plus SD cancel Merlin IDs
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when merlin message needs to be delivered.
Trigger Criteria:
- Context: A Merlin message needs to be delivered
- Applied to: Route ARRCANL Message
- Action: The message type is ARRCANL
Logic Flow:
IF A Merlin message needs to be delivered
AND The message type is ARRCANL
THEN:
- • The message should be routed to arrival cancellation recipients
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when message recipient has been determined.
Trigger Criteria:
- Context: A message recipient has been determined
- Applied to: Use AD Segment Configuration
- Action: The recipient is valid
Logic Flow:
IF A message recipient has been determined
AND The recipient is valid
THEN:
- • The system should use AD segment configuration for delivery
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when message recipient has been determined.
Trigger Criteria:
- Context: A message recipient has been determined
- Applied to: Use Default Recipient OM01247
- Action: The recipient is not valid
Logic Flow:
IF A message recipient has been determined
AND The recipient is not valid
THEN:
- • The system should use default recipient OM01247
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when message has been sent to a recipient.
Trigger Criteria:
- Context: A message has been sent to a recipient
- Applied to: Generate Error Notification
- Action: The delivery is not successful
Logic Flow:
IF A message has been sent to a recipient
AND The delivery is not successful
THEN:
- • The system should generate an error notification
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when message delivery has failed and error notification has been generated.
Trigger Criteria:
- Context: A message delivery has failed and error notification has been generated
- Applied to: Reroute to Default Recipient
- Action: Rerouting is attempted
Logic Flow:
IF A message delivery has failed and error notification has been generated
AND Rerouting is attempted
THEN:
- • The message should be sent to the default recipient
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when message rerouting has been attempted.
Trigger Criteria:
- Context: A message rerouting has been attempted
- Applied to: Final Delivery Failure
- Action: The rerouting is not successful
Logic Flow:
IF A message rerouting has been attempted
AND The rerouting is not successful
THEN:
- • The system should record a final delivery failure
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when message delivery process has completed.
Trigger Criteria:
- Context: A message delivery process has completed
- Applied to: Log Delivery Status
- Action: The delivery outcome is determined (success, rerouted success, or failure)
Logic Flow:
IF A message delivery process has completed
AND The delivery outcome is determined (success, rerouted success, or failure)
THEN:
- • The system should log the delivery status
R-GCX016E-cbl-02750 (+8) File: GCX016E.cbl Business Rule: Cargo Information Audit Logging
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo processing action has occurred that requires audit logging.
Trigger Criteria:
- Context: A cargo processing action has occurred that requires audit logging
- Applied to: Prepare Audit Log Entry
- Action: The system initiates audit log preparation
Logic Flow:
IF A cargo processing action has occurred that requires audit logging
AND The system initiates audit log preparation
THEN:
- • An audit log entry structure is prepared to capture the cargo processing action details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when audit log entry is being prepared for a cargo processing action.
Trigger Criteria:
- Context: An audit log entry is being prepared for a cargo processing action
- Applied to: Capture Timestamp Information
- Action: The system captures timestamp information
Logic Flow:
IF An audit log entry is being prepared for a cargo processing action
AND The system captures timestamp information
THEN:
- • The current date and time are recorded in the audit log entry for tracking when the action occurred
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when audit log entry is being prepared with timestamp information.
Trigger Criteria:
- Context: An audit log entry is being prepared with timestamp information
- Applied to: Capture User Information
- Action: The system captures user information
Logic Flow:
IF An audit log entry is being prepared with timestamp information
AND The system captures user information
THEN:
- • The user identification and relevant user context are recorded in the audit log entry for accountability tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when audit log entry has been prepared with timestamp and user information.
Trigger Criteria:
- Context: An audit log entry has been prepared with timestamp and user information
- Applied to: Set Action Code to LOG-USE-INPUT-MESSAGE
- Action: The system sets the action code for the audit log
Logic Flow:
IF An audit log entry has been prepared with timestamp and user information
AND The system sets the action code for the audit log
THEN:
- • The action code is set to LOG-USE-INPUT-MESSAGE to indicate this is an input message logging action
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when audit log entry is prepared with action code log-use-input-message.
Trigger Criteria:
- Context: An audit log entry is prepared with action code LOG-USE-INPUT-MESSAGE
- Applied to: Spawn GCT1051E Transaction
- Action: The system spawns the GCT1051E transaction
Logic Flow:
IF An audit log entry is prepared with action code LOG-USE-INPUT-MESSAGE
AND The system spawns the GCT1051E transaction
THEN:
- • The GCT1051E audit logging transaction is invoked to process the audit log entry
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when gct1051e transaction has been spawned for audit logging.
Trigger Criteria:
- Context: The GCT1051E transaction has been spawned for audit logging
- Applied to: Transaction Spawn Successful?
- Action: The system checks the transaction spawn result
Logic Flow:
IF The GCT1051E transaction has been spawned for audit logging
AND The system checks the transaction spawn result
THEN:
- • If the transaction spawn was successful, proceed to log audit entry creation,
otherwise handle the logging error
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when gct1051e transaction spawn was successful.
Trigger Criteria:
- Context: The GCT1051E transaction spawn was successful
- Applied to: Log Audit Entry Created
- Action: The audit log entry is processed
Logic Flow:
IF The GCT1051E transaction spawn was successful
AND The audit log entry is processed
THEN:
- • The audit log entry is successfully created and recorded in the audit system for compliance tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when gct1051e transaction spawn was not successful.
Trigger Criteria:
- Context: The GCT1051E transaction spawn was not successful
- Applied to: Handle Logging Error
- Action: The system handles the logging error
Logic Flow:
IF The GCT1051E transaction spawn was not successful
AND The system handles the logging error
THEN:
- • The logging error is processed and handled appropriately without stopping the main cargo processing flow
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when either the audit log entry was successfully created or the logging error was handled.
Trigger Criteria:
- Context: Either the audit log entry was successfully created or the logging error was handled
- Applied to: Continue Processing
- Action: The audit logging process is complete
Logic Flow:
IF Either the audit log entry was successfully created or the logging error was handled
AND The audit logging process is complete
THEN:
- • The system continues with the main cargo processing workflow without interruption
R-GCX016E-cbl-02759 (+15) File: GCX016E.cbl Business Rule: Merlin Report Field Management
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record contains equipment information.
Trigger Criteria:
- Context: A cargo record contains equipment information
- Applied to: Format Equipment Information
- Action: The system processes Merlin report field management
Logic Flow:
IF A cargo record contains equipment information
AND The system processes Merlin report field management
THEN:
- • The equipment information is formatted and prepared for report inclusion
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record exists with car identification data.
Trigger Criteria:
- Context: A cargo record exists with car identification data
- Applied to: Extract Car ID from Cargo Record
- Action: The system needs car ID information for Merlin reporting
Logic Flow:
IF A cargo record exists with car identification data
AND The system needs car ID information for Merlin reporting
THEN:
- • The car ID is extracted from the cargo record and made available for formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record contains waybill number information.
Trigger Criteria:
- Context: A cargo record contains waybill number information
- Applied to: Format Waybill Number
- Action: The system processes waybill data for Merlin reporting
Logic Flow:
IF A cargo record contains waybill number information
AND The system processes waybill data for Merlin reporting
THEN:
- • The waybill number is formatted according to report requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record contains us-ccn information.
Trigger Criteria:
- Context: A cargo record contains US-CCN information
- Applied to: Format US-CCN Information
- Action: The system processes CCN data for Merlin reporting
Logic Flow:
IF A cargo record contains US-CCN information
AND The system processes CCN data for Merlin reporting
THEN:
- • The US-CCN is formatted according to report standards
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code exists for the cargo.
Trigger Criteria:
- Context: A disposition code exists for the cargo
- Applied to: Format Disposition Code Information
- Action: The system processes disposition code data for Merlin reporting
Logic Flow:
IF A disposition code exists for the cargo
AND The system processes disposition code data for Merlin reporting
THEN:
- • The disposition code information is formatted for report inclusion
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code identifier exists.
Trigger Criteria:
- Context: A disposition code identifier exists
- Applied to: Retrieve Disposition Code
- Action: The system needs disposition code details for Merlin reporting
Logic Flow:
IF A disposition code identifier exists
AND The system needs disposition code details for Merlin reporting
THEN:
- • The disposition code is retrieved from the disposition code table
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code has been retrieved from the table.
Trigger Criteria:
- Context: A disposition code has been retrieved from the table
- Applied to: Get Disposition Description
- Action: The system needs the description for Merlin reporting
Logic Flow:
IF A disposition code has been retrieved from the table
AND The system needs the description for Merlin reporting
THEN:
- • The disposition code description is obtained from the disposition code table
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when date and time information is available for the cargo transaction.
Trigger Criteria:
- Context: Date and time information is available for the cargo transaction
- Applied to: Format Date and Time Information
- Action: The system processes temporal data for Merlin reporting
Logic Flow:
IF Date and time information is available for the cargo transaction
AND The system processes temporal data for Merlin reporting
THEN:
- • The date and time information is formatted according to report requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when uscs processing time data is available.
Trigger Criteria:
- Context: USCS processing time data is available
- Applied to: Format USCS Processing Time
- Action: The system processes USCS timing information for Merlin reporting
Logic Flow:
IF USCS processing time data is available
AND The system processes USCS timing information for Merlin reporting
THEN:
- • The USCS processing time is formatted according to report standards
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when system processing time data is available.
Trigger Criteria:
- Context: System processing time data is available
- Applied to: Format System Processing Time
- Action: The system processes internal timing information for Merlin reporting
Logic Flow:
IF System processing time data is available
AND The system processes internal timing information for Merlin reporting
THEN:
- • The system processing time is formatted according to report requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code is being processed for merlin reporting.
Trigger Criteria:
- Context: A disposition code is being processed for Merlin reporting
- Applied to: Apply Release Quantity Impact Logic
- Action: The system evaluates the disposition code's impact on release quantities
Logic Flow:
IF A disposition code is being processed for Merlin reporting
AND The system evaluates the disposition code's impact on release quantities
THEN:
- • The system determines whether the disposition code affects release quantities based on business rules
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code is being processed.
Trigger Criteria:
- Context: A disposition code is being processed
- Applied to: Does Disposition Code Affect Release Quantity?
- Action: The system checks if the disposition code affects release quantities
Logic Flow:
IF A disposition code is being processed
AND The system checks if the disposition code affects release quantities
THEN:
- • The system returns true if the disposition code affects release quantities, false
otherwise
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code affects release quantities.
Trigger Criteria:
- Context: A disposition code affects release quantities
- Applied to: Include Quantity Impact in Report
- Action: The system formats the Merlin report
Logic Flow:
IF A disposition code affects release quantities
AND The system formats the Merlin report
THEN:
- • The quantity impact information is included in the report
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code does not affect release quantities.
Trigger Criteria:
- Context: A disposition code does not affect release quantities
- Applied to: Exclude Quantity Impact from Report
- Action: The system formats the Merlin report
Logic Flow:
IF A disposition code does not affect release quantities
AND The system formats the Merlin report
THEN:
- • The quantity impact information is excluded from the report
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all individual report field components have been formatted.
Trigger Criteria:
- Context: All individual report field components have been formatted
- Applied to: Assemble Complete Merlin Report Fields
- Action: The system assembles the complete Merlin report
Logic Flow:
IF All individual report field components have been formatted
AND The system assembles the complete Merlin report
THEN:
- • All formatted fields are combined into a complete report structure
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when complete merlin report fields have been assembled.
Trigger Criteria:
- Context: The complete Merlin report fields have been assembled
- Applied to: Return Formatted Report Fields
- Action: The field management process completes
Logic Flow:
IF The complete Merlin report fields have been assembled
AND The field management process completes
THEN:
- • The formatted report fields are returned to the calling process
R-GCX016E-cbl-02775 (+9) File: GCX016E.cbl Business Rule: Merlin Message Rerouting
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when merlin message is ready for distribution with a recipient configured in the ad segment.
Trigger Criteria:
- Context: A Merlin message is ready for distribution with a recipient configured in the AD segment
- Applied to: Valid Recipient in AD Segment?
- Action: The system checks the validity of the recipient in the AD segment
Logic Flow:
IF A Merlin message is ready for distribution with a recipient configured in the AD segment
AND The system checks the validity of the recipient in the AD segment
THEN:
- • The system determines if the recipient is valid and proceeds accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when merlin message has a valid recipient configured in the ad segment.
Trigger Criteria:
- Context: A Merlin message has a valid recipient configured in the AD segment
- Applied to: Use Configured Recipient
- Action: The recipient validation passes successfully
Logic Flow:
IF A Merlin message has a valid recipient configured in the AD segment
AND The recipient validation passes successfully
THEN:
- • The system uses the configured recipient for message delivery
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when merlin message has an invalid recipient configured in the ad segment.
Trigger Criteria:
- Context: A Merlin message has an invalid recipient configured in the AD segment
- Applied to: Detect Invalid Recipient
- Action: The recipient validation fails
Logic Flow:
IF A Merlin message has an invalid recipient configured in the AD segment
AND The recipient validation fails
THEN:
- • The system detects the invalid recipient and generates an error notification
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when merlin message has an invalid recipient and an error notification has been generated.
Trigger Criteria:
- Context: A Merlin message has an invalid recipient and an error notification has been generated
- Applied to: Set Default Recipient OM01247
- Action: The system needs to assign a fallback recipient
Logic Flow:
IF A Merlin message has an invalid recipient and an error notification has been generated
AND The system needs to assign a fallback recipient
THEN:
- • The system sets OM01247 as the default recipient for message delivery
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when merlin message has been assigned the default recipient om01247 due to invalid original recipient.
Trigger Criteria:
- Context: A Merlin message has been assigned the default recipient OM01247 due to invalid original recipient
- Applied to: Route Message to Default Recipient
- Action: The system initiates message routing
Logic Flow:
IF A Merlin message has been assigned the default recipient OM01247 due to invalid original recipient
AND The system initiates message routing
THEN:
- • The message is routed to the default recipient OM01247
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when merlin message has been routed to a recipient (either original or default).
Trigger Criteria:
- Context: A Merlin message has been routed to a recipient (either original or default)
- Applied to: Delivery Successful?
- Action: The delivery attempt is completed
Logic Flow:
IF A Merlin message has been routed to a recipient (either original or default)
AND The delivery attempt is completed
THEN:
- • The system determines if the delivery was successful or failed
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when merlin message delivery attempt has been completed.
Trigger Criteria:
- Context: A Merlin message delivery attempt has been completed
- Applied to: Message Delivered Successfully
- Action: The delivery is determined to be successful
Logic Flow:
IF A Merlin message delivery attempt has been completed
AND The delivery is determined to be successful
THEN:
- • The system marks the message as delivered successfully and completes the process
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when merlin message delivery attempt has failed.
Trigger Criteria:
- Context: A Merlin message delivery attempt has failed
- Applied to: Handle Delivery Failure
- Action: The delivery failure is detected
Logic Flow:
IF A Merlin message delivery attempt has failed
AND The delivery failure is detected
THEN:
- • The system initiates delivery failure handling procedures
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when merlin message delivery has failed to the primary recipient.
Trigger Criteria:
- Context: A Merlin message delivery has failed to the primary recipient
- Applied to: Reroute to Alternative Default
- Action: Delivery failure handling is initiated
Logic Flow:
IF A Merlin message delivery has failed to the primary recipient
AND Delivery failure handling is initiated
THEN:
- • The system reroutes the message to an alternative default recipient
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when merlin message has been rerouted to an alternative default recipient.
Trigger Criteria:
- Context: A Merlin message has been rerouted to an alternative default recipient
- Applied to: Log Rerouting Action
- Action: The rerouting action is completed
Logic Flow:
IF A Merlin message has been rerouted to an alternative default recipient
AND The rerouting action is completed
THEN:
- • The system logs the rerouting action for audit and tracking purposes
R-GCX016E-cbl-02785 (+17) File: GCX016E.cbl Business Rule: Message Array Initialization for Cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo processing request is received.
Trigger Criteria:
- Context: A cargo processing request is received
- Applied to: Initialize X4 Segment Array
- Action: The system begins message array initialization for cargo
Logic Flow:
IF A cargo processing request is received
AND The system begins message array initialization for cargo
THEN:
- • The X4 segment array is initialized with proper structure and default values
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when x4 segment array is initialized and cargo equipment data is available.
Trigger Criteria:
- Context: An X4 segment array is initialized and cargo equipment data is available
- Applied to: Set Equipment Information in X4
- Action: The system processes equipment information for the cargo
Logic Flow:
IF An X4 segment array is initialized and cargo equipment data is available
AND The system processes equipment information for the cargo
THEN:
- • Equipment identification details are populated into the X4 segment structure
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when x4 segment is prepared and disposition code data is available.
Trigger Criteria:
- Context: An X4 segment is prepared and disposition code data is available
- Applied to: Set Cargo Disposition Code in X4
- Action: The system processes cargo disposition requirements
Logic Flow:
IF An X4 segment is prepared and disposition code data is available
AND The system processes cargo disposition requirements
THEN:
- • The appropriate disposition code is assigned to the X4 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when x4 segment is being populated and current date/time is available.
Trigger Criteria:
- Context: An X4 segment is being populated and current date/time is available
- Applied to: Set Date/Time Information in X4
- Action: The system processes timing information for the cargo transaction
Logic Flow:
IF An X4 segment is being populated and current date/time is available
AND The system processes timing information for the cargo transaction
THEN:
- • Current date and time information is populated into the X4 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when x4 segment is being populated and location data is available.
Trigger Criteria:
- Context: An X4 segment is being populated and location data is available
- Applied to: Set Location Information in X4
- Action: The system processes location requirements for the cargo
Logic Flow:
IF An X4 segment is being populated and location data is available
AND The system processes location requirements for the cargo
THEN:
- • Location information is assigned to the X4 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo processing requires equipment data handling.
Trigger Criteria:
- Context: Cargo processing requires equipment data handling
- Applied to: Initialize N7 Segment Array
- Action: The system begins N7 segment initialization
Logic Flow:
IF Cargo processing requires equipment data handling
AND The system begins N7 segment initialization
THEN:
- • The N7 segment array is initialized with proper structure and default values
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when n7 segment is initialized and equipment id data is available.
Trigger Criteria:
- Context: An N7 segment is initialized and equipment ID data is available
- Applied to: Set Equipment ID in N7
- Action: The system processes equipment identification for the cargo
Logic Flow:
IF An N7 segment is initialized and equipment ID data is available
AND The system processes equipment identification for the cargo
THEN:
- • Equipment ID is populated into the N7 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when n7 segment is being populated and equipment type data is available.
Trigger Criteria:
- Context: An N7 segment is being populated and equipment type data is available
- Applied to: Set Equipment Type in N7
- Action: The system processes equipment classification for the cargo
Logic Flow:
IF An N7 segment is being populated and equipment type data is available
AND The system processes equipment classification for the cargo
THEN:
- • Equipment type is assigned to the N7 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when n7 segment is being populated and quantity data is available.
Trigger Criteria:
- Context: An N7 segment is being populated and quantity data is available
- Applied to: Set Quantity Information in N7
- Action: The system processes cargo quantity information
Logic Flow:
IF An N7 segment is being populated and quantity data is available
AND The system processes cargo quantity information
THEN:
- • Quantity information is populated into the N7 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when n7 segment is being populated and weight data is available.
Trigger Criteria:
- Context: An N7 segment is being populated and weight data is available
- Applied to: Set Weight Information in N7
- Action: The system processes cargo weight information
Logic Flow:
IF An N7 segment is being populated and weight data is available
AND The system processes cargo weight information
THEN:
- • Weight information is assigned to the N7 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when n7 segment is being populated and waybill data is available.
Trigger Criteria:
- Context: An N7 segment is being populated and waybill data is available
- Applied to: Set Waybill Information in N7
- Action: The system processes waybill information for the cargo
Logic Flow:
IF An N7 segment is being populated and waybill data is available
AND The system processes waybill information for the cargo
THEN:
- • Waybill information is populated into the N7 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when x4 and n7 segments have been populated with cargo and equipment data.
Trigger Criteria:
- Context: X4 and N7 segments have been populated with cargo and equipment data
- Applied to: Validate Segment Data
- Action: The system performs data validation on the segments
Logic Flow:
IF X4 and N7 segments have been populated with cargo and equipment data
AND The system performs data validation on the segments
THEN:
- • All required data elements are verified for completeness and accuracy
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when segment data validation has been completed.
Trigger Criteria:
- Context: Segment data validation has been completed
- Applied to: Validation Successful?
- Action: The system evaluates validation results
Logic Flow:
IF Segment data validation has been completed
AND The system evaluates validation results
THEN:
- • A determination is made whether validation was successful or failed based on business requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when segment data validation has been successful.
Trigger Criteria:
- Context: Segment data validation has been successful
- Applied to: Mark Segments Ready for Processing
- Action: The system processes the validation success outcome
Logic Flow:
IF Segment data validation has been successful
AND The system processes the validation success outcome
THEN:
- • X4 and N7 segments are marked as ready for cargo processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when message segments have been successfully initialized and marked ready.
Trigger Criteria:
- Context: Message segments have been successfully initialized and marked ready
- Applied to: Log Initialization Complete
- Action: The system completes the initialization process
Logic Flow:
IF Message segments have been successfully initialized and marked ready
AND The system completes the initialization process
THEN:
- • Initialization completion is logged for audit and tracking purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when segment data validation has failed.
Trigger Criteria:
- Context: Segment data validation has failed
- Applied to: Generate Error Message
- Action: The system processes the validation failure outcome
Logic Flow:
IF Segment data validation has failed
AND The system processes the validation failure outcome
THEN:
- • An appropriate error message is generated describing the validation failure
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when error message has been generated for validation failure.
Trigger Criteria:
- Context: An error message has been generated for validation failure
- Applied to: Set Error Flag
- Action: The system handles the error condition
Logic Flow:
IF An error message has been generated for validation failure
AND The system handles the error condition
THEN:
- • Error flag is set to indicate validation failure and prevent further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when message array initialization process has completed (either successfully or with errors).
Trigger Criteria:
- Context: Message array initialization process has completed (either successfully or with errors)
- Applied to: Return to Cargo Processing
- Action: The system finishes the initialization workflow
Logic Flow:
IF Message array initialization process has completed (either successfully or with errors)
AND The system finishes the initialization workflow
THEN:
- • Control is returned to the main cargo processing workflow
R-GCX016E-cbl-02803 (+19) File: GCX016E.cbl Business Rule: Message Array Initialization for Trains
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train processing request is received.
Trigger Criteria:
- Context: A train processing request is received
- Applied to: Initialize Train Message Arrays
- Action: The system begins message array initialization
Logic Flow:
IF A train processing request is received
AND The system begins message array initialization
THEN:
- • Message arrays are initialized and prepared for M10 and V9 segment storage
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train message arrays are initialized.
Trigger Criteria:
- Context: Train message arrays are initialized
- Applied to: Create M10 Vessel Segment
- Action: The system creates M10 vessel segment
Logic Flow:
IF Train message arrays are initialized
AND The system creates M10 vessel segment
THEN:
- • M10 segment structure is created and ready to receive vessel data
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when m10 vessel segment is created and train id is available.
Trigger Criteria:
- Context: M10 vessel segment is created and train ID is available
- Applied to: Set Vessel Name from Train ID
- Action: The system sets vessel name from train ID
Logic Flow:
IF M10 vessel segment is created and train ID is available
AND The system sets vessel name from train ID
THEN:
- • Vessel name field in M10 segment is populated with train identifier
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when vessel name is set in m10 segment.
Trigger Criteria:
- Context: Vessel name is set in M10 segment
- Applied to: Set Transport Method Code
- Action: The system sets transport method code
Logic Flow:
IF Vessel name is set in M10 segment
AND The system sets transport method code
THEN:
- • Transport method code is assigned to indicate rail transportation mode
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when transport method code is set in m10 segment.
Trigger Criteria:
- Context: Transport method code is set in M10 segment
- Applied to: Set Country Code
- Action: The system sets country code
Logic Flow:
IF Transport method code is set in M10 segment
AND The system sets country code
THEN:
- • Country code is assigned to identify train's operational country
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when country code is set in m10 segment.
Trigger Criteria:
- Context: Country code is set in M10 segment
- Applied to: Set SCAC Code
- Action: The system sets SCAC code
Logic Flow:
IF Country code is set in M10 segment
AND The system sets SCAC code
THEN:
- • SCAC code is assigned to identify the carrier responsible for the train
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when m10 segment is completed with all required data.
Trigger Criteria:
- Context: M10 segment is completed with all required data
- Applied to: Create V9 Event Segment
- Action: The system creates V9 event segment
Logic Flow:
IF M10 segment is completed with all required data
AND The system creates V9 event segment
THEN:
- • V9 segment structure is created and ready to receive event data
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when v9 event segment is created and disposition code is available.
Trigger Criteria:
- Context: V9 event segment is created and disposition code is available
- Applied to: Set Event Code from Disposition
- Action: The system sets event code from disposition
Logic Flow:
IF V9 event segment is created and disposition code is available
AND The system sets event code from disposition
THEN:
- • Event code field in V9 segment is populated based on the disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when event code is set in v9 segment.
Trigger Criteria:
- Context: Event code is set in V9 segment
- Applied to: Set Event Date and Time
- Action: The system sets event date and time
Logic Flow:
IF Event code is set in V9 segment
AND The system sets event date and time
THEN:
- • Event date and time fields are populated with current timestamp
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when event date and time are set in v9 segment.
Trigger Criteria:
- Context: Event date and time are set in V9 segment
- Applied to: Set Location Information
- Action: The system sets location information
Logic Flow:
IF Event date and time are set in V9 segment
AND The system sets location information
THEN:
- • Location fields are populated with appropriate location data for the event
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when location information is set in v9 segment.
Trigger Criteria:
- Context: Location information is set in V9 segment
- Applied to: Set Event Description
- Action: The system sets event description
Logic Flow:
IF Location information is set in V9 segment
AND The system sets event description
THEN:
- • Event description field is populated with explanatory text for the event
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when m10 and v9 segments are populated with data.
Trigger Criteria:
- Context: M10 and V9 segments are populated with data
- Applied to: Validate Segment Data
- Action: The system validates segment data
Logic Flow:
IF M10 and V9 segments are populated with data
AND The system validates segment data
THEN:
- • All required fields are verified for completeness and accuracy
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when segment data validation is completed.
Trigger Criteria:
- Context: Segment data validation is completed
- Applied to: Validation Successful?
- Action: Validation is successful
Logic Flow:
IF Segment data validation is completed
AND Validation is successful
THEN:
- • System proceeds to store segments in message arrays
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when segment data validation is completed.
Trigger Criteria:
- Context: Segment data validation is completed
- Applied to: Validation Successful?
- Action: Validation fails
Logic Flow:
IF Segment data validation is completed
AND Validation fails
THEN:
- • System proceeds to log validation error and set error flag
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when m10 segment validation is successful.
Trigger Criteria:
- Context: M10 segment validation is successful
- Applied to: Store M10 Segment in Array
- Action: The system stores M10 segment in array
Logic Flow:
IF M10 segment validation is successful
AND The system stores M10 segment in array
THEN:
- • M10 segment is placed in the appropriate position in the message array
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when v9 segment validation is successful and m10 segment is stored.
Trigger Criteria:
- Context: V9 segment validation is successful and M10 segment is stored
- Applied to: Store V9 Segment in Array
- Action: The system stores V9 segment in array
Logic Flow:
IF V9 segment validation is successful and M10 segment is stored
AND The system stores V9 segment in array
THEN:
- • V9 segment is placed in the appropriate position in the message array
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when m10 and v9 segments are stored in arrays.
Trigger Criteria:
- Context: M10 and V9 segments are stored in arrays
- Applied to: Set Array Counters
- Action: The system sets array counters
Logic Flow:
IF M10 and V9 segments are stored in arrays
AND The system sets array counters
THEN:
- • Array counters are updated to reflect the current number of stored segments
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when array counters are set and segments are properly stored.
Trigger Criteria:
- Context: Array counters are set and segments are properly stored
- Applied to: Mark Arrays Ready for Processing
- Action: The system marks arrays ready for processing
Logic Flow:
IF Array counters are set and segments are properly stored
AND The system marks arrays ready for processing
THEN:
- • Arrays are flagged as ready and available for subsequent train processing operations
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when segment data validation fails.
Trigger Criteria:
- Context: Segment data validation fails
- Applied to: Log Validation Error
- Action: The system logs validation error
Logic Flow:
IF Segment data validation fails
AND The system logs validation error
THEN:
- • Error details are recorded for troubleshooting and audit purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when validation error is logged.
Trigger Criteria:
- Context: Validation error is logged
- Applied to: Set Error Flag
- Action: The system sets error flag
Logic Flow:
IF Validation error is logged
AND The system sets error flag
THEN:
- • Error flag is activated to prevent further processing with invalid data
R-GCX016E-cbl-02823 (+14) File: GCX016E.cbl Business Rule: Merlin Report Field Formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record with equipment information exists.
Trigger Criteria:
- Context: A cargo record with equipment information exists
- Applied to: Format Equipment Information
- Action: The system processes Merlin report field formatting
Logic Flow:
IF A cargo record with equipment information exists
AND The system processes Merlin report field formatting
THEN:
- • The equipment information is formatted and prepared for report inclusion
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record contains car id information.
Trigger Criteria:
- Context: A cargo record contains car ID information
- Applied to: Format Car ID
- Action: The car ID formatting process is executed
Logic Flow:
IF A cargo record contains car ID information
AND The car ID formatting process is executed
THEN:
- • The car ID is formatted with appropriate spacing and alignment for report display
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record contains waybill number information.
Trigger Criteria:
- Context: A cargo record contains waybill number information
- Applied to: Format Waybill Number
- Action: The waybill number formatting process is executed
Logic Flow:
IF A cargo record contains waybill number information
AND The waybill number formatting process is executed
THEN:
- • The waybill number is formatted for consistent display in the report
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record contains us-ccn information.
Trigger Criteria:
- Context: A cargo record contains US-CCN information
- Applied to: Format US-CCN
- Action: The US-CCN formatting process is executed
Logic Flow:
IF A cargo record contains US-CCN information
AND The US-CCN formatting process is executed
THEN:
- • The US-CCN is formatted with proper structure for report display
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code exists for the cargo.
Trigger Criteria:
- Context: A disposition code exists for the cargo
- Applied to: Format Disposition Code Information
- Action: The disposition code information formatting is processed
Logic Flow:
IF A disposition code exists for the cargo
AND The disposition code information formatting is processed
THEN:
- • The disposition code and its description are retrieved and formatted for report inclusion
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo is being processed with a disposition code.
Trigger Criteria:
- Context: A cargo is being processed with a disposition code
- Applied to: Retrieve Disposition Code
- Action: The disposition code retrieval is executed
Logic Flow:
IF A cargo is being processed with a disposition code
AND The disposition code retrieval is executed
THEN:
- • The current disposition code is retrieved from the processing context
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code has been identified.
Trigger Criteria:
- Context: A disposition code has been identified
- Applied to: Retrieve Disposition Description
- Action: The disposition description lookup is performed
Logic Flow:
IF A disposition code has been identified
AND The disposition description lookup is performed
THEN:
- • The corresponding description is retrieved from the disposition code table
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when processing timestamps are available for the cargo.
Trigger Criteria:
- Context: Processing timestamps are available for the cargo
- Applied to: Format Date/Time Information
- Action: The date/time formatting process is executed
Logic Flow:
IF Processing timestamps are available for the cargo
AND The date/time formatting process is executed
THEN:
- • The date and time information is formatted for consistent display in the report
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when uscs processing time information is available.
Trigger Criteria:
- Context: USCS processing time information is available
- Applied to: Format USCS Processing Time
- Action: The USCS processing time formatting is executed
Logic Flow:
IF USCS processing time information is available
AND The USCS processing time formatting is executed
THEN:
- • The USCS processing time is formatted for report display
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when system processing time information is available.
Trigger Criteria:
- Context: System processing time information is available
- Applied to: Format System Processing Time
- Action: The system processing time formatting is executed
Logic Flow:
IF System processing time information is available
AND The system processing time formatting is executed
THEN:
- • The system processing time is formatted for report display
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is being processed for a cargo.
Trigger Criteria:
- Context: A disposition code is being processed for a cargo
- Applied to: Apply Release Quantity Impact Logic
- Action: The release quantity impact logic is applied
Logic Flow:
IF A disposition code is being processed for a cargo
AND The release quantity impact logic is applied
THEN:
- • The system determines if the disposition code affects release quantities
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code is being evaluated for quantity impact.
Trigger Criteria:
- Context: A disposition code is being evaluated for quantity impact
- Applied to: Should Disposition Code Affect Release Quantities?
- Action: The system checks if the disposition code affects release quantities
Logic Flow:
IF A disposition code is being evaluated for quantity impact
AND The system checks if the disposition code affects release quantities
THEN:
- • The system returns true if the disposition code should affect quantities, false
otherwise
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code affects release quantities.
Trigger Criteria:
- Context: A disposition code affects release quantities
- Applied to: Include Quantity Impact in Report
- Action: The quantity impact inclusion process is executed
Logic Flow:
IF A disposition code affects release quantities
AND The quantity impact inclusion process is executed
THEN:
- • The quantity impact information is included in the Merlin report fields
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code does not affect release quantities.
Trigger Criteria:
- Context: A disposition code does not affect release quantities
- Applied to: Exclude Quantity Impact from Report
- Action: The quantity impact exclusion process is executed
Logic Flow:
IF A disposition code does not affect release quantities
AND The quantity impact exclusion process is executed
THEN:
- • The quantity impact information is excluded from the Merlin report fields
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all individual report components have been formatted.
Trigger Criteria:
- Context: All individual report components have been formatted
- Applied to: Assemble Complete Merlin Report Fields
- Action: The complete report field assembly is executed
Logic Flow:
IF All individual report components have been formatted
AND The complete report field assembly is executed
THEN:
- • All components are assembled into complete Merlin report fields ready for transmission
R-GCX016E-cbl-02838 (+13) File: GCX016E.cbl Business Rule: Shipment Minimum Information Creation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when shipment processing request is initiated.
Trigger Criteria:
- Context: A shipment processing request is initiated
- Applied to: Validate Shiproot Record Exists
- Action: The system attempts to validate shiproot record existence
Logic Flow:
IF A shipment processing request is initiated
AND The system attempts to validate shiproot record existence
THEN:
- • The system should verify the shiproot record exists in the shipment database and proceed only if found
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when shiproot record validation has been performed.
Trigger Criteria:
- Context: Shiproot record validation has been performed
- Applied to: Shiproot Found?
- Action: The system evaluates the shiproot record existence result
Logic Flow:
IF Shiproot record validation has been performed
AND The system evaluates the shiproot record existence result
THEN:
- • If shiproot is found, proceed to retrieve in-bond type code; if not found, terminate the shipment minimum creation process
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid shiproot record exists and cargo records are available.
Trigger Criteria:
- Context: A valid shiproot record exists and cargo records are available
- Applied to: Retrieve In-Bond Type Code from Cargo
- Action: The system retrieves in-bond type code from the cargo record
Logic Flow:
IF A valid shiproot record exists and cargo records are available
AND The system retrieves in-bond type code from the cargo record
THEN:
- • The in-bond type code should be extracted from the cargo record and made available for U1 segment population
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when in-bond type code has been successfully retrieved from cargo records.
Trigger Criteria:
- Context: In-bond type code has been successfully retrieved from cargo records
- Applied to: Extract Entry Number Information
- Action: The system extracts entry number information from cargo records
Logic Flow:
IF In-bond type code has been successfully retrieved from cargo records
AND The system extracts entry number information from cargo records
THEN:
- • Entry number information should be extracted and prepared for U1 segment population
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when entry number information has been extracted and x4 segments are available.
Trigger Criteria:
- Context: Entry number information has been extracted and X4 segments are available
- Applied to: Get Location Identifiers from X4 Segments
- Action: The system processes X4 segments to get location identifiers
Logic Flow:
IF Entry number information has been extracted and X4 segments are available
AND The system processes X4 segments to get location identifiers
THEN:
- • Location identifiers should be extracted from X4 segments and prepared for shipment minimum segment creation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when location identifiers have been extracted from x4 segments.
Trigger Criteria:
- Context: Location identifiers have been extracted from X4 segments
- Applied to: Process Destination Station Information
- Action: The system processes destination station information
Logic Flow:
IF Location identifiers have been extracted from X4 segments
AND The system processes destination station information
THEN:
- • Destination station information should be processed and prepared for U1 segment creation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when destination station information has been processed.
Trigger Criteria:
- Context: Destination station information has been processed
- Applied to: Process Key Station Information
- Action: The system processes key station information
Logic Flow:
IF Destination station information has been processed
AND The system processes key station information
THEN:
- • Key station information should be processed and prepared for U1 segment creation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all required station information has been processed.
Trigger Criteria:
- Context: All required station information has been processed
- Applied to: Create U1 Shipment Minimum Segment
- Action: The system creates a U1 shipment minimum segment
Logic Flow:
IF All required station information has been processed
AND The system creates a U1 shipment minimum segment
THEN:
- • A U1 segment structure should be created and ready for data population
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when u1 segment has been created and in-bond type code is available.
Trigger Criteria:
- Context: U1 segment has been created and in-bond type code is available
- Applied to: Populate In-Bond Type Code in U1
- Action: The system populates in-bond type code in the U1 segment
Logic Flow:
IF U1 segment has been created and in-bond type code is available
AND The system populates in-bond type code in the U1 segment
THEN:
- • The in-bond type code should be correctly populated in the appropriate field of the U1 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when in-bond type code has been populated in u1 segment and entry number information is available.
Trigger Criteria:
- Context: In-bond type code has been populated in U1 segment and entry number information is available
- Applied to: Populate Entry Number in U1
- Action: The system populates entry number in the U1 segment
Logic Flow:
IF In-bond type code has been populated in U1 segment and entry number information is available
AND The system populates entry number in the U1 segment
THEN:
- • Entry number information should be correctly populated in the appropriate field of the U1 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when entry number has been populated in u1 segment and location identifiers are available.
Trigger Criteria:
- Context: Entry number has been populated in U1 segment and location identifiers are available
- Applied to: Populate Location Identifiers in U1
- Action: The system populates location identifiers in the U1 segment
Logic Flow:
IF Entry number has been populated in U1 segment and location identifiers are available
AND The system populates location identifiers in the U1 segment
THEN:
- • Location identifiers should be correctly populated in the appropriate fields of the U1 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all data fields have been populated in the u1 segment.
Trigger Criteria:
- Context: All data fields have been populated in the U1 segment
- Applied to: Validate U1 Segment Data
- Action: The system validates U1 segment data completeness and accuracy
Logic Flow:
IF All data fields have been populated in the U1 segment
AND The system validates U1 segment data completeness and accuracy
THEN:
- • The U1 segment should pass validation checks for required fields and data integrity before storage
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when u1 segment data has been validated successfully.
Trigger Criteria:
- Context: U1 segment data has been validated successfully
- Applied to: Store U1 Segment for EDI Processing
- Action: The system stores the U1 segment for EDI processing
Logic Flow:
IF U1 segment data has been validated successfully
AND The system stores the U1 segment for EDI processing
THEN:
- • The U1 segment should be stored in the shipment minimum segments database and made available for EDI transmission
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when u1 segment has been successfully stored for edi processing.
Trigger Criteria:
- Context: U1 segment has been successfully stored for EDI processing
- Applied to: Log Shipment Creation Action
- Action: The system logs the shipment creation action
Logic Flow:
IF U1 segment has been successfully stored for EDI processing
AND The system logs the shipment creation action
THEN:
- • A log entry should be created documenting the successful creation of shipment minimum information with relevant identifiers and timestamp
R-GCX016E-cbl-02852 (+13) File: GCX016E.cbl Business Rule: Canadian Manifest Search and Validation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when us cargo record exists with equipment information.
Trigger Criteria:
- Context: A US cargo record exists with equipment information
- Applied to: Extract Equipment ID from US Cargo
- Action: The system processes the cargo for Canadian manifest matching
Logic Flow:
IF A US cargo record exists with equipment information
AND The system processes the cargo for Canadian manifest matching
THEN:
- • The equipment ID is extracted and formatted for Canadian system lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment id has been extracted from us cargo.
Trigger Criteria:
- Context: An equipment ID has been extracted from US cargo
- Applied to: Search Canadian Cargo Database
- Action: The system searches the Canadian cargo database
Logic Flow:
IF An equipment ID has been extracted from US cargo
AND The system searches the Canadian cargo database
THEN:
- • All Canadian cargo records with matching equipment ID are retrieved
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when search has been performed on the canadian cargo database.
Trigger Criteria:
- Context: A search has been performed on the Canadian cargo database
- Applied to: Canadian Cargo Found?
- Action: The system evaluates the search results
Logic Flow:
IF A search has been performed on the Canadian cargo database
AND The system evaluates the search results
THEN:
- • The system determines if Canadian cargo was found or not found
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when canadian cargo records have been found for the equipment id.
Trigger Criteria:
- Context: Canadian cargo records have been found for the equipment ID
- Applied to: Validate Canadian Cargo Status
- Action: The system validates the cargo status
Logic Flow:
IF Canadian cargo records have been found for the equipment ID
AND The system validates the cargo status
THEN:
- • The cargo status is checked to ensure it is not deleted or marked as new bond created
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when canadian cargo status has been retrieved and validated.
Trigger Criteria:
- Context: Canadian cargo status has been retrieved and validated
- Applied to: Status Valid?
- Action: The system determines status validity
Logic Flow:
IF Canadian cargo status has been retrieved and validated
AND The system determines status validity
THEN:
- • The status is classified as valid, deleted, or new bond created based on cargo state
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid canadian cargo has been found with matching equipment id.
Trigger Criteria:
- Context: Valid Canadian cargo has been found with matching equipment ID
- Applied to: Match Equipment IDs Between Systems
- Action: The system matches equipment IDs between systems
Logic Flow:
IF Valid Canadian cargo has been found with matching equipment ID
AND The system matches equipment IDs between systems
THEN:
- • Equipment ID correspondence is established between US and Canadian cargo records
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment ids have been successfully matched between systems.
Trigger Criteria:
- Context: Equipment IDs have been successfully matched between systems
- Applied to: Create Cross-Border Tracking Link
- Action: The system creates cross-border tracking links
Logic Flow:
IF Equipment IDs have been successfully matched between systems
AND The system creates cross-border tracking links
THEN:
- • A tracking relationship is established linking US and Canadian cargo records
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cross-border tracking links have been created successfully.
Trigger Criteria:
- Context: Cross-border tracking links have been created successfully
- Applied to: Log Canadian Manifest Match
- Action: The system logs the manifest match
Logic Flow:
IF Cross-border tracking links have been created successfully
AND The system logs the manifest match
THEN:
- • Match results are recorded with cargo details and timestamp information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when canadian cargo records have been found but have invalid deleted status.
Trigger Criteria:
- Context: Canadian cargo records have been found but have invalid deleted status
- Applied to: Exclude Deleted Cargo Records
- Action: The system processes cargo status validation
Logic Flow:
IF Canadian cargo records have been found but have invalid deleted status
AND The system processes cargo status validation
THEN:
- • Deleted cargo records are excluded from further cross-border processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when canadian cargo records have been found but have invalid new bond created status.
Trigger Criteria:
- Context: Canadian cargo records have been found but have invalid new bond created status
- Applied to: Exclude New Bond Created Records
- Action: The system processes cargo status validation
Logic Flow:
IF Canadian cargo records have been found but have invalid new bond created status
AND The system processes cargo status validation
THEN:
- • New bond created cargo records are excluded from further cross-border processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid canadian cargo has been matched and cross-border links created.
Trigger Criteria:
- Context: Valid Canadian cargo has been matched and cross-border links created
- Applied to: Update Cargo with Canadian Reference
- Action: The system updates US cargo with Canadian reference
Logic Flow:
IF Valid Canadian cargo has been matched and cross-border links created
AND The system updates US cargo with Canadian reference
THEN:
- • US cargo record is updated with Canadian manifest reference information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when us cargo has been updated with canadian reference information.
Trigger Criteria:
- Context: US cargo has been updated with Canadian reference information
- Applied to: Generate Cross-Border Audit Trail
- Action: The system generates cross-border audit trail
Logic Flow:
IF US cargo has been updated with Canadian reference information
AND The system generates cross-border audit trail
THEN:
- • Audit records are created documenting the cross-border manifest matching process
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when no canadian cargo records were found matching the equipment id.
Trigger Criteria:
- Context: No Canadian cargo records were found matching the equipment ID
- Applied to: No Canadian Manifest Found
- Action: The system processes the no match scenario
Logic Flow:
IF No Canadian cargo records were found matching the equipment ID
AND The system processes the no match scenario
THEN:
- • The system proceeds to log search results without creating cross-border links
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when canadian manifest search has been completed with either match or no match results.
Trigger Criteria:
- Context: Canadian manifest search has been completed with either match or no match results
- Applied to: Log Search Results
- Action: The system logs search results
Logic Flow:
IF Canadian manifest search has been completed with either match or no match results
AND The system logs search results
THEN:
- • Search outcome is recorded with equipment ID and result status information
R-GCX016E-cbl-02866 (+7) File: GCX016E.cbl Business Rule: Message Loading Logic
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when system needs to process export messages.
Trigger Criteria:
- Context: The system needs to process export messages
- Applied to: Execute MQGET to Retrieve Message from GC350.EXP.INPUT Queue
- Action: A message retrieval request is initiated
Logic Flow:
IF The system needs to process export messages
AND A message retrieval request is initiated
THEN:
- • The system executes MQGET operation to retrieve the next available message from GC350.EXP.INPUT queue
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when mqget operation has been executed.
Trigger Criteria:
- Context: An MQGET operation has been executed
- Applied to: Evaluate MQ Completion Code
- Action: The MQ completion code is evaluated
Logic Flow:
IF An MQGET operation has been executed
AND The MQ completion code is evaluated
THEN:
- • If completion code indicates success, proceed to message validation; if no message available, set message not available flag; if other error, handle error condition
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when message has been successfully retrieved from the queue.
Trigger Criteria:
- Context: A message has been successfully retrieved from the queue
- Applied to: Check Message Backout Count
- Action: The message backout count is evaluated
Logic Flow:
IF A message has been successfully retrieved from the queue
AND The message backout count is evaluated
THEN:
- • If backout count is zero, mark as good message; if backout count is greater than zero, mark as skip message due to high backout count
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when message has been retrieved successfully and backout count is zero.
Trigger Criteria:
- Context: A message has been retrieved successfully and backout count is zero
- Applied to: Set Good Message Flag
- Action: Message classification is performed
Logic Flow:
IF A message has been retrieved successfully and backout count is zero
AND Message classification is performed
THEN:
- • Set good message flag to indicate the message is ready for business processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when message has been retrieved successfully but backout count is greater than zero.
Trigger Criteria:
- Context: A message has been retrieved successfully but backout count is greater than zero
- Applied to: Set Skip Message Flag - High Backout Count
- Action: Message classification is performed
Logic Flow:
IF A message has been retrieved successfully but backout count is greater than zero
AND Message classification is performed
THEN:
- • Set skip message flag to prevent processing of potentially problematic message
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when mqget operation is executed.
Trigger Criteria:
- Context: An MQGET operation is executed
- Applied to: Set Message Not Available Flag
- Action: The completion code indicates no message is available (reason code 2033)
Logic Flow:
IF An MQGET operation is executed
AND The completion code indicates no message is available (reason code 2033)
THEN:
- • Set message not available flag to indicate queue is empty
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when mqget operation is executed.
Trigger Criteria:
- Context: An MQGET operation is executed
- Applied to: Handle MQ Error Condition
- Action: The completion code indicates an error other than 'no message available'
Logic Flow:
IF An MQGET operation is executed
AND The completion code indicates an error other than 'no message available'
THEN:
- • Handle the MQ error condition appropriately based on the specific error type
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when message has been classified as good, skip, or not available.
Trigger Criteria:
- Context: A message has been classified as good, skip, or not available
- Applied to: Message Classification
- Action: Processing decision is made
Logic Flow:
IF A message has been classified as good, skip, or not available
AND Processing decision is made
THEN:
- • If good message, proceed to business processing; if skip message, continue to next message; if no message available, end message loading process
R-GCX016E-cbl-02874 (+10) File: GCX016E.cbl Business Rule: Train Lookup and Validation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when m10 segment contains a vessel name field.
Trigger Criteria:
- Context: An M10 segment contains a vessel name field
- Applied to: Extract Train ID from Vessel Name
- Action: The system processes the M10 segment
Logic Flow:
IF An M10 segment contains a vessel name field
AND The system processes the M10 segment
THEN:
- • The train ID is extracted from the vessel name for database lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train id has been extracted from the vessel name. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A train ID has been extracted from the vessel name
- Applied to: Call GCCUTRIO Database Lookup
- Action: The system initiates train lookup
Logic Flow:
IF A train ID has been extracted from the vessel name
AND The system initiates train lookup
THEN:
- • GCCUTRIO database lookup is called to search for train information
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when database lookup has been performed for a train id.
Trigger Criteria:
- Context: A database lookup has been performed for a train ID
- Applied to: Train Found in System?
- Action: The lookup results are evaluated
Logic Flow:
IF A database lookup has been performed for a train ID
AND The lookup results are evaluated
THEN:
- • If train is found, retrieve train information; if not found, generate train not found error
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train exists in the database.
Trigger Criteria:
- Context: A train exists in the database
- Applied to: Retrieve Train Information
- Action: Train lookup is successful
Logic Flow:
IF A train exists in the database
AND Train lookup is successful
THEN:
- • Complete train information is retrieved from the database
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train information has been retrieved from the database.
Trigger Criteria:
- Context: Train information has been retrieved from the database
- Applied to: Is CPRS Train?
- Action: The system evaluates train type
Logic Flow:
IF Train information has been retrieved from the database
AND The system evaluates train type
THEN:
- • If train is CPRS type, apply CPRS special processing;
otherwise proceed with standard processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train has been identified as cprs type.
Trigger Criteria:
- Context: A train has been identified as CPRS type
- Applied to: Apply CPRS Special Processing
- Action: CPRS special processing is triggered
Logic Flow:
IF A train has been identified as CPRS type
AND CPRS special processing is triggered
THEN:
- • CPRS-specific business rules and processing logic are applied to the train
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train information has been successfully retrieved and processed.
Trigger Criteria:
- Context: Train information has been successfully retrieved and processed
- Applied to: Set Train Found Flag
- Action: Train processing is completed
Logic Flow:
IF Train information has been successfully retrieved and processed
AND Train processing is completed
THEN:
- • Train found flag is set to indicate successful train identification
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when train id does not exist in the database.
Trigger Criteria:
- Context: A train ID does not exist in the database
- Applied to: Generate Train Not Found Error
- Action: Train lookup fails
Logic Flow:
IF A train ID does not exist in the database
AND Train lookup fails
THEN:
- • A train not found error is generated for error handling
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train not found error has been generated.
Trigger Criteria:
- Context: A train not found error has been generated
- Applied to: Create Merlin Error Message
- Action: Error message creation is triggered
Logic Flow:
IF A train not found error has been generated
AND Error message creation is triggered
THEN:
- • A Merlin error message is created to notify relevant parties of the train lookup failure
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train not found error has occurred and merlin message has been created.
Trigger Criteria:
- Context: A train not found error has occurred and Merlin message has been created
- Applied to: Set Train Error Flag
- Action: Error flag setting is processed
Logic Flow:
IF A train not found error has occurred and Merlin message has been created
AND Error flag setting is processed
THEN:
- • Train error flag is set to indicate train lookup failure
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when train lookup processing has completed (either successfully or with error).
Trigger Criteria:
- Context: Train lookup processing has completed (either successfully or with error)
- Applied to: Continue Processing
- Action: Train lookup phase is finished
Logic Flow:
IF Train lookup processing has completed (either successfully or with error)
AND Train lookup phase is finished
THEN:
- • System continues with the next phase of message processing
R-GCX016E-cbl-02885 (+13) File: GCX016E.cbl Business Rule: Bond Number Database Search
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when incoming message contains bond number information.
Trigger Criteria:
- Context: An incoming message contains bond number information
- Applied to: Extract Bond Number from Message
- Action: The system processes the message to extract the bond number
Logic Flow:
IF An incoming message contains bond number information
AND The system processes the message to extract the bond number
THEN:
- • The bond number is extracted and validated for proper format
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when bond number has been extracted from the message.
Trigger Criteria:
- Context: A bond number has been extracted from the message
- Applied to: Bond Number Valid?
- Action: The system validates the bond number format
Logic Flow:
IF A bond number has been extracted from the message
AND The system validates the bond number format
THEN:
- • The bond number is accepted if it meets format requirements,
otherwise processing is terminated with error
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid bond number has been extracted and validated.
Trigger Criteria:
- Context: A valid bond number has been extracted and validated
- Applied to: Set Bond Number as Search Key
- Action: The system prepares to search for cargo records
Logic Flow:
IF A valid bond number has been extracted and validated
AND The system prepares to search for cargo records
THEN:
- • The bond number is set as the primary search key for database operations
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when bond number search key has been established. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A bond number search key has been established
- Applied to: Call Database Lookup - GCCUSIO2
- Action: The system needs to retrieve cargo records for the bond
Logic Flow:
IF A bond number search key has been established
AND The system needs to retrieve cargo records for the bond
THEN:
- • The GCCUSIO2 database service is called to perform the lookup operation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when database lookup has been initiated for a specific bond number.
Trigger Criteria:
- Context: Database lookup has been initiated for a specific bond number
- Applied to: Retrieve First Cargo Record
- Action: The system processes the database response
Logic Flow:
IF Database lookup has been initiated for a specific bond number
AND The system processes the database response
THEN:
- • The first cargo record associated with the bond number is retrieved for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when database lookup has been performed for a bond number.
Trigger Criteria:
- Context: A database lookup has been performed for a bond number
- Applied to: Record Found?
- Action: The system checks the lookup results
Logic Flow:
IF A database lookup has been performed for a bond number
AND The system checks the lookup results
THEN:
- • Processing continues if records are found,
otherwise a bond not found error is generated
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record has been retrieved from the database.
Trigger Criteria:
- Context: A cargo record has been retrieved from the database
- Applied to: Validate Status Code
- Action: The system examines the cargo record status code
Logic Flow:
IF A cargo record has been retrieved from the database
AND The system examines the cargo record status code
THEN:
- • The record is validated to ensure it has an acceptable status for bond processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record status code has been validated.
Trigger Criteria:
- Context: A cargo record status code has been validated
- Applied to: Status Code Valid?
- Action: The system evaluates the status code against business rules
Logic Flow:
IF A cargo record status code has been validated
AND The system evaluates the status code against business rules
THEN:
- • The record is accepted for processing if status is valid,
otherwise it is skipped
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record has passed status code validation.
Trigger Criteria:
- Context: A cargo record has passed status code validation
- Applied to: Store Cargo Record
- Action: The system processes the valid record
Logic Flow:
IF A cargo record has passed status code validation
AND The system processes the valid record
THEN:
- • The cargo record is stored in the processing collection for bond operations
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when at least one cargo record has been found for a bond number.
Trigger Criteria:
- Context: At least one cargo record has been found for a bond number
- Applied to: Get Next Cargo Record with Same Bond
- Action: The system searches for additional records with the same bond
Logic Flow:
IF At least one cargo record has been found for a bond number
AND The system searches for additional records with the same bond
THEN:
- • All remaining cargo records associated with the bond number are retrieved sequentially
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when system is retrieving cargo records for a bond number.
Trigger Criteria:
- Context: The system is retrieving cargo records for a bond number
- Applied to: More Records?
- Action: Each record retrieval operation completes
Logic Flow:
IF The system is retrieving cargo records for a bond number
AND Each record retrieval operation completes
THEN:
- • Processing continues if more records exist,
otherwise the bond collection is considered complete
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all cargo records for a bond number have been collected and validated.
Trigger Criteria:
- Context: All cargo records for a bond number have been collected and validated
- Applied to: Process All Bond Cargo Records
- Action: The system completes the bond record collection process
Logic Flow:
IF All cargo records for a bond number have been collected and validated
AND The system completes the bond record collection process
THEN:
- • All valid cargo records in the bond collection are processed according to business rules
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when bond number search has been performed.
Trigger Criteria:
- Context: A bond number search has been performed
- Applied to: Generate Bond Not Found Error
- Action: No valid cargo records are found for the bond number
Logic Flow:
IF A bond number search has been performed
AND No valid cargo records are found for the bond number
THEN:
- • A bond not found error is generated and appropriate error handling is initiated
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record has been retrieved but has an invalid status code.
Trigger Criteria:
- Context: A cargo record has been retrieved but has an invalid status code
- Applied to: Skip Invalid Status Record
- Action: The system evaluates the record for processing eligibility
Logic Flow:
IF A cargo record has been retrieved but has an invalid status code
AND The system evaluates the record for processing eligibility
THEN:
- • The record is skipped and the system continues to search for additional valid records
R-GCX016E-cbl-02899 (+16) File: GCX016E.cbl Business Rule: Car/Waybill Database Search
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when x4 segment contains equipment and waybill information.
Trigger Criteria:
- Context: An X4 segment contains equipment and waybill information
- Applied to: Extract Car ID and Waybill from X4 Segment
- Action: The system processes the X4 segment for car/waybill search
Logic Flow:
IF An X4 segment contains equipment and waybill information
AND The system processes the X4 segment for car/waybill search
THEN:
- • Car ID and waybill number are extracted and prepared for database search
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when raw car id has been extracted from the x4 segment.
Trigger Criteria:
- Context: A raw car ID has been extracted from the X4 segment
- Applied to: Format Car ID Using Standard Rules
- Action: The system prepares the car ID for database search
Logic Flow:
IF A raw car ID has been extracted from the X4 segment
AND The system prepares the car ID for database search
THEN:
- • Car ID is formatted according to standard business formatting rules for consistent lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when formatted car id and waybill number are available for search.
Trigger Criteria:
- Context: A formatted car ID and waybill number are available for search
- Applied to: Search Cargo Database by Car/Waybill Index
- Action: The system searches the cargo database
Logic Flow:
IF A formatted car ID and waybill number are available for search
AND The system searches the cargo database
THEN:
- • Database is searched using car/waybill index to locate existing cargo records
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when database search has been performed using car id and waybill.
Trigger Criteria:
- Context: A database search has been performed using car ID and waybill
- Applied to: Cargo Found?
- Action: The system evaluates the search results
Logic Flow:
IF A database search has been performed using car ID and waybill
AND The system evaluates the search results
THEN:
- • System determines if cargo records exist and routes processing accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo records exist for the car id and waybill combination.
Trigger Criteria:
- Context: Cargo records exist for the car ID and waybill combination
- Applied to: Retrieve First Cargo Record
- Action: The system needs to process the cargo
Logic Flow:
IF Cargo records exist for the car ID and waybill combination
AND The system needs to process the cargo
THEN:
- • The first cargo record is retrieved and prepared for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when first cargo record has been retrieved for a car id and waybill.
Trigger Criteria:
- Context: A first cargo record has been retrieved for a car ID and waybill
- Applied to: Check for Additional Records with Same Car/Waybill
- Action: The system checks for additional records
Logic Flow:
IF A first cargo record has been retrieved for a car ID and waybill
AND The system checks for additional records
THEN:
- • All cargo records with the same car ID and waybill are identified for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when no existing cargo records are found for the car id and waybill.
Trigger Criteria:
- Context: No existing cargo records are found for the car ID and waybill
- Applied to: CPRS Traffic?
- Action: The system evaluates the traffic type
Logic Flow:
IF No existing cargo records are found for the car ID and waybill
AND The system evaluates the traffic type
THEN:
- • System determines if this is CPRS traffic requiring special processing rules
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when traffic has been identified as cprs type.
Trigger Criteria:
- Context: Traffic has been identified as CPRS type
- Applied to: Handle CPRS Special Processing
- Action: The system processes CPRS cargo
Logic Flow:
IF Traffic has been identified as CPRS type
AND The system processes CPRS cargo
THEN:
- • Special CPRS business rules are applied including carrier validation and record creation logic
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cprs traffic is being processed.
Trigger Criteria:
- Context: CPRS traffic is being processed
- Applied to: Check SCAC Unknown Scenarios
- Action: The system validates the carrier information
Logic Flow:
IF CPRS traffic is being processed
AND The system validates the carrier information
THEN:
- • SCAC is validated against carrier database and unknown scenarios are handled appropriately
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cprs cargo requires key renumbering due to scac validation results.
Trigger Criteria:
- Context: CPRS cargo requires key renumbering due to SCAC validation results
- Applied to: Perform US-CCN Key Renumbering
- Action: The system processes the CCN key
Logic Flow:
IF CPRS cargo requires key renumbering due to SCAC validation results
AND The system processes the CCN key
THEN:
- • US-CCN key is renumbered according to CPRS business rules to ensure unique identification
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when no existing cargo records were found and traffic type has been determined.
Trigger Criteria:
- Context: No existing cargo records were found and traffic type has been determined
- Applied to: Create New Record?
- Action: The system evaluates record creation requirements
Logic Flow:
IF No existing cargo records were found and traffic type has been determined
AND The system evaluates record creation requirements
THEN:
- • System determines if a new cargo record should be created based on business rules
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when new record is required for cprs traffic.
Trigger Criteria:
- Context: A new record is required for CPRS traffic
- Applied to: Create New CPRS Cargo Record
- Action: The system creates the cargo record
Logic Flow:
IF A new record is required for CPRS traffic
AND The system creates the cargo record
THEN:
- • New CPRS cargo record is created with CPRS-specific business attributes and processing rules
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when new record is required for non-cprs foreign traffic.
Trigger Criteria:
- Context: A new record is required for non-CPRS foreign traffic
- Applied to: Create New Foreign Cargo Record
- Action: The system creates the cargo record
Logic Flow:
IF A new record is required for non-CPRS foreign traffic
AND The system creates the cargo record
THEN:
- • New foreign cargo record is created with standard business attributes and processing rules
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when new cargo record has been created.
Trigger Criteria:
- Context: A new cargo record has been created
- Applied to: Initialize New Record with X4/N7 Data
- Action: The system initializes the record with segment data
Logic Flow:
IF A new cargo record has been created
AND The system initializes the record with segment data
THEN:
- • Record is populated with disposition codes from X4 segment and equipment data from N7 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when new cargo record has been created and initialized with segment data.
Trigger Criteria:
- Context: A new cargo record has been created and initialized with segment data
- Applied to: Insert New Record into Database
- Action: The system saves the record
Logic Flow:
IF A new cargo record has been created and initialized with segment data
AND The system saves the record
THEN:
- • New cargo record is inserted into the cargo database and becomes available for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when new cargo record has been successfully inserted into the database.
Trigger Criteria:
- Context: A new cargo record has been successfully inserted into the database
- Applied to: Log Cargo Creation Action
- Action: The system completes the creation process
Logic Flow:
IF A new cargo record has been successfully inserted into the database
AND The system completes the creation process
THEN:
- • Cargo creation action is logged with relevant business details for audit and tracking purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record has been found or created through the search process.
Trigger Criteria:
- Context: A cargo record has been found or created through the search process
- Applied to: Return Cargo Record for Processing
- Action: The system completes the car/waybill database search
Logic Flow:
IF A cargo record has been found or created through the search process
AND The system completes the car/waybill database search
THEN:
- • Cargo record is returned to the calling process for disposition code processing and status updates
R-GCX016E-cbl-02916 (+5) File: GCX016E.cbl Business Rule: Disposition Code Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code is received for processing.
Trigger Criteria:
- Context: A disposition code is received for processing
- Applied to: Disposition Code Table Lookup
- Action: The system looks up the disposition code in the GCSTBRT disposition code table
Logic Flow:
IF A disposition code is received for processing
AND The system looks up the disposition code in the GCSTBRT disposition code table
THEN:
- • If the code is not found in the table, generate a Merlin error message and stop processing for this code
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid disposition code needs to be added to the cargo status array.
Trigger Criteria:
- Context: A valid disposition code needs to be added to the cargo status array
- Applied to: Duplicate Disposition Code Detection
- Action: The system searches the existing S09A status array for the same disposition code with matching entry number and quantity
Logic Flow:
IF A valid disposition code needs to be added to the cargo status array
AND The system searches the existing S09A status array for the same disposition code with matching entry number and quantity
THEN:
- • If an exact duplicate is found, skip processing and do not add the code again
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code has counterpart codes defined in the disposition code table.
Trigger Criteria:
- Context: A disposition code has counterpart codes defined in the disposition code table
- Applied to: Counterpart Disposition Code Removal
- Action: The system processes the new disposition code for addition to the status array
Logic Flow:
IF A disposition code has counterpart codes defined in the disposition code table
AND The system processes the new disposition code for addition to the status array
THEN:
- • Remove all existing counterpart disposition codes from the status array before adding the new code
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when validated disposition code needs to be added to the cargo status array.
Trigger Criteria:
- Context: A validated disposition code needs to be added to the cargo status array
- Applied to: Status Array Management and Processing
- Action: The system processes the code insertion into the S09A status array
Logic Flow:
IF A validated disposition code needs to be added to the cargo status array
AND The system processes the code insertion into the S09A status array
THEN:
- • Insert the new disposition code with its associated data (entry number, quantity, date/time) into the next available array position
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition codes have been added or removed from the status array.
Trigger Criteria:
- Context: Disposition codes have been added or removed from the status array
- Applied to: Status Array Management and Processing
- Action: The system completes the array modification operations
Logic Flow:
IF Disposition codes have been added or removed from the status array
AND The system completes the array modification operations
THEN:
- • Reorganize the status array sequence numbers to maintain consecutive numbering and update the total count of active status codes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when status array has been modified with additions or removals of disposition codes.
Trigger Criteria:
- Context: The status array has been modified with additions or removals of disposition codes
- Applied to: Status Array Management and Processing
- Action: The system completes all array operations
Logic Flow:
IF The status array has been modified with additions or removals of disposition codes
AND The system completes all array operations
THEN:
- • Update the status array counter to reflect the current number of active disposition codes in the array
R-GCX016E-cbl-02922 (+31) File: GCX016E.cbl Business Rule: Cargo Status Evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record exists in the system.
Trigger Criteria:
- Context: A cargo record exists in the system
- Applied to: Retrieve Current Cargo Status
- Action: The system needs to evaluate cargo status
Logic Flow:
IF A cargo record exists in the system
AND The system needs to evaluate cargo status
THEN:
- • The current cargo status, hold flags, release quantities, and processing flags are retrieved from the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has s09a status arrays with disposition codes.
Trigger Criteria:
- Context: A cargo has S09A status arrays with disposition codes
- Applied to: Analyze S09A Status Arrays
- Action: The system evaluates cargo status
Logic Flow:
IF A cargo has S09A status arrays with disposition codes
AND The system evaluates cargo status
THEN:
- • All disposition codes in the status arrays are analyzed for hold conditions, release conditions, and quantity impacts
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo with status arrays containing disposition codes.
Trigger Criteria:
- Context: A cargo with status arrays containing disposition codes
- Applied to: Hold Conditions Present?
- Action: The system checks for hold conditions
Logic Flow:
IF A cargo with status arrays containing disposition codes
AND The system checks for hold conditions
THEN:
- • The system identifies if border holds, destination holds, FDA holds, or piece count holds are active
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo with disposition codes in status arrays.
Trigger Criteria:
- Context: A cargo with disposition codes in status arrays
- Applied to: Check Border Hold Status
- Action: The system evaluates border hold conditions
Logic Flow:
IF A cargo with disposition codes in status arrays
AND The system evaluates border hold conditions
THEN:
- • The system determines if cargo is held at border based on specific disposition codes and location information
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo with disposition codes and destination information.
Trigger Criteria:
- Context: A cargo with disposition codes and destination information
- Applied to: Check Destination Hold Status
- Action: The system evaluates destination hold conditions
Logic Flow:
IF A cargo with disposition codes and destination information
AND The system evaluates destination hold conditions
THEN:
- • The system determines if cargo is held at destination based on disposition codes and destination location
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo with disposition codes that may include fda-related holds.
Trigger Criteria:
- Context: A cargo with disposition codes that may include FDA-related holds
- Applied to: Check FDA Hold Status
- Action: The system evaluates FDA hold conditions
Logic Flow:
IF A cargo with disposition codes that may include FDA-related holds
AND The system evaluates FDA hold conditions
THEN:
- • The system determines if cargo requires FDA clearance and sets HOLDFDA status if applicable
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo with quantity information and release history.
Trigger Criteria:
- Context: A cargo with quantity information and release history
- Applied to: Check Piece Count Hold Status
- Action: The system evaluates piece count hold conditions
Logic Flow:
IF A cargo with quantity information and release history
AND The system evaluates piece count hold conditions
THEN:
- • The system determines if cargo has piece count holds based on quantity discrepancies or partial release conditions
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo with disposition codes that may include manual release codes.
Trigger Criteria:
- Context: A cargo with disposition codes that may include manual release codes
- Applied to: Check Manual Release Status
- Action: The system checks for manual release authorization
Logic Flow:
IF A cargo with disposition codes that may include manual release codes
AND The system checks for manual release authorization
THEN:
- • The system identifies if manual release (MRL) disposition codes are present and takes precedence over other status conditions
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo with analyzed hold and release conditions.
Trigger Criteria:
- Context: A cargo with analyzed hold and release conditions
- Applied to: Release Conditions Met?
- Action: The system evaluates overall release eligibility
Logic Flow:
IF A cargo with analyzed hold and release conditions
AND The system evaluates overall release eligibility
THEN:
- • The system determines if cargo can be released based on absence of active holds and presence of valid release authorization
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo with disposition codes containing quantity information.
Trigger Criteria:
- Context: A cargo with disposition codes containing quantity information
- Applied to: Calculate Release Quantities
- Action: The system calculates release quantities
Logic Flow:
IF A cargo with disposition codes containing quantity information
AND The system calculates release quantities
THEN:
- • The system computes total cargo quantity, currently released quantity, remaining hold quantity, and validates quantity consistency across all disposition codes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo with analyzed status and release conditions.
Trigger Criteria:
- Context: A cargo with analyzed status and release conditions
- Applied to: Evaluate Proceed Conditions
- Action: The system evaluates proceed eligibility
Logic Flow:
IF A cargo with analyzed status and release conditions
AND The system evaluates proceed eligibility
THEN:
- • The system determines if cargo can proceed based on release status, hold conditions, and processing requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo with entry type information.
Trigger Criteria:
- Context: A cargo with entry type information
- Applied to: In-Bond Entry?
- Action: The system checks for in-bond entry classification
Logic Flow:
IF A cargo with entry type information
AND The system checks for in-bond entry classification
THEN:
- • The system identifies if cargo has entry types 61, 62, 63, or 69 indicating in-bond processing requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo identified as in-bond entry type.
Trigger Criteria:
- Context: A cargo identified as in-bond entry type
- Applied to: Process In-Bond Logic
- Action: The system processes in-bond logic
Logic Flow:
IF A cargo identified as in-bond entry type
AND The system processes in-bond logic
THEN:
- • The system sets in-bond information, updates broker details, handles bond numbers, and applies Canadian border crossing vessel swap rules if applicable
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo requiring in-bond processing.
Trigger Criteria:
- Context: A cargo requiring in-bond processing
- Applied to: Set Master In-Bond Flags
- Action: The system sets master in-bond flags
Logic Flow:
IF A cargo requiring in-bond processing
AND The system sets master in-bond flags
THEN:
- • The system establishes master-level in-bond indicators that control downstream processing and reporting
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo with disposition codes and location information.
Trigger Criteria:
- Context: A cargo with disposition codes and location information
- Applied to: Arrival Status Required?
- Action: The system evaluates arrival status requirements
Logic Flow:
IF A cargo with disposition codes and location information
AND The system evaluates arrival status requirements
THEN:
- • The system determines if cargo needs arrival status based on disposition codes indicating arrival events (POD, AAD) or arrival-related processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo requiring arrival status with location information.
Trigger Criteria:
- Context: A cargo requiring arrival status with location information
- Applied to: Validate Arrival Location
- Action: The system validates arrival location
Logic Flow:
IF A cargo requiring arrival status with location information
AND The system validates arrival location
THEN:
- • The system confirms the arrival location is valid and matches expected destination or border crossing points
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo with validated arrival location.
Trigger Criteria:
- Context: A cargo with validated arrival location
- Applied to: Set Arrival Status Flags
- Action: The system sets arrival status flags
Logic Flow:
IF A cargo with validated arrival location
AND The system sets arrival status flags
THEN:
- • The system sets arrival status flags, updates arrival dates, and establishes arrival processing indicators
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo with disposition codes and processing history.
Trigger Criteria:
- Context: A cargo with disposition codes and processing history
- Applied to: Export Status Required?
- Action: The system evaluates export status requirements
Logic Flow:
IF A cargo with disposition codes and processing history
AND The system evaluates export status requirements
THEN:
- • The system determines if cargo needs export status based on disposition codes or processing flags indicating export operations
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo requiring export status with location information.
Trigger Criteria:
- Context: A cargo requiring export status with location information
- Applied to: Validate Export Location
- Action: The system validates export location
Logic Flow:
IF A cargo requiring export status with location information
AND The system validates export location
THEN:
- • The system confirms the export location is valid and appropriate for export processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo with validated export location.
Trigger Criteria:
- Context: A cargo with validated export location
- Applied to: Set Export Status Flags
- Action: The system sets export status flags
Logic Flow:
IF A cargo with validated export location
AND The system sets export status flags
THEN:
- • The system sets export status flags, clears destination index, and establishes export processing indicators
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo with analyzed hold conditions, release conditions, and processing flags.
Trigger Criteria:
- Context: A cargo with analyzed hold conditions, release conditions, and processing flags
- Applied to: Determine Final Cargo Status
- Action: The system determines final cargo status
Logic Flow:
IF A cargo with analyzed hold conditions, release conditions, and processing flags
AND The system determines final cargo status
THEN:
- • The system applies status hierarchy: Manual Release → Released, FDA Hold → HOLDFDA, PTT conditions → PTT/PTT-EX, Hold combinations → various hold statuses, Release with quantity → RELSD/HOLDPCS, Export/Arrival → respective status, Default → ACK/PROCEED
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo with newly determined status and previous status information.
Trigger Criteria:
- Context: A cargo with newly determined status and previous status information
- Applied to: Status Changed?
- Action: The system checks for status changes
Logic Flow:
IF A cargo with newly determined status and previous status information
AND The system checks for status changes
THEN:
- • The system compares the new status with the previous status to determine if a change has occurred
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo with changed status.
Trigger Criteria:
- Context: A cargo with changed status
- Applied to: Preserve Previous Status for Audit
- Action: The system preserves previous status for audit
Logic Flow:
IF A cargo with changed status
AND The system preserves previous status for audit
THEN:
- • The system saves the previous status information for audit trail and compliance tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo with determined final status.
Trigger Criteria:
- Context: A cargo with determined final status
- Applied to: Update Cargo Status Flags
- Action: The system updates cargo status flags
Logic Flow:
IF A cargo with determined final status
AND The system updates cargo status flags
THEN:
- • The system updates all cargo status flags, processing indicators, and related status information in the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo with arrival date or initial processing date.
Trigger Criteria:
- Context: A cargo with arrival date or initial processing date
- Applied to: Calculate Cargo Age
- Action: The system calculates cargo age
Logic Flow:
IF A cargo with arrival date or initial processing date
AND The system calculates cargo age
THEN:
- • The system computes the number of days since cargo arrival or initial processing for aging analysis and reporting
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo with updated status information.
Trigger Criteria:
- Context: A cargo with updated status information
- Applied to: Generate Status Notifications
- Action: The system generates status notifications
Logic Flow:
IF A cargo with updated status information
AND The system generates status notifications
THEN:
- • The system creates Merlin messages, email notifications, or system alerts based on the status change and notification requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo with analyzed hold conditions.
Trigger Criteria:
- Context: A cargo with analyzed hold conditions
- Applied to: All Holds Released?
- Action: The system checks if all holds are released
Logic Flow:
IF A cargo with analyzed hold conditions
AND The system checks if all holds are released
THEN:
- • The system determines if no active hold conditions remain (no border holds, destination holds, FDA holds, or piece count holds)
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo with calculated release quantities and remaining holds.
Trigger Criteria:
- Context: A cargo with calculated release quantities and remaining holds
- Applied to: Partial Release?
- Action: The system checks for partial release status
Logic Flow:
IF A cargo with calculated release quantities and remaining holds
AND The system checks for partial release status
THEN:
- • The system determines if some cargo quantity has been released while other quantities remain held
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo with active hold conditions and no partial releases.
Trigger Criteria:
- Context: A cargo with active hold conditions and no partial releases
- Applied to: Full Hold Status?
- Action: The system checks for full hold status
Logic Flow:
IF A cargo with active hold conditions and no partial releases
AND The system checks for full hold status
THEN:
- • The system determines if the entire cargo quantity is held with no released portions
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo with all holds released and no remaining hold conditions.
Trigger Criteria:
- Context: A cargo with all holds released and no remaining hold conditions
- Applied to: Set RELEASED Status
- Action: The system sets released status
Logic Flow:
IF A cargo with all holds released and no remaining hold conditions
AND The system sets released status
THEN:
- • The system assigns RELEASED status and updates all related release flags and processing indicators
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo with partial quantity released and remaining holds.
Trigger Criteria:
- Context: A cargo with partial quantity released and remaining holds
- Applied to: Set PARTIAL RELEASE Status
- Action: The system sets partial release status
Logic Flow:
IF A cargo with partial quantity released and remaining holds
AND The system sets partial release status
THEN:
- • The system assigns HOLDPCS or similar partial release status indicating mixed release/hold condition
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo with active hold conditions and no releases.
Trigger Criteria:
- Context: A cargo with active hold conditions and no releases
- Applied to: Set HOLD Status
- Action: The system sets hold status
Logic Flow:
IF A cargo with active hold conditions and no releases
AND The system sets hold status
THEN:
- • The system assigns appropriate hold status (HOLD, HOLD-B for border, HOLD-D for destination, HOLDFDA for FDA) based on the type and location of holds
R-GCX016E-cbl-02954 (+12) File: GCX016E.cbl Business Rule: Status Array Population
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record exists in the system.
Trigger Criteria:
- Context: A cargo record exists in the system
- Applied to: Retrieve S09 Status Segments from Database
- Action: The system needs to process cargo status information
Logic Flow:
IF A cargo record exists in the system
AND The system needs to process cargo status information
THEN:
- • The system retrieves all S09 status segments from the GCSUSS09 database for the cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when system has attempted to retrieve s09 status segments from database.
Trigger Criteria:
- Context: The system has attempted to retrieve S09 status segments from database
- Applied to: Database Segments Found?
- Action: The database query completes
Logic Flow:
IF The system has attempted to retrieve S09 status segments from database
AND The database query completes
THEN:
- • The system determines if any status segments were found and branches processing accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when status segments exist in the database for the cargo.
Trigger Criteria:
- Context: Status segments exist in the database for the cargo
- Applied to: Initialize S09A Status Array
- Action: The system begins status array population
Logic Flow:
IF Status segments exist in the database for the cargo
AND The system begins status array population
THEN:
- • The system initializes the S09A status array structure to receive the segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when no status segments exist in the database for the cargo.
Trigger Criteria:
- Context: No status segments exist in the database for the cargo
- Applied to: Initialize Empty Status Array
- Action: The system needs to create a status array
Logic Flow:
IF No status segments exist in the database for the cargo
AND The system needs to create a status array
THEN:
- • The system initializes an empty S09A status array structure
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status segment exists in the database.
Trigger Criteria:
- Context: A status segment exists in the database
- Applied to: Convert Database Segment to Array Format
- Action: The system processes the segment for array population
Logic Flow:
IF A status segment exists in the database
AND The system processes the segment for array population
THEN:
- • The system converts the database segment format into the S09A array entry format
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status segments are being processed from the database.
Trigger Criteria:
- Context: Status segments are being processed from the database
- Applied to: Track Maximum Sequence Number
- Action: Each segment is converted to array format
Logic Flow:
IF Status segments are being processed from the database
AND Each segment is converted to array format
THEN:
- • The system tracks and updates the maximum sequence number encountered
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when database status segment contains a disposition code.
Trigger Criteria:
- Context: A database status segment contains a disposition code
- Applied to: Populate Array Entry with Disposition Code
- Action: The segment is being converted to array format
Logic Flow:
IF A database status segment contains a disposition code
AND The segment is being converted to array format
THEN:
- • The system populates the disposition code field in the corresponding array entry
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when database status segment contains date and time information.
Trigger Criteria:
- Context: A database status segment contains date and time information
- Applied to: Populate Array Entry with Date/Time
- Action: The segment is being converted to array format
Logic Flow:
IF A database status segment contains date and time information
AND The segment is being converted to array format
THEN:
- • The system populates the date and time fields in the corresponding array entry
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when database status segment contains location code information.
Trigger Criteria:
- Context: A database status segment contains location code information
- Applied to: Populate Array Entry with Location Code
- Action: The segment is being converted to array format
Logic Flow:
IF A database status segment contains location code information
AND The segment is being converted to array format
THEN:
- • The system populates the location code field in the corresponding array entry
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when database status segment contains quantity information.
Trigger Criteria:
- Context: A database status segment contains quantity information
- Applied to: Populate Array Entry with Quantity Information
- Action: The segment is being converted to array format
Logic Flow:
IF A database status segment contains quantity information
AND The segment is being converted to array format
THEN:
- • The system populates the quantity fields in the corresponding array entry
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when system has processed one or more status segments.
Trigger Criteria:
- Context: The system has processed one or more status segments
- Applied to: More Database Segments?
- Action: A segment conversion is complete
Logic Flow:
IF The system has processed one or more status segments
AND A segment conversion is complete
THEN:
- • The system checks if additional segments remain in the database for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status segment has been successfully converted and stored in the array.
Trigger Criteria:
- Context: A status segment has been successfully converted and stored in the array
- Applied to: Increment Array Index
- Action: Additional segments remain to be processed
Logic Flow:
IF A status segment has been successfully converted and stored in the array
AND Additional segments remain to be processed
THEN:
- • The system increments the array index to the next available position
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all status segments have been processed from the database.
Trigger Criteria:
- Context: All status segments have been processed from the database
- Applied to: Update Maximum Sequences Fetched Counter
- Action: The segment processing loop completes
Logic Flow:
IF All status segments have been processed from the database
AND The segment processing loop completes
THEN:
- • The system updates the maximum sequences fetched counter with the total number of segments processed
R-GCX016E-cbl-02967 (+20) File: GCX016E.cbl Business Rule: Status Array Database Conversion
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status array conversion process is starting.
Trigger Criteria:
- Context: Status array conversion process is starting
- Applied to: Initialize Database Segment Counter
- Action: The conversion initialization is triggered
Logic Flow:
IF Status array conversion process is starting
AND The conversion initialization is triggered
THEN:
- • Database segment counter is set to zero and work areas are cleared
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when database conversion process is active.
Trigger Criteria:
- Context: Database conversion process is active
- Applied to: Clear Database Segment Work Area
- Action: A new database segment needs to be prepared
Logic Flow:
IF Database conversion process is active
AND A new database segment needs to be prepared
THEN:
- • The database segment work area is cleared of all previous data
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status array conversion is in progress.
Trigger Criteria:
- Context: Status array conversion is in progress
- Applied to: More Status Array Entries?
- Action: System checks for remaining entries to process
Logic Flow:
IF Status array conversion is in progress
AND System checks for remaining entries to process
THEN:
- • Continue processing if entries exist,
otherwise complete conversion
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status array has remaining entries to process.
Trigger Criteria:
- Context: Status array has remaining entries to process
- Applied to: Get Next Status Array Entry
- Action: Next entry retrieval is requested
Logic Flow:
IF Status array has remaining entries to process
AND Next entry retrieval is requested
THEN:
- • The next status array entry is loaded for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status array entry with disposition code is being processed.
Trigger Criteria:
- Context: A status array entry with disposition code is being processed
- Applied to: Validate Disposition Code Format
- Action: Disposition code format validation is performed
Logic Flow:
IF A status array entry with disposition code is being processed
AND Disposition code format validation is performed
THEN:
- • Disposition code is checked against valid format criteria
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code format validation has been performed.
Trigger Criteria:
- Context: Disposition code format validation has been performed
- Applied to: Disposition Code Valid?
- Action: Validity determination is made
Logic Flow:
IF Disposition code format validation has been performed
AND Validity determination is made
THEN:
- • Valid codes proceed to formatting, invalid codes are skipped
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid disposition code exists in the status array entry.
Trigger Criteria:
- Context: A valid disposition code exists in the status array entry
- Applied to: Format Disposition Code for Database
- Action: Database formatting is applied
Logic Flow:
IF A valid disposition code exists in the status array entry
AND Database formatting is applied
THEN:
- • Disposition code is converted to proper database storage format
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status array entry contains date and time information.
Trigger Criteria:
- Context: Status array entry contains date and time information
- Applied to: Format Date/Time Information
- Action: Date/time formatting is applied
Logic Flow:
IF Status array entry contains date and time information
AND Date/time formatting is applied
THEN:
- • Date and time data is converted to database storage format
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when status array entry contains status information codes.
Trigger Criteria:
- Context: Status array entry contains status information codes
- Applied to: Format Status Information Code
- Action: Status code formatting is applied
Logic Flow:
IF Status array entry contains status information codes
AND Status code formatting is applied
THEN:
- • Status information is converted to database-compatible format
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status array entry contains quantity information.
Trigger Criteria:
- Context: Status array entry contains quantity information
- Applied to: Format Quantity Information
- Action: Quantity formatting is applied
Logic Flow:
IF Status array entry contains quantity information
AND Quantity formatting is applied
THEN:
- • Quantity data is converted to proper database storage format
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all data elements have been formatted for database storage.
Trigger Criteria:
- Context: All data elements have been formatted for database storage
- Applied to: Move Formatted Data to Database Segment
- Action: Data transfer to database segment is executed
Logic Flow:
IF All data elements have been formatted for database storage
AND Data transfer to database segment is executed
THEN:
- • Formatted data is moved to the database segment work area
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when data has been successfully moved to database segment.
Trigger Criteria:
- Context: Data has been successfully moved to database segment
- Applied to: Increment Database Segment Counter
- Action: Counter increment is performed
Logic Flow:
IF Data has been successfully moved to database segment
AND Counter increment is performed
THEN:
- • Database segment counter is increased by one
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when database segment has received new data entry.
Trigger Criteria:
- Context: Database segment has received new data entry
- Applied to: Segment Full or Array Complete?
- Action: Segment status evaluation is performed
Logic Flow:
IF Database segment has received new data entry
AND Segment status evaluation is performed
THEN:
- • Continue adding entries if segment has space and array has entries,
otherwise complete segment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when database segment is full or all array entries are processed.
Trigger Criteria:
- Context: Database segment is full or all array entries are processed
- Applied to: Prepare Database Segment for Storage
- Action: Segment preparation is initiated
Logic Flow:
IF Database segment is full or all array entries are processed
AND Segment preparation is initiated
THEN:
- • Database segment is prepared for storage with proper formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when database segment is being prepared for storage.
Trigger Criteria:
- Context: Database segment is being prepared for storage
- Applied to: Set Segment Sequence Number
- Action: Sequence number assignment is performed
Logic Flow:
IF Database segment is being prepared for storage
AND Sequence number assignment is performed
THEN:
- • Segment receives correct sequence number for database ordering
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when database segment requires car id information.
Trigger Criteria:
- Context: Database segment requires car ID information
- Applied to: Update Car ID Information
- Action: Car ID update is performed
Logic Flow:
IF Database segment requires car ID information
AND Car ID update is performed
THEN:
- • Current car identification data is added to database segment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo type needs to be evaluated for car id processing.
Trigger Criteria:
- Context: Cargo type needs to be evaluated for car ID processing
- Applied to: Non-CPRS Cargo?
- Action: CPRS status check is performed
Logic Flow:
IF Cargo type needs to be evaluated for car ID processing
AND CPRS status check is performed
THEN:
- • Non-CPRS cargos proceed to car ID update, CPRS cargos skip car ID update
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo is confirmed as non-cprs type.
Trigger Criteria:
- Context: Cargo is confirmed as non-CPRS type
- Applied to: Update Car ID in Database Segment
- Action: Car ID database update is executed
Logic Flow:
IF Cargo is confirmed as non-CPRS type
AND Car ID database update is executed
THEN:
- • Car identification information is updated in the database segment
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when database segment has been fully prepared with all required data.
Trigger Criteria:
- Context: Database segment has been fully prepared with all required data
- Applied to: Mark Segment Ready for Database Write
- Action: Ready status marking is applied
Logic Flow:
IF Database segment has been fully prepared with all required data
AND Ready status marking is applied
THEN:
- • Segment is flagged as ready for database write operation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when current database segment processing is complete.
Trigger Criteria:
- Context: Current database segment processing is complete
- Applied to: Continue to Next Segment
- Action: Continuation to next segment is initiated
Logic Flow:
IF Current database segment processing is complete
AND Continuation to next segment is initiated
THEN:
- • System proceeds to process next segment or remaining status array entries
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all status array entries have been processed and converted.
Trigger Criteria:
- Context: All status array entries have been processed and converted
- Applied to: Log Conversion Completion
- Action: Conversion completion logging is performed
Logic Flow:
IF All status array entries have been processed and converted
AND Conversion completion logging is performed
THEN:
- • Successful conversion completion is recorded in system logs
R-GCX016E-cbl-02988 (+10) File: GCX016E.cbl Business Rule: Disposition Code Validation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is received from x4 segment processing.
Trigger Criteria:
- Context: A disposition code is received from X4 segment processing
- Applied to: Search DC Table for Disposition Code
- Action: The system performs table lookup using GCCTBIO to search the DC table for the disposition code
Logic Flow:
IF A disposition code is received from X4 segment processing
AND The system performs table lookup using GCCTBIO to search the DC table for the disposition code
THEN:
- • The system determines if the disposition code exists in the table and sets appropriate validation flags
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code has been found valid in the dc table.
Trigger Criteria:
- Context: A disposition code has been found valid in the DC table
- Applied to: Extract Processing Rules from Table
- Action: The system extracts processing rules from the table entry
Logic Flow:
IF A disposition code has been found valid in the DC table
AND The system extracts processing rules from the table entry
THEN:
- • The system retrieves action type (add/subtract), hold/release indicator, status information flag, and removal processing flag for the disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code has been successfully found in the dc table.
Trigger Criteria:
- Context: A disposition code has been successfully found in the DC table
- Applied to: Set Disposition Code Valid Flag
- Action: The system completes table lookup validation
Logic Flow:
IF A disposition code has been successfully found in the DC table
AND The system completes table lookup validation
THEN:
- • The system sets the disposition code valid flag to true to enable further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid disposition code entry exists in the dc table.
Trigger Criteria:
- Context: A valid disposition code entry exists in the DC table
- Applied to: Extract Action Type - Add/Subtract
- Action: The system extracts action type information from the table entry
Logic Flow:
IF A valid disposition code entry exists in the DC table
AND The system extracts action type information from the table entry
THEN:
- • The system identifies whether the disposition code should add to or subtract from release quantities
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid disposition code entry exists in the dc table.
Trigger Criteria:
- Context: A valid disposition code entry exists in the DC table
- Applied to: Extract Hold/Release Indicator
- Action: The system extracts hold/release indicator from the table entry
Logic Flow:
IF A valid disposition code entry exists in the DC table
AND The system extracts hold/release indicator from the table entry
THEN:
- • The system identifies whether the disposition code represents a hold or release action
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid disposition code entry exists in the dc table.
Trigger Criteria:
- Context: A valid disposition code entry exists in the DC table
- Applied to: Extract Status Information Flag
- Action: The system extracts status information flag from the table entry
Logic Flow:
IF A valid disposition code entry exists in the DC table
AND The system extracts status information flag from the table entry
THEN:
- • The system identifies whether the disposition code is informational only or requires active processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid disposition code entry exists in the dc table.
Trigger Criteria:
- Context: A valid disposition code entry exists in the DC table
- Applied to: Extract Removal Processing Flag
- Action: The system extracts removal processing flag from the table entry
Logic Flow:
IF A valid disposition code entry exists in the DC table
AND The system extracts removal processing flag from the table entry
THEN:
- • The system identifies whether existing disposition codes should be removed before processing the current code
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all processing rules have been extracted from the dc table entry.
Trigger Criteria:
- Context: All processing rules have been extracted from the DC table entry
- Applied to: Set Processing Rules in Working Storage
- Action: The system completes rule extraction process
Logic Flow:
IF All processing rules have been extracted from the DC table entry
AND The system completes rule extraction process
THEN:
- • The system stores action type, hold/release indicator, status flag, and removal flag in working storage variables
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code is not found in the dc table during lookup.
Trigger Criteria:
- Context: A disposition code is not found in the DC table during lookup
- Applied to: Generate Merlin Error Message
- Action: The system determines the disposition code is invalid
Logic Flow:
IF A disposition code is not found in the DC table during lookup
AND The system determines the disposition code is invalid
THEN:
- • The system generates an error message to the Merlin messaging system reporting the unknown disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is not found in the dc table.
Trigger Criteria:
- Context: A disposition code is not found in the DC table
- Applied to: Set Disposition Code Invalid Flag
- Action: The system completes table lookup validation with negative result
Logic Flow:
IF A disposition code is not found in the DC table
AND The system completes table lookup validation with negative result
THEN:
- • The system sets the disposition code invalid flag to prevent downstream processing of the invalid code
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code has been determined invalid and error message generated.
Trigger Criteria:
- Context: A disposition code has been determined invalid and error message generated
- Applied to: Log Unknown Disposition Code
- Action: The system processes the invalid disposition code
Logic Flow:
IF A disposition code has been determined invalid and error message generated
AND The system processes the invalid disposition code
THEN:
- • The system logs the unknown disposition code details for audit and debugging purposes
R-GCX016E-cbl-02999 (+12) File: GCX016E.cbl Business Rule: Release Quantity Calculation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record exists with release quantity information.
Trigger Criteria:
- Context: A cargo record exists with release quantity information
- Applied to: Retrieve Current Release Quantity
- Action: The system processes a disposition code that may affect quantities
Logic Flow:
IF A cargo record exists with release quantity information
AND The system processes a disposition code that may affect quantities
THEN:
- • The current release quantity is retrieved and stored for calculation purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code is being processed.
Trigger Criteria:
- Context: A disposition code is being processed
- Applied to: Get Disposition Code Action Type
- Action: The system evaluates the disposition code action requirements
Logic Flow:
IF A disposition code is being processed
AND The system evaluates the disposition code action requirements
THEN:
- • The action type is classified as Add, Subtract, or Status Info Only based on disposition code characteristics
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code with add action type is being processed.
Trigger Criteria:
- Context: A disposition code with Add action type is being processed
- Applied to: Add Quantity Action
- Action: The system determines quantity changes are required
Logic Flow:
IF A disposition code with Add action type is being processed
AND The system determines quantity changes are required
THEN:
- • The disposition code quantity is marked for addition to current release quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code with subtract action type is being processed.
Trigger Criteria:
- Context: A disposition code with Subtract action type is being processed
- Applied to: Subtract Quantity Action
- Action: The system determines quantity reduction is required
Logic Flow:
IF A disposition code with Subtract action type is being processed
AND The system determines quantity reduction is required
THEN:
- • The disposition code quantity is marked for subtraction from current release quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code with status info only action type is being processed.
Trigger Criteria:
- Context: A disposition code with Status Info Only action type is being processed
- Applied to: No Quantity Change Action
- Action: The system determines no quantity changes are required
Logic Flow:
IF A disposition code with Status Info Only action type is being processed
AND The system determines no quantity changes are required
THEN:
- • The processing completes without modifying release quantities
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when current release quantity and disposition code action are available.
Trigger Criteria:
- Context: Current release quantity and disposition code action are available
- Applied to: Calculate New Release Quantity
- Action: The system performs quantity calculation
Logic Flow:
IF Current release quantity and disposition code action are available
AND The system performs quantity calculation
THEN:
- • New release quantity is computed by adding or subtracting the disposition code quantity from current release quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when new release quantity has been calculated.
Trigger Criteria:
- Context: A new release quantity has been calculated
- Applied to: Validate Against Total Quantity
- Action: The system validates the calculated quantity
Logic Flow:
IF A new release quantity has been calculated
AND The system validates the calculated quantity
THEN:
- • The release quantity is checked against total cargo quantity for validity
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when calculated release quantity exceeds total cargo quantity.
Trigger Criteria:
- Context: Calculated release quantity exceeds total cargo quantity
- Applied to: Set Release Qty = Total Qty
- Action: The system applies quantity validation rules
Logic Flow:
IF Calculated release quantity exceeds total cargo quantity
AND The system applies quantity validation rules
THEN:
- • Release quantity is set equal to total cargo quantity
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when calculated release quantity is less than zero.
Trigger Criteria:
- Context: Calculated release quantity is less than zero
- Applied to: Set Release Qty = 0
- Action: The system applies quantity validation rules
Logic Flow:
IF Calculated release quantity is less than zero
AND The system applies quantity validation rules
THEN:
- • Release quantity is set to zero
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when validated new release quantity is available.
Trigger Criteria:
- Context: A validated new release quantity is available
- Applied to: Update Release Quantity
- Action: The system updates cargo information
Logic Flow:
IF A validated new release quantity is available
AND The system updates cargo information
THEN:
- • The cargo record release quantity is updated with the new validated amount
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when release quantity has been updated.
Trigger Criteria:
- Context: Release quantity has been updated
- Applied to: Log Quantity Change
- Action: The system completes quantity processing
Logic Flow:
IF Release quantity has been updated
AND The system completes quantity processing
THEN:
- • A log entry is created documenting the quantity change transaction
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when original and new release quantities are available.
Trigger Criteria:
- Context: Original and new release quantities are available
- Applied to: Create Before/After Comparison
- Action: The system documents quantity changes
Logic Flow:
IF Original and new release quantities are available
AND The system documents quantity changes
THEN:
- • A before and after comparison record is created showing quantity differences
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when quantity changes have been processed and documented.
Trigger Criteria:
- Context: Quantity changes have been processed and documented
- Applied to: Generate Quantity Impact Message
- Action: The system generates impact notifications
Logic Flow:
IF Quantity changes have been processed and documented
AND The system generates impact notifications
THEN:
- • A quantity impact message is created showing the effect of disposition code on release quantities
R-GCX016E-cbl-03012 (+15) File: GCX016E.cbl Business Rule: Status Condition Analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record with status array containing disposition codes.
Trigger Criteria:
- Context: A cargo record with status array containing disposition codes
- Applied to: Border Hold Present?
- Action: The system analyzes the cargo status for border hold conditions
Logic Flow:
IF A cargo record with status array containing disposition codes
AND The system analyzes the cargo status for border hold conditions
THEN:
- • The system identifies if border hold is present and sets appropriate processing flags
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record with status array and destination information.
Trigger Criteria:
- Context: A cargo record with status array and destination information
- Applied to: Destination Hold Present?
- Action: The system checks for destination-specific hold conditions
Logic Flow:
IF A cargo record with status array and destination information
AND The system checks for destination-specific hold conditions
THEN:
- • The system determines if destination hold is active and updates processing flags accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record with regulatory status information.
Trigger Criteria:
- Context: A cargo record with regulatory status information
- Applied to: FDA Hold Present?
- Action: The system checks for FDA hold conditions in the status array
Logic Flow:
IF A cargo record with regulatory status information
AND The system checks for FDA hold conditions in the status array
THEN:
- • The system identifies FDA hold presence and sets regulatory compliance flags
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record with quantity information and release data.
Trigger Criteria:
- Context: A cargo record with quantity information and release data
- Applied to: Piece Count Hold Present?
- Action: The system compares released quantities against total cargo quantities
Logic Flow:
IF A cargo record with quantity information and release data
AND The system compares released quantities against total cargo quantities
THEN:
- • The system determines if piece count hold exists and updates quantity validation flags
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record with disposition codes and release information.
Trigger Criteria:
- Context: A cargo record with disposition codes and release information
- Applied to: Manual Release Present?
- Action: The system evaluates manual release status in the disposition code array
Logic Flow:
IF A cargo record with disposition codes and release information
AND The system evaluates manual release status in the disposition code array
THEN:
- • The system identifies manual release presence and sets override processing flags
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record with disposition codes and processing status.
Trigger Criteria:
- Context: A cargo record with disposition codes and processing status
- Applied to: Proceed Code Present?
- Action: The system checks for proceed authorization in the status array
Logic Flow:
IF A cargo record with disposition codes and processing status
AND The system checks for proceed authorization in the status array
THEN:
- • The system determines proceed code presence and enables movement authorization
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record with status information and release criteria.
Trigger Criteria:
- Context: A cargo record with status information and release criteria
- Applied to: Auto Release Available?
- Action: The system evaluates automatic release eligibility conditions
Logic Flow:
IF A cargo record with status information and release criteria
AND The system evaluates automatic release eligibility conditions
THEN:
- • The system determines auto release availability and sets automated processing flags
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record with entry type and customs information.
Trigger Criteria:
- Context: A cargo record with entry type and customs information
- Applied to: In-Bond Entry?
- Action: The system evaluates entry types 61, 62, 63, or 69 for in-bond classification
Logic Flow:
IF A cargo record with entry type and customs information
AND The system evaluates entry types 61, 62, 63, or 69 for in-bond classification
THEN:
- • The system sets in-bond processing flags and enables customs movement tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record with arrival information and location data.
Trigger Criteria:
- Context: A cargo record with arrival information and location data
- Applied to: Arrival Status Valid?
- Action: The system validates arrival status against business rules and location constraints
Logic Flow:
IF A cargo record with arrival information and location data
AND The system validates arrival status against business rules and location constraints
THEN:
- • The system confirms arrival status validity and enables arrival processing workflows
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record with export information and regulatory compliance data.
Trigger Criteria:
- Context: A cargo record with export information and regulatory compliance data
- Applied to: Export Status Valid?
- Action: The system validates export status against customs regulations and business rules
Logic Flow:
IF A cargo record with export information and regulatory compliance data
AND The system validates export status against customs regulations and business rules
THEN:
- • The system confirms export status validity and enables export processing workflows
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record with multiple conflicting status conditions including holds, releases, and proceed codes.
Trigger Criteria:
- Context: A cargo record with multiple conflicting status conditions including holds, releases, and proceed codes
- Applied to: Hold Takes Precedence?
- Action: The system evaluates status priority hierarchy with holds having highest precedence
Logic Flow:
IF A cargo record with multiple conflicting status conditions including holds, releases, and proceed codes
AND The system evaluates status priority hierarchy with holds having highest precedence
THEN:
- • The system determines final status based on hold precedence rules and sets appropriate processing flags
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record where hold conditions have been determined to take precedence.
Trigger Criteria:
- Context: A cargo record where hold conditions have been determined to take precedence
- Applied to: HOLD
- Action: The system applies final status assignment logic
Logic Flow:
IF A cargo record where hold conditions have been determined to take precedence
AND The system applies final status assignment logic
THEN:
- • The system sets cargo status to HOLD and updates all related processing flags and notifications
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record where release conditions take precedence and no overriding holds exist.
Trigger Criteria:
- Context: A cargo record where release conditions take precedence and no overriding holds exist
- Applied to: RELEASE
- Action: The system applies final status assignment logic
Logic Flow:
IF A cargo record where release conditions take precedence and no overriding holds exist
AND The system applies final status assignment logic
THEN:
- • The system sets cargo status to RELEASE and enables cargo movement and delivery processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record where proceed authorization takes precedence and no blocking conditions exist.
Trigger Criteria:
- Context: A cargo record where proceed authorization takes precedence and no blocking conditions exist
- Applied to: PROCEED
- Action: The system applies final status assignment logic
Logic Flow:
IF A cargo record where proceed authorization takes precedence and no blocking conditions exist
AND The system applies final status assignment logic
THEN:
- • The system sets cargo status to PROCEED and enables next stage processing workflows
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record where arrival status takes precedence and arrival validation is successful.
Trigger Criteria:
- Context: A cargo record where arrival status takes precedence and arrival validation is successful
- Applied to: ARRIVED
- Action: The system applies final status assignment logic
Logic Flow:
IF A cargo record where arrival status takes precedence and arrival validation is successful
AND The system applies final status assignment logic
THEN:
- • The system sets cargo status to ARRIVED and triggers arrival notification and processing workflows
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record where export status takes precedence and export validation is successful.
Trigger Criteria:
- Context: A cargo record where export status takes precedence and export validation is successful
- Applied to: EXPORTED
- Action: The system applies final status assignment logic
Logic Flow:
IF A cargo record where export status takes precedence and export validation is successful
AND The system applies final status assignment logic
THEN:
- • The system sets cargo status to EXPORTED and triggers export documentation and compliance workflows
R-GCX016E-cbl-03028 (+22) File: GCX016E.cbl Business Rule: Merlin Message Content Assembly
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record exists with equipment information.
Trigger Criteria:
- Context: A cargo record exists with equipment information
- Applied to: Retrieve Equipment Details
- Action: The system processes Merlin message assembly
Logic Flow:
IF A cargo record exists with equipment information
AND The system processes Merlin message assembly
THEN:
- • Equipment details are retrieved and made available for message formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment details are available with car id and waybill information.
Trigger Criteria:
- Context: Equipment details are available with car ID and waybill information
- Applied to: Format Car ID and Waybill Information
- Action: The system formats message content
Logic Flow:
IF Equipment details are available with car ID and waybill information
AND The system formats message content
THEN:
- • Car ID and waybill information are formatted according to Merlin message standards
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record contains us-ccn information.
Trigger Criteria:
- Context: A cargo record contains US-CCN information
- Applied to: Add US-CCN Information
- Action: The system assembles Merlin message content
Logic Flow:
IF A cargo record contains US-CCN information
AND The system assembles Merlin message content
THEN:
- • US-CCN information is included in the message
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code exists for the cargo.
Trigger Criteria:
- Context: A disposition code exists for the cargo
- Applied to: Retrieve Disposition Code Information
- Action: The system processes Merlin message assembly
Logic Flow:
IF A disposition code exists for the cargo
AND The system processes Merlin message assembly
THEN:
- • Disposition code information is retrieved from the DC table
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code information is available.
Trigger Criteria:
- Context: Disposition code information is available
- Applied to: Format Disposition Code and Description
- Action: The system formats message content
Logic Flow:
IF Disposition code information is available
AND The system formats message content
THEN:
- • Disposition code and description are formatted for Merlin message display
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code with quantity information exists.
Trigger Criteria:
- Context: A disposition code with quantity information exists
- Applied to: Calculate Release Quantity Impact
- Action: The system processes quantity impact analysis
Logic Flow:
IF A disposition code with quantity information exists
AND The system processes quantity impact analysis
THEN:
- • The impact on release quantity is calculated and determined
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when release quantity impact has been calculated.
Trigger Criteria:
- Context: Release quantity impact has been calculated
- Applied to: Quantity Impact Analysis
- Action: The system evaluates quantity impact
Logic Flow:
IF Release quantity impact has been calculated
AND The system evaluates quantity impact
THEN:
- • Processing is routed to show quantity details if impact is detected,
otherwise continues to comment processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when quantity impact has been detected.
Trigger Criteria:
- Context: Quantity impact has been detected
- Applied to: Show Before Release Quantity
- Action: The system processes quantity display
Logic Flow:
IF Quantity impact has been detected
AND The system processes quantity display
THEN:
- • The current release quantity before changes is shown in the message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when before release quantity has been displayed.
Trigger Criteria:
- Context: Before release quantity has been displayed
- Applied to: Show After Release Quantity
- Action: The system continues quantity processing
Logic Flow:
IF Before release quantity has been displayed
AND The system continues quantity processing
THEN:
- • The projected release quantity after changes is shown in the message
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when before and after release quantities have been displayed.
Trigger Criteria:
- Context: Before and after release quantities have been displayed
- Applied to: Add Quantity Change Details
- Action: The system processes quantity change details
Logic Flow:
IF Before and after release quantities have been displayed
AND The system processes quantity change details
THEN:
- • Detailed quantity change information is added to the message content
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when k1 segment comments exist for the cargo.
Trigger Criteria:
- Context: K1 segment comments exist for the cargo
- Applied to: Include K1 Comment Processing
- Action: The system processes message content assembly
Logic Flow:
IF K1 segment comments exist for the cargo
AND The system processes message content assembly
THEN:
- • K1 comments are included in the Merlin message up to the maximum allowed lines
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when free-form text messages exist from disposition code processing.
Trigger Criteria:
- Context: Free-form text messages exist from disposition code processing
- Applied to: Add Free-Form Text Messages
- Action: The system assembles message content
Logic Flow:
IF Free-form text messages exist from disposition code processing
AND The system assembles message content
THEN:
- • Free-form text messages are added to the Merlin message content
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when special comments exist for the cargo processing.
Trigger Criteria:
- Context: Special comments exist for the cargo processing
- Applied to: Include Special Comments
- Action: The system processes message content
Logic Flow:
IF Special comments exist for the cargo processing
AND The system processes message content
THEN:
- • Special comments are included in the Merlin message up to the maximum allowed lines
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when processing context and details are available.
Trigger Criteria:
- Context: Processing context and details are available
- Applied to: Add Processing Details
- Action: The system assembles message content
Logic Flow:
IF Processing context and details are available
AND The system assembles message content
THEN:
- • Processing details are added to provide context in the Merlin message
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when k1 segment comments are being processed.
Trigger Criteria:
- Context: K1 segment comments are being processed
- Applied to: Bond Creation Scenario?
- Action: The system evaluates bond creation conditions
Logic Flow:
IF K1 segment comments are being processed
AND The system evaluates bond creation conditions
THEN:
- • Processing is routed to bond creation if CP Rail identifiers are found,
otherwise continues to date/time processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cp rail identifiers are detected in k1 comments.
Trigger Criteria:
- Context: CP Rail identifiers are detected in K1 comments
- Applied to: Process Canadian Pacific Railway Bond Creation
- Action: The system processes bond creation scenario
Logic Flow:
IF CP Rail identifiers are detected in K1 comments
AND The system processes bond creation scenario
THEN:
- • Special Canadian Pacific Railway bond creation processing is performed
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when canadian pacific railway bond creation has been processed.
Trigger Criteria:
- Context: Canadian Pacific Railway bond creation has been processed
- Applied to: Add Bond Creation Notification
- Action: The system adds notification content
Logic Flow:
IF Canadian Pacific Railway bond creation has been processed
AND The system adds notification content
THEN:
- • Bond creation notification is added to the Merlin message
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when processing date and time information is available.
Trigger Criteria:
- Context: Processing date and time information is available
- Applied to: Format Date and Time Information
- Action: The system formats message content
Logic Flow:
IF Processing date and time information is available
AND The system formats message content
THEN:
- • Date and time information is formatted according to Merlin message standards
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when uscs processing time is available.
Trigger Criteria:
- Context: USCS processing time is available
- Applied to: Add USCS Processing Time
- Action: The system adds time information
Logic Flow:
IF USCS processing time is available
AND The system adds time information
THEN:
- • USCS processing time is included in the Merlin message content
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when system processing time is available.
Trigger Criteria:
- Context: System processing time is available
- Applied to: Add System Processing Time
- Action: The system adds time information
Logic Flow:
IF System processing time is available
AND The system adds time information
THEN:
- • System processing time is included in the Merlin message content
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all message components have been processed and formatted.
Trigger Criteria:
- Context: All message components have been processed and formatted
- Applied to: Assemble Complete Message Content
- Action: The system assembles complete content
Logic Flow:
IF All message components have been processed and formatted
AND The system assembles complete content
THEN:
- • All components are combined into complete Merlin message content
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when complete message content has been assembled.
Trigger Criteria:
- Context: Complete message content has been assembled
- Applied to: Validate Message Format
- Action: The system validates message format
Logic Flow:
IF Complete message content has been assembled
AND The system validates message format
THEN:
- • Message format is validated against Merlin standards and requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when message format has been validated successfully.
Trigger Criteria:
- Context: Message format has been validated successfully
- Applied to: Finalize Merlin Message
- Action: The system finalizes the message
Logic Flow:
IF Message format has been validated successfully
AND The system finalizes the message
THEN:
- • Merlin message is finalized and ready for transmission
R-GCX016E-cbl-03051 (+12) File: GCX016E.cbl Business Rule: Freight Forwarder Identification
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is being processed for cargo.
Trigger Criteria:
- Context: A disposition code is being processed for cargo
- Applied to: Search Broker Database for Freight Forwarder Disposition Codes
- Action: The system searches the broker database for freight forwarder disposition codes
Logic Flow:
IF A disposition code is being processed for cargo
AND The system searches the broker database for freight forwarder disposition codes
THEN:
- • The system identifies whether the disposition code is associated with freight forwarder processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when broker database has been searched for freight forwarder disposition codes.
Trigger Criteria:
- Context: The broker database has been searched for freight forwarder disposition codes
- Applied to: Freight Forwarder Code Found?
- Action: The search results are evaluated
Logic Flow:
IF The broker database has been searched for freight forwarder disposition codes
AND The search results are evaluated
THEN:
- • If a freight forwarder code is found, proceed to retrieve cargo segment data,
otherwise log freight forwarder not found
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when freight forwarder disposition code has been identified.
Trigger Criteria:
- Context: A freight forwarder disposition code has been identified
- Applied to: Retrieve Cargo Segment Data from GCSUSS03
- Action: The system needs cargo segment information for processing
Logic Flow:
IF A freight forwarder disposition code has been identified
AND The system needs cargo segment information for processing
THEN:
- • The system retrieves cargo segment data from the GCSUSS03 database
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when primary cargo segment data has been retrieved from gcsuss03.
Trigger Criteria:
- Context: Primary cargo segment data has been retrieved from GCSUSS03
- Applied to: Retrieve Additional Cargo Data from GCSUSS07
- Action: Additional cargo information is needed for freight forwarder processing
Logic Flow:
IF Primary cargo segment data has been retrieved from GCSUSS03
AND Additional cargo information is needed for freight forwarder processing
THEN:
- • The system retrieves additional cargo data from the GCSUSS07 database
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo segment data has been retrieved from both gcsuss03 and gcsuss07.
Trigger Criteria:
- Context: Cargo segment data has been retrieved from both GCSUSS03 and GCSUSS07
- Applied to: Extract Freight Forwarder Information from Cargo Segments
- Action: The system processes the cargo segment information
Logic Flow:
IF Cargo segment data has been retrieved from both GCSUSS03 and GCSUSS07
AND The system processes the cargo segment information
THEN:
- • The system extracts freight forwarder identification details from the cargo segments
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when freight forwarder identification has been extracted from cargo segments.
Trigger Criteria:
- Context: Freight forwarder identification has been extracted from cargo segments
- Applied to: Lookup Freight Forwarder Name in Broker Table GCST2RT
- Action: The system needs to validate and retrieve complete freight forwarder information
Logic Flow:
IF Freight forwarder identification has been extracted from cargo segments
AND The system needs to validate and retrieve complete freight forwarder information
THEN:
- • The system looks up the freight forwarder name in the GCST2RT broker name table
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when broker name table gcst2rt has been searched for the freight forwarder name.
Trigger Criteria:
- Context: The broker name table GCST2RT has been searched for the freight forwarder name
- Applied to: Freight Forwarder Name Found?
- Action: The search results are evaluated
Logic Flow:
IF The broker name table GCST2RT has been searched for the freight forwarder name
AND The search results are evaluated
THEN:
- • If the freight forwarder name is found, proceed to retrieve contact information,
otherwise log freight forwarder not found
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when freight forwarder name has been successfully found in the broker name table.
Trigger Criteria:
- Context: The freight forwarder name has been successfully found in the broker name table
- Applied to: Retrieve Freight Forwarder Contact Information
- Action: Complete contact information is needed for notification processing
Logic Flow:
IF The freight forwarder name has been successfully found in the broker name table
AND Complete contact information is needed for notification processing
THEN:
- • The system retrieves freight forwarder contact information from the broker database
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when freight forwarder contact information has been retrieved.
Trigger Criteria:
- Context: Freight forwarder contact information has been retrieved
- Applied to: Get Email Address from Broker Table GCSTBRT
- Action: An email address is needed for electronic notification
Logic Flow:
IF Freight forwarder contact information has been retrieved
AND An email address is needed for electronic notification
THEN:
- • The system retrieves the email address from the GCSTBRT broker table
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when broker table has been searched for the freight forwarder's email address.
Trigger Criteria:
- Context: The broker table has been searched for the freight forwarder's email address
- Applied to: Email Address Available?
- Action: The system needs to determine the notification method
Logic Flow:
IF The broker table has been searched for the freight forwarder's email address
AND The system needs to determine the notification method
THEN:
- • If an email address is available, set the freight forwarder identified flag,
otherwise log freight forwarder not found
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when freight forwarder has been successfully identified with available contact information.
Trigger Criteria:
- Context: A freight forwarder has been successfully identified with available contact information
- Applied to: Set Freight Forwarder Identified Flag
- Action: The freight forwarder validation process is complete
Logic Flow:
IF A freight forwarder has been successfully identified with available contact information
AND The freight forwarder validation process is complete
THEN:
- • The system sets the freight forwarder identified flag to indicate successful identification
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when freight forwarder identified flag has been set.
Trigger Criteria:
- Context: The freight forwarder identified flag has been set
- Applied to: Store Freight Forwarder Details for Processing
- Action: Freight forwarder details need to be preserved for notification processing
Logic Flow:
IF The freight forwarder identified flag has been set
AND Freight forwarder details need to be preserved for notification processing
THEN:
- • The system stores freight forwarder details including contact information and email address for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when freight forwarder identification process has failed at any validation step.
Trigger Criteria:
- Context: The freight forwarder identification process has failed at any validation step
- Applied to: Log Freight Forwarder Not Found
- Action: No valid freight forwarder can be identified for the disposition code
Logic Flow:
IF The freight forwarder identification process has failed at any validation step
AND No valid freight forwarder can be identified for the disposition code
THEN:
- • The system logs that the freight forwarder was not found and continues processing without freight forwarder notification
R-GCX016E-cbl-03064 (+19) File: GCX016E.cbl Business Rule: CIH Email Content Creation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record exists with equipment information.
Trigger Criteria:
- Context: A cargo record exists with equipment information
- Applied to: Retrieve Equipment Information
- Action: The system processes email content creation
Logic Flow:
IF A cargo record exists with equipment information
AND The system processes email content creation
THEN:
- • Equipment details are retrieved from the cargo segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment information has been retrieved from cargo data.
Trigger Criteria:
- Context: Equipment information has been retrieved from cargo data
- Applied to: Format Car ID and Equipment Type
- Action: The system formats the equipment details
Logic Flow:
IF Equipment information has been retrieved from cargo data
AND The system formats the equipment details
THEN:
- • Car ID and equipment type are formatted according to business display standards
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record contains waybill information.
Trigger Criteria:
- Context: A cargo record contains waybill information
- Applied to: Retrieve Waybill Number
- Action: The system processes cargo information for email content
Logic Flow:
IF A cargo record contains waybill information
AND The system processes cargo information for email content
THEN:
- • The waybill number is retrieved from the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record contains us-ccn data.
Trigger Criteria:
- Context: A cargo record contains US-CCN data
- Applied to: Get US-CCN Information
- Action: The system processes cargo identification information
Logic Flow:
IF A cargo record contains US-CCN data
AND The system processes cargo identification information
THEN:
- • US-CCN information is retrieved from the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record contains content description information.
Trigger Criteria:
- Context: A cargo record contains content description information
- Applied to: Retrieve Content Description
- Action: The system processes cargo details for email content
Logic Flow:
IF A cargo record contains content description information
AND The system processes cargo details for email content
THEN:
- • Content description is retrieved from the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record contains origin station reference.
Trigger Criteria:
- Context: A cargo record contains origin station reference
- Applied to: Get Origin Station Information
- Action: The system processes station information for email content
Logic Flow:
IF A cargo record contains origin station reference
AND The system processes station information for email content
THEN:
- • Origin station details are retrieved from station information tables
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record contains destination station reference.
Trigger Criteria:
- Context: A cargo record contains destination station reference
- Applied to: Get Destination Station Information
- Action: The system processes station information for email content
Logic Flow:
IF A cargo record contains destination station reference
AND The system processes station information for email content
THEN:
- • Destination station details are retrieved from station information tables
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when origin and destination station information has been retrieved.
Trigger Criteria:
- Context: Origin and destination station information has been retrieved
- Applied to: Format Station Names and Codes
- Action: The system formats station information for display
Logic Flow:
IF Origin and destination station information has been retrieved
AND The system formats station information for display
THEN:
- • Station names and codes are formatted according to business display standards
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record contains disposition code reference.
Trigger Criteria:
- Context: A cargo record contains disposition code reference
- Applied to: Retrieve Disposition Code Details
- Action: The system processes disposition information for email content
Logic Flow:
IF A cargo record contains disposition code reference
AND The system processes disposition information for email content
THEN:
- • Disposition code details are retrieved from disposition code tables
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code details have been retrieved.
Trigger Criteria:
- Context: Disposition code details have been retrieved
- Applied to: Format Disposition Description
- Action: The system formats disposition information for display
Logic Flow:
IF Disposition code details have been retrieved
AND The system formats disposition information for display
THEN:
- • Disposition description is formatted according to business display standards
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when email content is being created.
Trigger Criteria:
- Context: Email content is being created
- Applied to: Get Processing Date and Time
- Action: The system processes timestamp information
Logic Flow:
IF Email content is being created
AND The system processes timestamp information
THEN:
- • Current processing date and time are retrieved for email content
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all cargo and disposition information has been retrieved and formatted.
Trigger Criteria:
- Context: All cargo and disposition information has been retrieved and formatted
- Applied to: Build Email Subject Line
- Action: The system builds the email subject line
Logic Flow:
IF All cargo and disposition information has been retrieved and formatted
AND The system builds the email subject line
THEN:
- • Email subject line is constructed with relevant cargo and disposition details
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when email subject line has been constructed.
Trigger Criteria:
- Context: Email subject line has been constructed
- Applied to: Create Email Header Section
- Action: The system creates the email header section
Logic Flow:
IF Email subject line has been constructed
AND The system creates the email header section
THEN:
- • Email header section is created with identification and routing information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when email header section has been created and equipment information is formatted.
Trigger Criteria:
- Context: Email header section has been created and equipment information is formatted
- Applied to: Add Equipment Details Section
- Action: The system adds equipment details to email content
Logic Flow:
IF Email header section has been created and equipment information is formatted
AND The system adds equipment details to email content
THEN:
- • Equipment details section is added with car ID and equipment type information
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when equipment details section has been added and cargo information is available.
Trigger Criteria:
- Context: Equipment details section has been added and cargo information is available
- Applied to: Add Cargo Information Section
- Action: The system adds cargo information to email content
Logic Flow:
IF Equipment details section has been added and cargo information is available
AND The system adds cargo information to email content
THEN:
- • Cargo information section is added with waybill, US-CCN, and content description
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo information section has been added and station information is formatted.
Trigger Criteria:
- Context: Cargo information section has been added and station information is formatted
- Applied to: Add Station Information Section
- Action: The system adds station information to email content
Logic Flow:
IF Cargo information section has been added and station information is formatted
AND The system adds station information to email content
THEN:
- • Station information section is added with origin and destination station details
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when station information section has been added and disposition information is formatted.
Trigger Criteria:
- Context: Station information section has been added and disposition information is formatted
- Applied to: Add Disposition Information Section
- Action: The system adds disposition information to email content
Logic Flow:
IF Station information section has been added and disposition information is formatted
AND The system adds disposition information to email content
THEN:
- • Disposition information section is added with disposition code and description
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition information section has been added and processing date/time is available.
Trigger Criteria:
- Context: Disposition information section has been added and processing date/time is available
- Applied to: Add Processing Timestamp
- Action: The system adds timestamp to email content
Logic Flow:
IF Disposition information section has been added and processing date/time is available
AND The system adds timestamp to email content
THEN:
- • Processing timestamp is added to email content for tracking purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all email sections have been added including timestamp.
Trigger Criteria:
- Context: All email sections have been added including timestamp
- Applied to: Finalize Email Content
- Action: The system finalizes email content
Logic Flow:
IF All email sections have been added including timestamp
AND The system finalizes email content
THEN:
- • Email content is finalized with proper formatting and ready for distribution
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when email content has been finalized.
Trigger Criteria:
- Context: Email content has been finalized
- Applied to: Email Content Ready for Distribution
- Action: The system prepares email for distribution
Logic Flow:
IF Email content has been finalized
AND The system prepares email for distribution
THEN:
- • Email content is confirmed ready for distribution to appropriate recipients
R-GCX016E-cbl-03084 (+10) File: GCX016E.cbl Business Rule: Message Recipient Determination
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when message requires recipient determination.
Trigger Criteria:
- Context: A message requires recipient determination
- Applied to: AD Segment Available?
- Action: The system evaluates AD segment availability
Logic Flow:
IF A message requires recipient determination
AND The system evaluates AD segment availability
THEN:
- • The system identifies whether AD segment configuration exists for recipient lookup
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when ad segment is available for the message. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: AD segment is available for the message
- Applied to: Read AD Segment Configuration
- Action: The system reads the AD segment configuration
Logic Flow:
IF AD segment is available for the message
AND The system reads the AD segment configuration
THEN:
- • The system loads the recipient configuration data from the AD segment
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when ad segment configuration has been read successfully. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: AD segment configuration has been read successfully
- Applied to: Extract Recipient Information
- Action: The system processes the configuration data
Logic Flow:
IF AD segment configuration has been read successfully
AND The system processes the configuration data
THEN:
- • The system extracts recipient identification and routing information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when recipient information has been extracted from ad segment.
Trigger Criteria:
- Context: Recipient information has been extracted from AD segment
- Applied to: Valid Recipient Found?
- Action: The system evaluates the extracted recipient data
Logic Flow:
IF Recipient information has been extracted from AD segment
AND The system evaluates the extracted recipient data
THEN:
- • The system determines if a valid recipient identifier exists
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when either no ad segment is available or no valid recipient was found in ad segment.
Trigger Criteria:
- Context: Either no AD segment is available or no valid recipient was found in AD segment
- Applied to: Set Default Recipient OM01247
- Action: The system applies default recipient logic
Logic Flow:
IF Either no AD segment is available or no valid recipient was found in AD segment
AND The system applies default recipient logic
THEN:
- • The system sets OM01247 as the message recipient
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid recipient was found in the ad segment configuration.
Trigger Criteria:
- Context: A valid recipient was found in the AD segment configuration
- Applied to: Validate Recipient Format
- Action: The system validates the recipient format
Logic Flow:
IF A valid recipient was found in the AD segment configuration
AND The system validates the recipient format
THEN:
- • The system verifies the recipient identifier meets required format standards
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when recipient format validation has been performed.
Trigger Criteria:
- Context: Recipient format validation has been performed
- Applied to: Recipient Valid?
- Action: The system evaluates validation results
Logic Flow:
IF Recipient format validation has been performed
AND The system evaluates validation results
THEN:
- • The system confirms whether the recipient identifier is valid for message routing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when recipient identifier has passed format validation.
Trigger Criteria:
- Context: The recipient identifier has passed format validation
- Applied to: Use Configured Recipient
- Action: The system finalizes recipient selection
Logic Flow:
IF The recipient identifier has passed format validation
AND The system finalizes recipient selection
THEN:
- • The system uses the configured recipient from the AD segment for message delivery
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when recipient identifier failed format validation.
Trigger Criteria:
- Context: The recipient identifier failed format validation
- Applied to: Generate Invalid Recipient Error
- Action: The system processes the validation failure
Logic Flow:
IF The recipient identifier failed format validation
AND The system processes the validation failure
THEN:
- • The system generates an invalid recipient error and initiates rerouting logic
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when invalid recipient error has been generated.
Trigger Criteria:
- Context: An invalid recipient error has been generated
- Applied to: Apply Rerouting Logic
- Action: The system applies rerouting logic
Logic Flow:
IF An invalid recipient error has been generated
AND The system applies rerouting logic
THEN:
- • The system redirects the message to alternative routing paths to ensure delivery
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when either a configured recipient is validated or default recipient is assigned.
Trigger Criteria:
- Context: Either a configured recipient is validated or default recipient is assigned
- Applied to: Set Final Message Recipient
- Action: The system completes recipient determination process
Logic Flow:
IF Either a configured recipient is validated or default recipient is assigned
AND The system completes recipient determination process
THEN:
- • The system sets the final message recipient for delivery routing
R-GCX016E-cbl-03115 (+13) File: GCX016E.cbl Business Rule: Foreign Cargo Record Setup
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when foreign cargo processing request is initiated.
Trigger Criteria:
- Context: A foreign cargo processing request is initiated
- Applied to: Initialize New Cargo Record Structure
- Action: The system begins foreign cargo record setup
Logic Flow:
IF A foreign cargo processing request is initiated
AND The system begins foreign cargo record setup
THEN:
- • A new cargo record structure is initialized with default values and prepared for data population
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when n7 segment containing equipment data is available.
Trigger Criteria:
- Context: An N7 segment containing equipment data is available
- Applied to: Extract Equipment Data from N7 Segment
- Action: The system processes the N7 segment for foreign cargo setup
Logic Flow:
IF An N7 segment containing equipment data is available
AND The system processes the N7 segment for foreign cargo setup
THEN:
- • Equipment information including equipment initial and number are extracted and prepared for cargo record population
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment data has been extracted from n7 segment.
Trigger Criteria:
- Context: Equipment data has been extracted from N7 segment
- Applied to: Set Car ID and Equipment Type
- Action: The system processes equipment information for cargo record setup
Logic Flow:
IF Equipment data has been extracted from N7 segment
AND The system processes equipment information for cargo record setup
THEN:
- • Car ID is formatted by combining equipment initial and number, and equipment type is assigned to the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when x4 segment containing cargo disposition data is available.
Trigger Criteria:
- Context: An X4 segment containing cargo disposition data is available
- Applied to: Extract Cargo Data from X4 Segment
- Action: The system processes the X4 segment for foreign cargo setup
Logic Flow:
IF An X4 segment containing cargo disposition data is available
AND The system processes the X4 segment for foreign cargo setup
THEN:
- • Cargo data including waybill number, quantities, and disposition information are extracted for cargo record population
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo data has been extracted from x4 segment.
Trigger Criteria:
- Context: Cargo data has been extracted from X4 segment
- Applied to: Set Waybill Number and Quantities
- Action: The system processes waybill and quantity information
Logic Flow:
IF Cargo data has been extracted from X4 segment
AND The system processes waybill and quantity information
THEN:
- • Waybill number and cargo quantities are assigned to the appropriate fields in the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code data has been extracted from x4 segment.
Trigger Criteria:
- Context: Disposition code data has been extracted from X4 segment
- Applied to: Set Disposition Code Information
- Action: The system processes disposition information for cargo setup
Logic Flow:
IF Disposition code data has been extracted from X4 segment
AND The system processes disposition information for cargo setup
THEN:
- • Disposition code information is assigned to the cargo record for subsequent processing and status tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when m10 segment containing manifest data is available.
Trigger Criteria:
- Context: An M10 segment containing manifest data is available
- Applied to: Build Foreign Manifest from M10 Segment
- Action: The system processes manifest information for foreign cargo setup
Logic Flow:
IF An M10 segment containing manifest data is available
AND The system processes manifest information for foreign cargo setup
THEN:
- • Foreign manifest information is extracted and prepared for cargo record population including transport and vessel details
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when manifest data from m10 segment is being processed.
Trigger Criteria:
- Context: Manifest data from M10 segment is being processed
- Applied to: Extract SCAC Code
- Action: The system extracts carrier identification information
Logic Flow:
IF Manifest data from M10 segment is being processed
AND The system extracts carrier identification information
THEN:
- • SCAC code is extracted and assigned to identify the transportation carrier for the foreign cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when manifest information has been processed from m10 segment.
Trigger Criteria:
- Context: Manifest information has been processed from M10 segment
- Applied to: Set Transport Type
- Action: The system determines transport method for foreign cargo
Logic Flow:
IF Manifest information has been processed from M10 segment
AND The system determines transport method for foreign cargo
THEN:
- • Transport type is assigned to the cargo record based on the mode of transportation indicated in the manifest
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when foreign cargo manifest information is being processed.
Trigger Criteria:
- Context: Foreign cargo manifest information is being processed
- Applied to: Set Country Code
- Action: The system determines country of origin
Logic Flow:
IF Foreign cargo manifest information is being processed
AND The system determines country of origin
THEN:
- • Country code is assigned to the cargo record to identify the foreign origin country
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when transport type and manifest information have been processed.
Trigger Criteria:
- Context: Transport type and manifest information have been processed
- Applied to: Set Vessel/Train Details
- Action: The system assigns conveyance details to foreign cargo
Logic Flow:
IF Transport type and manifest information have been processed
AND The system assigns conveyance details to foreign cargo
THEN:
- • Vessel or train identification details are assigned to the cargo record based on the transport method
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when car id information has been assembled from equipment data.
Trigger Criteria:
- Context: Car ID information has been assembled from equipment data
- Applied to: Format Car ID for Database
- Action: The system prepares car ID for database storage
Logic Flow:
IF Car ID information has been assembled from equipment data
AND The system prepares car ID for database storage
THEN:
- • Car ID is formatted according to database requirements for proper storage and future retrieval operations
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when complete foreign cargo record has been assembled with all required data.
Trigger Criteria:
- Context: A complete foreign cargo record has been assembled with all required data
- Applied to: Insert New Cargo Record to Database
- Action: The system stores the new cargo record
Logic Flow:
IF A complete foreign cargo record has been assembled with all required data
AND The system stores the new cargo record
THEN:
- • The foreign cargo record is inserted into the GCSUSRT US cargo database for subsequent processing and status tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when new foreign cargo record has been successfully inserted into the database.
Trigger Criteria:
- Context: A new foreign cargo record has been successfully inserted into the database
- Applied to: Log Cargo Creation Action
- Action: The system completes cargo record creation
Logic Flow:
IF A new foreign cargo record has been successfully inserted into the database
AND The system completes cargo record creation
THEN:
- • The cargo creation action is logged with appropriate details for audit trail and processing history tracking
R-GCX016E-cbl-03129 (+18) File: GCX016E.cbl Business Rule: Apply CPRS Special Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train record is being processed for arrival or departure.
Trigger Criteria:
- Context: A train record is being processed for arrival or departure
- Applied to: Train ID Contains CPRS Indicator?
- Action: The system evaluates the train ID for CPRS indicators or Canadian Pacific Railway naming conventions
Logic Flow:
IF A train record is being processed for arrival or departure
AND The system evaluates the train ID for CPRS indicators or Canadian Pacific Railway naming conventions
THEN:
- • The system routes the train to CPRS-specific processing if indicators are found,
otherwise processes as regular train
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when train has been identified as a cprs train.
Trigger Criteria:
- Context: A train has been identified as a CPRS train
- Applied to: Apply CPRS Naming Conventions
- Action: The system processes the train identification
Logic Flow:
IF A train has been identified as a CPRS train
AND The system processes the train identification
THEN:
- • The system applies CPRS naming conventions and formats the train ID according to Canadian Pacific Railway standards
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cprs train id has been formatted according to naming conventions.
Trigger Criteria:
- Context: A CPRS train ID has been formatted according to naming conventions
- Applied to: Validate CPRS Train Format
- Action: The system validates the train format against CPRS standards
Logic Flow:
IF A CPRS train ID has been formatted according to naming conventions
AND The system validates the train format against CPRS standards
THEN:
- • The system confirms the train ID meets Canadian Pacific Railway formatting requirements or flags format violations
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when validated cprs train id is ready for processing.
Trigger Criteria:
- Context: A validated CPRS train ID is ready for processing
- Applied to: CPRS Train Found in System?
- Action: The system searches the GCWTL train data for the CPRS train
Logic Flow:
IF A validated CPRS train ID is ready for processing
AND The system searches the GCWTL train data for the CPRS train
THEN:
- • The system either finds the train record and proceeds with normal processing or generates a train not found error
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cprs train id has been validated but not found in the train data system.
Trigger Criteria:
- Context: A CPRS train ID has been validated but not found in the train data system
- Applied to: Generate CPRS Train Not Found Error
- Action: The system cannot locate the train in GCWTL train data
Logic Flow:
IF A CPRS train ID has been validated but not found in the train data system
AND The system cannot locate the train in GCWTL train data
THEN:
- • The system generates a train not found error message and continues with cargo lookup processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cprs train processing has been initiated (whether train was found or not).
Trigger Criteria:
- Context: CPRS train processing has been initiated (whether train was found or not)
- Applied to: CPRS Cargo Lookup by Car ID
- Action: The system searches GCSUSRT cargo records using the car ID from the N7 segment
Logic Flow:
IF CPRS train processing has been initiated (whether train was found or not)
AND The system searches GCSUSRT cargo records using the car ID from the N7 segment
THEN:
- • The system identifies existing CPRS cargo records or determines that new cargo records need to be created
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cprs cargo records have been found in the system for the specified car id.
Trigger Criteria:
- Context: CPRS cargo records have been found in the system for the specified car ID
- Applied to: Process Existing CPRS Cargo
- Action: The system processes the existing cargo records
Logic Flow:
IF CPRS cargo records have been found in the system for the specified car ID
AND The system processes the existing cargo records
THEN:
- • The system updates the existing CPRS cargo with new disposition codes, status changes, and associated processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when no existing cprs cargo records are found for the specified car id.
Trigger Criteria:
- Context: No existing CPRS cargo records are found for the specified car ID
- Applied to: Create New CPRS Cargo Record
- Action: The system needs to process new CPRS cargo
Logic Flow:
IF No existing CPRS cargo records are found for the specified car ID
AND The system needs to process new CPRS cargo
THEN:
- • The system creates new cargo records in GCSUSRT with appropriate CPRS-specific attributes and initial status
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cprs cargo records are ready for bond processing (either existing or newly created).
Trigger Criteria:
- Context: CPRS cargo records are ready for bond processing (either existing or newly created)
- Applied to: Apply CPRS Bond Processing Rules
- Action: The system applies CPRS bond processing rules from GCSTBRT bond tables
Logic Flow:
IF CPRS cargo records are ready for bond processing (either existing or newly created)
AND The system applies CPRS bond processing rules from GCSTBRT bond tables
THEN:
- • The system processes bonds according to Canadian Pacific Railway requirements and cross-border regulations
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cprs bond processing rules have been applied to the cargo.
Trigger Criteria:
- Context: CPRS bond processing rules have been applied to the cargo
- Applied to: Set CPRS Special Flags
- Action: The system configures CPRS-specific processing flags
Logic Flow:
IF CPRS bond processing rules have been applied to the cargo
AND The system configures CPRS-specific processing flags
THEN:
- • The system sets appropriate flags for Canadian Pacific Railway processing, cross-border handling, and special routing requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cprs special flags have been configured for the cargo.
Trigger Criteria:
- Context: CPRS special flags have been configured for the cargo
- Applied to: Handle CPRS Cross-Border Validation
- Action: The system performs cross-border validation for Canadian Pacific Railway operations
Logic Flow:
IF CPRS special flags have been configured for the cargo
AND The system performs cross-border validation for Canadian Pacific Railway operations
THEN:
- • The system validates compliance with cross-border regulations and determines if Canadian border crossing processing is required
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cprs cross-border validation has been completed.
Trigger Criteria:
- Context: CPRS cross-border validation has been completed
- Applied to: Canadian Border Crossing?
- Action: The system evaluates routing information to determine border crossing requirements
Logic Flow:
IF CPRS cross-border validation has been completed
AND The system evaluates routing information to determine border crossing requirements
THEN:
- • The system identifies Canadian border crossings and routes to appropriate location mapping or proceeds to bond information processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when canadian border crossing has been identified for cprs cargo.
Trigger Criteria:
- Context: A Canadian border crossing has been identified for CPRS cargo
- Applied to: Map US Port to Canadian Location
- Action: The system maps US port information to Canadian location equivalents using border location maps
Logic Flow:
IF A Canadian border crossing has been identified for CPRS cargo
AND The system maps US port information to Canadian location equivalents using border location maps
THEN:
- • The system establishes proper location mapping for cross-border processing and routing validation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when us port to canadian location mapping has been completed.
Trigger Criteria:
- Context: US port to Canadian location mapping has been completed
- Applied to: Validate CPRS Routing Rules
- Action: The system validates routing against CPRS routing rules and cross-border requirements
Logic Flow:
IF US port to Canadian location mapping has been completed
AND The system validates routing against CPRS routing rules and cross-border requirements
THEN:
- • The system confirms routing compliance and proceeds to bond information processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cprs routing rules have been validated (either after border crossing mapping or direct validation).
Trigger Criteria:
- Context: CPRS routing rules have been validated (either after border crossing mapping or direct validation)
- Applied to: Apply CPRS Bond Information
- Action: The system applies CPRS bond information to the cargo
Logic Flow:
IF CPRS routing rules have been validated (either after border crossing mapping or direct validation)
AND The system applies CPRS bond information to the cargo
THEN:
- • The system updates cargo records with appropriate Canadian Pacific Railway bond details and requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cprs bond information has been applied to the cargo.
Trigger Criteria:
- Context: CPRS bond information has been applied to the cargo
- Applied to: Set Canadian Pacific Railway Bond
- Action: The system sets Canadian Pacific Railway bond configuration
Logic Flow:
IF CPRS bond information has been applied to the cargo
AND The system sets Canadian Pacific Railway bond configuration
THEN:
- • The system establishes proper bond settings specific to Canadian Pacific Railway requirements and generates bond creation messaging
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when canadian pacific railway bond has been configured.
Trigger Criteria:
- Context: Canadian Pacific Railway bond has been configured
- Applied to: Generate K1 Bond Creation Message
- Action: The system generates bond creation messaging
Logic Flow:
IF Canadian Pacific Railway bond has been configured
AND The system generates bond creation messaging
THEN:
- • The system creates K1 segment messages documenting the bond creation for Canadian Pacific Railway operations
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when k1 bond creation messages have been generated.
Trigger Criteria:
- Context: K1 bond creation messages have been generated
- Applied to: Update CPRS Cargo Status
- Action: The system updates CPRS cargo status
Logic Flow:
IF K1 bond creation messages have been generated
AND The system updates CPRS cargo status
THEN:
- • The system sets appropriate status indicators reflecting completed Canadian Pacific Railway processing and prepares for notification generation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cprs cargo status has been updated.
Trigger Criteria:
- Context: CPRS cargo status has been updated
- Applied to: Send CPRS Notifications
- Action: The system sends CPRS processing notifications
Logic Flow:
IF CPRS cargo status has been updated
AND The system sends CPRS processing notifications
THEN:
- • The system delivers appropriate notifications to stakeholders regarding Canadian Pacific Railway cargo processing completion
R-GCX016E-cbl-03148 (+10) File: GCX016E.cbl Business Rule: Validate Status Code
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo identification number is provided for processing.
Trigger Criteria:
- Context: A cargo identification number is provided for processing
- Applied to: Retrieve Cargo Record
- Action: The system needs to validate cargo status
Logic Flow:
IF A cargo identification number is provided for processing
AND The system needs to validate cargo status
THEN:
- • The cargo record is retrieved from the US Cargo Root database
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record has been retrieved from the database.
Trigger Criteria:
- Context: A cargo record has been retrieved from the database
- Applied to: Cargo Status Code Check
- Action: The system examines the cargo status code field
Logic Flow:
IF A cargo record has been retrieved from the database
AND The system examines the cargo status code field
THEN:
- • The status code is validated against acceptable values for processing eligibility
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record with status code information is available.
Trigger Criteria:
- Context: A cargo record with status code information is available
- Applied to: Check Deleted Status
- Action: The system checks the cargo deletion status indicator
Logic Flow:
IF A cargo record with status code information is available
AND The system checks the cargo deletion status indicator
THEN:
- • The cargo is identified as deleted or active based on the status flag
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record has been checked for deletion status.
Trigger Criteria:
- Context: A cargo record has been checked for deletion status
- Applied to: Is Cargo Deleted?
- Action: The cargo is marked as deleted
Logic Flow:
IF A cargo record has been checked for deletion status
AND The cargo is marked as deleted
THEN:
- • The cargo is excluded from processing and marked as invalid for operations
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record is not marked as deleted.
Trigger Criteria:
- Context: A cargo record is not marked as deleted
- Applied to: Check New Bond Creation Status
- Action: The system examines the bond creation status
Logic Flow:
IF A cargo record is not marked as deleted
AND The system examines the bond creation status
THEN:
- • The new bond creation flag is evaluated to determine processing eligibility
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record has been checked for new bond creation status.
Trigger Criteria:
- Context: A cargo record has been checked for new bond creation status
- Applied to: New Bond Created?
- Action: The cargo is associated with a newly created bond
Logic Flow:
IF A cargo record has been checked for new bond creation status
AND The cargo is associated with a newly created bond
THEN:
- • The cargo is excluded from processing to prevent conflicts with bond creation procedures
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record is not deleted and not associated with a new bond creation.
Trigger Criteria:
- Context: A cargo record is not deleted and not associated with a new bond creation
- Applied to: Verify Active Status
- Action: The system verifies the active status of the cargo
Logic Flow:
IF A cargo record is not deleted and not associated with a new bond creation
AND The system verifies the active status of the cargo
THEN:
- • The cargo active status is confirmed against business rules for processing eligibility
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record has been verified for active status.
Trigger Criteria:
- Context: A cargo record has been verified for active status
- Applied to: Is Status Active?
- Action: The cargo status is confirmed as active
Logic Flow:
IF A cargo record has been verified for active status
AND The cargo status is confirmed as active
THEN:
- • The cargo is marked as valid for processing operations
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record has passed all validation checks including deletion status, bond creation status, and active status.
Trigger Criteria:
- Context: A cargo record has passed all validation checks including deletion status, bond creation status, and active status
- Applied to: Mark as Valid for Processing
- Action: All validation criteria are met
Logic Flow:
IF A cargo record has passed all validation checks including deletion status, bond creation status, and active status
AND All validation criteria are met
THEN:
- • The cargo is marked as valid and approved for subsequent processing operations
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo status validation has been completed with either valid or invalid result.
Trigger Criteria:
- Context: Cargo status validation has been completed with either valid or invalid result
- Applied to: Log Validation Result
- Action: The validation process concludes
Logic Flow:
IF Cargo status validation has been completed with either valid or invalid result
AND The validation process concludes
THEN:
- • The validation result is logged with cargo identification and validation outcome details
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status validation has been completed and results have been logged.
Trigger Criteria:
- Context: Cargo status validation has been completed and results have been logged
- Applied to: Continue with Cargo Processing
- Action: The cargo is marked as valid for processing
Logic Flow:
IF Cargo status validation has been completed and results have been logged
AND The cargo is marked as valid for processing
THEN:
- • The system continues with the next phase of cargo processing operations
R-GCX016E-cbl-03159 (+9) File: GCX016E.cbl Business Rule: Handle CPRS Special Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cprs traffic has been identified for processing.
Trigger Criteria:
- Context: CPRS traffic has been identified for processing
- Applied to: SCAC Code Available?
- Action: the system checks for SCAC code availability
Logic Flow:
IF CPRS traffic has been identified for processing
AND the system checks for SCAC code availability
THEN:
- • if SCAC code is available, use existing SCAC code,
otherwise set SCAC as unknown
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cprs traffic processing is initiated and scac code status is determined.
Trigger Criteria:
- Context: CPRS traffic processing is initiated and SCAC code status is determined
- Applied to: Search Cargo by Car ID
- Action: the system searches for cargo records using car ID
Logic Flow:
IF CPRS traffic processing is initiated and SCAC code status is determined
AND the system searches for cargo records using car ID
THEN:
- • retrieve matching cargo records based on car identification number
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when car id search has been performed for cprs cargo.
Trigger Criteria:
- Context: car ID search has been performed for CPRS cargo
- Applied to: Cargo Found?
- Action: the system evaluates search results
Logic Flow:
IF car ID search has been performed for CPRS cargo
AND the system evaluates search results
THEN:
- • if cargo record is found, use existing cargo record,
otherwise proceed to US-CCN key requirements check
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when no existing cargo record was found and us-ccn key requirements are being checked.
Trigger Criteria:
- Context: no existing cargo record was found and US-CCN key requirements are being checked
- Applied to: US-CCN Key Renumbering Needed?
- Action: the system evaluates US-CCN key renumbering requirements
Logic Flow:
IF no existing cargo record was found and US-CCN key requirements are being checked
AND the system evaluates US-CCN key renumbering requirements
THEN:
- • if renumbering is needed, renumber US-CCN key,
otherwise keep original US-CCN key
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when us-ccn key renumbering has been determined as necessary.
Trigger Criteria:
- Context: US-CCN key renumbering has been determined as necessary
- Applied to: Renumber US-CCN Key
- Action: the system performs key renumbering
Logic Flow:
IF US-CCN key renumbering has been determined as necessary
AND the system performs key renumbering
THEN:
- • generate new US-CCN key value and update cargo identification
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when us-ccn key processing is complete for new cprs cargo.
Trigger Criteria:
- Context: US-CCN key processing is complete for new CPRS cargo
- Applied to: Apply CPRS Cargo Creation Rules
- Action: the system applies CPRS-specific cargo creation rules
Logic Flow:
IF US-CCN key processing is complete for new CPRS cargo
AND the system applies CPRS-specific cargo creation rules
THEN:
- • enforce CPRS business rules and validation requirements for cargo creation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cprs cargo creation rules have been applied successfully.
Trigger Criteria:
- Context: CPRS cargo creation rules have been applied successfully
- Applied to: Create New CPRS Cargo Record
- Action: the system creates new CPRS cargo record
Logic Flow:
IF CPRS cargo creation rules have been applied successfully
AND the system creates new CPRS cargo record
THEN:
- • establish new cargo record with CPRS-specific data structure and attributes
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when new cprs cargo record has been created.
Trigger Criteria:
- Context: new CPRS cargo record has been created
- Applied to: Initialize CPRS-Specific Fields
- Action: the system initializes CPRS-specific fields
Logic Flow:
IF new CPRS cargo record has been created
AND the system initializes CPRS-specific fields
THEN:
- • set default values and initialize all CPRS-required data fields
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cprs-specific fields have been initialized.
Trigger Criteria:
- Context: CPRS-specific fields have been initialized
- Applied to: Set CPRS Processing Flags
- Action: the system sets CPRS processing flags
Logic Flow:
IF CPRS-specific fields have been initialized
AND the system sets CPRS processing flags
THEN:
- • activate flags that control CPRS-specific processing behavior throughout the system
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cprs processing flags have been configured.
Trigger Criteria:
- Context: CPRS processing flags have been configured
- Applied to: Log CPRS Special Processing
- Action: the system logs CPRS special processing
Logic Flow:
IF CPRS processing flags have been configured
AND the system logs CPRS special processing
THEN:
- • create audit trail entries documenting CPRS-specific processing actions and decisions
R-GCX016E-cbl-03169 (+26) File: GCX016E.cbl Business Rule: Counterpart Disposition Code Removal Logic
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when new disposition code needs to be processed.
Trigger Criteria:
- Context: A new disposition code needs to be processed
- Applied to: Start Counterpart Disposition Code Removal
- Action: The counterpart removal process is initiated
Logic Flow:
IF A new disposition code needs to be processed
AND The counterpart removal process is initiated
THEN:
- • The system prepares to search the existing status array for conflicting codes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code processing request is received.
Trigger Criteria:
- Context: A disposition code processing request is received
- Applied to: Receive New Disposition Code
- Action: The new disposition code is provided to the system
Logic Flow:
IF A disposition code processing request is received
AND The new disposition code is provided to the system
THEN:
- • The system accepts the disposition code for counterpart analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when new disposition code is received and the s09a status array exists.
Trigger Criteria:
- Context: A new disposition code is received and the S09A status array exists
- Applied to: Search S09A Status Array for Existing Codes
- Action: The system searches for existing disposition codes in the status array
Logic Flow:
IF A new disposition code is received and the S09A status array exists
AND The system searches for existing disposition codes in the status array
THEN:
- • All existing disposition codes in the array are identified and made available for conflict analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status array has been searched and existing codes are identified.
Trigger Criteria:
- Context: The status array has been searched and existing codes are identified
- Applied to: Conflicting Codes Found?
- Action: The system compares the new disposition code against existing codes
Logic Flow:
IF The status array has been searched and existing codes are identified
AND The system compares the new disposition code against existing codes
THEN:
- • The system determines whether conflicting codes exist and proceeds accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when conflicting disposition codes have been found in the status array.
Trigger Criteria:
- Context: Conflicting disposition codes have been found in the status array
- Applied to: Identify Counterpart Code Types
- Action: The system analyzes the conflicting codes
Logic Flow:
IF Conflicting disposition codes have been found in the status array
AND The system analyzes the conflicting codes
THEN:
- • Each conflicting code is classified by type (hold, release, proceed, cancel, arrival, export) for targeted removal
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when counterpart code types have been identified.
Trigger Criteria:
- Context: Counterpart code types have been identified
- Applied to: Code Type Analysis
- Action: The system performs code type analysis
Logic Flow:
IF Counterpart code types have been identified
AND The system performs code type analysis
THEN:
- • The system determines the specific removal action based on code type relationships
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when release disposition code is being added and hold codes exist in the status array.
Trigger Criteria:
- Context: A release disposition code is being added and hold codes exist in the status array
- Applied to: Remove Hold Codes if Release Code Added
- Action: The system processes the release code addition
Logic Flow:
IF A release disposition code is being added and hold codes exist in the status array
AND The system processes the release code addition
THEN:
- • All conflicting hold disposition codes are removed from the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when hold disposition code is being added and release codes exist in the status array.
Trigger Criteria:
- Context: A hold disposition code is being added and release codes exist in the status array
- Applied to: Remove Release Codes if Hold Code Added
- Action: The system processes the hold code addition
Logic Flow:
IF A hold disposition code is being added and release codes exist in the status array
AND The system processes the hold code addition
THEN:
- • All conflicting release disposition codes are removed from the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cancel disposition code is being added and proceed codes exist in the status array.
Trigger Criteria:
- Context: A cancel disposition code is being added and proceed codes exist in the status array
- Applied to: Remove Proceed Codes if Cancel Code Added
- Action: The system processes the cancel code addition
Logic Flow:
IF A cancel disposition code is being added and proceed codes exist in the status array
AND The system processes the cancel code addition
THEN:
- • All conflicting proceed disposition codes are removed from the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cancel arrival disposition code is being added and arrival codes exist in the status array.
Trigger Criteria:
- Context: A cancel arrival disposition code is being added and arrival codes exist in the status array
- Applied to: Remove Arrival Codes if Cancel Arrival Added
- Action: The system processes the cancel arrival code addition
Logic Flow:
IF A cancel arrival disposition code is being added and arrival codes exist in the status array
AND The system processes the cancel arrival code addition
THEN:
- • All conflicting arrival disposition codes are removed from the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cancel export disposition code is being added and export codes exist in the status array.
Trigger Criteria:
- Context: A cancel export disposition code is being added and export codes exist in the status array
- Applied to: Remove Export Codes if Cancel Export Added
- Action: The system processes the cancel export code addition
Logic Flow:
IF A cancel export disposition code is being added and export codes exist in the status array
AND The system processes the cancel export code addition
THEN:
- • All conflicting export disposition codes are removed from the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition codes have been removed from the status array creating gaps.
Trigger Criteria:
- Context: Disposition codes have been removed from the status array creating gaps
- Applied to: Compress Status Array
- Action: The system compresses the status array
Logic Flow:
IF Disposition codes have been removed from the status array creating gaps
AND The system compresses the status array
THEN:
- • All remaining disposition codes are moved to eliminate gaps and maintain array continuity
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status array has been compressed after code removal.
Trigger Criteria:
- Context: The status array has been compressed after code removal
- Applied to: Update Array Sequence Numbers
- Action: The system updates sequence numbers
Logic Flow:
IF The status array has been compressed after code removal
AND The system updates sequence numbers
THEN:
- • All remaining disposition codes are assigned sequential numbers starting from 1
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status array has been modified through code removal and compression.
Trigger Criteria:
- Context: The status array has been modified through code removal and compression
- Applied to: Validate Array Integrity
- Action: The system validates array integrity
Logic Flow:
IF The status array has been modified through code removal and compression
AND The system validates array integrity
THEN:
- • The array structure is verified for proper sequence numbers, valid codes, and data consistency
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when array integrity validation has been performed.
Trigger Criteria:
- Context: Array integrity validation has been performed
- Applied to: Array Valid?
- Action: The system checks array validity
Logic Flow:
IF Array integrity validation has been performed
AND The system checks array validity
THEN:
- • The system determines whether the array is valid and proceeds with success or error handling
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when counterpart disposition codes have been successfully removed and the array is valid.
Trigger Criteria:
- Context: Counterpart disposition codes have been successfully removed and the array is valid
- Applied to: Log Removal Action
- Action: The system logs the removal action
Logic Flow:
IF Counterpart disposition codes have been successfully removed and the array is valid
AND The system logs the removal action
THEN:
- • A record of the removed codes and the removal reason is created for audit purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when counterpart disposition code removal process has completed successfully.
Trigger Criteria:
- Context: The counterpart disposition code removal process has completed successfully
- Applied to: Return Success Status
- Action: The system returns success status
Logic Flow:
IF The counterpart disposition code removal process has completed successfully
AND The system returns success status
THEN:
- • Control is returned to the calling process with a successful completion indicator
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when array validation has failed during the counterpart removal process.
Trigger Criteria:
- Context: Array validation has failed during the counterpart removal process
- Applied to: Generate Error Message
- Action: The system generates an error message
Logic Flow:
IF Array validation has failed during the counterpart removal process
AND The system generates an error message
THEN:
- • An appropriate error message is created describing the validation failure
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when error has occurred during counterpart code removal and an error message has been generated.
Trigger Criteria:
- Context: An error has occurred during counterpart code removal and an error message has been generated
- Applied to: Restore Previous Array State
- Action: The system restores the previous array state
Logic Flow:
IF An error has occurred during counterpart code removal and an error message has been generated
AND The system restores the previous array state
THEN:
- • The status array is returned to its state before the counterpart removal attempt began
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when new disposition code is being processed for a cargo and current status arrays exist with existing disposition codes.
Trigger Criteria:
- Context: A new disposition code is being processed for a cargo AND current status arrays exist with existing disposition codes
- Applied to: Search for Conflicting Codes?
- Action: The system needs to check for conflicting codes before adding the new disposition code
Logic Flow:
IF A new disposition code is being processed for a cargo AND current status arrays exist with existing disposition codes
AND The system needs to check for conflicting codes before adding the new disposition code
THEN:
- • The system searches through all existing disposition codes in the status arrays to identify potential conflicts
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when search for conflicting codes has been initiated and existing disposition codes are found in status arrays.
Trigger Criteria:
- Context: A search for conflicting codes has been initiated AND existing disposition codes are found in status arrays
- Applied to: Identify Counterpart Codes
- Action: The system evaluates each existing disposition code against the new disposition code
Logic Flow:
IF A search for conflicting codes has been initiated AND existing disposition codes are found in status arrays
AND The system evaluates each existing disposition code against the new disposition code
THEN:
- • The system identifies which existing codes are counterparts that conflict with the new code based on predefined business relationships
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when counterpart disposition codes have been identified and business rules exist for code conflict resolution.
Trigger Criteria:
- Context: Counterpart disposition codes have been identified AND business rules exist for code conflict resolution
- Applied to: Evaluate Business Rules
- Action: The system needs to determine if the conflicting code should be removed
Logic Flow:
IF Counterpart disposition codes have been identified AND business rules exist for code conflict resolution
AND The system needs to determine if the conflicting code should be removed
THEN:
- • The system evaluates the business rules considering factors such as code hierarchy, timing, and business logic to make the removal decision
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when conflicting disposition code has been identified and business rules determine it should be removed.
Trigger Criteria:
- Context: A conflicting disposition code has been identified AND business rules determine it should be removed
- Applied to: Remove Conflicting Code from Array
- Action: The system processes the removal of the conflicting code
Logic Flow:
IF A conflicting disposition code has been identified AND business rules determine it should be removed
AND The system processes the removal of the conflicting code
THEN:
- • The system removes the conflicting disposition code from the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code has been removed from the status array.
Trigger Criteria:
- Context: A disposition code has been removed from the status array
- Applied to: Update Status Array Sequence
- Action: The status array structure needs to be maintained
Logic Flow:
IF A disposition code has been removed from the status array
AND The status array structure needs to be maintained
THEN:
- • The system updates the array sequence numbers and reorganizes the remaining codes to maintain proper array structure
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code has been removed from the status array.
Trigger Criteria:
- Context: A disposition code has been removed from the status array
- Applied to: Log Removal Action
- Action: The removal action is completed
Logic Flow:
IF A disposition code has been removed from the status array
AND The removal action is completed
THEN:
- • The system logs the removal action including details of which code was removed and why
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when one disposition code has been processed for conflicts and there are additional codes in the status array.
Trigger Criteria:
- Context: One disposition code has been processed for conflicts AND there are additional codes in the status array
- Applied to: More Codes to Check?
- Action: The system completes processing of one code
Logic Flow:
IF One disposition code has been processed for conflicts AND there are additional codes in the status array
AND The system completes processing of one code
THEN:
- • The system checks if there are more codes remaining to be evaluated and continues the conflict checking process if more codes exist
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all disposition codes have been checked for conflicts and any necessary removals have been completed.
Trigger Criteria:
- Context: All disposition codes have been checked for conflicts AND any necessary removals have been completed
- Applied to: Continue with Status Processing
- Action: The counterpart removal process is finished
Logic Flow:
IF All disposition codes have been checked for conflicts AND any necessary removals have been completed
AND The counterpart removal process is finished
THEN:
- • The system continues with the normal disposition code processing workflow
R-GCX016E-cbl-03188 (+54) File: GCX016E.cbl Business Rule: In
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record is being processed for in-bond entry.
Trigger Criteria:
- Context: A cargo record is being processed for in-bond entry
- Applied to: Entry Number Present?
- Action: The system checks for entry number presence
Logic Flow:
IF A cargo record is being processed for in-bond entry
AND The system checks for entry number presence
THEN:
- • If entry number is present, proceed to validation; if not present, complete processing without further validation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when entry number is present in the cargo record.
Trigger Criteria:
- Context: An entry number is present in the cargo record
- Applied to: Validate Against Broker Entry Numbers
- Action: The system validates the entry number against broker entry numbers
Logic Flow:
IF An entry number is present in the cargo record
AND The system validates the entry number against broker entry numbers
THEN:
- • The entry number must match an existing broker entry number to be considered valid
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when entry number has passed broker entry validation.
Trigger Criteria:
- Context: An entry number has passed broker entry validation
- Applied to: Validate Against In-Bond Control Numbers
- Action: The system validates against in-bond control numbers
Logic Flow:
IF An entry number has passed broker entry validation
AND The system validates against in-bond control numbers
THEN:
- • The entry number must also be valid against in-bond control number records
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when entry number has passed standard validations.
Trigger Criteria:
- Context: An entry number has passed standard validations
- Applied to: Check Special V37 Entries
- Action: The system checks for special V37 entry requirements
Logic Flow:
IF An entry number has passed standard validations
AND The system checks for special V37 entry requirements
THEN:
- • V37 entries must meet additional validation criteria specific to this entry type
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all entry number validations have been completed.
Trigger Criteria:
- Context: All entry number validations have been completed
- Applied to: Entry Number Valid?
- Action: The system evaluates overall entry number validity
Logic Flow:
IF All entry number validations have been completed
AND The system evaluates overall entry number validity
THEN:
- • If all validations pass, proceed with entry type processing; if any validation fails, generate error
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid entry number with edi entry type code.
Trigger Criteria:
- Context: A valid entry number with EDI entry type code
- Applied to: Convert EDI Entry Type Code
- Action: The system processes the entry type code
Logic Flow:
IF A valid entry number with EDI entry type code
AND The system processes the entry type code
THEN:
- • Convert EDI entry type code to internal system format for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid entry with entry type code 61.
Trigger Criteria:
- Context: A valid entry with entry type code 61
- Applied to: Set Master In-Bond Flag for Code 61
- Action: The system processes the entry type code
Logic Flow:
IF A valid entry with entry type code 61
AND The system processes the entry type code
THEN:
- • Set the master in-bond flag to indicate this is a master in-bond entry
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid entry with entry type code 62.
Trigger Criteria:
- Context: A valid entry with entry type code 62
- Applied to: Set Master In-Bond Flag for Code 62
- Action: The system processes the entry type code
Logic Flow:
IF A valid entry with entry type code 62
AND The system processes the entry type code
THEN:
- • Set the master in-bond flag to indicate this is a master in-bond entry
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid entry with entry type code 63.
Trigger Criteria:
- Context: A valid entry with entry type code 63
- Applied to: Set Master In-Bond Flag for Code 63
- Action: The system processes the entry type code
Logic Flow:
IF A valid entry with entry type code 63
AND The system processes the entry type code
THEN:
- • Set the master in-bond flag to indicate this is a master in-bond entry
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid entry with entry type code 69.
Trigger Criteria:
- Context: A valid entry with entry type code 69
- Applied to: Set Master In-Bond Flag for Code 69
- Action: The system processes the entry type code
Logic Flow:
IF A valid entry with entry type code 69
AND The system processes the entry type code
THEN:
- • Set the master in-bond flag to indicate this is a master in-bond entry
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid entry with entry type code other than 61, 62, 63, or 69.
Trigger Criteria:
- Context: A valid entry with entry type code other than 61, 62, 63, or 69
- Applied to: Process Standard Entry Type
- Action: The system processes the entry type code
Logic Flow:
IF A valid entry with entry type code other than 61, 62, 63, or 69
AND The system processes the entry type code
THEN:
- • Apply standard entry type processing without setting master in-bond flags
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when entry type processing has been completed.
Trigger Criteria:
- Context: Entry type processing has been completed
- Applied to: Update Broker Bond Information
- Action: The system updates broker bond information
Logic Flow:
IF Entry type processing has been completed
AND The system updates broker bond information
THEN:
- • Update broker bond records with current entry information and bond details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when broker bond information has been updated.
Trigger Criteria:
- Context: Broker bond information has been updated
- Applied to: CPRS Bond Processing Required?
- Action: The system checks for CPRS bond processing requirements
Logic Flow:
IF Broker bond information has been updated
AND The system checks for CPRS bond processing requirements
THEN:
- • If CPRS bond processing is required, proceed with CPRS bond assignment;
otherwise, proceed to bond owner information
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cprs bond processing is required.
Trigger Criteria:
- Context: CPRS bond processing is required
- Applied to: Handle CPRS Bond Assignment
- Action: The system processes CPRS bond assignment
Logic Flow:
IF CPRS bond processing is required
AND The system processes CPRS bond assignment
THEN:
- • Assign appropriate CPRS bond information and update bond records accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cprs bond assignment has been completed.
Trigger Criteria:
- Context: CPRS bond assignment has been completed
- Applied to: Update Broker QP Information
- Action: The system updates broker QP information
Logic Flow:
IF CPRS bond assignment has been completed
AND The system updates broker QP information
THEN:
- • Update broker qualified person information with current bond and entry details
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all bond processing steps have been completed.
Trigger Criteria:
- Context: All bond processing steps have been completed
- Applied to: Set Bond Owner Information
- Action: The system sets bond owner information
Logic Flow:
IF All bond processing steps have been completed
AND The system sets bond owner information
THEN:
- • Establish bond ownership details and finalize bond assignment for the entry
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when entry number validation has failed.
Trigger Criteria:
- Context: Entry number validation has failed
- Applied to: Generate Error - Invalid Entry Number & Generate Error Message
- Action: The system processes the validation failure
Logic Flow:
IF Entry number validation has failed
AND The system processes the validation failure
THEN:
- • Generate appropriate error message indicating invalid entry number and halt processing
- • An appropriate error message is generated describing the validation failure
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all in-bond entry processing steps have been completed successfully or entry number was not present.
Trigger Criteria:
- Context: All in-bond entry processing steps have been completed successfully or entry number was not present
- Applied to: Complete In-Bond Entry Processing
- Action: The system finalizes in-bond entry processing
Logic Flow:
IF All in-bond entry processing steps have been completed successfully or entry number was not present
AND The system finalizes in-bond entry processing
THEN:
- • Complete the in-bond entry processing and proceed to next processing stage
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record contains an in-bond entry number.
Trigger Criteria:
- Context: A cargo record contains an in-bond entry number
- Applied to: In-Bond Entry Number Validation
- Action: The system processes the cargo for in-bond validation
Logic Flow:
IF A cargo record contains an in-bond entry number
AND The system processes the cargo for in-bond validation
THEN:
- • The entry number is validated for proper format and business rules compliance
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when in-bond entry number has been submitted for validation.
Trigger Criteria:
- Context: An in-bond entry number has been submitted for validation
- Applied to: Entry Number Valid?
- Action: The validation process completes
Logic Flow:
IF An in-bond entry number has been submitted for validation
AND The validation process completes
THEN:
- • The system either accepts the entry number for further processing or rejects it with error handling
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid entry number format has been confirmed.
Trigger Criteria:
- Context: A valid entry number format has been confirmed
- Applied to: Validate Against Existing Broker Entry Numbers
- Action: The system checks against existing broker entry numbers
Logic Flow:
IF A valid entry number format has been confirmed
AND The system checks against existing broker entry numbers
THEN:
- • The entry number is validated for consistency with broker records
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when entry number has passed broker validation.
Trigger Criteria:
- Context: The entry number has passed broker validation
- Applied to: Validate Against In-Bond Control Numbers
- Action: The system validates against in-bond control numbers
Logic Flow:
IF The entry number has passed broker validation
AND The system validates against in-bond control numbers
THEN:
- • The entry number is confirmed to match in-bond control number requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when entry number has passed standard validations.
Trigger Criteria:
- Context: The entry number has passed standard validations
- Applied to: Check Special V37 Entries
- Action: The system checks for special V37 entry requirements
Logic Flow:
IF The entry number has passed standard validations
AND The system checks for special V37 entry requirements
THEN:
- • Special V37 validation rules are applied if applicable
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all validations have been completed successfully.
Trigger Criteria:
- Context: All validations have been completed successfully
- Applied to: Entry Type Code?
- Action: The system evaluates the entry type code
Logic Flow:
IF All validations have been completed successfully
AND The system evaluates the entry type code
THEN:
- • The appropriate entry type specific processing path is selected (61, 62, 63, 69, or Other)
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when entry type code is determined to be 61.
Trigger Criteria:
- Context: The entry type code is determined to be 61
- Applied to: Master In-Bond Flag Setting for Code 61
- Action: The system processes the in-bond flag setting
Logic Flow:
IF The entry type code is determined to be 61
AND The system processes the in-bond flag setting
THEN:
- • Master in-bond flags are set according to entry type 61 business rules
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when entry type code is determined to be 62.
Trigger Criteria:
- Context: The entry type code is determined to be 62
- Applied to: Master In-Bond Flag Setting for Code 62
- Action: The system processes the in-bond flag setting
Logic Flow:
IF The entry type code is determined to be 62
AND The system processes the in-bond flag setting
THEN:
- • Master in-bond flags are set according to entry type 62 business rules
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when entry type code is determined to be 63.
Trigger Criteria:
- Context: The entry type code is determined to be 63
- Applied to: Master In-Bond Flag Setting for Code 63
- Action: The system processes the in-bond flag setting
Logic Flow:
IF The entry type code is determined to be 63
AND The system processes the in-bond flag setting
THEN:
- • Master in-bond flags are set according to entry type 63 business rules
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when entry type code is determined to be 69.
Trigger Criteria:
- Context: The entry type code is determined to be 69
- Applied to: Master In-Bond Flag Setting for Code 69
- Action: The system processes the in-bond flag setting
Logic Flow:
IF The entry type code is determined to be 69
AND The system processes the in-bond flag setting
THEN:
- • Master in-bond flags are set according to entry type 69 business rules
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when entry type code is not 61, 62, 63, or 69.
Trigger Criteria:
- Context: The entry type code is not 61, 62, 63, or 69
- Applied to: Process Other Entry Type Codes
- Action: The system processes the other entry type
Logic Flow:
IF The entry type code is not 61, 62, 63, or 69
AND The system processes the other entry type
THEN:
- • Standard in-bond processing rules are applied for the non-specific entry type
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when in-bond flag setting has been completed for the entry type.
Trigger Criteria:
- Context: In-bond flag setting has been completed for the entry type
- Applied to: Update Cargo with Broker Information
- Action: The system updates the cargo record
Logic Flow:
IF In-bond flag setting has been completed for the entry type
AND The system updates the cargo record
THEN:
- • Broker information and in-bond details are stored in the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has been updated with broker information.
Trigger Criteria:
- Context: Cargo has been updated with broker information
- Applied to: Log In-Bond Processing Action
- Action: The system logs the processing action
Logic Flow:
IF Cargo has been updated with broker information
AND The system logs the processing action
THEN:
- • In-bond processing details are recorded in the system log
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when in-bond processing has completed (either successfully or with error handling).
Trigger Criteria:
- Context: In-bond processing has completed (either successfully or with error handling)
- Applied to: Continue Cargo Processing
- Action: The system continues with cargo processing
Logic Flow:
IF In-bond processing has completed (either successfully or with error handling)
AND The system continues with cargo processing
THEN:
- • Standard cargo processing workflow resumes
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when x4 segment is being processed for cargo disposition.
Trigger Criteria:
- Context: An X4 segment is being processed for cargo disposition
- Applied to: Entry Type Code Present?
- Action: The system checks for the presence of an entry type code in the segment
Logic Flow:
IF An X4 segment is being processed for cargo disposition
AND The system checks for the presence of an entry type code in the segment
THEN:
- • If entry type code is present, continue with conversion processing,
otherwise skip entry type processing and continue with cargo processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when entry type code is present in the x4 segment.
Trigger Criteria:
- Context: An entry type code is present in the X4 segment
- Applied to: Retrieve Current Entry Type Code Value
- Action: The system needs to process entry type code conversion
Logic Flow:
IF An entry type code is present in the X4 segment
AND The system needs to process entry type code conversion
THEN:
- • Retrieve the current entry type code value from the US cargo root segment record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when edi entry type code is received from the x4 segment.
Trigger Criteria:
- Context: An EDI entry type code is received from the X4 segment
- Applied to: Convert EDI Entry Type Code to Internal System Value
- Action: The system processes the entry type code for internal use
Logic Flow:
IF An EDI entry type code is received from the X4 segment
AND The system processes the entry type code for internal use
THEN:
- • Convert the EDI entry type code to the corresponding internal system value using entry type code lookup arrays
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when entry type code has been converted to internal system value.
Trigger Criteria:
- Context: An entry type code has been converted to internal system value
- Applied to: Entry Type Code = 61, 62, 63, or 69?
- Action: The system evaluates the entry type code for in-bond classification
Logic Flow:
IF An entry type code has been converted to internal system value
AND The system evaluates the entry type code for in-bond classification
THEN:
- • If entry type code equals 61, 62, 63, or 69, classify as in-bond and set master in-bond flag,
otherwise proceed with standard entry type processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when entry type code has been converted to internal system value.
Trigger Criteria:
- Context: An entry type code has been converted to internal system value
- Applied to: Update Entry Type Code in Cargo Record
- Action: The system completes entry type code processing
Logic Flow:
IF An entry type code has been converted to internal system value
AND The system completes entry type code processing
THEN:
- • Update the entry type code field in the US cargo root segment record with the converted internal value
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when entry type code is classified as in-bond (61, 62, 63, or 69).
Trigger Criteria:
- Context: The entry type code is classified as in-bond (61, 62, 63, or 69)
- Applied to: Set Master In-Bond Flag
- Action: The system processes in-bond entry type classification
Logic Flow:
IF The entry type code is classified as in-bond (61, 62, 63, or 69)
AND The system processes in-bond entry type classification
THEN:
- • Set the master in-bond flag to indicate this cargo requires in-bond processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when entry type code has been updated in the cargo record.
Trigger Criteria:
- Context: Entry type code has been updated in the cargo record
- Applied to: Border Crossing Scenario?
- Action: The system evaluates processing context for special scenarios
Logic Flow:
IF Entry type code has been updated in the cargo record
AND The system evaluates processing context for special scenarios
THEN:
- • If the cargo involves a border crossing scenario, apply special border crossing rules,
otherwise proceed with standard validation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when border crossing scenario has been detected.
Trigger Criteria:
- Context: A border crossing scenario has been detected
- Applied to: Apply Special Border Crossing Rules
- Action: The system processes entry type code for border crossing cargo
Logic Flow:
IF A border crossing scenario has been detected
AND The system processes entry type code for border crossing cargo
THEN:
- • Apply special border crossing rules for entry type code processing and validation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when entry type code has been converted and potentially processed for border crossing.
Trigger Criteria:
- Context: An entry type code has been converted and potentially processed for border crossing
- Applied to: Validate Converted Entry Type Code
- Action: The system validates the converted entry type code
Logic Flow:
IF An entry type code has been converted and potentially processed for border crossing
AND The system validates the converted entry type code
THEN:
- • Verify that the converted entry type code is valid and meets system requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when converted entry type code has passed validation.
Trigger Criteria:
- Context: The converted entry type code has passed validation
- Applied to: Store Internal Entry Type Code Value
- Action: The system completes entry type code processing
Logic Flow:
IF The converted entry type code has passed validation
AND The system completes entry type code processing
THEN:
- • Store the validated internal entry type code value in the cargo record for future processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when entry type code has been successfully stored.
Trigger Criteria:
- Context: The entry type code has been successfully stored
- Applied to: Log Entry Type Code Conversion
- Action: The system completes entry type code conversion processing
Logic Flow:
IF The entry type code has been successfully stored
AND The system completes entry type code conversion processing
THEN:
- • Log the entry type code conversion details for audit trail and tracking purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when converted entry type code fails validation.
Trigger Criteria:
- Context: The converted entry type code fails validation
- Applied to: Generate Error for Invalid Entry Type Code
- Action: The system detects an invalid entry type code
Logic Flow:
IF The converted entry type code fails validation
AND The system detects an invalid entry type code
THEN:
- • Generate an error message indicating invalid entry type code and continue with cargo processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when entry number is received from x4 segment.
Trigger Criteria:
- Context: An entry number is received from X4 segment
- Applied to: Check Entry Number Format
- Action: The system checks the entry number format
Logic Flow:
IF An entry number is received from X4 segment
AND The system checks the entry number format
THEN:
- • The entry number is validated for proper format structure and marked as valid or invalid format
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when entry number with valid format.
Trigger Criteria:
- Context: An entry number with valid format
- Applied to: Search Existing Broker Entry Numbers
- Action: The system searches existing broker entry numbers in the database
Logic Flow:
IF An entry number with valid format
AND The system searches existing broker entry numbers in the database
THEN:
- • If broker entry number is found, mark entry number as valid,
otherwise continue to next validation step
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when entry number that was not found in broker entry numbers.
Trigger Criteria:
- Context: An entry number that was not found in broker entry numbers
- Applied to: Search In-Bond Control Numbers
- Action: The system searches in-bond control numbers in the database
Logic Flow:
IF An entry number that was not found in broker entry numbers
AND The system searches in-bond control numbers in the database
THEN:
- • If in-bond control number is found, mark entry number as valid,
otherwise continue to next validation step
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when entry number that was not found in broker entry numbers or in-bond control numbers.
Trigger Criteria:
- Context: An entry number that was not found in broker entry numbers or in-bond control numbers
- Applied to: Check for Special V37 Entries
- Action: The system searches special V37 entries in the database
Logic Flow:
IF An entry number that was not found in broker entry numbers or in-bond control numbers
AND The system searches special V37 entries in the database
THEN:
- • If V37 entry is found, mark entry number as valid,
otherwise generate entry number error
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when entry number that has been found in broker entry numbers, in-bond control numbers, or special v37 entries.
Trigger Criteria:
- Context: An entry number that has been found in broker entry numbers, in-bond control numbers, or special V37 entries
- Applied to: Mark Entry Number as Valid
- Action: The system marks the entry number as valid
Logic Flow:
IF An entry number that has been found in broker entry numbers, in-bond control numbers, or special V37 entries
AND The system marks the entry number as valid
THEN:
- • Set in-bond processing flag, log entry number validation success, and continue with in-bond processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when entry number that has invalid format or was not found in any validation databases.
Trigger Criteria:
- Context: An entry number that has invalid format or was not found in any validation databases
- Applied to: Generate Entry Number Error
- Action: The system generates entry number error
Logic Flow:
IF An entry number that has invalid format or was not found in any validation databases
AND The system generates entry number error
THEN:
- • Log entry number validation failure and skip in-bond processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when entry number format validation result.
Trigger Criteria:
- Context: An entry number format validation result
- Applied to: Entry Number Valid Format?
- Action: The system evaluates if entry number has valid format
Logic Flow:
IF An entry number format validation result
AND The system evaluates if entry number has valid format
THEN:
- • If format is valid, proceed to search existing broker entry numbers,
otherwise generate entry number error
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when broker entry number search result.
Trigger Criteria:
- Context: A broker entry number search result
- Applied to: Broker Entry Number Found?
- Action: The system evaluates if broker entry number was found
Logic Flow:
IF A broker entry number search result
AND The system evaluates if broker entry number was found
THEN:
- • If broker entry number is found, mark entry number as valid,
otherwise search in-bond control numbers
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when in-bond control number search result.
Trigger Criteria:
- Context: An in-bond control number search result
- Applied to: In-Bond Control Number Found?
- Action: The system evaluates if in-bond control number was found
Logic Flow:
IF An in-bond control number search result
AND The system evaluates if in-bond control number was found
THEN:
- • If in-bond control number is found, mark entry number as valid,
otherwise check for special V37 entries
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when special v37 entry search result.
Trigger Criteria:
- Context: A special V37 entry search result
- Applied to: V37 Entry Found?
- Action: The system evaluates if V37 entry was found
Logic Flow:
IF A special V37 entry search result
AND The system evaluates if V37 entry was found
THEN:
- • If V37 entry is found, mark entry number as valid,
otherwise generate entry number error
R-GCX016E-cbl-03206 (+12) File: GCX016E.cbl Business Rule: Arrival and Export Location Validation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when train arrival processing event (pod/aad disposition) is being processed.
Trigger Criteria:
- Context: A train arrival processing event (POD/AAD disposition) is being processed
- Applied to: Train ID Suffix Check
- Action: The system checks the train ID suffix
Logic Flow:
IF A train arrival processing event (POD/AAD disposition) is being processed
AND The system checks the train ID suffix
THEN:
- • If train ID ends with 'T', classify as export manifest train,
otherwise classify as import manifest train
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when export manifest train (suffix 't') is arriving at a port.
Trigger Criteria:
- Context: An export manifest train (suffix 'T') is arriving at a port
- Applied to: Export Manifest Port Validation
- Action: The system validates the arrival port against export port configuration
Logic Flow:
IF An export manifest train (suffix 'T') is arriving at a port
AND The system validates the arrival port against export port configuration
THEN:
- • If port is designated for export, allow export manifest processing,
otherwise generate validation message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when export manifest train is processed and arrival port information is available from p4 location segments.
Trigger Criteria:
- Context: An export manifest train is processed and arrival port information is available from P4 location segments
- Applied to: Arrival Port Designated for Export?
- Action: The system checks if the arrival port is designated for export processing
Logic Flow:
IF An export manifest train is processed and arrival port information is available from P4 location segments
AND The system checks if the arrival port is designated for export processing
THEN:
- • If port is designated for export, proceed with export manifest business rules,
otherwise generate location validation messages
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train is identified as export manifest and arrival port is validated for export.
Trigger Criteria:
- Context: A train is identified as export manifest and arrival port is validated for export
- Applied to: Apply Export Manifest Business Rules
- Action: The system processes the export manifest
Logic Flow:
IF A train is identified as export manifest and arrival port is validated for export
AND The system processes the export manifest
THEN:
- • Apply export-specific processing rules including location validation and status updates
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train is identified as import manifest (no 't' suffix).
Trigger Criteria:
- Context: A train is identified as import manifest (no 'T' suffix)
- Applied to: Standard Import Processing Rules
- Action: The system processes the import manifest
Logic Flow:
IF A train is identified as import manifest (no 'T' suffix)
AND The system processes the import manifest
THEN:
- • Apply standard import processing rules and proceed to location validation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when location identifier information is available from p4 location segments.
Trigger Criteria:
- Context: Location identifier information is available from P4 location segments
- Applied to: Valid Destination Location?
- Action: The system validates the destination location against destination station table
Logic Flow:
IF Location identifier information is available from P4 location segments
AND The system validates the destination location against destination station table
THEN:
- • If destination location is valid, proceed with location-specific rule application,
otherwise generate location validation messages
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid destination location is confirmed.
Trigger Criteria:
- Context: A valid destination location is confirmed
- Applied to: Border Crossing Location?
- Action: The system checks if the location is a border crossing point
Logic Flow:
IF A valid destination location is confirmed
AND The system checks if the location is a border crossing point
THEN:
- • If location is border crossing, apply border crossing rules,
otherwise apply standard location rules
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when location is identified as a border crossing point.
Trigger Criteria:
- Context: A location is identified as a border crossing point
- Applied to: Apply Border Crossing Rules
- Action: The system processes the border crossing location
Logic Flow:
IF A location is identified as a border crossing point
AND The system processes the border crossing location
THEN:
- • Apply border-specific processing rules including vessel information swapping and special status handling
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when location is identified as non-border crossing.
Trigger Criteria:
- Context: A location is identified as non-border crossing
- Applied to: Apply Standard Location Rules
- Action: The system processes the standard location
Logic Flow:
IF A location is identified as non-border crossing
AND The system processes the standard location
THEN:
- • Apply standard location processing rules without special border crossing handling
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when export manifest business rules have been applied successfully.
Trigger Criteria:
- Context: Export manifest business rules have been applied successfully
- Applied to: Set Export Manifest Status
- Action: The system updates the manifest status
Logic Flow:
IF Export manifest business rules have been applied successfully
AND The system updates the manifest status
THEN:
- • Set export manifest status and proceed to train arrival status update
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when import manifest processing rules have been applied successfully.
Trigger Criteria:
- Context: Import manifest processing rules have been applied successfully
- Applied to: Set Import Manifest Status
- Action: The system updates the manifest status
Logic Flow:
IF Import manifest processing rules have been applied successfully
AND The system updates the manifest status
THEN:
- • Set import manifest status and proceed to train arrival status update
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when location-specific rules have been applied and manifest status has been set.
Trigger Criteria:
- Context: Location-specific rules have been applied and manifest status has been set
- Applied to: Update Train Arrival Status
- Action: The system finalizes train arrival processing
Logic Flow:
IF Location-specific rules have been applied and manifest status has been set
AND The system finalizes train arrival processing
THEN:
- • Update train arrival status to reflect completed processing and generate location validation messages
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train arrival processing is complete or validation errors occurred.
Trigger Criteria:
- Context: Train arrival processing is complete or validation errors occurred
- Applied to: Generate Location Validation Messages
- Action: The system generates validation messages
Logic Flow:
IF Train arrival processing is complete or validation errors occurred
AND The system generates validation messages
THEN:
- • Create appropriate messages for successful processing or validation failures including invalid ports or destinations
R-GCX016E-cbl-03219 (+21) File: GCX016E.cbl Business Rule: Database Segment Validation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record exists in the system with associated status segments.
Trigger Criteria:
- Context: A cargo record exists in the system with associated status segments
- Applied to: Retrieve S09 Status Segment from Database
- Action: The system attempts to retrieve the S09 status segment from the database
Logic Flow:
IF A cargo record exists in the system with associated status segments
AND The system attempts to retrieve the S09 status segment from the database
THEN:
- • The segment data is successfully fetched and made available for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when attempt has been made to retrieve s09 status segment from database.
Trigger Criteria:
- Context: An attempt has been made to retrieve S09 status segment from database
- Applied to: Segment Retrieved Successfully?
- Action: The system checks the retrieval operation result
Logic Flow:
IF An attempt has been made to retrieve S09 status segment from database
AND The system checks the retrieval operation result
THEN:
- • If segment was found and retrieved, proceed to format validation,
otherwise initiate corrupted segment recovery
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when s09 status segment has been successfully retrieved from database.
Trigger Criteria:
- Context: An S09 status segment has been successfully retrieved from database
- Applied to: Check Segment Format Structure
- Action: The system examines the segment format structure
Logic Flow:
IF An S09 status segment has been successfully retrieved from database
AND The system examines the segment format structure
THEN:
- • The segment structure is validated against expected format specifications
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when s09 segment format structure has been examined.
Trigger Criteria:
- Context: The S09 segment format structure has been examined
- Applied to: Valid Segment Format?
- Action: The system evaluates format validity
Logic Flow:
IF The S09 segment format structure has been examined
AND The system evaluates format validity
THEN:
- • If format is valid, proceed to sequence number verification,
otherwise log format error and attempt reconstruction
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when s09 segment with valid format structure.
Trigger Criteria:
- Context: An S09 segment with valid format structure
- Applied to: Verify Sequence Numbers
- Action: The system checks sequence numbers within the segment
Logic Flow:
IF An S09 segment with valid format structure
AND The system checks sequence numbers within the segment
THEN:
- • Sequence numbers are verified for proper ordering and valid ranges
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when sequence numbers in s09 segment have been verified.
Trigger Criteria:
- Context: Sequence numbers in S09 segment have been verified
- Applied to: Sequence Numbers Valid?
- Action: The system evaluates sequence number validity
Logic Flow:
IF Sequence numbers in S09 segment have been verified
AND The system evaluates sequence number validity
THEN:
- • If sequence numbers are valid, proceed to data integrity check,
otherwise log sequence error and correct numbering
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when s09 segment with valid format and sequence numbers.
Trigger Criteria:
- Context: An S09 segment with valid format and sequence numbers
- Applied to: Check Data Integrity Fields
- Action: The system examines data integrity fields
Logic Flow:
IF An S09 segment with valid format and sequence numbers
AND The system examines data integrity fields
THEN:
- • Data integrity is validated against consistency and completeness requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when data integrity fields in s09 segment have been checked.
Trigger Criteria:
- Context: Data integrity fields in S09 segment have been checked
- Applied to: Data Integrity Valid?
- Action: The system evaluates data integrity validity
Logic Flow:
IF Data integrity fields in S09 segment have been checked
AND The system evaluates data integrity validity
THEN:
- • If data integrity is valid, initialize status array from segment,
otherwise log integrity error and apply correction rules
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid s09 segment with proper format, sequence numbers, and data integrity.
Trigger Criteria:
- Context: A valid S09 segment with proper format, sequence numbers, and data integrity
- Applied to: Initialize Status Array from Valid Segment
- Action: The system initializes the status array
Logic Flow:
IF A valid S09 segment with proper format, sequence numbers, and data integrity
AND The system initializes the status array
THEN:
- • Status array is populated with disposition codes and status information from the segment
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status array has been initialized from valid s09 segment.
Trigger Criteria:
- Context: Status array has been initialized from valid S09 segment
- Applied to: Track Maximum Sequence Fetched
- Action: The system processes sequence numbers
Logic Flow:
IF Status array has been initialized from valid S09 segment
AND The system processes sequence numbers
THEN:
- • The maximum sequence number encountered is recorded for future reference
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when s09 segment has passed all validation checks and maximum sequence has been tracked.
Trigger Criteria:
- Context: S09 segment has passed all validation checks and maximum sequence has been tracked
- Applied to: Mark Segment as Valid for Processing
- Action: The system finalizes segment validation
Logic Flow:
IF S09 segment has passed all validation checks and maximum sequence has been tracked
AND The system finalizes segment validation
THEN:
- • Segment is marked as valid and ready for cargo status processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when s09 segment retrieval has failed or segment is corrupted.
Trigger Criteria:
- Context: S09 segment retrieval has failed or segment is corrupted
- Applied to: Handle Corrupted Segment Recovery
- Action: The system detects segment unavailability or corruption
Logic Flow:
IF S09 segment retrieval has failed or segment is corrupted
AND The system detects segment unavailability or corruption
THEN:
- • Recovery procedures are initiated to attempt segment reconstruction
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when s09 segment format validation has failed.
Trigger Criteria:
- Context: S09 segment format validation has failed
- Applied to: Log Segment Format Error
- Action: The system detects invalid segment format
Logic Flow:
IF S09 segment format validation has failed
AND The system detects invalid segment format
THEN:
- • Format error is logged with details for troubleshooting and segment reconstruction is attempted
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when s09 segment is invalid, corrupted, or has format errors.
Trigger Criteria:
- Context: S09 segment is invalid, corrupted, or has format errors
- Applied to: Attempt Segment Reconstruction
- Action: The system attempts segment reconstruction
Logic Flow:
IF S09 segment is invalid, corrupted, or has format errors
AND The system attempts segment reconstruction
THEN:
- • Reconstruction process is executed using available cargo data and default values
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when segment reconstruction has been attempted.
Trigger Criteria:
- Context: Segment reconstruction has been attempted
- Applied to: Recovery Successful?
- Action: The system evaluates reconstruction results
Logic Flow:
IF Segment reconstruction has been attempted
AND The system evaluates reconstruction results
THEN:
- • If reconstruction successful, proceed to sequence verification,
otherwise use default segment values
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when segment reconstruction has failed.
Trigger Criteria:
- Context: Segment reconstruction has failed
- Applied to: Use Default Segment Values
- Action: The system cannot recover valid segment data
Logic Flow:
IF Segment reconstruction has failed
AND The system cannot recover valid segment data
THEN:
- • Default segment values are applied and validation is marked as failed
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when sequence number validation has failed.
Trigger Criteria:
- Context: Sequence number validation has failed
- Applied to: Log Sequence Number Error
- Action: The system detects invalid sequence numbers
Logic Flow:
IF Sequence number validation has failed
AND The system detects invalid sequence numbers
THEN:
- • Sequence number error is logged and correction procedures are initiated
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when invalid sequence numbers have been detected and logged.
Trigger Criteria:
- Context: Invalid sequence numbers have been detected and logged
- Applied to: Correct Sequence Numbering
- Action: The system applies sequence number corrections
Logic Flow:
IF Invalid sequence numbers have been detected and logged
AND The system applies sequence number corrections
THEN:
- • Sequence numbers are corrected and processing continues to data integrity check
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when data integrity validation has failed.
Trigger Criteria:
- Context: Data integrity validation has failed
- Applied to: Log Data Integrity Error
- Action: The system detects data integrity issues
Logic Flow:
IF Data integrity validation has failed
AND The system detects data integrity issues
THEN:
- • Data integrity error is logged and correction rules are applied
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when data integrity errors have been detected and logged.
Trigger Criteria:
- Context: Data integrity errors have been detected and logged
- Applied to: Apply Data Correction Rules
- Action: The system applies data correction rules
Logic Flow:
IF Data integrity errors have been detected and logged
AND The system applies data correction rules
THEN:
- • Data integrity issues are corrected and status array initialization proceeds
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when s09 segment has passed all validation checks and is marked as valid.
Trigger Criteria:
- Context: S09 segment has passed all validation checks and is marked as valid
- Applied to: Validation Complete - Segment Ready
- Action: The system completes validation process
Logic Flow:
IF S09 segment has passed all validation checks and is marked as valid
AND The system completes validation process
THEN:
- • Segment is confirmed ready for cargo status processing and business logic application
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when s09 segment validation has failed and recovery attempts were unsuccessful.
Trigger Criteria:
- Context: S09 segment validation has failed and recovery attempts were unsuccessful
- Applied to: Validation Failed - Segment Rejected
- Action: The system cannot establish valid segment data
Logic Flow:
IF S09 segment validation has failed and recovery attempts were unsuccessful
AND The system cannot establish valid segment data
THEN:
- • Segment is rejected and default processing procedures are applied
R-GCX016E-cbl-03241 (+10) File: GCX016E.cbl Business Rule: Processing Rules Extraction
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code has been received for processing.
Trigger Criteria:
- Context: A disposition code has been received for processing
- Applied to: Lookup Disposition Code in DC Table
- Action: The system looks up the disposition code in the DC table
Logic Flow:
IF A disposition code has been received for processing
AND The system looks up the disposition code in the DC table
THEN:
- • The system retrieves the corresponding processing rules including action type, quantity impact, and removal requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code lookup has been performed in the dc table.
Trigger Criteria:
- Context: A disposition code lookup has been performed in the DC table
- Applied to: Code Found in Table?
- Action: The disposition code is not found in the table
Logic Flow:
IF A disposition code lookup has been performed in the DC table
AND The disposition code is not found in the table
THEN:
- • The system generates an error message for the unknown disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code has been successfully looked up in the dc table.
Trigger Criteria:
- Context: A disposition code has been successfully looked up in the DC table
- Applied to: Set Hold Indicator
- Action: The action type from the DC table indicates a hold operation
Logic Flow:
IF A disposition code has been successfully looked up in the DC table
AND The action type from the DC table indicates a hold operation
THEN:
- • The system sets the hold indicator flag for subsequent processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code has been successfully looked up in the dc table.
Trigger Criteria:
- Context: A disposition code has been successfully looked up in the DC table
- Applied to: Set Release Indicator
- Action: The action type from the DC table indicates a release operation
Logic Flow:
IF A disposition code has been successfully looked up in the DC table
AND The action type from the DC table indicates a release operation
THEN:
- • The system sets the release indicator flag for subsequent processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code has been successfully looked up in the dc table.
Trigger Criteria:
- Context: A disposition code has been successfully looked up in the DC table
- Applied to: Set Status Info Indicator
- Action: The action type from the DC table indicates a status information operation
Logic Flow:
IF A disposition code has been successfully looked up in the DC table
AND The action type from the DC table indicates a status information operation
THEN:
- • The system sets the status info indicator flag for subsequent processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code has been successfully looked up in the dc table.
Trigger Criteria:
- Context: A disposition code has been successfully looked up in the DC table
- Applied to: Set Removal Indicator
- Action: The action type from the DC table indicates a removal operation
Logic Flow:
IF A disposition code has been successfully looked up in the DC table
AND The action type from the DC table indicates a removal operation
THEN:
- • The system sets the removal indicator flag for subsequent processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code processing rules have been extracted from the dc table.
Trigger Criteria:
- Context: Disposition code processing rules have been extracted from the DC table
- Applied to: Set Quantity Add Flag
- Action: The quantity impact flag indicates the disposition code adds to release quantity
Logic Flow:
IF Disposition code processing rules have been extracted from the DC table
AND The quantity impact flag indicates the disposition code adds to release quantity
THEN:
- • The system sets the quantity add flag to increase release quantities during processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code processing rules have been extracted from the dc table.
Trigger Criteria:
- Context: Disposition code processing rules have been extracted from the DC table
- Applied to: Set Quantity Subtract Flag
- Action: The quantity impact flag indicates the disposition code subtracts from release quantity
Logic Flow:
IF Disposition code processing rules have been extracted from the DC table
AND The quantity impact flag indicates the disposition code subtracts from release quantity
THEN:
- • The system sets the quantity subtract flag to decrease release quantities during processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code processing rules have been extracted from the dc table.
Trigger Criteria:
- Context: Disposition code processing rules have been extracted from the DC table
- Applied to: Set No Quantity Impact
- Action: The quantity impact flag indicates the disposition code has no effect on release quantity
Logic Flow:
IF Disposition code processing rules have been extracted from the DC table
AND The quantity impact flag indicates the disposition code has no effect on release quantity
THEN:
- • The system sets the no quantity impact flag to maintain current release quantities during processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code removal processing requirements have been extracted from the dc table.
Trigger Criteria:
- Context: Disposition code removal processing requirements have been extracted from the DC table
- Applied to: Set Counterpart Removal Flag
- Action: The removal requirements indicate counterpart disposition codes must be removed
Logic Flow:
IF Disposition code removal processing requirements have been extracted from the DC table
AND The removal requirements indicate counterpart disposition codes must be removed
THEN:
- • The system sets the counterpart removal flag to remove conflicting disposition codes before applying the new code
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code removal processing requirements have been extracted from the dc table.
Trigger Criteria:
- Context: Disposition code removal processing requirements have been extracted from the DC table
- Applied to: Set Standard Processing Flag
- Action: The removal requirements indicate no counterpart removal is needed
Logic Flow:
IF Disposition code removal processing requirements have been extracted from the DC table
AND The removal requirements indicate no counterpart removal is needed
THEN:
- • The system sets the standard processing flag to apply the disposition code using normal processing rules
R-GCX016E-cbl-03252 (+24) File: GCX016E.cbl Business Rule: Business Rule Priority Application
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record exists with associated status segments.
Trigger Criteria:
- Context: A cargo record exists with associated status segments
- Applied to: Retrieve Complete S09A Status Array
- Action: The system needs to determine final cargo status
Logic Flow:
IF A cargo record exists with associated status segments
AND The system needs to determine final cargo status
THEN:
- • The complete S09A status array containing all disposition codes and status information is retrieved and made available for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when system is about to evaluate cargo status priorities.
Trigger Criteria:
- Context: The system is about to evaluate cargo status priorities
- Applied to: Initialize Priority Flags
- Action: Priority evaluation process begins
Logic Flow:
IF The system is about to evaluate cargo status priorities
AND Priority evaluation process begins
THEN:
- • All priority flags for hold, release, proceed, arrival, and export conditions are set to initial false state
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status array contains disposition codes.
Trigger Criteria:
- Context: A cargo status array contains disposition codes
- Applied to: Hold Conditions Present?
- Action: The system checks for hold conditions including border holds, destination holds, or FDA holds
Logic Flow:
IF A cargo status array contains disposition codes
AND The system checks for hold conditions including border holds, destination holds, or FDA holds
THEN:
- • The system identifies if any hold disposition codes are present and sets hold priority flag accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status array contains disposition codes.
Trigger Criteria:
- Context: A cargo status array contains disposition codes
- Applied to: Release Conditions Present?
- Action: The system checks for release conditions including manual release or automatic release codes
Logic Flow:
IF A cargo status array contains disposition codes
AND The system checks for release conditions including manual release or automatic release codes
THEN:
- • The system identifies if any release disposition codes are present and sets release priority flag accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status array contains disposition codes.
Trigger Criteria:
- Context: A cargo status array contains disposition codes
- Applied to: Proceed Conditions Present?
- Action: The system checks for proceed disposition codes that allow cargo movement
Logic Flow:
IF A cargo status array contains disposition codes
AND The system checks for proceed disposition codes that allow cargo movement
THEN:
- • The system identifies if any proceed disposition codes are present and sets proceed priority flag accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status array contains disposition codes.
Trigger Criteria:
- Context: A cargo status array contains disposition codes
- Applied to: Arrival Conditions Present?
- Action: The system checks for arrival disposition codes indicating cargo has arrived at destination
Logic Flow:
IF A cargo status array contains disposition codes
AND The system checks for arrival disposition codes indicating cargo has arrived at destination
THEN:
- • The system identifies if any arrival disposition codes are present and sets arrival priority flag accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status array contains disposition codes.
Trigger Criteria:
- Context: A cargo status array contains disposition codes
- Applied to: Export Conditions Present?
- Action: The system checks for export disposition codes indicating cargo is being exported
Logic Flow:
IF A cargo status array contains disposition codes
AND The system checks for export disposition codes indicating cargo is being exported
THEN:
- • The system identifies if any export disposition codes are present and sets export priority flag accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when hold conditions have been detected in the cargo status array.
Trigger Criteria:
- Context: Hold conditions have been detected in the cargo status array
- Applied to: Set Hold Priority Flag
- Action: The system processes the hold condition detection result
Logic Flow:
IF Hold conditions have been detected in the cargo status array
AND The system processes the hold condition detection result
THEN:
- • The hold priority flag is set to true to indicate hold conditions take precedence in status determination
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when release conditions have been detected in the cargo status array.
Trigger Criteria:
- Context: Release conditions have been detected in the cargo status array
- Applied to: Set Release Priority Flag
- Action: The system processes the release condition detection result
Logic Flow:
IF Release conditions have been detected in the cargo status array
AND The system processes the release condition detection result
THEN:
- • The release priority flag is set to true to indicate release conditions are present for priority evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when proceed conditions have been detected in the cargo status array.
Trigger Criteria:
- Context: Proceed conditions have been detected in the cargo status array
- Applied to: Set Proceed Priority Flag
- Action: The system processes the proceed condition detection result
Logic Flow:
IF Proceed conditions have been detected in the cargo status array
AND The system processes the proceed condition detection result
THEN:
- • The proceed priority flag is set to true to indicate proceed conditions are present for priority evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when arrival conditions have been detected in the cargo status array.
Trigger Criteria:
- Context: Arrival conditions have been detected in the cargo status array
- Applied to: Set Arrival Priority Flag
- Action: The system processes the arrival condition detection result
Logic Flow:
IF Arrival conditions have been detected in the cargo status array
AND The system processes the arrival condition detection result
THEN:
- • The arrival priority flag is set to true to indicate arrival conditions are present for priority evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when export conditions have been detected in the cargo status array.
Trigger Criteria:
- Context: Export conditions have been detected in the cargo status array
- Applied to: Set Export Priority Flag
- Action: The system processes the export condition detection result
Logic Flow:
IF Export conditions have been detected in the cargo status array
AND The system processes the export condition detection result
THEN:
- • The export priority flag is set to true to indicate export conditions are present for priority evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when multiple status condition flags are set for a cargo.
Trigger Criteria:
- Context: Multiple status condition flags are set for a cargo
- Applied to: Apply Regulatory Hierarchy Rules
- Action: The system needs to determine the final authoritative status
Logic Flow:
IF Multiple status condition flags are set for a cargo
AND The system needs to determine the final authoritative status
THEN:
- • Regulatory hierarchy rules are applied to establish precedence order among competing status conditions
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when hold conditions are present along with other status conditions.
Trigger Criteria:
- Context: Hold conditions are present along with other status conditions
- Applied to: Hold Takes Precedence?
- Action: The system evaluates precedence according to regulatory hierarchy
Logic Flow:
IF Hold conditions are present along with other status conditions
AND The system evaluates precedence according to regulatory hierarchy
THEN:
- • The system determines if hold conditions take absolute precedence over release, proceed, arrival, or export conditions
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when hold conditions have been determined to take precedence.
Trigger Criteria:
- Context: Hold conditions have been determined to take precedence
- Applied to: HELD
- Action: The system assigns the final cargo status
Logic Flow:
IF Hold conditions have been determined to take precedence
AND The system assigns the final cargo status
THEN:
- • The cargo status is set to HELD and all other competing status conditions are overridden
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when both hold and release conditions are present and hold does not take absolute precedence.
Trigger Criteria:
- Context: Both hold and release conditions are present and hold does not take absolute precedence
- Applied to: Release Overrides Hold?
- Action: The system evaluates if release authorization can override the hold
Logic Flow:
IF Both hold and release conditions are present and hold does not take absolute precedence
AND The system evaluates if release authorization can override the hold
THEN:
- • The system determines if release conditions have sufficient authority to override hold conditions based on regulatory rules
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when release conditions have been determined to override hold conditions.
Trigger Criteria:
- Context: Release conditions have been determined to override hold conditions
- Applied to: RELEASED
- Action: The system assigns the final cargo status
Logic Flow:
IF Release conditions have been determined to override hold conditions
AND The system assigns the final cargo status
THEN:
- • The cargo status is set to RELEASED and hold conditions are overridden by authorized release
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when proceed conditions are present and neither hold nor release take precedence.
Trigger Criteria:
- Context: Proceed conditions are present and neither hold nor release take precedence
- Applied to: Proceed Conditions Valid?
- Action: The system validates proceed condition legitimacy
Logic Flow:
IF Proceed conditions are present and neither hold nor release take precedence
AND The system validates proceed condition legitimacy
THEN:
- • The system determines if proceed conditions meet all regulatory requirements and can be applied as final status
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when proceed conditions have been validated as legitimate and applicable.
Trigger Criteria:
- Context: Proceed conditions have been validated as legitimate and applicable
- Applied to: PROCEED
- Action: The system assigns the final cargo status
Logic Flow:
IF Proceed conditions have been validated as legitimate and applicable
AND The system assigns the final cargo status
THEN:
- • The cargo status is set to PROCEED allowing cargo movement according to disposition instructions
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when arrival conditions are present and higher precedence conditions do not apply.
Trigger Criteria:
- Context: Arrival conditions are present and higher precedence conditions do not apply
- Applied to: Arrival Status Valid?
- Action: The system validates arrival status legitimacy
Logic Flow:
IF Arrival conditions are present and higher precedence conditions do not apply
AND The system validates arrival status legitimacy
THEN:
- • The system determines if arrival conditions meet all requirements and can be applied as final status
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when arrival conditions have been validated as legitimate and applicable.
Trigger Criteria:
- Context: Arrival conditions have been validated as legitimate and applicable
- Applied to: ARRIVED
- Action: The system assigns the final cargo status
Logic Flow:
IF Arrival conditions have been validated as legitimate and applicable
AND The system assigns the final cargo status
THEN:
- • The cargo status is set to ARRIVED indicating successful cargo arrival at destination
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when export conditions are present and higher precedence conditions do not apply.
Trigger Criteria:
- Context: Export conditions are present and higher precedence conditions do not apply
- Applied to: Export Status Valid?
- Action: The system validates export status legitimacy
Logic Flow:
IF Export conditions are present and higher precedence conditions do not apply
AND The system validates export status legitimacy
THEN:
- • The system determines if export conditions meet all requirements and can be applied as final status
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when export conditions have been validated as legitimate and applicable.
Trigger Criteria:
- Context: Export conditions have been validated as legitimate and applicable
- Applied to: EXPORTED
- Action: The system assigns the final cargo status
Logic Flow:
IF Export conditions have been validated as legitimate and applicable
AND The system assigns the final cargo status
THEN:
- • The cargo status is set to EXPORTED indicating cargo has been processed for export
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when no specific status conditions (hold, release, proceed, arrival, export) are valid or applicable.
Trigger Criteria:
- Context: No specific status conditions (hold, release, proceed, arrival, export) are valid or applicable
- Applied to: DEFAULT
- Action: The system assigns the final cargo status
Logic Flow:
IF No specific status conditions (hold, release, proceed, arrival, export) are valid or applicable
AND The system assigns the final cargo status
THEN:
- • The cargo status is set to a default value indicating standard processing state
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when final cargo status has been determined through priority rule application.
Trigger Criteria:
- Context: A final cargo status has been determined through priority rule application
- Applied to: Return Final Cargo Status
- Action: The status determination process completes
Logic Flow:
IF A final cargo status has been determined through priority rule application
AND The status determination process completes
THEN:
- • The final cargo status is returned to the calling process for further business operations
R-GCX016E-cbl-03277 (+9) File: GCX016E.cbl Business Rule: K1 Comment Integration Processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when k1 segment is received for processing.
Trigger Criteria:
- Context: A K1 segment is received for processing
- Applied to: Validate K1 Segment Format
- Action: The system validates the K1 segment format and structure
Logic Flow:
IF A K1 segment is received for processing
AND The system validates the K1 segment format and structure
THEN:
- • The segment is accepted if format is valid,
otherwise it is rejected and logged as invalid
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when valid k1 segment has been received.
Trigger Criteria:
- Context: A valid K1 segment has been received
- Applied to: Extract Free-Form Text Content
- Action: The system processes the K1 segment to extract message content
Logic Flow:
IF A valid K1 segment has been received
AND The system processes the K1 segment to extract message content
THEN:
- • The free-form text content is extracted and made available for comment type determination
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when free-form text content has been extracted from a k1 segment.
Trigger Criteria:
- Context: Free-form text content has been extracted from a K1 segment
- Applied to: Determine Comment Type
- Action: The system analyzes the content to determine comment classification
Logic Flow:
IF Free-form text content has been extracted from a K1 segment
AND The system analyzes the content to determine comment classification
THEN:
- • The comment is classified as either special comment type or standard comment type based on content analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when k1 comment has been classified as special comment type.
Trigger Criteria:
- Context: A K1 comment has been classified as special comment type
- Applied to: Canadian Pacific Railway Bond Creation
- Action: The comment content contains 'DIRECTOR OF CUSTOMS, CP RAIL' or 'CANADIAN PACIFIC LIMITED' or 'CANADIAN PACIFIC RAILWAY CO'
Logic Flow:
IF A K1 comment has been classified as special comment type
AND The comment content contains 'DIRECTOR OF CUSTOMS, CP RAIL' or 'CANADIAN PACIFIC LIMITED' or 'CANADIAN PACIFIC RAILWAY CO'
THEN:
- • The system triggers Canadian Pacific Railway bond creation processing and generates appropriate broker bond messages
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when k1 comment has been processed and classified.
Trigger Criteria:
- Context: A K1 comment has been processed and classified
- Applied to: Store K1 Comment in Memory
- Action: The system stores the comment for integration with disposition processing
Logic Flow:
IF A K1 comment has been processed and classified
AND The system stores the comment for integration with disposition processing
THEN:
- • The K1 comment is stored in memory with up to 4 lines of comment text available for notification integration
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when k1 comment is stored in memory and a disposition code is being processed.
Trigger Criteria:
- Context: A K1 comment is stored in memory and a disposition code is being processed
- Applied to: Associate with Current Disposition Code
- Action: The system associates the comment with the current disposition code context
Logic Flow:
IF A K1 comment is stored in memory and a disposition code is being processed
AND The system associates the comment with the current disposition code context
THEN:
- • The K1 comment becomes available for inclusion in disposition code notifications and Merlin messages
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when k1 comment is ready for integration with disposition notifications.
Trigger Criteria:
- Context: A K1 comment is ready for integration with disposition notifications
- Applied to: Train or Cargo Context?
- Action: The system evaluates the current processing context
Logic Flow:
IF A K1 comment is ready for integration with disposition notifications
AND The system evaluates the current processing context
THEN:
- • The comment is routed to either train disposition notification or cargo disposition notification based on the current processing context
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when k1 comments are available for integration and merlin messages are being generated.
Trigger Criteria:
- Context: K1 comments are available for integration and Merlin messages are being generated
- Applied to: Add to Merlin Message Content
- Action: The system formats Merlin message content including disposition code information
Logic Flow:
IF K1 comments are available for integration and Merlin messages are being generated
AND The system formats Merlin message content including disposition code information
THEN:
- • K1 comments are included in the Merlin message content along with cargo information, disposition codes, and other relevant details
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when k1 comments are integrated with merlin messages and release quantity impacts are being calculated.
Trigger Criteria:
- Context: K1 comments are integrated with Merlin messages and release quantity impacts are being calculated
- Applied to: Include in Release Quantity Impact Message
- Action: The system generates messages showing quantity impact of disposition codes
Logic Flow:
IF K1 comments are integrated with Merlin messages and release quantity impacts are being calculated
AND The system generates messages showing quantity impact of disposition codes
THEN:
- • K1 comments are included to provide additional context about how release quantities will be affected (add/subtract)
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when k1 segment fails format validation.
Trigger Criteria:
- Context: A K1 segment fails format validation
- Applied to: Log Invalid K1 Segment
- Action: The system processes the invalid segment
Logic Flow:
IF A K1 segment fails format validation
AND The system processes the invalid segment
THEN:
- • The invalid K1 segment is logged for audit purposes and processing continues without including the invalid comment
R-GCX016E-cbl-03287 (+13) File: GCX016E.cbl Business Rule: Cargo Segment Data Analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record exists and requires freight forwarder analysis.
Trigger Criteria:
- Context: A cargo record exists and requires freight forwarder analysis
- Applied to: Retrieve GCSUSS03 Cargo Segment Data
- Action: The system initiates cargo segment data analysis
Logic Flow:
IF A cargo record exists and requires freight forwarder analysis
AND The system initiates cargo segment data analysis
THEN:
- • The system retrieves GCSUSS03 cargo segment data for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when primary cargo segment data has been retrieved from gcsuss03.
Trigger Criteria:
- Context: Primary cargo segment data has been retrieved from GCSUSS03
- Applied to: Retrieve GCSUSS07 Cargo Segment Data
- Action: The system continues cargo segment data analysis
Logic Flow:
IF Primary cargo segment data has been retrieved from GCSUSS03
AND The system continues cargo segment data analysis
THEN:
- • The system retrieves GCSUSS07 cargo segment data for additional processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when gcsuss03 and gcsuss07 cargo segment data have been retrieved.
Trigger Criteria:
- Context: GCSUSS03 and GCSUSS07 cargo segment data have been retrieved
- Applied to: Extract Freight Forwarder Identifiers
- Action: The system processes the cargo segment data
Logic Flow:
IF GCSUSS03 and GCSUSS07 cargo segment data have been retrieved
AND The system processes the cargo segment data
THEN:
- • The system extracts freight forwarder identifiers from the segment data
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when freight forwarder identifier extraction has been completed.
Trigger Criteria:
- Context: Freight forwarder identifier extraction has been completed
- Applied to: Freight Forwarder ID Found?
- Action: The system evaluates the extraction results
Logic Flow:
IF Freight forwarder identifier extraction has been completed
AND The system evaluates the extraction results
THEN:
- • The system determines if a valid freight forwarder ID was found and proceeds accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid freight forwarder id has been found in cargo segments.
Trigger Criteria:
- Context: A valid freight forwarder ID has been found in cargo segments
- Applied to: Search Broker Database for Freight Forwarder
- Action: The system needs to validate the freight forwarder
Logic Flow:
IF A valid freight forwarder ID has been found in cargo segments
AND The system needs to validate the freight forwarder
THEN:
- • The system searches the broker database for matching freight forwarder information
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when freight forwarder information has been located in the broker database.
Trigger Criteria:
- Context: Freight forwarder information has been located in the broker database
- Applied to: Validate Broker Relationship
- Action: The system evaluates the broker-freight forwarder relationship
Logic Flow:
IF Freight forwarder information has been located in the broker database
AND The system evaluates the broker-freight forwarder relationship
THEN:
- • The system validates whether a legitimate broker relationship exists
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when broker relationship validation has been completed.
Trigger Criteria:
- Context: Broker relationship validation has been completed
- Applied to: Valid Broker Relationship?
- Action: The system evaluates the validation results
Logic Flow:
IF Broker relationship validation has been completed
AND The system evaluates the validation results
THEN:
- • The system determines if the broker relationship is valid and routes processing accordingly
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid broker relationship has been established with the freight forwarder.
Trigger Criteria:
- Context: A valid broker relationship has been established with the freight forwarder
- Applied to: Retrieve Freight Forwarder Name
- Action: The system needs freight forwarder identification details
Logic Flow:
IF A valid broker relationship has been established with the freight forwarder
AND The system needs freight forwarder identification details
THEN:
- • The system retrieves the freight forwarder name from the broker records
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when freight forwarder name has been retrieved from broker records.
Trigger Criteria:
- Context: Freight forwarder name has been retrieved from broker records
- Applied to: Retrieve Contact Information
- Action: The system needs to obtain contact details for notifications
Logic Flow:
IF Freight forwarder name has been retrieved from broker records
AND The system needs to obtain contact details for notifications
THEN:
- • The system retrieves contact information from GCSTBRT table segments
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when freight forwarder contact information has been retrieved.
Trigger Criteria:
- Context: Freight forwarder contact information has been retrieved
- Applied to: Determine Notification Requirements
- Action: The system evaluates notification requirements
Logic Flow:
IF Freight forwarder contact information has been retrieved
AND The system evaluates notification requirements
THEN:
- • The system determines the appropriate notification method and requirements based on freight forwarder setup and cargo status
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when notification requirements have been determined for the freight forwarder.
Trigger Criteria:
- Context: Notification requirements have been determined for the freight forwarder
- Applied to: CIH Hold Scenario?
- Action: The system evaluates the cargo hold status
Logic Flow:
IF Notification requirements have been determined for the freight forwarder
AND The system evaluates the cargo hold status
THEN:
- • The system determines if the scenario qualifies as a CIH hold requiring email notification
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo situation has been identified as a cih hold scenario.
Trigger Criteria:
- Context: The cargo situation has been identified as a CIH hold scenario
- Applied to: Set Email Notification Required Flag
- Action: The system processes the hold scenario determination
Logic Flow:
IF The cargo situation has been identified as a CIH hold scenario
AND The system processes the hold scenario determination
THEN:
- • The system sets the email notification required flag to trigger email delivery
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when either no freight forwarder id was found, no valid broker relationship exists, or the scenario is not a cih hold.
Trigger Criteria:
- Context: Either no freight forwarder ID was found, no valid broker relationship exists, or the scenario is not a CIH hold
- Applied to: Set No Notification Required Flag
- Action: The system determines notification requirements
Logic Flow:
IF Either no freight forwarder ID was found, no valid broker relationship exists, or the scenario is not a CIH hold
AND The system determines notification requirements
THEN:
- • The system sets the no notification required flag to bypass email delivery
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when either email notification required flag or no notification required flag has been set.
Trigger Criteria:
- Context: Either email notification required flag or no notification required flag has been set
- Applied to: Complete Analysis
- Action: The system finalizes the cargo segment data analysis
Logic Flow:
IF Either email notification required flag or no notification required flag has been set
AND The system finalizes the cargo segment data analysis
THEN:
- • The system completes the analysis process with all notification requirements determined
R-GCX016E-cbl-03301 (+15) File: GCX016E.cbl Business Rule: Individual Record Status Analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record is being evaluated for status analysis.
Trigger Criteria:
- Context: A cargo record is being evaluated for status analysis
- Applied to: Is Cargo Record Deleted?
- Action: The cargo record has a deleted status indicator
Logic Flow:
IF A cargo record is being evaluated for status analysis
AND The cargo record has a deleted status indicator
THEN:
- • The cargo record is excluded from further processing and analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when non-deleted cargo record is being analyzed.
Trigger Criteria:
- Context: A non-deleted cargo record is being analyzed
- Applied to: Check Manual Release Status
- Action: The system checks the cargo's release status indicators
Logic Flow:
IF A non-deleted cargo record is being analyzed
AND The system checks the cargo's release status indicators
THEN:
- • The manual release status is determined and recorded for subsequent processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record has been identified as manually released.
Trigger Criteria:
- Context: A cargo record has been identified as manually released
- Applied to: Set Manual Release Flag
- Action: The manual release detection process completes
Logic Flow:
IF A cargo record has been identified as manually released
AND The manual release detection process completes
THEN:
- • The manual release flag is set for the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record is undergoing hold type evaluation.
Trigger Criteria:
- Context: A cargo record is undergoing hold type evaluation
- Applied to: Border Hold Present?
- Action: The system checks for border hold indicators in the cargo status
Logic Flow:
IF A cargo record is undergoing hold type evaluation
AND The system checks for border hold indicators in the cargo status
THEN:
- • The presence or absence of border hold is determined
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record has been identified with border hold conditions.
Trigger Criteria:
- Context: A cargo record has been identified with border hold conditions
- Applied to: Set Border Hold Flag
- Action: The border hold evaluation completes
Logic Flow:
IF A cargo record has been identified with border hold conditions
AND The border hold evaluation completes
THEN:
- • The border hold flag is set for the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record is being evaluated for hold types.
Trigger Criteria:
- Context: A cargo record is being evaluated for hold types
- Applied to: Destination Hold Present?
- Action: The system checks for destination hold indicators in the cargo status
Logic Flow:
IF A cargo record is being evaluated for hold types
AND The system checks for destination hold indicators in the cargo status
THEN:
- • The presence or absence of destination hold is determined
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record has been identified with destination hold conditions.
Trigger Criteria:
- Context: A cargo record has been identified with destination hold conditions
- Applied to: Set Destination Hold Flag
- Action: The destination hold evaluation completes
Logic Flow:
IF A cargo record has been identified with destination hold conditions
AND The destination hold evaluation completes
THEN:
- • The destination hold flag is set for the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record is being evaluated for regulatory hold types.
Trigger Criteria:
- Context: A cargo record is being evaluated for regulatory hold types
- Applied to: FDA Hold Present?
- Action: The system checks for FDA hold indicators in the cargo status
Logic Flow:
IF A cargo record is being evaluated for regulatory hold types
AND The system checks for FDA hold indicators in the cargo status
THEN:
- • The presence or absence of FDA hold is determined
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record has been identified with fda hold conditions.
Trigger Criteria:
- Context: A cargo record has been identified with FDA hold conditions
- Applied to: Set FDA Hold Flag
- Action: The FDA hold evaluation completes
Logic Flow:
IF A cargo record has been identified with FDA hold conditions
AND The FDA hold evaluation completes
THEN:
- • The FDA hold flag is set for the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record is being evaluated for quantity-related hold types.
Trigger Criteria:
- Context: A cargo record is being evaluated for quantity-related hold types
- Applied to: Piece Count Hold Present?
- Action: The system checks for piece count hold indicators in the cargo status
Logic Flow:
IF A cargo record is being evaluated for quantity-related hold types
AND The system checks for piece count hold indicators in the cargo status
THEN:
- • The presence or absence of piece count hold is determined
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record has piece count hold indicators.
Trigger Criteria:
- Context: A cargo record has piece count hold indicators
- Applied to: Validate Piece Count
- Action: The system validates the piece count against expected quantities
Logic Flow:
IF A cargo record has piece count hold indicators
AND The system validates the piece count against expected quantities
THEN:
- • The piece count validation result is determined
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record has invalid piece count validation results.
Trigger Criteria:
- Context: A cargo record has invalid piece count validation results
- Applied to: Set Piece Count Hold Flag
- Action: The piece count validation process completes
Logic Flow:
IF A cargo record has invalid piece count validation results
AND The piece count validation process completes
THEN:
- • The piece count hold flag is set for the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record has completed hold type evaluation.
Trigger Criteria:
- Context: A cargo record has completed hold type evaluation
- Applied to: All Holds Cleared?
- Action: The system checks all hold flags (border, destination, FDA, piece count)
Logic Flow:
IF A cargo record has completed hold type evaluation
AND The system checks all hold flags (border, destination, FDA, piece count)
THEN:
- • The overall hold clearance status is determined
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo record has all hold conditions cleared.
Trigger Criteria:
- Context: A cargo record has all hold conditions cleared
- Applied to: Set Release Eligible Flag
- Action: The release eligibility evaluation completes
Logic Flow:
IF A cargo record has all hold conditions cleared
AND The release eligibility evaluation completes
THEN:
- • The release eligible flag is set for the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record has one or more active hold conditions.
Trigger Criteria:
- Context: A cargo record has one or more active hold conditions
- Applied to: Set Hold Status Flag
- Action: The release eligibility evaluation completes
Logic Flow:
IF A cargo record has one or more active hold conditions
AND The release eligibility evaluation completes
THEN:
- • The hold status flag is set for the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when individual cargo record analysis has completed with all flags determined.
Trigger Criteria:
- Context: Individual cargo record analysis has completed with all flags determined
- Applied to: Update Cargo Status Flags
- Action: The system updates the cargo record status information
Logic Flow:
IF Individual cargo record analysis has completed with all flags determined
AND The system updates the cargo record status information
THEN:
- • All status flags are updated to reflect the current cargo state
R-GCX016E-cbl-03317 (+16) File: GCX016E.cbl Business Rule: M10 Manifest Data Extraction
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when m10 segment is received with manifest data.
Trigger Criteria:
- Context: An M10 segment is received with manifest data
- Applied to: Extract SCAC Code from M10
- Action: The system processes the M10 segment
Logic Flow:
IF An M10 segment is received with manifest data
AND The system processes the M10 segment
THEN:
- • The SCAC code is extracted from positions 3-6 of the M10 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when scac code has been extracted from the m10 segment.
Trigger Criteria:
- Context: A SCAC code has been extracted from the M10 segment
- Applied to: SCAC Code Valid?
- Action: The system validates the SCAC code
Logic Flow:
IF A SCAC code has been extracted from the M10 segment
AND The system validates the SCAC code
THEN:
- • The SCAC code must be non-blank and contain valid alphanumeric characters
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when m10 segment with valid scac code is being processed.
Trigger Criteria:
- Context: An M10 segment with valid SCAC code is being processed
- Applied to: Extract Transport Type
- Action: The system extracts transport type information
Logic Flow:
IF An M10 segment with valid SCAC code is being processed
AND The system extracts transport type information
THEN:
- • The transport type code is extracted from the designated position in the M10 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when transport type code has been extracted from the m10 segment.
Trigger Criteria:
- Context: A transport type code has been extracted from the M10 segment
- Applied to: Transport Type Valid?
- Action: The system validates the transport type
Logic Flow:
IF A transport type code has been extracted from the M10 segment
AND The system validates the transport type
THEN:
- • The transport type must be a valid code representing rail, truck, vessel, or air transportation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when m10 segment with valid transport type is being processed.
Trigger Criteria:
- Context: An M10 segment with valid transport type is being processed
- Applied to: Extract Country Code
- Action: The system extracts country code information
Logic Flow:
IF An M10 segment with valid transport type is being processed
AND The system extracts country code information
THEN:
- • The country code is extracted from the designated position in the M10 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when country code has been extracted from the m10 segment.
Trigger Criteria:
- Context: A country code has been extracted from the M10 segment
- Applied to: Country Code Valid?
- Action: The system validates the country code
Logic Flow:
IF A country code has been extracted from the M10 segment
AND The system validates the country code
THEN:
- • The country code must be a valid ISO country code or recognized customs country identifier
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when m10 segment with valid country code is being processed.
Trigger Criteria:
- Context: An M10 segment with valid country code is being processed
- Applied to: Extract Vessel Name
- Action: The system extracts vessel name information
Logic Flow:
IF An M10 segment with valid country code is being processed
AND The system extracts vessel name information
THEN:
- • The vessel name is extracted from positions 7-16 of the M10 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when vessel name has been extracted from the m10 segment.
Trigger Criteria:
- Context: A vessel name has been extracted from the M10 segment
- Applied to: Extract Vessel Details
- Action: The system extracts additional vessel details
Logic Flow:
IF A vessel name has been extracted from the M10 segment
AND The system extracts additional vessel details
THEN:
- • Voyage number, vessel flag, and other vessel identifiers are extracted from their respective positions in the M10 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when vessel details have been extracted from the m10 segment.
Trigger Criteria:
- Context: Vessel details have been extracted from the M10 segment
- Applied to: Vessel Info Valid?
- Action: The system validates the vessel information
Logic Flow:
IF Vessel details have been extracted from the M10 segment
AND The system validates the vessel information
THEN:
- • The vessel name must be non-blank and vessel details must conform to transportation standards
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid vessel information has been extracted from the m10 segment.
Trigger Criteria:
- Context: Valid vessel information has been extracted from the M10 segment
- Applied to: Extract Cross-Border Routing Info
- Action: The system extracts cross-border routing information
Logic Flow:
IF Valid vessel information has been extracted from the M10 segment
AND The system extracts cross-border routing information
THEN:
- • Port of entry, port of exit, and routing codes are extracted from their designated positions in the M10 segment
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cross-border routing information has been extracted from the m10 segment.
Trigger Criteria:
- Context: Cross-border routing information has been extracted from the M10 segment
- Applied to: Routing Valid?
- Action: The system validates the routing information
Logic Flow:
IF Cross-border routing information has been extracted from the M10 segment
AND The system validates the routing information
THEN:
- • Port codes must be valid customs ports and routing must be logically consistent for the transportation mode
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all m10 segment data has been validated successfully.
Trigger Criteria:
- Context: All M10 segment data has been validated successfully
- Applied to: Build Foreign Manifest Structure
- Action: The system builds the foreign manifest structure
Logic Flow:
IF All M10 segment data has been validated successfully
AND The system builds the foreign manifest structure
THEN:
- • A complete foreign manifest record is created with SCAC, transport type, country, vessel, and routing information
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when foreign manifest structure has been built.
Trigger Criteria:
- Context: A foreign manifest structure has been built
- Applied to: Set Manifest Data Fields
- Action: The system sets manifest data fields
Logic Flow:
IF A foreign manifest structure has been built
AND The system sets manifest data fields
THEN:
- • All extracted data elements are assigned to their corresponding fields in the manifest record
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when manifest data fields have been set with extracted information.
Trigger Criteria:
- Context: Manifest data fields have been set with extracted information
- Applied to: Manifest Complete?
- Action: The system validates the complete manifest
Logic Flow:
IF Manifest data fields have been set with extracted information
AND The system validates the complete manifest
THEN:
- • All mandatory fields must be populated and the manifest must meet completeness requirements for customs processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when complete and validated manifest has been created.
Trigger Criteria:
- Context: A complete and validated manifest has been created
- Applied to: Store Manifest Data
- Action: The system stores the manifest data
Logic Flow:
IF A complete and validated manifest has been created
AND The system stores the manifest data
THEN:
- • The manifest data is stored in the system for subsequent cargo and customs processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when manifest validation has failed for any required field.
Trigger Criteria:
- Context: Manifest validation has failed for any required field
- Applied to: Generate Error Message
- Action: The system generates an error message
Logic Flow:
IF Manifest validation has failed for any required field
AND The system generates an error message
THEN:
- • A descriptive error message is created indicating the specific validation failure and the manifest is marked as invalid
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when some m10 segment data is invalid but not critical for processing.
Trigger Criteria:
- Context: Some M10 segment data is invalid but not critical for processing
- Applied to: Set Default Values
- Action: The system sets default values
Logic Flow:
IF Some M10 segment data is invalid but not critical for processing
AND The system sets default values
THEN:
- • Appropriate default values are assigned to non-critical fields to allow continued processing
R-GCX016E-cbl-03334 (+23) File: GCX016E.cbl Business Rule: Search S09A Status Array for Existing Codes
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status array search operation is initiated.
Trigger Criteria:
- Context: A status array search operation is initiated
- Applied to: Initialize Search Parameters
- Action: The search process begins
Logic Flow:
IF A status array search operation is initiated
AND The search process begins
THEN:
- • All search parameters are initialized including duplicate flags, conflict flags, position counters, and removal lists are cleared
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record exists with potential s09a status array data.
Trigger Criteria:
- Context: A cargo record exists with potential S09A status array data
- Applied to: Load Current S09A Status Array
- Action: The status array loading process is executed
Logic Flow:
IF A cargo record exists with potential S09A status array data
AND The status array loading process is executed
THEN:
- • The current S09A status array is loaded into working storage for analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when s09a status array has been loaded.
Trigger Criteria:
- Context: The S09A status array has been loaded
- Applied to: Status Array Empty?
- Action: The array is examined for content
Logic Flow:
IF The S09A status array has been loaded
AND The array is examined for content
THEN:
- • If the array contains no entries, set array empty flag and terminate search;
otherwise proceed with sequential search
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when s09a status array has been examined and found to contain no entries.
Trigger Criteria:
- Context: The S09A status array has been examined and found to contain no entries
- Applied to: Set Array Empty Flag
- Action: The empty condition is confirmed
Logic Flow:
IF The S09A status array has been examined and found to contain no entries
AND The empty condition is confirmed
THEN:
- • Set the array empty flag to indicate no disposition codes exist for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when s09a status array contains one or more entries.
Trigger Criteria:
- Context: The S09A status array contains one or more entries
- Applied to: Begin Sequential Array Search
- Action: The sequential search process is initiated
Logic Flow:
IF The S09A status array contains one or more entries
AND The sequential search process is initiated
THEN:
- • Begin iterating through each status array entry starting from the first position
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when sequential search through the status array is in progress.
Trigger Criteria:
- Context: A sequential search through the status array is in progress
- Applied to: More Array Entries?
- Action: The current position in the array is evaluated
Logic Flow:
IF A sequential search through the status array is in progress
AND The current position in the array is evaluated
THEN:
- • If more entries exist, continue to next entry;
otherwise complete the array analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when more entries exist in the status array to examine.
Trigger Criteria:
- Context: More entries exist in the status array to examine
- Applied to: Get Next Status Entry
- Action: The next entry retrieval is executed
Logic Flow:
IF More entries exist in the status array to examine
AND The next entry retrieval is executed
THEN:
- • The next status array entry is loaded for disposition code analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status array entry has been retrieved.
Trigger Criteria:
- Context: A status array entry has been retrieved
- Applied to: Extract Disposition Code
- Action: The disposition code extraction is performed
Logic Flow:
IF A status array entry has been retrieved
AND The disposition code extraction is performed
THEN:
- • The disposition code is extracted from the entry for comparison purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code has been extracted from the current status entry and a target code is defined.
Trigger Criteria:
- Context: A disposition code has been extracted from the current status entry and a target code is defined
- Applied to: Code Matches Target?
- Action: The code comparison is performed
Logic Flow:
IF A disposition code has been extracted from the current status entry and a target code is defined
AND The code comparison is performed
THEN:
- • If the extracted code matches the target code, mark as duplicate found;
otherwise check for counterpart codes
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when extracted disposition code matches the target code being searched.
Trigger Criteria:
- Context: The extracted disposition code matches the target code being searched
- Applied to: Mark Duplicate Found
- Action: The duplicate marking process is executed
Logic Flow:
IF The extracted disposition code matches the target code being searched
AND The duplicate marking process is executed
THEN:
- • Set the duplicate found flag to indicate an existing matching disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when duplicate disposition code has been identified in the status array.
Trigger Criteria:
- Context: A duplicate disposition code has been identified in the status array
- Applied to: Record Entry Position
- Action: The position recording is performed
Logic Flow:
IF A duplicate disposition code has been identified in the status array
AND The position recording is performed
THEN:
- • Record the current array position for potential future reference or removal operations
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code has been extracted from the status array entry.
Trigger Criteria:
- Context: A disposition code has been extracted from the status array entry
- Applied to: Check for Counterpart Codes
- Action: The counterpart code analysis is performed
Logic Flow:
IF A disposition code has been extracted from the status array entry
AND The counterpart code analysis is performed
THEN:
- • Determine if the current code conflicts with existing codes and requires counterpart removal
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when counterpart code analysis has been completed for the current disposition code.
Trigger Criteria:
- Context: The counterpart code analysis has been completed for the current disposition code
- Applied to: Counterpart Code Found?
- Action: The counterpart detection results are evaluated
Logic Flow:
IF The counterpart code analysis has been completed for the current disposition code
AND The counterpart detection results are evaluated
THEN:
- • If counterpart codes are found, mark for removal;
otherwise continue with the search process
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when counterpart disposition codes have been identified that conflict with the current processing.
Trigger Criteria:
- Context: Counterpart disposition codes have been identified that conflict with the current processing
- Applied to: Mark for Removal
- Action: The removal marking process is executed
Logic Flow:
IF Counterpart disposition codes have been identified that conflict with the current processing
AND The removal marking process is executed
THEN:
- • Mark the conflicting codes for removal from the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition codes have been marked for removal due to conflicts.
Trigger Criteria:
- Context: Disposition codes have been marked for removal due to conflicts
- Applied to: Add to Removal List
- Action: The removal list update is performed
Logic Flow:
IF Disposition codes have been marked for removal due to conflicts
AND The removal list update is performed
THEN:
- • Add the conflicting codes and their positions to the removal list for subsequent processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when current status array entry has been processed for duplicates and conflicts.
Trigger Criteria:
- Context: The current status array entry has been processed for duplicates and conflicts
- Applied to: Continue Search
- Action: The search continuation is executed
Logic Flow:
IF The current status array entry has been processed for duplicates and conflicts
AND The search continuation is executed
THEN:
- • Move to the next array position to continue the sequential search process
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all entries in the s09a status array have been examined.
Trigger Criteria:
- Context: All entries in the S09A status array have been examined
- Applied to: Complete Array Analysis
- Action: The array analysis completion is executed
Logic Flow:
IF All entries in the S09A status array have been examined
AND The array analysis completion is executed
THEN:
- • Prepare to evaluate the search results for duplicates and conflicts
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when complete status array has been searched for disposition codes.
Trigger Criteria:
- Context: The complete status array has been searched for disposition codes
- Applied to: Duplicates Found?
- Action: The duplicate detection results are evaluated
Logic Flow:
IF The complete status array has been searched for disposition codes
AND The duplicate detection results are evaluated
THEN:
- • If duplicates were found, set duplicate flag;
otherwise proceed to check for conflicts
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when duplicate disposition codes have been identified during the array search.
Trigger Criteria:
- Context: Duplicate disposition codes have been identified during the array search
- Applied to: Set Duplicate Flag
- Action: The duplicate flag setting is executed
Logic Flow:
IF Duplicate disposition codes have been identified during the array search
AND The duplicate flag setting is executed
THEN:
- • Set the duplicate flag to indicate that matching disposition codes already exist
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status array search has been completed and duplicate analysis is done.
Trigger Criteria:
- Context: The status array search has been completed and duplicate analysis is done
- Applied to: Conflicts Found?
- Action: The conflict detection results are evaluated
Logic Flow:
IF The status array search has been completed and duplicate analysis is done
AND The conflict detection results are evaluated
THEN:
- • If conflicts were found, set conflict flag;
otherwise prepare search results
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when conflicting counterpart disposition codes have been identified during the search.
Trigger Criteria:
- Context: Conflicting counterpart disposition codes have been identified during the search
- Applied to: Set Conflict Flag
- Action: The conflict flag setting is executed
Logic Flow:
IF Conflicting counterpart disposition codes have been identified during the search
AND The conflict flag setting is executed
THEN:
- • Set the conflict flag to indicate that counterpart codes need removal
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when status array search has been completed with duplicate and conflict analysis.
Trigger Criteria:
- Context: The status array search has been completed with duplicate and conflict analysis
- Applied to: Prepare Search Results
- Action: The search results preparation is executed
Logic Flow:
IF The status array search has been completed with duplicate and conflict analysis
AND The search results preparation is executed
THEN:
- • Compile all search findings including duplicate flags, conflict flags, positions, and removal lists
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when search results have been prepared with all findings compiled.
Trigger Criteria:
- Context: The search results have been prepared with all findings compiled
- Applied to: Return Search Status
- Action: The search status return is executed
Logic Flow:
IF The search results have been prepared with all findings compiled
AND The search status return is executed
THEN:
- • Return the complete search status including duplicate indicators, conflict indicators, and removal requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when search status has been returned to the calling process.
Trigger Criteria:
- Context: The search status has been returned to the calling process
- Applied to: End Search Process
- Action: The search process termination is executed
Logic Flow:
IF The search status has been returned to the calling process
AND The search process termination is executed
THEN:
- • End the status array search operation and return control to the disposition code processing logic
R-GCX016E-cbl-03358 (+11) File: GCX016E.cbl Business Rule: Convert EDI Entry Type Code
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when x4 segment is being processed for cargo disposition.
Trigger Criteria:
- Context: An X4 segment is being processed for cargo disposition
- Applied to: Entry Type Code Present?
- Action: The system checks for the presence of an entry type code in the segment
Logic Flow:
IF An X4 segment is being processed for cargo disposition
AND The system checks for the presence of an entry type code in the segment
THEN:
- • If entry type code is present, continue with conversion process,
otherwise skip entry type processing and continue with other segment processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when edi entry type code is present in the x4 segment and conversion arrays are initialized.
Trigger Criteria:
- Context: An EDI entry type code is present in the X4 segment and conversion arrays are initialized
- Applied to: Lookup EDI Code in Conversion Table
- Action: The system searches the EDI entry type code conversion table for a matching code
Logic Flow:
IF An EDI entry type code is present in the X4 segment and conversion arrays are initialized
AND The system searches the EDI entry type code conversion table for a matching code
THEN:
- • The system locates the position of the EDI code in the lookup array for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when edi entry type code has been searched in the conversion table.
Trigger Criteria:
- Context: An EDI entry type code has been searched in the conversion table
- Applied to: Code Found in Table?
- Action: The system evaluates whether the code was found in the lookup table
Logic Flow:
IF An EDI entry type code has been searched in the conversion table
AND The system evaluates whether the code was found in the lookup table
THEN:
- • If code is found, retrieve the internal system value,
otherwise generate an error message for invalid code
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when edi entry type code is found in the conversion lookup table.
Trigger Criteria:
- Context: The EDI entry type code is found in the conversion lookup table
- Applied to: Retrieve Internal System Value
- Action: The system retrieves the corresponding internal value from the same array position
Logic Flow:
IF The EDI entry type code is found in the conversion lookup table
AND The system retrieves the corresponding internal value from the same array position
THEN:
- • The internal system entry type value is obtained for further processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when internal system entry type value has been retrieved from the conversion table.
Trigger Criteria:
- Context: An internal system entry type value has been retrieved from the conversion table
- Applied to: Border Crossing Code?
- Action: The system evaluates whether the entry type code indicates a border crossing
Logic Flow:
IF An internal system entry type value has been retrieved from the conversion table
AND The system evaluates whether the entry type code indicates a border crossing
THEN:
- • If it is a border crossing code, apply special border crossing logic,
otherwise proceed with standard in-bond flag processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when entry type code is identified as a border crossing code.
Trigger Criteria:
- Context: The entry type code is identified as a border crossing code
- Applied to: Apply Special Border Crossing Logic
- Action: The system applies border crossing specific processing rules
Logic Flow:
IF The entry type code is identified as a border crossing code
AND The system applies border crossing specific processing rules
THEN:
- • Special border crossing logic is applied including Canadian border location mapping
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when border crossing entry type code requires location mapping.
Trigger Criteria:
- Context: A border crossing entry type code requires location mapping
- Applied to: Map to Canadian Border Location
- Action: The system maps the code to Canadian border crossing locations
Logic Flow:
IF A border crossing entry type code requires location mapping
AND The system maps the code to Canadian border crossing locations
THEN:
- • The appropriate Canadian border location identifier is assigned to the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when entry type code has been processed (either border crossing or standard).
Trigger Criteria:
- Context: An entry type code has been processed (either border crossing or standard)
- Applied to: Set Master In-Bond Flag for Codes 61,62,63,69
- Action: The entry type code is 61, 62, 63, or 69
Logic Flow:
IF An entry type code has been processed (either border crossing or standard)
AND The entry type code is 61, 62, 63, or 69
THEN:
- • The master in-bond flag is set to indicate this cargo requires in-bond processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when entry type code processing including border crossing logic and in-bond flag setting has been completed.
Trigger Criteria:
- Context: Entry type code processing including border crossing logic and in-bond flag setting has been completed
- Applied to: Code Validation Successful?
- Action: The system evaluates whether all validation steps were successful
Logic Flow:
IF Entry type code processing including border crossing logic and in-bond flag setting has been completed
AND The system evaluates whether all validation steps were successful
THEN:
- • If validation is successful, update the cargo record with the internal code,
otherwise generate an error message
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when entry type code validation has been successful.
Trigger Criteria:
- Context: Entry type code validation has been successful
- Applied to: Update Cargo Record with Internal Code
- Action: The system updates the cargo record with the converted entry type information
Logic Flow:
IF Entry type code validation has been successful
AND The system updates the cargo record with the converted entry type information
THEN:
- • The cargo record is updated with the internal entry type code, border crossing information, and in-bond flags as applicable
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record has been successfully updated with the converted entry type code.
Trigger Criteria:
- Context: The cargo record has been successfully updated with the converted entry type code
- Applied to: Log Code Conversion Action
- Action: The system logs the code conversion action
Logic Flow:
IF The cargo record has been successfully updated with the converted entry type code
AND The system logs the code conversion action
THEN:
- • An audit log entry is created documenting the entry type code conversion from EDI format to internal system format
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when entry type code cannot be found in the conversion table or validation fails.
Trigger Criteria:
- Context: An entry type code cannot be found in the conversion table or validation fails
- Applied to: Generate Error Message for Invalid Code
- Action: The system generates an error message for the invalid entry type code
Logic Flow:
IF An entry type code cannot be found in the conversion table or validation fails
AND The system generates an error message for the invalid entry type code
THEN:
- • An error message is created indicating the entry type code is invalid and cannot be processed
R-GCX016E-cbl-03380 (+12) File: GCX016E.cbl Business Rule: Initialize Status Array from Valid Segment
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record exists in the system.
Trigger Criteria:
- Context: A cargo record exists in the system
- Applied to: Retrieve S09 Status Segment from Database
- Action: The system needs to retrieve S09 status segments from the database
Logic Flow:
IF A cargo record exists in the system
AND The system needs to retrieve S09 status segments from the database
THEN:
- • The system should fetch the status segment data from GCSUSS09 table
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when database query for s09 status segment has been executed.
Trigger Criteria:
- Context: A database query for S09 status segment has been executed
- Applied to: Valid Segment Found?
- Action: The system checks if a valid segment was found
Logic Flow:
IF A database query for S09 status segment has been executed
AND The system checks if a valid segment was found
THEN:
- • The system should determine if segment data exists and is accessible for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status segment has been retrieved from the database.
Trigger Criteria:
- Context: A status segment has been retrieved from the database
- Applied to: Validate Segment Structure
- Action: The system validates the segment structure
Logic Flow:
IF A status segment has been retrieved from the database
AND The system validates the segment structure
THEN:
- • The system should verify that the segment contains valid data fields, proper formatting, and required elements
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status segment structure validation has been performed.
Trigger Criteria:
- Context: A status segment structure validation has been performed
- Applied to: Segment Structure Valid?
- Action: The system evaluates the validation results
Logic Flow:
IF A status segment structure validation has been performed
AND The system evaluates the validation results
THEN:
- • The system should determine if the segment structure meets required standards for array population
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid status segment has been retrieved and validated.
Trigger Criteria:
- Context: A valid status segment has been retrieved and validated
- Applied to: Initialize S09A Status Array
- Action: The system initializes the S09A status array
Logic Flow:
IF A valid status segment has been retrieved and validated
AND The system initializes the S09A status array
THEN:
- • The system should set up the array structure with proper indexing and prepare it for data population
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid status segment is being processed.
Trigger Criteria:
- Context: A valid status segment is being processed
- Applied to: Extract Sequence Number from Segment
- Action: The system extracts the sequence number from the segment
Logic Flow:
IF A valid status segment is being processed
AND The system extracts the sequence number from the segment
THEN:
- • The system should identify and capture the sequence number for proper array ordering
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when valid status segment with extracted sequence number is available.
Trigger Criteria:
- Context: A valid status segment with extracted sequence number is available
- Applied to: Populate Array Entry with Segment Data
- Action: The system populates the array entry with segment data
Logic Flow:
IF A valid status segment with extracted sequence number is available
AND The system populates the array entry with segment data
THEN:
- • The system should transfer all relevant status information from the segment into the appropriate array position
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when status segments are being processed with sequence numbers.
Trigger Criteria:
- Context: Status segments are being processed with sequence numbers
- Applied to: Track Maximum Sequence Number
- Action: The system tracks the maximum sequence number
Logic Flow:
IF Status segments are being processed with sequence numbers
AND The system tracks the maximum sequence number
THEN:
- • The system should maintain the highest sequence number encountered for array boundary management
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status segments are being processed for a cargo record.
Trigger Criteria:
- Context: Status segments are being processed for a cargo record
- Applied to: More Segments Available?
- Action: The system checks for more segments availability
Logic Flow:
IF Status segments are being processed for a cargo record
AND The system checks for more segments availability
THEN:
- • The system should determine if additional S09 segments exist that need to be processed for the current cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when all available status segments have been processed.
Trigger Criteria:
- Context: All available status segments have been processed
- Applied to: Set Array Initialization Complete Flag
- Action: The system completes array initialization
Logic Flow:
IF All available status segments have been processed
AND The system completes array initialization
THEN:
- • The system should set a completion flag indicating that status array population is finished
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when status array initialization has been completed.
Trigger Criteria:
- Context: Status array initialization has been completed
- Applied to: Log Array Population Results
- Action: The system logs array population results
Logic Flow:
IF Status array initialization has been completed
AND The system logs array population results
THEN:
- • The system should record the number of segments processed, array entries created, and completion status
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when status segment has failed structure validation.
Trigger Criteria:
- Context: A status segment has failed structure validation
- Applied to: Set Error Flag for Invalid Structure
- Action: The system handles the invalid structure
Logic Flow:
IF A status segment has failed structure validation
AND The system handles the invalid structure
THEN:
- • The system should set an error flag indicating that segment structure is invalid and cannot be processed
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when invalid status segment has been identified.
Trigger Criteria:
- Context: An invalid status segment has been identified
- Applied to: Handle Invalid Segment Error
- Action: The system handles the invalid segment error
Logic Flow:
IF An invalid status segment has been identified
AND The system handles the invalid segment error
THEN:
- • The system should process the error condition and take appropriate corrective action
R-GCX016E-cbl-03393 (+3) File: GCX016E.cbl Business Rule: Lookup Disposition Code in DC Table
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code from x4 segment needs to be validated. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A disposition code from X4 segment needs to be validated
- Applied to: Call GCCTBIO Table Lookup
- Action: The system calls GCCTBIO table lookup service with the disposition code
Logic Flow:
IF A disposition code from X4 segment needs to be validated
AND The system calls GCCTBIO table lookup service with the disposition code
THEN:
- • The system searches the DC table and initiates the lookup process
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code has been searched in the dc table.
Trigger Criteria:
- Context: A disposition code has been searched in the DC table
- Applied to: Code Found in DC Table?
- Action: The table lookup is completed
Logic Flow:
IF A disposition code has been searched in the DC table
AND The table lookup is completed
THEN:
- • The system determines if the code exists and branches to either retrieve processing rules or handle invalid code scenario
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code exists in the dc table.
Trigger Criteria:
- Context: A disposition code exists in the DC table
- Applied to: Retrieve Processing Rules
- Action: The code is successfully found during table lookup
Logic Flow:
IF A disposition code exists in the DC table
AND The code is successfully found during table lookup
THEN:
- • The system retrieves the processing rules, extracts code description, sets valid code flag, and returns processing rules to caller
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code does not exist in the dc table.
Trigger Criteria:
- Context: A disposition code does not exist in the DC table
- Applied to: Set Invalid Code Flag
- Action: The table lookup fails to find the code
Logic Flow:
IF A disposition code does not exist in the DC table
AND The table lookup fails to find the code
THEN:
- • The system sets invalid code flag, generates Merlin error message, logs unknown code error, and continues processing with error status
R-GCX016E-cbl-03397 (+17) File: GCX016E.cbl Business Rule: Apply Regulatory Hierarchy Rules
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record exists with status information.
Trigger Criteria:
- Context: A cargo record exists with status information
- Applied to: Retrieve Current Status Array
- Action: Regulatory hierarchy processing is initiated
Logic Flow:
IF A cargo record exists with status information
AND Regulatory hierarchy processing is initiated
THEN:
- • The system retrieves the current S09 status array containing all existing disposition codes and their details
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when new disposition code is received from x4 segment processing.
Trigger Criteria:
- Context: A new disposition code is received from X4 segment processing
- Applied to: Identify New Disposition Code
- Action: The disposition code is ready for regulatory hierarchy evaluation
Logic Flow:
IF A new disposition code is received from X4 segment processing
AND The disposition code is ready for regulatory hierarchy evaluation
THEN:
- • The system identifies the disposition code type and prepares it for hierarchy processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is identified for processing.
Trigger Criteria:
- Context: A disposition code is identified for processing
- Applied to: Check Disposition Code Type
- Action: The system evaluates the disposition code characteristics
Logic Flow:
IF A disposition code is identified for processing
AND The system evaluates the disposition code characteristics
THEN:
- • The disposition code is classified as Hold Code, Release Code, Proceed Code, or Status Info based on its regulatory function
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is classified as a hold code type.
Trigger Criteria:
- Context: A disposition code is classified as a Hold Code type
- Applied to: Apply Hold Code Hierarchy
- Action: Regulatory hierarchy processing is applied
Logic Flow:
IF A disposition code is classified as a Hold Code type
AND Regulatory hierarchy processing is applied
THEN:
- • The system applies hold-specific precedence rules including border holds, destination holds, and FDA holds with appropriate priority ordering
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code is classified as a release code type.
Trigger Criteria:
- Context: A disposition code is classified as a Release Code type
- Applied to: Apply Release Code Hierarchy
- Action: Regulatory hierarchy processing is applied
Logic Flow:
IF A disposition code is classified as a Release Code type
AND Regulatory hierarchy processing is applied
THEN:
- • The system applies release-specific precedence rules including manual releases, auto releases, and PTT releases with quantity validation requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code is classified as a proceed code type.
Trigger Criteria:
- Context: A disposition code is classified as a Proceed Code type
- Applied to: Apply Proceed Code Hierarchy
- Action: Regulatory hierarchy processing is applied
Logic Flow:
IF A disposition code is classified as a Proceed Code type
AND Regulatory hierarchy processing is applied
THEN:
- • The system applies proceed-specific precedence rules including in-bond processing requirements and entry type validations
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is classified as status info type.
Trigger Criteria:
- Context: A disposition code is classified as Status Info type
- Applied to: Apply Status Info Code Hierarchy
- Action: Regulatory hierarchy processing is applied
Logic Flow:
IF A disposition code is classified as Status Info type
AND Regulatory hierarchy processing is applied
THEN:
- • The system applies informational code precedence rules that do not affect cargo release status but provide tracking information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when new disposition code is processed and existing status array contains disposition codes.
Trigger Criteria:
- Context: A new disposition code is processed and existing status array contains disposition codes
- Applied to: Check for Conflicting Codes
- Action: The system evaluates code compatibility
Logic Flow:
IF A new disposition code is processed and existing status array contains disposition codes
AND The system evaluates code compatibility
THEN:
- • The system identifies if conflicts exist between the new code and existing codes based on regulatory business rules
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when conflicting disposition codes are detected in the status array.
Trigger Criteria:
- Context: Conflicting disposition codes are detected in the status array
- Applied to: Identify Counterpart Codes
- Action: The system processes counterpart code logic
Logic Flow:
IF Conflicting disposition codes are detected in the status array
AND The system processes counterpart code logic
THEN:
- • The system identifies specific counterpart codes that must be removed based on regulatory requirements and business logic
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when counterpart codes are identified and regulatory precedence must be determined.
Trigger Criteria:
- Context: Counterpart codes are identified and regulatory precedence must be determined
- Applied to: Apply Regulatory Precedence Rules
- Action: The system applies regulatory precedence logic
Logic Flow:
IF Counterpart codes are identified and regulatory precedence must be determined
AND The system applies regulatory precedence logic
THEN:
- • The system determines which codes have higher priority based on customs regulations, FDA requirements, and business policy hierarchy
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when regulatory precedence rules are applied to conflicting disposition codes.
Trigger Criteria:
- Context: Regulatory precedence rules are applied to conflicting disposition codes
- Applied to: Higher Priority Code?
- Action: The system evaluates priority levels
Logic Flow:
IF Regulatory precedence rules are applied to conflicting disposition codes
AND The system evaluates priority levels
THEN:
- • The system determines if the new disposition code has higher priority than existing codes based on regulatory hierarchy
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code is determined to have lower priority than a conflicting code.
Trigger Criteria:
- Context: A disposition code is determined to have lower priority than a conflicting code
- Applied to: Remove Lower Priority Code
- Action: Priority resolution is executed
Logic Flow:
IF A disposition code is determined to have lower priority than a conflicting code
AND Priority resolution is executed
THEN:
- • The system removes the lower priority disposition code from the status array and maintains audit trail
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when disposition code is determined to have higher priority than conflicting codes.
Trigger Criteria:
- Context: A disposition code is determined to have higher priority than conflicting codes
- Applied to: Keep Higher Priority Code
- Action: Priority resolution is executed
Logic Flow:
IF A disposition code is determined to have higher priority than conflicting codes
AND Priority resolution is executed
THEN:
- • The system retains the higher priority disposition code in the status array and proceeds with processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code conflicts are resolved and final codes are determined.
Trigger Criteria:
- Context: Disposition code conflicts are resolved and final codes are determined
- Applied to: Validate Final Code Combination
- Action: Final validation is performed
Logic Flow:
IF Disposition code conflicts are resolved and final codes are determined
AND Final validation is performed
THEN:
- • The system validates that the final combination of disposition codes is legally compliant and business-rule compliant
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when final disposition code combination is validated.
Trigger Criteria:
- Context: Final disposition code combination is validated
- Applied to: Regulatory Compliance Check
- Action: Regulatory compliance verification is performed
Logic Flow:
IF Final disposition code combination is validated
AND Regulatory compliance verification is performed
THEN:
- • The system determines if the combination is compliant with customs regulations, FDA requirements, and other applicable regulatory standards
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when final disposition code combination fails regulatory compliance check.
Trigger Criteria:
- Context: Final disposition code combination fails regulatory compliance check
- Applied to: Apply Default Regulatory Action
- Action: Default regulatory action is triggered
Logic Flow:
IF Final disposition code combination fails regulatory compliance check
AND Default regulatory action is triggered
THEN:
- • The system applies predefined default actions to ensure regulatory compliance including hold placement or status correction
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when final disposition codes are validated and compliance is confirmed.
Trigger Criteria:
- Context: Final disposition codes are validated and compliance is confirmed
- Applied to: Update Status Array with Final Codes
- Action: Status array update is executed
Logic Flow:
IF Final disposition codes are validated and compliance is confirmed
AND Status array update is executed
THEN:
- • The system updates the S09 status array with final disposition codes including sequence numbers and occurrence tracking
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when regulatory hierarchy processing is completed and status array is updated.
Trigger Criteria:
- Context: Regulatory hierarchy processing is completed and status array is updated
- Applied to: Log Regulatory Decision
- Action: Audit logging is performed
Logic Flow:
IF Regulatory hierarchy processing is completed and status array is updated
AND Audit logging is performed
THEN:
- • The system logs the regulatory decisions made, codes removed or added, and rationale for compliance and audit purposes
R-GCX016E-cbl-03415 (+7) File: GCX016E.cbl Business Rule: Determine Comment Type
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when k1 segment comment is received for processing.
Trigger Criteria:
- Context: A K1 segment comment is received for processing
- Applied to: Identify as CPR Bond Creation Comment
- Action: The comment text contains 'DIRECTOR OF CUSTOMS, CP RAIL' OR 'CANADIAN PACIFIC LIMITED' OR 'CANADIAN PACIFIC RAILWAY CO'
Logic Flow:
IF A K1 segment comment is received for processing
AND The comment text contains 'DIRECTOR OF CUSTOMS, CP RAIL' OR 'CANADIAN PACIFIC LIMITED' OR 'CANADIAN PACIFIC RAILWAY CO'
THEN:
- • The system identifies this as a CPR bond creation comment and sets the special comment flag for broker bond message generation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when k1 segment comment is received for processing.
Trigger Criteria:
- Context: A K1 segment comment is received for processing
- Applied to: Identify as Standard Comment
- Action: The comment text does not contain any Canadian Pacific Railway bond creation keywords
Logic Flow:
IF A K1 segment comment is received for processing
AND The comment text does not contain any Canadian Pacific Railway bond creation keywords
THEN:
- • The system identifies this as a standard comment and sets the standard comment flag for regular comment processing
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when k1 segment is received in the message.
Trigger Criteria:
- Context: A K1 segment is received in the message
- Applied to: Extract K1 Comment Text
- Action: The system processes the K1 segment
Logic Flow:
IF A K1 segment is received in the message
AND The system processes the K1 segment
THEN:
- • The comment text is extracted from the K1 segment and made available for content analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when k1 comment text has been extracted.
Trigger Criteria:
- Context: K1 comment text has been extracted
- Applied to: Analyze Comment Content
- Action: The system analyzes the comment content for specific keywords
Logic Flow:
IF K1 comment text has been extracted
AND The system analyzes the comment content for specific keywords
THEN:
- • The system determines whether the comment requires special CPR bond processing or standard comment handling
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when k1 comment has been identified as a cpr bond creation comment.
Trigger Criteria:
- Context: A K1 comment has been identified as a CPR bond creation comment
- Applied to: Set Special Comment Flag
- Action: The system processes the comment classification
Logic Flow:
IF A K1 comment has been identified as a CPR bond creation comment
AND The system processes the comment classification
THEN:
- • A special comment flag is set to indicate this comment requires broker bond message generation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when k1 comment has been identified as a standard comment.
Trigger Criteria:
- Context: A K1 comment has been identified as a standard comment
- Applied to: Set Standard Comment Flag
- Action: The system processes the comment classification
Logic Flow:
IF A K1 comment has been identified as a standard comment
AND The system processes the comment classification
THEN:
- • A standard comment flag is set to indicate this comment follows normal processing procedures
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when k1 comment has been classified and flagged appropriately.
Trigger Criteria:
- Context: A K1 comment has been classified and flagged appropriately
- Applied to: Store Comment for Processing
- Action: The system prepares the comment for processing
Logic Flow:
IF A K1 comment has been classified and flagged appropriately
AND The system prepares the comment for processing
THEN:
- • The comment text and its classification flags are stored in the appropriate processing structures
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when k1 comment has been classified and stored with appropriate flags.
Trigger Criteria:
- Context: A K1 comment has been classified and stored with appropriate flags
- Applied to: Route to Appropriate Handler
- Action: The system determines the next processing step
Logic Flow:
IF A K1 comment has been classified and stored with appropriate flags
AND The system determines the next processing step
THEN:
- • The comment is routed to either the CPR bond creation handler or the standard comment handler based on the classification flags
R-GCX016E-cbl-03423 (+8) File: GCX016E.cbl Business Rule: Search Broker Database for Freight Forwarder
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code needs to be processed for freight forwarder validation.
Trigger Criteria:
- Context: A disposition code needs to be processed for freight forwarder validation
- Applied to: Search GCST2RT Broker Database
- Action: The system searches the GCST2RT broker database for matching freight forwarder records
Logic Flow:
IF A disposition code needs to be processed for freight forwarder validation
AND The system searches the GCST2RT broker database for matching freight forwarder records
THEN:
- • The system retrieves broker segments that match the disposition code criteria
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when search has been performed against the gcst2rt broker database.
Trigger Criteria:
- Context: A search has been performed against the GCST2RT broker database
- Applied to: Broker Record Found?
- Action: The system evaluates the search results for broker record existence
Logic Flow:
IF A search has been performed against the GCST2RT broker database
AND The system evaluates the search results for broker record existence
THEN:
- • The system returns true if a broker record is found, false if no matching record exists
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when broker record has been found in the database.
Trigger Criteria:
- Context: A broker record has been found in the database
- Applied to: Valid Freight Forwarder?
- Action: The system validates the freight forwarder relationship status
Logic Flow:
IF A broker record has been found in the database
AND The system validates the freight forwarder relationship status
THEN:
- • The system confirms the broker is authorized to act as a freight forwarder for the given context
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid freight forwarder relationship has been confirmed.
Trigger Criteria:
- Context: A valid freight forwarder relationship has been confirmed
- Applied to: Retrieve Broker Information
- Action: The system retrieves detailed broker information from the record
Logic Flow:
IF A valid freight forwarder relationship has been confirmed
AND The system retrieves detailed broker information from the record
THEN:
- • The system extracts broker identification, contact details, and operational parameters
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when broker information has been retrieved for a freight forwarder.
Trigger Criteria:
- Context: Broker information has been retrieved for a freight forwarder
- Applied to: Authorized for Disposition Code?
- Action: The system validates the broker's authority for the specific disposition code
Logic Flow:
IF Broker information has been retrieved for a freight forwarder
AND The system validates the broker's authority for the specific disposition code
THEN:
- • The system confirms the freight forwarder is authorized to process this disposition code type
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when freight forwarder has been validated and authorized for disposition code processing.
Trigger Criteria:
- Context: A freight forwarder has been validated and authorized for disposition code processing
- Applied to: Set Freight Forwarder Found Flag
- Action: The system sets the freight forwarder found flag
Logic Flow:
IF A freight forwarder has been validated and authorized for disposition code processing
AND The system sets the freight forwarder found flag
THEN:
- • The system marks the freight forwarder as available for subsequent processing operations
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when freight forwarder has been successfully identified and validated.
Trigger Criteria:
- Context: A freight forwarder has been successfully identified and validated
- Applied to: Store Broker Details
- Action: The system stores the broker details in working storage
Logic Flow:
IF A freight forwarder has been successfully identified and validated
AND The system stores the broker details in working storage
THEN:
- • The system retains broker identification, contact information, and authorization details for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when no valid freight forwarder record exists or the broker lacks proper authorization or the freight forwarder relationship is invalid.
Trigger Criteria:
- Context: No valid freight forwarder record exists OR the broker lacks proper authorization OR the freight forwarder relationship is invalid
- Applied to: Log Freight Forwarder Not Found
- Action: The system processes the freight forwarder search failure
Logic Flow:
IF No valid freight forwarder record exists OR the broker lacks proper authorization OR the freight forwarder relationship is invalid
AND The system processes the freight forwarder search failure
THEN:
- • The system logs the freight forwarder not found event for audit and troubleshooting purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when freight forwarder search has completed without finding a valid authorized freight forwarder.
Trigger Criteria:
- Context: Freight forwarder search has completed without finding a valid authorized freight forwarder
- Applied to: Continue with Standard Processing
- Action: The system continues with standard processing procedures
Logic Flow:
IF Freight forwarder search has completed without finding a valid authorized freight forwarder
AND The system continues with standard processing procedures
THEN:
- • The system processes the disposition code using standard business rules without freight forwarder-specific handling
R-GCX016E-cbl-03432 (+18) File: GCX016E.cbl Business Rule: Evaluate Hold Types
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo record requires hold status evaluation.
Trigger Criteria:
- Context: A cargo record requires hold status evaluation
- Applied to: Initialize Hold Status Flags
- Action: The hold type evaluation process begins
Logic Flow:
IF A cargo record requires hold status evaluation
AND The hold type evaluation process begins
THEN:
- • All hold status flags (border hold, destination hold, FDA hold, piece count hold) are set to false and overall hold status is cleared
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has a status array with disposition codes.
Trigger Criteria:
- Context: A cargo has a status array with disposition codes
- Applied to: Check Border Hold Status
- Action: The system checks for border hold status
Logic Flow:
IF A cargo has a status array with disposition codes
AND The system checks for border hold status
THEN:
- • The system searches the status array for border hold disposition codes and identifies if border hold is active
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has a status array with disposition codes.
Trigger Criteria:
- Context: A cargo has a status array with disposition codes
- Applied to: Check Destination Hold Status
- Action: The system checks for destination hold status
Logic Flow:
IF A cargo has a status array with disposition codes
AND The system checks for destination hold status
THEN:
- • The system searches the status array for destination hold disposition codes and identifies if destination hold is active
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has a status array with disposition codes.
Trigger Criteria:
- Context: A cargo has a status array with disposition codes
- Applied to: Check FDA Hold Status
- Action: The system checks for FDA hold status
Logic Flow:
IF A cargo has a status array with disposition codes
AND The system checks for FDA hold status
THEN:
- • The system searches the status array for FDA hold disposition codes and identifies if FDA hold is active
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when system has checked cargo status array for border hold codes.
Trigger Criteria:
- Context: The system has checked cargo status array for border hold codes
- Applied to: Border Hold Active?
- Action: Border hold disposition codes are found in the status array
Logic Flow:
IF The system has checked cargo status array for border hold codes
AND Border hold disposition codes are found in the status array
THEN:
- • The border hold active flag is set to true,
otherwise it remains false
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when border hold status has been determined to be active.
Trigger Criteria:
- Context: Border hold status has been determined to be active
- Applied to: Set Border Hold Flag
- Action: The system processes the border hold determination
Logic Flow:
IF Border hold status has been determined to be active
AND The system processes the border hold determination
THEN:
- • The border hold flag is set to true to indicate cargo is held at border
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when system has checked cargo status array for destination hold codes.
Trigger Criteria:
- Context: The system has checked cargo status array for destination hold codes
- Applied to: Destination Hold Active?
- Action: Destination hold disposition codes are found in the status array
Logic Flow:
IF The system has checked cargo status array for destination hold codes
AND Destination hold disposition codes are found in the status array
THEN:
- • The destination hold active flag is set to true,
otherwise it remains false
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when destination hold status has been determined to be active.
Trigger Criteria:
- Context: Destination hold status has been determined to be active
- Applied to: Set Destination Hold Flag
- Action: The system processes the destination hold determination
Logic Flow:
IF Destination hold status has been determined to be active
AND The system processes the destination hold determination
THEN:
- • The destination hold flag is set to true to indicate cargo is held at destination
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when system has checked cargo status array for fda hold codes.
Trigger Criteria:
- Context: The system has checked cargo status array for FDA hold codes
- Applied to: FDA Hold Active?
- Action: FDA hold disposition codes are found in the status array
Logic Flow:
IF The system has checked cargo status array for FDA hold codes
AND FDA hold disposition codes are found in the status array
THEN:
- • The FDA hold active flag is set to true,
otherwise it remains false
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when fda hold status has been determined to be active.
Trigger Criteria:
- Context: FDA hold status has been determined to be active
- Applied to: Set FDA Hold Flag
- Action: The system processes the FDA hold determination
Logic Flow:
IF FDA hold status has been determined to be active
AND The system processes the FDA hold determination
THEN:
- • The FDA hold flag is set to true to indicate cargo is held by FDA
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo has a status array with disposition codes and quantity information.
Trigger Criteria:
- Context: A cargo has a status array with disposition codes and quantity information
- Applied to: Check Piece Count Hold Status
- Action: The system checks for piece count hold status
Logic Flow:
IF A cargo has a status array with disposition codes and quantity information
AND The system checks for piece count hold status
THEN:
- • The system evaluates release quantities against total quantities to identify if piece count hold is active
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when system has checked cargo quantities for piece count hold conditions.
Trigger Criteria:
- Context: The system has checked cargo quantities for piece count hold conditions
- Applied to: Piece Count Hold Active?
- Action: Released quantity is less than total quantity or partial release conditions exist
Logic Flow:
IF The system has checked cargo quantities for piece count hold conditions
AND Released quantity is less than total quantity or partial release conditions exist
THEN:
- • The piece count hold active flag is set to true,
otherwise it remains false
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when piece count hold status has been determined to be active.
Trigger Criteria:
- Context: Piece count hold status has been determined to be active
- Applied to: Set Piece Count Hold Flag
- Action: The system processes the piece count hold determination
Logic Flow:
IF Piece count hold status has been determined to be active
AND The system processes the piece count hold determination
THEN:
- • The piece count hold flag is set to true to indicate cargo has quantity-related holds
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when all individual hold type flags have been evaluated (border, destination, fda, piece count).
Trigger Criteria:
- Context: All individual hold type flags have been evaluated (border, destination, FDA, piece count)
- Applied to: Evaluate Combined Hold Status
- Action: The system evaluates the combined hold status
Logic Flow:
IF All individual hold type flags have been evaluated (border, destination, FDA, piece count)
AND The system evaluates the combined hold status
THEN:
- • The system analyzes all hold flags to determine the overall hold condition
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when all hold type flags have been set (border hold, destination hold, fda hold, piece count hold).
Trigger Criteria:
- Context: All hold type flags have been set (border hold, destination hold, FDA hold, piece count hold)
- Applied to: Any Hold Type Active?
- Action: The system checks if any hold type is active
Logic Flow:
IF All hold type flags have been set (border hold, destination hold, FDA hold, piece count hold)
AND The system checks if any hold type is active
THEN:
- • If any hold flag is true,
then overall hold status is active,
otherwise cargo is not held
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when at least one hold type flag is active (border, destination, fda, or piece count).
Trigger Criteria:
- Context: At least one hold type flag is active (border, destination, FDA, or piece count)
- Applied to: Set Overall Hold Status
- Action: The system processes the overall hold determination
Logic Flow:
IF At least one hold type flag is active (border, destination, FDA, or piece count)
AND The system processes the overall hold determination
THEN:
- • The overall hold status is set to indicate cargo is held with appropriate hold type designation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when no hold type flags are active (border, destination, fda, and piece count are all false).
Trigger Criteria:
- Context: No hold type flags are active (border, destination, FDA, and piece count are all false)
- Applied to: Set Release Status
- Action: The system processes the overall hold determination
Logic Flow:
IF No hold type flags are active (border, destination, FDA, and piece count are all false)
AND The system processes the overall hold determination
THEN:
- • The release status is set to indicate cargo is released and available for processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when hold status has been determined for the cargo.
Trigger Criteria:
- Context: Hold status has been determined for the cargo
- Applied to: Apply Hold Validation Rules
- Action: The system applies hold validation rules
Logic Flow:
IF Hold status has been determined for the cargo
AND The system applies hold validation rules
THEN:
- • The system validates hold status against business rules and regulatory requirements to ensure compliance
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when hold status has been determined and validated for the cargo.
Trigger Criteria:
- Context: Hold status has been determined and validated for the cargo
- Applied to: Update Cargo Hold Status
- Action: The system updates the cargo hold status
Logic Flow:
IF Hold status has been determined and validated for the cargo
AND The system updates the cargo hold status
THEN:
- • The cargo record is updated with the final hold status and all related status fields are set appropriately
R-GCX016E-cbl-03451 (+12) File: GCX016E.cbl Business Rule: Build Foreign Manifest Structure
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when m10 segment is available for processing.
Trigger Criteria:
- Context: An M10 segment is available for processing
- Applied to: Extract M10 Segment Data
- Action: The system processes the M10 segment
Logic Flow:
IF An M10 segment is available for processing
AND The system processes the M10 segment
THEN:
- • All M10 segment data fields are extracted and made available for manifest building
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when m10 segment data has been extracted.
Trigger Criteria:
- Context: M10 segment data has been extracted
- Applied to: Map SCAC Code from M10
- Action: The system processes the SCAC code field from M10 segment
Logic Flow:
IF M10 segment data has been extracted
AND The system processes the SCAC code field from M10 segment
THEN:
- • The SCAC code is mapped to the appropriate field in the foreign manifest structure
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when m10 segment scac code has been mapped.
Trigger Criteria:
- Context: M10 segment SCAC code has been mapped
- Applied to: Extract Transport Type
- Action: The system processes the transport type field from M10 segment
Logic Flow:
IF M10 segment SCAC code has been mapped
AND The system processes the transport type field from M10 segment
THEN:
- • The transport type is extracted and prepared for manifest structure mapping
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when transport type has been extracted from m10 segment.
Trigger Criteria:
- Context: Transport type has been extracted from M10 segment
- Applied to: Map Country Code
- Action: The system processes the country code field from M10 segment
Logic Flow:
IF Transport type has been extracted from M10 segment
AND The system processes the country code field from M10 segment
THEN:
- • The country code is mapped to the foreign manifest structure with proper validation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when country code has been mapped from m10 segment.
Trigger Criteria:
- Context: Country code has been mapped from M10 segment
- Applied to: Extract Vessel Details
- Action: The system processes vessel information fields from M10 segment
Logic Flow:
IF Country code has been mapped from M10 segment
AND The system processes vessel information fields from M10 segment
THEN:
- • Vessel name and identification details are extracted and prepared for manifest structure
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when vessel details have been extracted from m10 segment.
Trigger Criteria:
- Context: Vessel details have been extracted from M10 segment
- Applied to: Map Port Information
- Action: The system processes port information fields from M10 segment
Logic Flow:
IF Vessel details have been extracted from M10 segment
AND The system processes port information fields from M10 segment
THEN:
- • Port of loading and discharge codes are mapped to the foreign manifest structure
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when port information has been mapped from m10 segment.
Trigger Criteria:
- Context: Port information has been mapped from M10 segment
- Applied to: Extract Manifest Number
- Action: The system processes the manifest number field from M10 segment
Logic Flow:
IF Port information has been mapped from M10 segment
AND The system processes the manifest number field from M10 segment
THEN:
- • The manifest number is extracted and prepared for foreign manifest structure
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when manifest number has been extracted from m10 segment.
Trigger Criteria:
- Context: Manifest number has been extracted from M10 segment
- Applied to: Map Date Information
- Action: The system processes date fields from M10 segment
Logic Flow:
IF Manifest number has been extracted from M10 segment
AND The system processes date fields from M10 segment
THEN:
- • Arrival and departure dates are mapped to the foreign manifest structure with proper formatting
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when date information has been mapped from m10 segment.
Trigger Criteria:
- Context: Date information has been mapped from M10 segment
- Applied to: Validate Field Mappings
- Action: The system validates all mapped fields for completeness and accuracy
Logic Flow:
IF Date information has been mapped from M10 segment
AND The system validates all mapped fields for completeness and accuracy
THEN:
- • All field mappings are verified for data integrity and business rule compliance
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when field mappings have been validated.
Trigger Criteria:
- Context: Field mappings have been validated
- Applied to: All Fields Valid?
- Action: The system evaluates the validation results
Logic Flow:
IF Field mappings have been validated
AND The system evaluates the validation results
THEN:
- • The system determines if all fields are valid and processing can continue or if error handling is required
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when field mapping validation has failed.
Trigger Criteria:
- Context: Field mapping validation has failed
- Applied to: Set Error Flag
- Action: The system detects invalid or missing field mappings
Logic Flow:
IF Field mapping validation has failed
AND The system detects invalid or missing field mappings
THEN:
- • An error flag is set to indicate foreign manifest processing cannot continue normally
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when all field mappings have been validated successfully.
Trigger Criteria:
- Context: All field mappings have been validated successfully
- Applied to: Build Complete Manifest Structure
- Action: The system builds the foreign manifest structure
Logic Flow:
IF All field mappings have been validated successfully
AND The system builds the foreign manifest structure
THEN:
- • A complete foreign manifest data structure is constructed with all required fields properly populated
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when complete foreign manifest structure has been built.
Trigger Criteria:
- Context: Complete foreign manifest structure has been built
- Applied to: Store Foreign Manifest Data
- Action: The system stores the foreign manifest data
Logic Flow:
IF Complete foreign manifest structure has been built
AND The system stores the foreign manifest data
THEN:
- • The foreign manifest data structure is stored and available for further processing operations
R-GCX016E-cbl-03464 (+11) File: GCX016E.cbl Business Rule: Check for Counterpart Codes
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when disposition code is being processed for cargo status update.
Trigger Criteria:
- Context: A disposition code is being processed for cargo status update
- Applied to: Does Code Have Counterparts?
- Action: The system checks the disposition code table for counterpart relationships
Logic Flow:
IF A disposition code is being processed for cargo status update
AND The system checks the disposition code table for counterpart relationships
THEN:
- • The system identifies if the code has any defined counterpart codes that require evaluation
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code has been confirmed to have counterparts.
Trigger Criteria:
- Context: A disposition code has been confirmed to have counterparts
- Applied to: Get Counterpart Code List
- Action: The system accesses the disposition code table counterpart fields
Logic Flow:
IF A disposition code has been confirmed to have counterparts
AND The system accesses the disposition code table counterpart fields
THEN:
- • The system retrieves all defined counterpart codes for the current disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when list of counterpart codes has been retrieved from the disposition code table.
Trigger Criteria:
- Context: A list of counterpart codes has been retrieved from the disposition code table
- Applied to: Search Status Array for Counterparts
- Action: The system searches through the cargo's S09A status array
Logic Flow:
IF A list of counterpart codes has been retrieved from the disposition code table
AND The system searches through the cargo's S09A status array
THEN:
- • The system identifies any existing counterpart codes in the current status array
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when system has searched the status array for counterpart codes.
Trigger Criteria:
- Context: The system has searched the status array for counterpart codes
- Applied to: Counterpart Found in Array?
- Action: The search results are evaluated
Logic Flow:
IF The system has searched the status array for counterpart codes
AND The search results are evaluated
THEN:
- • The system determines whether any counterpart codes were found in the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when counterpart codes have been found in the cargo status array.
Trigger Criteria:
- Context: Counterpart codes have been found in the cargo status array
- Applied to: Evaluate Regulatory Hierarchy
- Action: The system evaluates the regulatory hierarchy rules between codes
Logic Flow:
IF Counterpart codes have been found in the cargo status array
AND The system evaluates the regulatory hierarchy rules between codes
THEN:
- • The system determines which code takes precedence based on regulatory requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when regulatory hierarchy has been evaluated between current and counterpart codes.
Trigger Criteria:
- Context: Regulatory hierarchy has been evaluated between current and counterpart codes
- Applied to: Current Code Supersedes Counterpart?
- Action: The system applies supersession rules
Logic Flow:
IF Regulatory hierarchy has been evaluated between current and counterpart codes
AND The system applies supersession rules
THEN:
- • The system determines if the current code supersedes the counterpart code requiring its removal
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when current disposition code supersedes a counterpart code.
Trigger Criteria:
- Context: The current disposition code supersedes a counterpart code
- Applied to: Mark Counterpart for Removal
- Action: The system processes the supersession rule
Logic Flow:
IF The current disposition code supersedes a counterpart code
AND The system processes the supersession rule
THEN:
- • The system marks the counterpart code for removal from the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when counterpart code has been marked for removal.
Trigger Criteria:
- Context: A counterpart code has been marked for removal
- Applied to: Log Counterpart Removal Action
- Action: The system processes the removal action
Logic Flow:
IF A counterpart code has been marked for removal
AND The system processes the removal action
THEN:
- • The system logs the counterpart removal action with relevant details
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when counterpart code has been marked for removal and logged.
Trigger Criteria:
- Context: A counterpart code has been marked for removal and logged
- Applied to: Remove Counterpart from Status Array
- Action: The system updates the cargo status array
Logic Flow:
IF A counterpart code has been marked for removal and logged
AND The system updates the cargo status array
THEN:
- • The system removes the counterpart code from the S09A status array
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when one counterpart code has been processed.
Trigger Criteria:
- Context: One counterpart code has been processed
- Applied to: More Counterparts to Check?
- Action: The system checks the remaining counterpart code list
Logic Flow:
IF One counterpart code has been processed
AND The system checks the remaining counterpart code list
THEN:
- • The system determines if more counterpart codes require processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when all counterpart codes have been processed and removed.
Trigger Criteria:
- Context: All counterpart codes have been processed and removed
- Applied to: Reorganize Status Array Sequence
- Action: The system reorganizes the status array
Logic Flow:
IF All counterpart codes have been processed and removed
AND The system reorganizes the status array
THEN:
- • The system resequences the remaining status codes to eliminate gaps
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when status array has been reorganized after counterpart removals.
Trigger Criteria:
- Context: The status array has been reorganized after counterpart removals
- Applied to: Update Status Array Indexes
- Action: The system updates array management fields
Logic Flow:
IF The status array has been reorganized after counterpart removals
AND The system updates array management fields
THEN:
- • The system updates status array indexes and occurrence counters to reflect the current array state
R-GCX016E-cbl-03476 (+12) File: GCX016E.cbl Business Rule: Apply Special Border Crossing Logic
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record with origin and destination location information.
Trigger Criteria:
- Context: A cargo record with origin and destination location information
- Applied to: Cargo Movement Type?
- Action: The system evaluates the cargo movement pattern for border crossing processing
Logic Flow:
IF A cargo record with origin and destination location information
AND The system evaluates the cargo movement pattern for border crossing processing
THEN:
- • The system classifies the movement as US to Canada Transit, Canada to US Transit, or US-Canada-US Transit based on origin and destination locations
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when us port code from cargo location information and a us port to canadian border mapping table.
Trigger Criteria:
- Context: A US port code from cargo location information and a US Port to Canadian Border Mapping table
- Applied to: Map US Port Code to Canadian Border Location
- Action: The system needs to identify the corresponding Canadian border location
Logic Flow:
IF A US port code from cargo location information and a US Port to Canadian Border Mapping table
AND The system needs to identify the corresponding Canadian border location
THEN:
- • The system retrieves the mapped Canadian border location code from the mapping table
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when mapped canadian border location code and the canadian border location table.
Trigger Criteria:
- Context: A mapped Canadian border location code and the Canadian Border Location Table
- Applied to: Validate Canadian Border Location
- Action: The system validates the Canadian border location
Logic Flow:
IF A mapped Canadian border location code and the Canadian Border Location Table
AND The system validates the Canadian border location
THEN:
- • The system confirms whether the Canadian location exists in the reference table
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when validated canadian border location code from the canadian border location table.
Trigger Criteria:
- Context: A validated Canadian border location code from the Canadian Border Location Table
- Applied to: Set Canadian Border Port Name
- Action: The Canadian location is confirmed to exist
Logic Flow:
IF A validated Canadian border location code from the Canadian Border Location Table
AND The Canadian location is confirmed to exist
THEN:
- • The system sets the Canadian border port name for the cargo record
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo equipment information and access to gccc-cargo-root canadian cargo database.
Trigger Criteria:
- Context: Cargo equipment information and access to GCCC-CARGO-ROOT Canadian Cargo database
- Applied to: Search Canadian Manifest Database
- Action: The system needs to find corresponding Canadian manifest records
Logic Flow:
IF Cargo equipment information and access to GCCC-CARGO-ROOT Canadian Cargo database
AND The system needs to find corresponding Canadian manifest records
THEN:
- • The system searches the Canadian manifest database using equipment identification criteria
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when us cargo record with equipment id and a canadian manifest record with equipment id.
Trigger Criteria:
- Context: A US cargo record with equipment ID and a Canadian manifest record with equipment ID
- Applied to: Equipment ID Matches?
- Action: The system compares equipment IDs for cross-border record linking
Logic Flow:
IF A US cargo record with equipment ID and a Canadian manifest record with equipment ID
AND The system compares equipment IDs for cross-border record linking
THEN:
- • The system confirms whether the equipment IDs match exactly between the US and Canadian records
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when matching us and canadian cargo records with validated equipment ids.
Trigger Criteria:
- Context: Matching US and Canadian cargo records with validated equipment IDs
- Applied to: Link US and Canadian Records
- Action: Equipment IDs match between the records
Logic Flow:
IF Matching US and Canadian cargo records with validated equipment IDs
AND Equipment IDs match between the records
THEN:
- • The system establishes a cross-border linkage between the US and Canadian cargo records
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when successfully linked us and canadian cargo records.
Trigger Criteria:
- Context: Successfully linked US and Canadian cargo records
- Applied to: Set Cross-Border Transit Flags
- Action: Cross-border record linkage is established
Logic Flow:
IF Successfully linked US and Canadian cargo records
AND Cross-border record linkage is established
THEN:
- • The system sets cross-border transit flags on both US and Canadian cargo records
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record identified as us-canada-us transit movement.
Trigger Criteria:
- Context: A cargo record identified as US-Canada-US transit movement
- Applied to: Apply Special Transit Rules
- Action: The cargo movement type is US-Canada-US Transit
Logic Flow:
IF A cargo record identified as US-Canada-US transit movement
AND The cargo movement type is US-Canada-US Transit
THEN:
- • The system applies special transit processing rules specific to round-trip cross-border movements
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when canadian manifest record found for cross-border cargo movement.
Trigger Criteria:
- Context: A Canadian manifest record found for cross-border cargo movement
- Applied to: Create Cross-Border Audit Trail
- Action: Canadian manifest is successfully located
Logic Flow:
IF A Canadian manifest record found for cross-border cargo movement
AND Canadian manifest is successfully located
THEN:
- • The system creates audit trail records documenting the cross-border cargo movement
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record requiring border crossing processing and canadian border location table.
Trigger Criteria:
- Context: A cargo record requiring border crossing processing and Canadian Border Location Table
- Applied to: Generate Border Crossing Error
- Action: The Canadian location is not found in the reference table
Logic Flow:
IF A cargo record requiring border crossing processing and Canadian Border Location Table
AND The Canadian location is not found in the reference table
THEN:
- • The system generates a border crossing error indicating the location validation failure
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record undergoing border crossing logic where canadian manifest search fails or equipment id validation fails.
Trigger Criteria:
- Context: A cargo record undergoing border crossing logic where Canadian manifest search fails or equipment ID validation fails
- Applied to: Continue Standard Processing
- Action: No Canadian manifest is found OR equipment IDs do not match
Logic Flow:
IF A cargo record undergoing border crossing logic where Canadian manifest search fails or equipment ID validation fails
AND No Canadian manifest is found OR equipment IDs do not match
THEN:
- • The system continues with standard cargo processing without cross-border linkage
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo record that has completed border crossing logic processing.
Trigger Criteria:
- Context: A cargo record that has completed border crossing logic processing
- Applied to: Update Cargo Status for Border Transit
- Action: Border crossing logic is complete (whether successful linkage, error, or standard processing)
Logic Flow:
IF A cargo record that has completed border crossing logic processing
AND Border crossing logic is complete (whether successful linkage, error, or standard processing)
THEN:
- • The system updates the cargo status to reflect the border transit processing results
R-GCX016E-cbl-03489 (+16) File: GCX016E.cbl Business Rule: Validate Segment Structure
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record requires s09 segment validation.
Trigger Criteria:
- Context: A cargo record requires S09 segment validation
- Applied to: Retrieve S09 Segment from Database
- Action: The system attempts to retrieve the S09 segment from the GCSUSS09 database
Logic Flow:
IF A cargo record requires S09 segment validation
AND The system attempts to retrieve the S09 segment from the GCSUSS09 database
THEN:
- • The S09 segment data is successfully retrieved and made available for validation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when attempt has been made to retrieve s09 segment from database.
Trigger Criteria:
- Context: An attempt has been made to retrieve S09 segment from database
- Applied to: Segment Retrieved Successfully?
- Action: The system checks the retrieval operation result
Logic Flow:
IF An attempt has been made to retrieve S09 segment from database
AND The system checks the retrieval operation result
THEN:
- • If segment is retrieved successfully, proceed to format validation,
otherwise log validation error
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when s09 segment has been successfully retrieved from database.
Trigger Criteria:
- Context: An S09 segment has been successfully retrieved from database
- Applied to: Validate Segment Format Structure
- Action: The system validates the segment format structure
Logic Flow:
IF An S09 segment has been successfully retrieved from database
AND The system validates the segment format structure
THEN:
- • The segment format must conform to S09 structure requirements to proceed to field integrity validation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when s09 segment format structure has been validated.
Trigger Criteria:
- Context: S09 segment format structure has been validated
- Applied to: Format Valid?
- Action: The system evaluates format validity
Logic Flow:
IF S09 segment format structure has been validated
AND The system evaluates format validity
THEN:
- • If format is valid, proceed to field integrity check,
otherwise log validation error
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when s09 segment has valid format structure.
Trigger Criteria:
- Context: S09 segment has valid format structure
- Applied to: Check Field Integrity
- Action: The system checks field integrity of the segment
Logic Flow:
IF S09 segment has valid format structure
AND The system checks field integrity of the segment
THEN:
- • All required fields must be present and properly formatted to proceed to data consistency validation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when s09 segment field integrity has been validated.
Trigger Criteria:
- Context: S09 segment field integrity has been validated
- Applied to: Fields Complete?
- Action: The system evaluates field completeness
Logic Flow:
IF S09 segment field integrity has been validated
AND The system evaluates field completeness
THEN:
- • If all fields are complete, proceed to data consistency validation,
otherwise log validation error
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when s09 segment has complete and valid fields.
Trigger Criteria:
- Context: S09 segment has complete and valid fields
- Applied to: Validate Data Consistency
- Action: The system validates data consistency across segment fields
Logic Flow:
IF S09 segment has complete and valid fields
AND The system validates data consistency across segment fields
THEN:
- • All data values must be consistent and logically coherent to proceed to sequence number validation
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when s09 segment data consistency has been validated.
Trigger Criteria:
- Context: S09 segment data consistency has been validated
- Applied to: Data Consistent?
- Action: The system evaluates data consistency
Logic Flow:
IF S09 segment data consistency has been validated
AND The system evaluates data consistency
THEN:
- • If data is consistent, proceed to sequence number validation,
otherwise log validation error
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when s09 segment has consistent data values.
Trigger Criteria:
- Context: S09 segment has consistent data values
- Applied to: Validate Sequence Numbers
- Action: The system validates sequence numbers
Logic Flow:
IF S09 segment has consistent data values
AND The system validates sequence numbers
THEN:
- • Sequence numbers must be properly ordered and within valid ranges to proceed to status code validation
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when s09 segment sequence numbers have been validated.
Trigger Criteria:
- Context: S09 segment sequence numbers have been validated
- Applied to: Sequences Valid?
- Action: The system evaluates sequence validity
Logic Flow:
IF S09 segment sequence numbers have been validated
AND The system evaluates sequence validity
THEN:
- • If sequences are valid, proceed to status code validation,
otherwise log validation error
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when s09 segment has valid sequence numbers.
Trigger Criteria:
- Context: S09 segment has valid sequence numbers
- Applied to: Validate Status Code Values
- Action: The system validates status code values
Logic Flow:
IF S09 segment has valid sequence numbers
AND The system validates status code values
THEN:
- • All status codes must be valid and recognized to proceed to segment approval
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when s09 segment status codes have been validated.
Trigger Criteria:
- Context: S09 segment status codes have been validated
- Applied to: Status Codes Valid?
- Action: The system evaluates status code validity
Logic Flow:
IF S09 segment status codes have been validated
AND The system evaluates status code validity
THEN:
- • If status codes are valid, mark segment as valid,
otherwise log validation error
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when s09 segment has passed all validation checks including status codes.
Trigger Criteria:
- Context: S09 segment has passed all validation checks including status codes
- Applied to: Mark Segment as Valid
- Action: The system marks the segment as valid
Logic Flow:
IF S09 segment has passed all validation checks including status codes
AND The system marks the segment as valid
THEN:
- • The segment is flagged as valid and ready for status array population processing
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when s09 segment has failed any validation check during the validation process.
Trigger Criteria:
- Context: S09 segment has failed any validation check during the validation process
- Applied to: Log Validation Error
- Action: The system encounters a validation failure
Logic Flow:
IF S09 segment has failed any validation check during the validation process
AND The system encounters a validation failure
THEN:
- • A validation error is logged with appropriate error details for troubleshooting
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when validation error has been logged for the s09 segment.
Trigger Criteria:
- Context: A validation error has been logged for the S09 segment
- Applied to: Set Error Flag
- Action: The system sets the error flag
Logic Flow:
IF A validation error has been logged for the S09 segment
AND The system sets the error flag
THEN:
- • The error flag is set to indicate validation failure and prevent invalid segment processing
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when s09 segment has been marked as valid after successful validation.
Trigger Criteria:
- Context: S09 segment has been marked as valid after successful validation
- Applied to: Continue to Status Array Population
- Action: The system continues processing
Logic Flow:
IF S09 segment has been marked as valid after successful validation
AND The system continues processing
THEN:
- • The valid segment data is used to populate status arrays for cargo processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when s09 segment has failed validation and error flag has been set.
Trigger Criteria:
- Context: S09 segment has failed validation and error flag has been set
- Applied to: Skip Invalid Segment
- Action: The system processes the validation result
Logic Flow:
IF S09 segment has failed validation and error flag has been set
AND The system processes the validation result
THEN:
- • The invalid segment is skipped and not used for status array population
R-GCX016E-cbl-03506 (+9) File: GCX016E.cbl Business Rule: Generate Merlin Error Message
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when disposition code is received for processing.
Trigger Criteria:
- Context: A disposition code is received for processing
- Applied to: Lookup Disposition Code in DC Table
- Action: The system looks up the disposition code in the DC table
Logic Flow:
IF A disposition code is received for processing
AND The system looks up the disposition code in the DC table
THEN:
- • The system determines if the code exists in the table and proceeds with appropriate processing path
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code has been received and validated against the dc table.
Trigger Criteria:
- Context: A disposition code has been received and validated against the DC table
- Applied to: Continue Normal Processing
- Action: The disposition code is found in the DC table
Logic Flow:
IF A disposition code has been received and validated against the DC table
AND The disposition code is found in the DC table
THEN:
- • The system continues with normal disposition code processing workflow
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when disposition code has been received for processing.
Trigger Criteria:
- Context: A disposition code has been received for processing
- Applied to: Generate Merlin Error Message
- Action: The disposition code is not found in the DC table
Logic Flow:
IF A disposition code has been received for processing
AND The disposition code is not found in the DC table
THEN:
- • The system initiates generation of a Merlin error message for the unknown code
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when unknown disposition code has been detected.
Trigger Criteria:
- Context: An unknown disposition code has been detected
- Applied to: Format Error Message with Code Details
- Action: The system formats the error message
Logic Flow:
IF An unknown disposition code has been detected
AND The system formats the error message
THEN:
- • The error message includes the invalid disposition code value and descriptive details about the error
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when error message is being formatted for an unknown disposition code.
Trigger Criteria:
- Context: An error message is being formatted for an unknown disposition code
- Applied to: Include Processing Context Information
- Action: The system adds processing context information
Logic Flow:
IF An error message is being formatted for an unknown disposition code
AND The system adds processing context information
THEN:
- • The error message includes relevant context such as processing stage, transaction details, and timing information
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when error message is being prepared for an unknown disposition code.
Trigger Criteria:
- Context: An error message is being prepared for an unknown disposition code
- Applied to: Add Equipment/Cargo Identification
- Action: The system adds identification information
Logic Flow:
IF An error message is being prepared for an unknown disposition code
AND The system adds identification information
THEN:
- • The error message includes equipment identifiers, cargo details, and other relevant identification data
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when error message has been formatted with all required details.
Trigger Criteria:
- Context: An error message has been formatted with all required details
- Applied to: Set Error Message Type
- Action: The system sets the message type
Logic Flow:
IF An error message has been formatted with all required details
AND The system sets the message type
THEN:
- • The error message is classified with the appropriate error type indicator for disposition code validation failures
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when error message has been formatted and classified.
Trigger Criteria:
- Context: An error message has been formatted and classified
- Applied to: Route Error Message to Recipients
- Action: The system routes the error message
Logic Flow:
IF An error message has been formatted and classified
AND The system routes the error message
THEN:
- • The error message is sent to the designated recipients according to error routing rules
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when error message has been generated and routed for an unknown disposition code.
Trigger Criteria:
- Context: An error message has been generated and routed for an unknown disposition code
- Applied to: Log Error for Audit Trail
- Action: The system logs the error
Logic Flow:
IF An error message has been generated and routed for an unknown disposition code
AND The system logs the error
THEN:
- • The error details are recorded in the audit trail with timestamp and relevant transaction information
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when unknown disposition code error has been processed and logged.
Trigger Criteria:
- Context: An unknown disposition code error has been processed and logged
- Applied to: Continue Processing Next Code
- Action: The system completes error handling
Logic Flow:
IF An unknown disposition code error has been processed and logged
AND The system completes error handling
THEN:
- • The system continues processing the next disposition code in the sequence without stopping the overall transaction
R-GCX016E-cbl-03516 (+12) File: GCX016E.cbl Business Rule: Apply Regulatory Precedence Rules
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo record exists with disposition codes in the status array.
Trigger Criteria:
- Context: A cargo record exists with disposition codes in the status array
- Applied to: Retrieve Current Status Array
- Action: The system needs to apply regulatory precedence rules for a new disposition code
Logic Flow:
IF A cargo record exists with disposition codes in the status array
AND The system needs to apply regulatory precedence rules for a new disposition code
THEN:
- • The system retrieves all current disposition codes from the S09 status segments
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when new disposition code is being added to a cargo's status array.
Trigger Criteria:
- Context: A new disposition code is being added to a cargo's status array
- Applied to: Identify New Disposition Code
- Action: The system processes the disposition code
Logic Flow:
IF A new disposition code is being added to a cargo's status array
AND The system processes the disposition code
THEN:
- • The system identifies the specific disposition code and its regulatory classification
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when new disposition code and existing status array with current disposition codes.
Trigger Criteria:
- Context: A new disposition code and existing status array with current disposition codes
- Applied to: Check for Conflicting Codes?
- Action: The system checks for regulatory conflicts between codes
Logic Flow:
IF A new disposition code and existing status array with current disposition codes
AND The system checks for regulatory conflicts between codes
THEN:
- • The system determines if conflicting codes exist that require precedence rule application
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when conflicting disposition codes exist in the cargo status array.
Trigger Criteria:
- Context: Conflicting disposition codes exist in the cargo status array
- Applied to: Apply Customs Regulatory Hierarchy
- Action: The system applies customs regulatory hierarchy rules
Logic Flow:
IF Conflicting disposition codes exist in the cargo status array
AND The system applies customs regulatory hierarchy rules
THEN:
- • The system determines the precedence order based on regulatory requirements and customs policies
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when regulatory hierarchy has been applied to conflicting disposition codes.
Trigger Criteria:
- Context: Regulatory hierarchy has been applied to conflicting disposition codes
- Applied to: Higher Priority Code Exists?
- Action: The system evaluates code priorities
Logic Flow:
IF Regulatory hierarchy has been applied to conflicting disposition codes
AND The system evaluates code priorities
THEN:
- • The system determines if an existing code has higher regulatory priority than the new code
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when higher priority disposition code exists compared to a lower priority code.
Trigger Criteria:
- Context: A higher priority disposition code exists compared to a lower priority code
- Applied to: Remove Lower Priority Code
- Action: The system applies precedence rules
Logic Flow:
IF A higher priority disposition code exists compared to a lower priority code
AND The system applies precedence rules
THEN:
- • The system removes the lower priority code from the status array
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when existing disposition code has higher priority than the new code.
Trigger Criteria:
- Context: An existing disposition code has higher priority than the new code
- Applied to: Keep Higher Priority Code
- Action: The system applies precedence rules
Logic Flow:
IF An existing disposition code has higher priority than the new code
AND The system applies precedence rules
THEN:
- • The system keeps the existing higher priority code and may reject or modify the new code
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when precedence rules have been applied to disposition codes.
Trigger Criteria:
- Context: Precedence rules have been applied to disposition codes
- Applied to: Validate Regulatory Compliance
- Action: The system validates regulatory compliance
Logic Flow:
IF Precedence rules have been applied to disposition codes
AND The system validates regulatory compliance
THEN:
- • The system confirms that the resulting code combination meets all customs regulatory requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when regulatory compliance validation has been performed.
Trigger Criteria:
- Context: Regulatory compliance validation has been performed
- Applied to: Precedence Rules Satisfied?
- Action: The system checks if precedence rules are satisfied
Logic Flow:
IF Regulatory compliance validation has been performed
AND The system checks if precedence rules are satisfied
THEN:
- • The system determines if all precedence requirements have been met successfully
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when precedence rules have been successfully applied and validated.
Trigger Criteria:
- Context: Precedence rules have been successfully applied and validated
- Applied to: Update Status Array
- Action: The system updates the status array
Logic Flow:
IF Precedence rules have been successfully applied and validated
AND The system updates the status array
THEN:
- • The system commits the precedence-adjusted disposition codes to the cargo's S09 status segments
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when precedence rules have been applied and status array updated.
Trigger Criteria:
- Context: Precedence rules have been applied and status array updated
- Applied to: Log Precedence Decision
- Action: The system logs the precedence decision
Logic Flow:
IF Precedence rules have been applied and status array updated
AND The system logs the precedence decision
THEN:
- • The system records the precedence actions, removed codes, and regulatory justification for audit purposes
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when precedence rules cannot be satisfied or regulatory conflicts exist.
Trigger Criteria:
- Context: Precedence rules cannot be satisfied or regulatory conflicts exist
- Applied to: Generate Conflict Warning
- Action: The system encounters unresolvable precedence issues
Logic Flow:
IF Precedence rules cannot be satisfied or regulatory conflicts exist
AND The system encounters unresolvable precedence issues
THEN:
- • The system generates appropriate conflict warnings for manual review and intervention
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when specific precedence rules cannot resolve disposition code conflicts.
Trigger Criteria:
- Context: Specific precedence rules cannot resolve disposition code conflicts
- Applied to: Apply Default Precedence Rule
- Action: The system applies default precedence rules
Logic Flow:
IF Specific precedence rules cannot resolve disposition code conflicts
AND The system applies default precedence rules
THEN:
- • The system uses predefined default hierarchy to resolve conflicts and proceed with processing
R-GCX016E-cbl-03529 (+11) File: GCX016E.cbl Business Rule: Analyze Comment Content
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when k1 segment is received with comment data.
Trigger Criteria:
- Context: A K1 segment is received with comment data
- Applied to: Extract Comment Text Content
- Action: The system processes the K1 segment
Logic Flow:
IF A K1 segment is received with comment data
AND The system processes the K1 segment
THEN:
- • The comment text content is extracted and made available for pattern matching analysis
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when k1 segment comment text content is available for analysis.
Trigger Criteria:
- Context: K1 segment comment text content is available for analysis
- Applied to: Canadian Pacific Railway Bond Creation Pattern
- Action: The comment contains 'DIRECTOR OF CUSTOMS, CP RAIL' OR 'CANADIAN PACIFIC LIMITED' OR 'CANADIAN PACIFIC RAILWAY CO'
Logic Flow:
IF K1 segment comment text content is available for analysis
AND The comment contains 'DIRECTOR OF CUSTOMS, CP RAIL' OR 'CANADIAN PACIFIC LIMITED' OR 'CANADIAN PACIFIC RAILWAY CO'
THEN:
- • The system identifies this as a Canadian Pacific Railway bond creation pattern and sets the bond creation processing flag
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when k1 segment comment text content is available for analysis.
Trigger Criteria:
- Context: K1 segment comment text content is available for analysis
- Applied to: Train Disposition Comment Pattern
- Action: The comment contains train-related disposition information
Logic Flow:
IF K1 segment comment text content is available for analysis
AND The comment contains train-related disposition information
THEN:
- • The system identifies this as a train disposition comment pattern and sets the train comment processing flag
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when k1 segment comment text content is available for analysis.
Trigger Criteria:
- Context: K1 segment comment text content is available for analysis
- Applied to: Cargo Disposition Comment Pattern
- Action: The comment contains cargo-related disposition information
Logic Flow:
IF K1 segment comment text content is available for analysis
AND The comment contains cargo-related disposition information
THEN:
- • The system identifies this as a cargo disposition comment pattern and sets the cargo comment processing flag
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when k1 segment comment text content is available for analysis.
Trigger Criteria:
- Context: K1 segment comment text content is available for analysis
- Applied to: General Comment Pattern
- Action: The comment does not match Canadian Pacific Railway, train disposition, or cargo disposition patterns
Logic Flow:
IF K1 segment comment text content is available for analysis
AND The comment does not match Canadian Pacific Railway, train disposition, or cargo disposition patterns
THEN:
- • The system classifies this as a general comment pattern and sets the general comment processing flag
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when canadian pacific railway bond creation pattern has been detected in the comment.
Trigger Criteria:
- Context: Canadian Pacific Railway bond creation pattern has been detected in the comment
- Applied to: Set Bond Creation Processing Flag
- Action: The system processes the pattern detection result
Logic Flow:
IF Canadian Pacific Railway bond creation pattern has been detected in the comment
AND The system processes the pattern detection result
THEN:
- • The bond creation processing flag is set to indicate special bond processing is required
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when train disposition comment pattern has been detected in the comment.
Trigger Criteria:
- Context: Train disposition comment pattern has been detected in the comment
- Applied to: Set Train Comment Processing Flag
- Action: The system processes the pattern detection result
Logic Flow:
IF Train disposition comment pattern has been detected in the comment
AND The system processes the pattern detection result
THEN:
- • The train comment processing flag is set to indicate special train processing is required
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo disposition comment pattern has been detected in the comment.
Trigger Criteria:
- Context: Cargo disposition comment pattern has been detected in the comment
- Applied to: Set Cargo Comment Processing Flag
- Action: The system processes the pattern detection result
Logic Flow:
IF Cargo disposition comment pattern has been detected in the comment
AND The system processes the pattern detection result
THEN:
- • The cargo comment processing flag is set to indicate special cargo processing is required
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when general comment pattern has been detected in the comment.
Trigger Criteria:
- Context: General comment pattern has been detected in the comment
- Applied to: Set General Comment Processing Flag
- Action: The system processes the pattern detection result
Logic Flow:
IF General comment pattern has been detected in the comment
AND The system processes the pattern detection result
THEN:
- • The general comment processing flag is set to indicate standard comment processing is required
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when comment processing flag has been set (bond creation, train, cargo, or general).
Trigger Criteria:
- Context: A comment processing flag has been set (bond creation, train, cargo, or general)
- Applied to: Determine Processing Requirements
- Action: The system evaluates the processing requirements
Logic Flow:
IF A comment processing flag has been set (bond creation, train, cargo, or general)
AND The system evaluates the processing requirements
THEN:
- • The specific processing requirements are determined based on the comment pattern type
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when processing requirements have been determined for the comment.
Trigger Criteria:
- Context: Processing requirements have been determined for the comment
- Applied to: Store Comment for Merlin Integration
- Action: The system prepares the comment for downstream processing
Logic Flow:
IF Processing requirements have been determined for the comment
AND The system prepares the comment for downstream processing
THEN:
- • The comment is stored in the appropriate format for Merlin integration
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when comment has been stored for merlin integration.
Trigger Criteria:
- Context: Comment has been stored for Merlin integration
- Applied to: Mark for Special Processing
- Action: The comment requires special processing (bond creation, train disposition, or cargo disposition)
Logic Flow:
IF Comment has been stored for Merlin integration
AND The comment requires special processing (bond creation, train disposition, or cargo disposition)
THEN:
- • The comment is marked for special processing to ensure appropriate downstream handling
R-GCX016E-cbl-03541 (+9) File: GCX016E.cbl Business Rule: Validate Freight Forwarder Relationship
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when disposition code has been retrieved from x4 segment.
Trigger Criteria:
- Context: A disposition code has been retrieved from X4 segment
- Applied to: Search Broker Database for Freight Forwarder Codes
- Action: The system searches the GCSTBRT broker database for freight forwarder disposition codes
Logic Flow:
IF A disposition code has been retrieved from X4 segment
AND The system searches the GCSTBRT broker database for freight forwarder disposition codes
THEN:
- • The system identifies whether the disposition code requires freight forwarder validation
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when broker database has been searched for the disposition code.
Trigger Criteria:
- Context: The broker database has been searched for the disposition code
- Applied to: Disposition Code Found in Broker Database?
- Action: The disposition code is found in the broker database
Logic Flow:
IF The broker database has been searched for the disposition code
AND The disposition code is found in the broker database
THEN:
- • The system proceeds to retrieve cargo segment data for freight forwarder processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo segment data has been retrieved from gcsuss03 and gcsuss07 segments.
Trigger Criteria:
- Context: Cargo segment data has been retrieved from GCSUSS03 and GCSUSS07 segments
- Applied to: Extract Freight Forwarder Information from Cargo Segments
- Action: The system processes the cargo segments to extract freight forwarder information
Logic Flow:
IF Cargo segment data has been retrieved from GCSUSS03 and GCSUSS07 segments
AND The system processes the cargo segments to extract freight forwarder information
THEN:
- • The system identifies the freight forwarder code and related business information for validation
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when freight forwarder information has been extracted from cargo segments.
Trigger Criteria:
- Context: Freight forwarder information has been extracted from cargo segments
- Applied to: Valid Broker-Freight Forwarder Relationship?
- Action: The system looks up the freight forwarder in the GCST2RT broker name table
Logic Flow:
IF Freight forwarder information has been extracted from cargo segments
AND The system looks up the freight forwarder in the GCST2RT broker name table
THEN:
- • The system validates whether a valid business relationship exists between the broker and freight forwarder
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when valid broker-freight forwarder relationship has been established.
Trigger Criteria:
- Context: A valid broker-freight forwarder relationship has been established
- Applied to: Freight Forwarder Authorized for This Disposition?
- Action: The system validates authorization for the specific disposition code
Logic Flow:
IF A valid broker-freight forwarder relationship has been established
AND The system validates authorization for the specific disposition code
THEN:
- • The system determines whether the freight forwarder is authorized to use this disposition code
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when freight forwarder has been authorized for the disposition code.
Trigger Criteria:
- Context: The freight forwarder has been authorized for the disposition code
- Applied to: Set Freight Forwarder as Validated
- Action: The system sets the freight forwarder validation status
Logic Flow:
IF The freight forwarder has been authorized for the disposition code
AND The system sets the freight forwarder validation status
THEN:
- • The freight forwarder is marked as validated and approved for email notification processing
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when freight forwarder has been validated and approved.
Trigger Criteria:
- Context: The freight forwarder has been validated and approved
- Applied to: Retrieve Freight Forwarder Contact Information
- Action: The system retrieves freight forwarder contact information
Logic Flow:
IF The freight forwarder has been validated and approved
AND The system retrieves freight forwarder contact information
THEN:
- • The system obtains email addresses and notification preferences for the freight forwarder
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when valid broker-freight forwarder relationship exists but authorization check fails.
Trigger Criteria:
- Context: A valid broker-freight forwarder relationship exists but authorization check fails
- Applied to: Mark Validation as Failed - Unauthorized
- Action: The freight forwarder is not authorized for the disposition code
Logic Flow:
IF A valid broker-freight forwarder relationship exists but authorization check fails
AND The freight forwarder is not authorized for the disposition code
THEN:
- • The system marks validation as failed due to unauthorized access and skips email notification
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when freight forwarder lookup has been performed in the broker name table.
Trigger Criteria:
- Context: Freight forwarder lookup has been performed in the broker name table
- Applied to: Mark Validation as Failed - Invalid Relationship
- Action: No valid broker-freight forwarder relationship is found
Logic Flow:
IF Freight forwarder lookup has been performed in the broker name table
AND No valid broker-freight forwarder relationship is found
THEN:
- • The system marks validation as failed due to invalid relationship and skips email notification
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when freight forwarder validation has failed due to unauthorized access, invalid relationship, or disposition code not found.
Trigger Criteria:
- Context: Freight forwarder validation has failed due to unauthorized access, invalid relationship, or disposition code not found
- Applied to: Skip Email Notification - Validation Failed
- Action: The system processes the validation failure
Logic Flow:
IF Freight forwarder validation has failed due to unauthorized access, invalid relationship, or disposition code not found
AND The system processes the validation failure
THEN:
- • The system bypasses email notification processing and continues with standard disposition code processing
R-GCX016E-cbl-03551 (+22) File: GCX016E.cbl Business Rule: Apply Hold Validation Rules
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo record exists with associated status information.
Trigger Criteria:
- Context: A cargo record exists with associated status information
- Applied to: Retrieve Current Hold Status Array
- Action: The hold validation process is initiated
Logic Flow:
IF A cargo record exists with associated status information
AND The hold validation process is initiated
THEN:
- • The system retrieves the current S09 status array containing all active disposition codes and hold statuses for the cargo
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status array has been retrieved.
Trigger Criteria:
- Context: A cargo status array has been retrieved
- Applied to: Check for Multiple Hold Types
- Action: The system processes the status array for hold validation
Logic Flow:
IF A cargo status array has been retrieved
AND The system processes the status array for hold validation
THEN:
- • The system identifies and flags the presence of multiple concurrent hold types
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo status array contains disposition codes.
Trigger Criteria:
- Context: A cargo status array contains disposition codes
- Applied to: Border Hold Present? & Destination Hold Present? & FDA Hold Present? & Piece Count Hold Present?
- Action: The system evaluates hold types
Logic Flow:
IF A cargo status array contains disposition codes
AND The system evaluates hold types
THEN:
- • The system returns true if a border hold disposition code is found, false
otherwise - • The system returns true if a destination hold disposition code is found, false
otherwise - • The system returns true if an FDA hold disposition code is found, false
otherwise - • The system returns true if a piece count hold disposition code is found, false
otherwise
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo status array contains disposition codes.
Trigger Criteria:
- Context: A cargo status array contains disposition codes
- Applied to: Manual Release Present?
- Action: The system evaluates for manual release overrides
Logic Flow:
IF A cargo status array contains disposition codes
AND The system evaluates for manual release overrides
THEN:
- • The system returns true if a manual release disposition code is found, false
otherwise
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when multiple hold types have been identified in the cargo status.
Trigger Criteria:
- Context: Multiple hold types have been identified in the cargo status
- Applied to: Evaluate Hold Combination Rules
- Action: The system validates hold combinations
Logic Flow:
IF Multiple hold types have been identified in the cargo status
AND The system validates hold combinations
THEN:
- • The system determines if the combination of holds is valid based on business rules and regulatory requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when hold combination rules have been evaluated.
Trigger Criteria:
- Context: Hold combination rules have been evaluated
- Applied to: Hold Combination Valid?
- Action: The system checks combination validity
Logic Flow:
IF Hold combination rules have been evaluated
AND The system checks combination validity
THEN:
- • The system returns true if the hold combination is valid, false if it violates business rules
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when multiple valid holds are present on a cargo.
Trigger Criteria:
- Context: Multiple valid holds are present on a cargo
- Applied to: Apply Regulatory Priority Rules
- Action: The system applies regulatory priority rules
Logic Flow:
IF Multiple valid holds are present on a cargo
AND The system applies regulatory priority rules
THEN:
- • The system determines the priority order of holds based on regulatory requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when fda hold is present along with other hold types.
Trigger Criteria:
- Context: FDA hold is present along with other hold types
- Applied to: FDA Hold Takes Priority?
- Action: The system evaluates hold priority
Logic Flow:
IF FDA hold is present along with other hold types
AND The system evaluates hold priority
THEN:
- • The system returns true if FDA hold takes priority over other holds, false
otherwise
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when border hold is present and fda hold does not take priority.
Trigger Criteria:
- Context: Border hold is present and FDA hold does not take priority
- Applied to: Border Hold Takes Priority?
- Action: The system evaluates hold priority
Logic Flow:
IF Border hold is present and FDA hold does not take priority
AND The system evaluates hold priority
THEN:
- • The system returns true if border hold takes priority over remaining hold types, false
otherwise
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when piece count hold is present and higher priority holds do not apply.
Trigger Criteria:
- Context: Piece count hold is present and higher priority holds do not apply
- Applied to: Piece Count Hold Active?
- Action: The system evaluates remaining hold types
Logic Flow:
IF Piece count hold is present and higher priority holds do not apply
AND The system evaluates remaining hold types
THEN:
- • The system returns true if piece count hold is active, false
otherwise
Rule Belongs to : GCX016E.cbl
Business Justification: Dictates the expected operational logic and validation steps when fda hold has been determined to take priority.
Trigger Criteria:
- Context: FDA hold has been determined to take priority
- Applied to: Set Final Hold Status - FDA Priority
- Action: The system sets the final hold status
Logic Flow:
IF FDA hold has been determined to take priority
AND The system sets the final hold status
THEN:
- • The system sets the cargo status to FDA hold and updates all related status flags
Rule Belongs to : GCX016E.cbl
Business Justification: Ensures correct system behavior and process compliance when border hold has been determined to take priority.
Trigger Criteria:
- Context: Border hold has been determined to take priority
- Applied to: Set Final Hold Status - Border Priority
- Action: The system sets the final hold status
Logic Flow:
IF Border hold has been determined to take priority
AND The system sets the final hold status
THEN:
- • The system sets the cargo status to border hold and updates all related status flags
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when destination hold is present and no higher priority holds apply.
Trigger Criteria:
- Context: Destination hold is present and no higher priority holds apply
- Applied to: Set Final Hold Status - Destination Hold
- Action: The system sets the final hold status
Logic Flow:
IF Destination hold is present and no higher priority holds apply
AND The system sets the final hold status
THEN:
- • The system sets the cargo status to destination hold and updates all related status flags
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when piece count hold is active and no higher priority holds apply.
Trigger Criteria:
- Context: Piece count hold is active and no higher priority holds apply
- Applied to: Set Final Hold Status - Piece Count Hold
- Action: The system sets the final hold status
Logic Flow:
IF Piece count hold is active and no higher priority holds apply
AND The system sets the final hold status
THEN:
- • The system sets the cargo status to piece count hold and updates all related status flags
Rule Belongs to : GCX016E.cbl
Business Justification: Defines the strict business conditions required to proceed when manual release disposition code is present.
Trigger Criteria:
- Context: Manual release disposition code is present
- Applied to: Set Final Hold Status - Manual Release Override
- Action: The system processes manual release override
Logic Flow:
IF Manual release disposition code is present
AND The system processes manual release override
THEN:
- • The system overrides system holds and sets the cargo status to released with manual release flag
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when hold combination validation has been performed.
Trigger Criteria:
- Context: Hold combination validation has been performed
- Applied to: Conflicting Holds Detected?
- Action: The system checks for conflicting holds
Logic Flow:
IF Hold combination validation has been performed
AND The system checks for conflicting holds
THEN:
- • The system returns true if conflicting holds are detected, false
otherwise
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when conflicting holds have been detected.
Trigger Criteria:
- Context: Conflicting holds have been detected
- Applied to: Generate Hold Conflict Warning
- Action: The system processes the conflict
Logic Flow:
IF Conflicting holds have been detected
AND The system processes the conflict
THEN:
- • The system generates a hold conflict warning message for operational review
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when standard hold priority rules do not determine a clear status or conflicts exist.
Trigger Criteria:
- Context: Standard hold priority rules do not determine a clear status or conflicts exist
- Applied to: Apply Default Hold Hierarchy
- Action: The system applies default hierarchy rules
Logic Flow:
IF Standard hold priority rules do not determine a clear status or conflicts exist
AND The system applies default hierarchy rules
THEN:
- • The system applies the default hold hierarchy to determine the final hold status
Rule Belongs to : GCX016E.cbl
Business Justification: Establishes the required business protocol to be followed when final hold status has been determined.
Trigger Criteria:
- Context: A final hold status has been determined
- Applied to: Validate Final Hold Status
- Action: The system validates the final status
Logic Flow:
IF A final hold status has been determined
AND The system validates the final status
THEN:
- • The system confirms the final hold status meets all business rules and regulatory requirements
Rule Belongs to : GCX016E.cbl
Business Justification: Governs the functional prerequisites and system routing when final hold status has been validated.
Trigger Criteria:
- Context: Final hold status has been validated
- Applied to: Update Hold Status Flags
- Action: The system updates status flags
Logic Flow:
IF Final hold status has been validated
AND The system updates status flags
THEN:
- • The system updates all hold status flags, indicators, and related cargo status information