BIG Pega COE Team
Business Rules to be added in EPICs
Category: GCX146_Canada_Import_train
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.
🎯 GCX146_Canada_Import_train Scope Detected: Extracted 1872 rules, Optimally Merged into 163 Feature Scenarios.
📁 File: GCX146.cbl
Select All in File
R-GCX146-cbl-00001 (+34) File: GCX146.cbl Business Rule: Overview Rules
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when system is ready to process train manifest requests.
Trigger Criteria:
- Context: The system is ready to process train manifest requests
- Applied to: Input Message Retrieval
- Action: The system attempts to retrieve the next input message from the queue
Logic Flow:
IF The system is ready to process train manifest requests
AND The system attempts to retrieve the next input message from the queue
THEN:
- • If a message is available, processing continues; if no message is available, processing terminates
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when user submits a train manifest request with a specific scac code.
Trigger Criteria:
- Context: A user submits a train manifest request with a specific SCAC code
- Applied to: SCAC Access Validation
- Action: The system validates SCAC access permissions for the user
Logic Flow:
IF A user submits a train manifest request with a specific SCAC code
AND The system validates SCAC access permissions for the user
THEN:
- • If SCAC access is invalid AND the request is not an AEI train send, the system generates error 36 and rolls back the transaction
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when input message is received for train manifest processing.
Trigger Criteria:
- Context: An input message is received for train manifest processing
- Applied to: Request Type Validation
- Action: The system examines the request type flags
Logic Flow:
IF An input message is received for train manifest processing
AND The system examines the request type flags
THEN:
- • The request must be classified as ADD, VERIFY, or NOTIFY; if none of these flags are set, the input is marked as invalid
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when system needs to validate estimated time of arrival dates.
Trigger Criteria:
- Context: The system needs to validate estimated time of arrival dates
- Applied to: Date and Time Processing
- Action: Date range calculations are performed
Logic Flow:
IF The system needs to validate estimated time of arrival dates
AND Date range calculations are performed
THEN:
- • The system calculates N30 (minus 30 days), P05 (plus 5 days), N02 (minus 2 days), and P02 (plus 2 days) from current date for validation boundaries
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when user submits a train manifest with an estimated time of arrival.
Trigger Criteria:
- Context: A user submits a train manifest with an estimated time of arrival
- Applied to: ETA Date Range Validation
- Action: The system validates the ETA date against user-specific date ranges
Logic Flow:
IF A user submits a train manifest with an estimated time of arrival
AND The system validates the ETA date against user-specific date ranges
THEN:
- • For 'S' type users, ETA must be between N30 and P05 dates (error 25 if violated); for other users, ETA must be between N02 and P02 dates (error 35 if violated)
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when train manifest request requires merlin communication capabilities.
Trigger Criteria:
- Context: A train manifest request requires Merlin communication capabilities
- Applied to: Merlin ID Management
- Action: The system validates Merlin ID configurations
Logic Flow:
IF A train manifest request requires Merlin communication capabilities
AND The system validates Merlin ID configurations
THEN:
- • Public, Supervisor, Customs, DC-P, and System FAX Merlin IDs must all exist in EMTZ table; missing IDs generate specific errors (4-8, 29)
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when train identification components are provided in the input.
Trigger Criteria:
- Context: Train identification components are provided in the input
- Applied to: Train ID Construction
- Action: The system constructs the customs train ID
Logic Flow:
IF Train identification components are provided in the input
AND The system constructs the customs train ID
THEN:
- • Spaces in train number, day, from/to stations, and consist number are replaced with zeros to create a standardized format
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when train manifest contains origin and destination station codes.
Trigger Criteria:
- Context: Train manifest contains origin and destination station codes
- Applied to: Station Information Validation
- Action: The system validates station information
Logic Flow:
IF Train manifest contains origin and destination station codes
AND The system validates station information
THEN:
- • Station codes must exist in the station master data and associated station names and routing information must be retrievable
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when train manifest operation requires database record management.
Trigger Criteria:
- Context: A train manifest operation requires database record management
- Applied to: Train Record Management
- Action: The system performs train record operations
Logic Flow:
IF A train manifest operation requires database record management
AND The system performs train record operations
THEN:
- • For ADD operations, existing train records are deleted and new records are inserted with SENT status; for other operations, records are retrieved for validation
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when train manifest contains a list of equipment.
Trigger Criteria:
- Context: A train manifest contains a list of equipment
- Applied to: Equipment Data Extraction
- Action: The system validates the equipment list
Logic Flow:
IF A train manifest contains a list of equipment
AND The system validates the equipment list
THEN:
- • The equipment list must contain at least one entry (error 34 if none) and no more than 500 entries (error 28 if exceeded)
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment requires waybill information for processing.
Trigger Criteria:
- Context: Equipment requires waybill information for processing
- Applied to: Waybill Lookup Processing
- Action: The system searches for waybill data
Logic Flow:
IF Equipment requires waybill information for processing
AND The system searches for waybill data
THEN:
- • Primary lookup uses FWCARGET for latest waybill by car ID; if not found, secondary lookup uses FWCIIO for car inquiry; if still not found, tertiary lookup uses FWIQIO for waybill inquiry
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when primary waybill lookup has failed for equipment.
Trigger Criteria:
- Context: Primary waybill lookup has failed for equipment
- Applied to: Waybill Inquiry Database Processing
- Action: The system performs inquiry database processing
Logic Flow:
IF Primary waybill lookup has failed for equipment
AND The system performs inquiry database processing
THEN:
- • The system searches FWINQ inquiry records and processes waybill sequences to extract equipment and shipment information
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment information is available for classification.
Trigger Criteria:
- Context: Equipment information is available for classification
- Applied to: Equipment Type Classification
- Action: The system determines equipment type
Logic Flow:
IF Equipment information is available for classification
AND The system determines equipment type
THEN:
- • Equipment is classified as Unit (L,P,D,U), Van (V), SBU, ETU (E), or regular car based on equipment type codes
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has a designated load/empty status.
Trigger Criteria:
- Context: Equipment has a designated load/empty status
- Applied to: Load/Empty Status Processing
- Action: The system validates waybill requirements
Logic Flow:
IF Equipment has a designated load/empty status
AND The system validates waybill requirements
THEN:
- • Empty cars (LE = 'E') are allowed without waybill for ADD operations; loaded cars without waybill generate error 21 for ADD operations or report 'LOADED CAR - NO WAYBILL' for VERIFY operations
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment requires ccn validation for customs processing.
Trigger Criteria:
- Context: Equipment requires CCN validation for customs processing
- Applied to: CCN Database Lookup
- Action: The system performs CCN database lookup
Logic Flow:
IF Equipment requires CCN validation for customs processing
AND The system performs CCN database lookup
THEN:
- • The system searches GCCCRT database using equipment ID and waybill information to retrieve existing CCN records and status
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn record exists for equipment.
Trigger Criteria:
- Context: A CCN record exists for equipment
- Applied to: CCN Status Validation
- Action: The system validates CCN status
Logic Flow:
IF A CCN record exists for equipment
AND The system validates CCN status
THEN:
- • CCN status must be 'SENT', 'RETURN', 'MANUAL', 'RELEASE', 'ACK', or 'CSA-DLV'; invalid status generates error 24 for ADD operations or reports current status for VERIFY operations
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn is being assigned to a train.
Trigger Criteria:
- Context: A CCN is being assigned to a train
- Applied to: Train Assignment Validation
- Action: The system checks for existing train assignments
Logic Flow:
IF A CCN is being assigned to a train
AND The system checks for existing train assignments
THEN:
- • If the CCN is already assigned to a different train, error 13 is generated to prevent duplicate assignments
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when flat car is carrying containers and waybill information is available.
Trigger Criteria:
- Context: A flat car is carrying containers and waybill information is available
- Applied to: Container Processing
- Action: The system processes container information
Logic Flow:
IF A flat car is carrying containers and waybill information is available
AND The system processes container information
THEN:
- • Container IDs are extracted from waybill cross-reference data and formatted using GCCCARFM utility for 12-character format
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment is classified as empty or exempted from ccn requirements.
Trigger Criteria:
- Context: Equipment is classified as empty or exempted from CCN requirements
- Applied to: Empty/Exempted Equipment Processing
- Action: The system processes the equipment
Logic Flow:
IF Equipment is classified as empty or exempted from CCN requirements
AND The system processes the equipment
THEN:
- • Empty cars and exempted equipment types bypass CCN validation requirements and are processed with appropriate status indicators
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has been processed and status determined.
Trigger Criteria:
- Context: Equipment has been processed and status determined
- Applied to: Equipment Status Totals Compilation
- Action: The system compiles status totals
Logic Flow:
IF Equipment has been processed and status determined
AND The system compiles status totals
THEN:
- • TOTAL-RELEASE counts equipment with 'RELEASE' or 'CSA-DLV' status; TOTAL-HAULAGE counts equipment with haulage rights; TOTAL-PROCEED counts equipment in transit between different stations; TOTAL-HELD-CCRA counts equipment with 'HOLD' or 'AGI-HOLD' status; TOTAL-HELD-DOCS counts equipment at same station with no broker entry
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when train manifest data has been validated and processed.
Trigger Criteria:
- Context: Train manifest data has been validated and processed
- Applied to: EDI Transmission Processing
- Action: The system transmits EDI transactions
Logic Flow:
IF Train manifest data has been validated and processed
AND The system transmits EDI transactions
THEN:
- • EDI transactions are sent to appropriate trading partners and customs authorities with train and equipment information
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when aei train send operation is performed.
Trigger Criteria:
- Context: An AEI train send operation is performed
- Applied to: AEI Logging
- Action: The system logs AEI activity
Logic Flow:
IF An AEI train send operation is performed
AND The system logs AEI activity
THEN:
- • AEI send activity is logged regardless of processing errors for audit trail and tracking purposes
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when train manifest processing has completed.
Trigger Criteria:
- Context: Train manifest processing has completed
- Applied to: Confirmation Message Generation
- Action: The system generates confirmation messages
Logic Flow:
IF Train manifest processing has completed
AND The system generates confirmation messages
THEN:
- • Successful operations generate confirmation messages to originating terminals; failed operations generate error notifications with appropriate error codes
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when add operation completed successfully without errors.
Trigger Criteria:
- Context: ADD operation completed successfully without errors
- Applied to: Canada Customs Trip Sheet Generation
- Action: The system generates Canada customs trip sheets
Logic Flow:
IF ADD operation completed successfully without errors
AND The system generates Canada customs trip sheets
THEN:
- • Trip sheets include equipment details, waybill information, shipper/consignee data, and are sent to appropriate Canadian customs terminals
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when verify operation is requested for train manifest.
Trigger Criteria:
- Context: VERIFY operation is requested for train manifest
- Applied to: Status Report Generation
- Action: The system generates status reports
Logic Flow:
IF VERIFY operation is requested for train manifest
AND The system generates status reports
THEN:
- • Status report includes equipment totals by category, detailed status information, transit status indicators, and up to 90 lines of US status messages
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when validation errors are detected during processing.
Trigger Criteria:
- Context: Validation errors are detected during processing
- Applied to: Error Message Processing
- Action: The system processes error messages
Logic Flow:
IF Validation errors are detected during processing
AND The system processes error messages
THEN:
- • Error messages are formatted with appropriate error codes and descriptions,
then distributed to supervisors and originating terminals for resolution
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when reports or notifications need to be distributed electronically.
Trigger Criteria:
- Context: Reports or notifications need to be distributed electronically
- Applied to: Email/FAX Distribution
- Action: The system processes email and FAX distribution
Logic Flow:
IF Reports or notifications need to be distributed electronically
AND The system processes email and FAX distribution
THEN:
- • Email messages are limited to 699 lines per message; larger reports create continuation messages with 'CONTINUATION OF REPORT...' header; failed emails are sent to support team (OM01247, AEI9999)
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when us-bound cargo requires trip sheet documentation.
Trigger Criteria:
- Context: US-bound cargo requires trip sheet documentation
- Applied to: US Trip Sheet Generation
- Action: The system generates US trip sheets
Logic Flow:
IF US-bound cargo requires trip sheet documentation
AND The system generates US trip sheets
THEN:
- • Trip sheets include equipment type descriptions, status mappings (RELEASE with export transit becomes 'EXPORT', transit status 'T' becomes 'TRANSIT', return status 'R' becomes 'RETURN'), and are distributed to US Merlin users
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when train manifest contains cargo with destination information.
Trigger Criteria:
- Context: Train manifest contains cargo with destination information
- Applied to: Cargo Arrival Detection
- Action: The system detects cargo arrivals
Logic Flow:
IF Train manifest contains cargo with destination information
AND The system detects cargo arrivals
THEN:
- • Cargo is identified as arriving when manifest destination codes match station codes; only non-ocean manifest cargo is processed for arrival notifications
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when arriving cargo has been detected at destination stations.
Trigger Criteria:
- Context: Arriving cargo has been detected at destination stations
- Applied to: Cargo Arrival Notification
- Action: The system processes arrival notifications
Logic Flow:
IF Arriving cargo has been detected at destination stations
AND The system processes arrival notifications
THEN:
- • Arrival notices are created and sent to customs processing systems via GCT1481E transactions for appropriate handling
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo requires return processing with new ccn creation.
Trigger Criteria:
- Context: Cargo requires return processing with new CCN creation
- Applied to: Return CCN Creation
- Action: The system creates return CCN records
Logic Flow:
IF Cargo requires return processing with new CCN creation
AND The system creates return CCN records
THEN:
- • New CCN records are created with 'RETURN' status, CCN key format includes type(6) + carrier(105) + E + equipment_id + waybill_date + sequence, and audit trail entries are created via GCX105 spawning
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn keys starting with '6105' (excluding 'i' type) require broker notification.
Trigger Criteria:
- Context: CCN keys starting with '6105' (excluding 'I' type) require broker notification
- Applied to: Broker Notification Processing
- Action: The system processes broker notifications
Logic Flow:
IF CCN keys starting with '6105' (excluding 'I' type) require broker notification
AND The system processes broker notifications
THEN:
- • Notifications are sent to brokers only if current status is not 'RETURN' or 'MANUAL'; multiple notification methods are supported (X12, Merlin, Internet, FAX, Paper) with primary and secondary broker handling
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has us customs records requiring status processing.
Trigger Criteria:
- Context: Equipment has US customs records requiring status processing
- Applied to: US Customs Status Processing
- Action: The system processes US customs status
Logic Flow:
IF Equipment has US customs records requiring status processing
AND The system processes US customs status
THEN:
- • Bond types (IT, TR, MT, TE) are validated; warnings are generated for IT bond types, train vessel mismatches, in-transit location mismatches, and TIB date issues; arrival keys are tracked for specific bond types during ADD operations
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when canadian border processing requires special manifest creation.
Trigger Criteria:
- Context: Canadian border processing requires special manifest creation
- Applied to: Special Manifest Processing
- Action: The system processes special manifests
Logic Flow:
IF Canadian border processing requires special manifest creation
AND The system processes special manifests
THEN:
- • Special manifest records are created with record type 'CA' (Canadian), border code and station name from train data, and CCN keys are stored for processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn exists for equipment validation.
Trigger Criteria:
- Context: A CCN exists for equipment validation
- Applied to: CCN Usability Validation
- Action: The system validates CCN usability
Logic Flow:
IF A CCN exists for equipment validation
AND The system validates CCN usability
THEN:
- • CCN is usable if equipment ID matches saved equipment ID AND (waybill number matches OR new bond created flag = 'Y'); if CCN exists with same equipment but different waybill and no new bond created, it's marked unusable; for VERIFY operations, 'CCN FOUND NOT USABLE' status message is added
R-GCX146-cbl-00036 (+7) File: GCX146.cbl Business Rule: Input Message Retrieval
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when system needs to process train manifest requests. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: The system needs to process train manifest requests
- Applied to: Call READQ to Access Message Queue
- Action: A READQ call is made to access the message queue
Logic Flow:
IF The system needs to process train manifest requests
AND A READQ call is made to access the message queue
THEN:
- • The system attempts to read the next available message from the IMS message queue
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when readq operation has been performed on the message queue.
Trigger Criteria:
- Context: A READQ operation has been performed on the message queue
- Applied to: Message Available in Queue?
- Action: The system checks the return code from the READQ operation
Logic Flow:
IF A READQ operation has been performed on the message queue
AND The system checks the return code from the READQ operation
THEN:
- • If return code is zero, a message is available; if return code is non-zero, no message is available
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when message has been successfully retrieved from the queue.
Trigger Criteria:
- Context: A message has been successfully retrieved from the queue
- Applied to: Move Message to INPUT-MESSAGE Buffer
- Action: The message needs to be prepared for processing
Logic Flow:
IF A message has been successfully retrieved from the queue
AND The message needs to be prepared for processing
THEN:
- • The message content is moved to the INPUT-MESSAGE buffer
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when message has been moved to the input-message buffer.
Trigger Criteria:
- Context: A message has been moved to the INPUT-MESSAGE buffer
- Applied to: Get Message Length
- Action: The system needs to know the message boundaries
Logic Flow:
IF A message has been moved to the INPUT-MESSAGE buffer
AND The system needs to know the message boundaries
THEN:
- • The message length is determined and stored for processing validation
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when message has been successfully retrieved and prepared for processing.
Trigger Criteria:
- Context: A message has been successfully retrieved and prepared for processing
- Applied to: Set Return Code to Continue Processing
- Action: The system needs to indicate processing should continue
Logic Flow:
IF A message has been successfully retrieved and prepared for processing
AND The system needs to indicate processing should continue
THEN:
- • The return code is set to zero to signal continuation of the message retrieval loop
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when no message is available in the queue.
Trigger Criteria:
- Context: No message is available in the queue
- Applied to: Set Return Code to Stop Processing
- Action: The system determines the queue is empty
Logic Flow:
IF No message is available in the queue
AND The system determines the queue is empty
THEN:
- • The return code is set to non-zero to signal termination of the message retrieval loop
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when message has been successfully retrieved and prepared.
Trigger Criteria:
- Context: A message has been successfully retrieved and prepared
- Applied to: Proceed to Message Validation
- Action: The return code indicates continuation of processing
Logic Flow:
IF A message has been successfully retrieved and prepared
AND The return code indicates continuation of processing
THEN:
- • The system proceeds to the next phase of message validation and processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when message queue is empty or no more messages are available.
Trigger Criteria:
- Context: The message queue is empty or no more messages are available
- Applied to: End Message Retrieval Loop
- Action: The return code indicates processing should stop
Logic Flow:
IF The message queue is empty or no more messages are available
AND The return code indicates processing should stop
THEN:
- • The message retrieval loop is terminated and the system exits the input processing phase
R-GCX146-cbl-00044 (+7) File: GCX146.cbl Business Rule: SCAC Access Validation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when input message is received for processing.
Trigger Criteria:
- Context: An input message is received for processing
- Applied to: Extract User ID from Input Message
- Action: The system begins SCAC access validation
Logic Flow:
IF An input message is received for processing
AND The system begins SCAC access validation
THEN:
- • The user ID is extracted from the input message for authorization checking
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when customs train id is provided in the request.
Trigger Criteria:
- Context: A customs train ID is provided in the request
- Applied to: Extract SCAC Code from Customs Train ID
- Action: SCAC validation is performed
Logic Flow:
IF A customs train ID is provided in the request
AND SCAC validation is performed
THEN:
- • The SCAC code is extracted from the customs train ID for authorization verification
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when user id and scac code have been extracted. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: User ID and SCAC code have been extracted
- Applied to: Call GCCSCAC Module for Validation
- Action: Authorization validation is required
Logic Flow:
IF User ID and SCAC code have been extracted
AND Authorization validation is required
THEN:
- • The GCCSCAC module is called to validate user access to the SCAC code
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when gccscac module has completed validation.
Trigger Criteria:
- Context: GCCSCAC module has completed validation
- Applied to: Check GCCSCAC-FLAG Result
- Action: The validation result flag is checked
Logic Flow:
IF GCCSCAC module has completed validation
AND The validation result flag is checked
THEN:
- • The system determines whether SCAC access is valid based on the returned flag
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when scac validation has been performed.
Trigger Criteria:
- Context: SCAC validation has been performed
- Applied to: Set Access Granted Flag
- Action: The SCAC access is determined to be valid
Logic Flow:
IF SCAC validation has been performed
AND The SCAC access is determined to be valid
THEN:
- • The access granted flag is set and processing continues
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when scac access validation has failed.
Trigger Criteria:
- Context: SCAC access validation has failed
- Applied to: Is AEI Train Send Request?
- Action: The system checks the request type
Logic Flow:
IF SCAC access validation has failed
AND The system checks the request type
THEN:
- • If the request is NOT an AEI train send, access is denied with Error 36,
otherwise processing continues
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when scac access validation has failed.
Trigger Criteria:
- Context: SCAC access validation has failed
- Applied to: Generate Error 36 - Access Denied
- Action: The request is not an AEI train send
Logic Flow:
IF SCAC access validation has failed
AND The request is not an AEI train send
THEN:
- • Error 36 is generated indicating access denied due to invalid SCAC authorization
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when access denied error has been generated.
Trigger Criteria:
- Context: Access denied error has been generated
- Applied to: Set Rollback Flag
- Action: Transaction rollback is required
Logic Flow:
IF Access denied error has been generated
AND Transaction rollback is required
THEN:
- • The rollback flag is set to ensure no partial updates are committed
R-GCX146-cbl-00052 (+7) File: GCX146.cbl Business Rule: Request Type Validation
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when input message is received for processing.
Trigger Criteria:
- Context: An input message is received for processing
- Applied to: Request Type = ADD?
- Action: The request type field equals 'ADD'
Logic Flow:
IF An input message is received for processing
AND The request type field equals 'ADD'
THEN:
- • The system sets the AEI-TRAIN-SEND flag and establishes ADD processing mode
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when input message is received for processing.
Trigger Criteria:
- Context: An input message is received for processing
- Applied to: Set INVALID-INPUT-FLAG
- Action: The request type is not ADD, VERIFY, or NOTIFY
Logic Flow:
IF An input message is received for processing
AND The request type is not ADD, VERIFY, or NOTIFY
THEN:
- • The system sets the INVALID-INPUT-FLAG to indicate unsupported request type
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when input message is received for processing and request type is not add.
Trigger Criteria:
- Context: An input message is received for processing and request type is not ADD
- Applied to: Request Type = VERIFY?
- Action: The request type field equals 'VERIFY'
Logic Flow:
IF An input message is received for processing and request type is not ADD
AND The request type field equals 'VERIFY'
THEN:
- • The system sets the AEI-TRAIN-SEND flag and establishes VERIFY processing mode
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when input message is received for processing and request type is neither add nor verify.
Trigger Criteria:
- Context: An input message is received for processing and request type is neither ADD nor VERIFY
- Applied to: Request Type = NOTIFY?
- Action: The request type field equals 'NOTIFY'
Logic Flow:
IF An input message is received for processing and request type is neither ADD nor VERIFY
AND The request type field equals 'NOTIFY'
THEN:
- • The system sets the AEI-TRAIN-SEND flag and establishes NOTIFY processing mode
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when request type has been validated as add.
Trigger Criteria:
- Context: The request type has been validated as ADD
- Applied to: Set AEI-TRAIN-SEND Flag for ADD
- Action: Processing flags need to be established
Logic Flow:
IF The request type has been validated as ADD
AND Processing flags need to be established
THEN:
- • The system sets the AEI-TRAIN-SEND flag to enable automatic equipment identification processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when request type has been validated as verify.
Trigger Criteria:
- Context: The request type has been validated as VERIFY
- Applied to: Set AEI-TRAIN-SEND Flag for VERIFY
- Action: Processing flags need to be established
Logic Flow:
IF The request type has been validated as VERIFY
AND Processing flags need to be established
THEN:
- • The system sets the AEI-TRAIN-SEND flag to enable automatic equipment identification processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when request type has been validated as notify.
Trigger Criteria:
- Context: The request type has been validated as NOTIFY
- Applied to: Set AEI-TRAIN-SEND Flag for NOTIFY
- Action: Processing flags need to be established
Logic Flow:
IF The request type has been validated as NOTIFY
AND Processing flags need to be established
THEN:
- • The system sets the AEI-TRAIN-SEND flag to enable automatic equipment identification processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when valid request type (add, verify, or notify) has been identified and aei-train-send flag is set.
Trigger Criteria:
- Context: A valid request type (ADD, VERIFY, or NOTIFY) has been identified and AEI-TRAIN-SEND flag is set
- Applied to: Set Processing Flags for Request Type
- Action: The system needs to configure processing parameters
Logic Flow:
IF A valid request type (ADD, VERIFY, or NOTIFY) has been identified and AEI-TRAIN-SEND flag is set
AND The system needs to configure processing parameters
THEN:
- • The system sets all necessary processing flags to enable the appropriate business logic flow for the request type
R-GCX146-cbl-00060 (+6) File: GCX146.cbl Business Rule: Date and Time Processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when date and time processing routine is initiated.
Trigger Criteria:
- Context: The date and time processing routine is initiated
- Applied to: Capture Current System Date and Time
- Action: The system needs to establish current date and time
Logic Flow:
IF The date and time processing routine is initiated
AND The system needs to establish current date and time
THEN:
- • The current system date and time are captured and stored for subsequent calculations
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when current system date is available.
Trigger Criteria:
- Context: The current system date is available
- Applied to: Calculate 30 Days Before Current Date
- Action: A 30-day lookback date range is required for supervisor-level ETA validation
Logic Flow:
IF The current system date is available
AND A 30-day lookback date range is required for supervisor-level ETA validation
THEN:
- • The system calculates and stores a date that is exactly 30 days before the current date
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when current system date is available.
Trigger Criteria:
- Context: The current system date is available
- Applied to: Calculate 5 Days After Current Date
- Action: A 5-day forward date range is required for supervisor-level ETA validation
Logic Flow:
IF The current system date is available
AND A 5-day forward date range is required for supervisor-level ETA validation
THEN:
- • The system calculates and stores a date that is exactly 5 days after the current date
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when current system date is available.
Trigger Criteria:
- Context: The current system date is available
- Applied to: Calculate 2 Days Before Current Date
- Action: A 2-day lookback date range is required for standard user ETA validation
Logic Flow:
IF The current system date is available
AND A 2-day lookback date range is required for standard user ETA validation
THEN:
- • The system calculates and stores a date that is exactly 2 days before the current date
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when current system date is available.
Trigger Criteria:
- Context: The current system date is available
- Applied to: Calculate 2 Days After Current Date
- Action: A 2-day forward date range is required for standard user ETA validation
Logic Flow:
IF The current system date is available
AND A 2-day forward date range is required for standard user ETA validation
THEN:
- • The system calculates and stores a date that is exactly 2 days after the current date
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when year value needs century determination for date processing.
Trigger Criteria:
- Context: A year value needs century determination for date processing
- Applied to: Handle Century Format for Y2K Compliance
- Action: The year value is greater than 70
Logic Flow:
IF A year value needs century determination for date processing
AND The year value is greater than 70
THEN:
- • The century is set to 19xx (1900s),
otherwise the century is set to 20xx (2000s)
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when all date calculations (30-day lookback, 5-day forward, 2-day lookback, 2-day forward) are completed.
Trigger Criteria:
- Context: All date calculations (30-day lookback, 5-day forward, 2-day lookback, 2-day forward) are completed
- Applied to: Store Calculated Date Ranges for ETA Validation
- Action: The date ranges need to be preserved for ETA validation
Logic Flow:
IF All date calculations (30-day lookback, 5-day forward, 2-day lookback, 2-day forward) are completed
AND The date ranges need to be preserved for ETA validation
THEN:
- • All calculated date ranges are stored in working storage variables for use in ETA validation routines
R-GCX146-cbl-00067 (+7) File: GCX146.cbl Business Rule: ETA Date Range Validation
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when current date is available in the system.
Trigger Criteria:
- Context: Current date is available in the system
- Applied to: Calculate Date Ranges Using DATECALC
- Action: ETA validation process is initiated
Logic Flow:
IF Current date is available in the system
AND ETA validation process is initiated
THEN:
- • Standard date range of minus 2 days to plus 2 days from current date is calculated AND extended date range of minus 30 days to plus 5 days from current date is calculated
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when user is authenticated and has a profile in gcstbrt-us-ctf-add.
Trigger Criteria:
- Context: User is authenticated and has a profile in GCSTBRT-US-CTF-ADD
- Applied to: Get User Type from GCSTBRT-US-CTF-ADD
- Action: ETA validation is performed
Logic Flow:
IF User is authenticated and has a profile in GCSTBRT-US-CTF-ADD
AND ETA validation is performed
THEN:
- • User type is retrieved from the user profile for date range determination
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when user type has been retrieved from user profile.
Trigger Criteria:
- Context: User type has been retrieved from user profile
- Applied to: User Type = 'S' Special User?
- Action: User type equals 'S' (Special User)
Logic Flow:
IF User type has been retrieved from user profile
AND User type equals 'S' (Special User)
THEN:
- • Extended date range of minus 30 days to plus 5 days is applied for ETA validation
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when user type has been retrieved from user profile.
Trigger Criteria:
- Context: User type has been retrieved from user profile
- Applied to: User Type = 'S' Special User?
- Action: User type is not equal to 'S' (not Special User)
Logic Flow:
IF User type has been retrieved from user profile
AND User type is not equal to 'S' (not Special User)
THEN:
- • Standard date range of minus 2 days to plus 2 days is applied for ETA validation
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when eta date is provided in the train request.
Trigger Criteria:
- Context: ETA date is provided in the train request
- Applied to: Validate ETA Date Using ISDATECV
- Action: Date format validation is performed using ISDATECV
Logic Flow:
IF ETA date is provided in the train request
AND Date format validation is performed using ISDATECV
THEN:
- • ETA date format is validated and confirmed as a legitimate calendar date
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when user is a special user (type 's') and eta date is provided.
Trigger Criteria:
- Context: User is a special user (type 'S') AND ETA date is provided
- Applied to: ETA Date Within Allowed Range?
- Action: ETA date is compared against extended date range
Logic Flow:
IF User is a special user (type 'S') AND ETA date is provided
AND ETA date is compared against extended date range
THEN:
- • ETA date is accepted if within minus 30 to plus 5 days range OR error 25 is generated if outside this range
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when user is a standard user (not type 's') and eta date is provided.
Trigger Criteria:
- Context: User is a standard user (not type 'S') AND ETA date is provided
- Applied to: ETA Date Within Allowed Range?
- Action: ETA date is compared against standard date range
Logic Flow:
IF User is a standard user (not type 'S') AND ETA date is provided
AND ETA date is compared against standard date range
THEN:
- • ETA date is accepted if within minus 2 to plus 2 days range OR error 35 is generated if outside this range
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when eta time is provided in the train request.
Trigger Criteria:
- Context: ETA time is provided in the train request
- Applied to: MM
- Action: Time format validation is performed
Logic Flow:
IF ETA time is provided in the train request
AND Time format validation is performed
THEN:
- • Time format is validated as HH:MM where hours are 00-23 and minutes are 00-59 OR time format error is generated for invalid format
R-GCX146-cbl-00075 (+10) File: GCX146.cbl Business Rule: Merlin ID Management
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when admin table segment is available in gcstbrt database.
Trigger Criteria:
- Context: The admin table segment is available in GCSTBRT database
- Applied to: Extract PUBLIC Merlin ID & Extract DC-P Merlin ID
- Action: The system processes Merlin ID extraction
Logic Flow:
IF The admin table segment is available in GCSTBRT database
AND The system processes Merlin ID extraction
THEN:
- • The PUBLIC Merlin ID is extracted from the admin table and stored for validation
- • The DC-P Merlin ID is extracted from the admin table and stored for validation
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when terminal table segment is available in gcstbrt database.
Trigger Criteria:
- Context: The terminal table segment is available in GCSTBRT database
- Applied to: Extract SUPERVISOR Merlin ID & Extract ALTERNATE Merlin ID
- Action: The system processes Merlin ID extraction
Logic Flow:
IF The terminal table segment is available in GCSTBRT database
AND The system processes Merlin ID extraction
THEN:
- • The SUPERVISOR Merlin ID is extracted from the terminal table and stored for validation
- • The ALTERNATE Merlin ID is extracted from the terminal table and stored for validation
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when public merlin id has been extracted from the admin table.
Trigger Criteria:
- Context: A PUBLIC Merlin ID has been extracted from the admin table
- Applied to: PUBLIC ID Valid?
- Action: The system validates the PUBLIC Merlin ID against the EMTZ database
Logic Flow:
IF A PUBLIC Merlin ID has been extracted from the admin table
AND The system validates the PUBLIC Merlin ID against the EMTZ database
THEN:
- • If the PUBLIC Merlin ID exists in EMTZ database, validation passes,
otherwise validation fails with error 4
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when supervisor merlin id has been extracted from the terminal table and the public merlin id validation has passed.
Trigger Criteria:
- Context: A SUPERVISOR Merlin ID has been extracted from the terminal table AND the PUBLIC Merlin ID validation has passed
- Applied to: SUPERVISOR ID Valid?
- Action: The system validates the SUPERVISOR Merlin ID against the EMTZ database
Logic Flow:
IF A SUPERVISOR Merlin ID has been extracted from the terminal table AND the PUBLIC Merlin ID validation has passed
AND The system validates the SUPERVISOR Merlin ID against the EMTZ database
THEN:
- • If the SUPERVISOR Merlin ID exists in EMTZ database, validation passes,
otherwise validation fails with error 5
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when customs merlin id needs validation and the supervisor merlin id validation has passed.
Trigger Criteria:
- Context: The CUSTOMS Merlin ID needs validation AND the SUPERVISOR Merlin ID validation has passed
- Applied to: CUSTOMS ID Valid?
- Action: The system validates the CUSTOMS Merlin ID against the EMTZ database
Logic Flow:
IF The CUSTOMS Merlin ID needs validation AND the SUPERVISOR Merlin ID validation has passed
AND The system validates the CUSTOMS Merlin ID against the EMTZ database
THEN:
- • If the CUSTOMS Merlin ID exists in EMTZ database, validation passes,
otherwise validation fails with error 6
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when dc-p merlin id has been extracted from the admin table and the customs merlin id validation has passed.
Trigger Criteria:
- Context: A DC-P Merlin ID has been extracted from the admin table AND the CUSTOMS Merlin ID validation has passed
- Applied to: DC-P ID Valid?
- Action: The system validates the DC-P Merlin ID against the EMTZ database
Logic Flow:
IF A DC-P Merlin ID has been extracted from the admin table AND the CUSTOMS Merlin ID validation has passed
AND The system validates the DC-P Merlin ID against the EMTZ database
THEN:
- • If the DC-P Merlin ID exists in EMTZ database, validation passes,
otherwise validation fails with error 7
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when system-fax merlin id needs validation and the dc-p merlin id validation has passed.
Trigger Criteria:
- Context: The SYSTEM-FAX Merlin ID needs validation AND the DC-P Merlin ID validation has passed
- Applied to: SYSTEM-FAX ID Valid?
- Action: The system validates the SYSTEM-FAX Merlin ID against the EMTZ database
Logic Flow:
IF The SYSTEM-FAX Merlin ID needs validation AND the DC-P Merlin ID validation has passed
AND The system validates the SYSTEM-FAX Merlin ID against the EMTZ database
THEN:
- • If the SYSTEM-FAX Merlin ID exists in EMTZ database, validation passes,
otherwise validation fails with error 8
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all five merlin ids (public, supervisor, customs, dc-p, system-fax) have been extracted from their respective tables.
Trigger Criteria:
- Context: All five Merlin IDs (PUBLIC, SUPERVISOR, CUSTOMS, DC-P, SYSTEM-FAX) have been extracted from their respective tables
- Applied to: All Merlin IDs Successfully Validated
- Action: All Merlin ID validations against the EMTZ database have been completed successfully
Logic Flow:
IF All five Merlin IDs (PUBLIC, SUPERVISOR, CUSTOMS, DC-P, SYSTEM-FAX) have been extracted from their respective tables
AND All Merlin ID validations against the EMTZ database have been completed successfully
THEN:
- • The system proceeds with customs reporting operations using the validated communication channels
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when one or more merlin ids are being validated against the emtz database.
Trigger Criteria:
- Context: One or more Merlin IDs are being validated against the EMTZ database
- Applied to: Merlin ID Validation Failed
- Action: Any Merlin ID validation fails (PUBLIC, SUPERVISOR, CUSTOMS, DC-P, or SYSTEM-FAX)
Logic Flow:
IF One or more Merlin IDs are being validated against the EMTZ database
AND Any Merlin ID validation fails (PUBLIC, SUPERVISOR, CUSTOMS, DC-P, or SYSTEM-FAX)
THEN:
- • The system stops the validation process and reports the specific validation error without proceeding to customs reporting operations
R-GCX146-cbl-00086 (+10) File: GCX146.cbl Business Rule: Train ID Construction
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when input message containing train identification data.
Trigger Criteria:
- Context: An input message containing train identification data
- Applied to: Extract Train Number from Input & Extract Train Day from Input & Extract From Station Code & Extract To Station Code & Extract Consist Number
- Action: The system processes the train ID construction request
Logic Flow:
IF An input message containing train identification data
AND The system processes the train ID construction request
THEN:
- • The train number component is extracted from the input message and stored for further processing
- • The train day component is extracted from the input message and stored for further processing
- • The from station code is extracted from the input message and stored for further processing
- • The to station code is extracted from the input message and stored for further processing
- • The consist number is extracted from the input message and stored for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when train id construction request is being processed.
Trigger Criteria:
- Context: A train ID construction request is being processed
- Applied to: Get System Date
- Action: The system needs to build the customs train ID
Logic Flow:
IF A train ID construction request is being processed
AND The system needs to build the customs train ID
THEN:
- • The current system date is retrieved and stored for inclusion in the train ID
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when train id components have been extracted from the input message.
Trigger Criteria:
- Context: Train ID components have been extracted from the input message
- Applied to: Replace Spaces with Zeros in All Components
- Action: Any component contains spaces
Logic Flow:
IF Train ID components have been extracted from the input message
AND Any component contains spaces
THEN:
- • All spaces in train number, day, from station, to station, and consist number are replaced with zeros
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when all train id components have been extracted and spaces replaced with zeros. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: All train ID components have been extracted and spaces replaced with zeros
- Applied to: Construct WS-CUSTOMS-TRAIN-ID
- Action: The system constructs the customs train ID
Logic Flow:
IF All train ID components have been extracted and spaces replaced with zeros
AND The system constructs the customs train ID
THEN:
- • The customs train ID is built by concatenating train number, day, from station, to station, consist number, and system date
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when customs train id has been constructed.
Trigger Criteria:
- Context: The customs train ID has been constructed
- Applied to: Build GCWB4TL-CP-TRAIN-ID
- Action: The system needs to create the CP train ID
Logic Flow:
IF The customs train ID has been constructed
AND The system needs to create the CP train ID
THEN:
- • The GCWB4TL-CP-TRAIN-ID is built using the standardized customs train ID format
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when customs train id and cp train id have been constructed.
Trigger Criteria:
- Context: The customs train ID and CP train ID have been constructed
- Applied to: Validate Train ID Format
- Action: The system validates the train ID format
Logic Flow:
IF The customs train ID and CP train ID have been constructed
AND The system validates the train ID format
THEN:
- • The train ID format is checked against business requirements and validation rules
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when train id has been constructed and validated successfully.
Trigger Criteria:
- Context: The train ID has been constructed and validated successfully
- Applied to: Set Train ID for Processing
- Action: The train ID format validation passes
Logic Flow:
IF The train ID has been constructed and validated successfully
AND The train ID format validation passes
THEN:
- • The train ID is set as valid and ready for use in downstream processing
R-GCX146-cbl-00097 (+4) File: GCX146.cbl Business Rule: Station Information Validation
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when from-station code has been extracted from the input message.
Trigger Criteria:
- Context: A from-station code has been extracted from the input message
- Applied to: Search Station Configuration Table
- Action: The system searches the station configuration table for the station code
Logic Flow:
IF A from-station code has been extracted from the input message
AND The system searches the station configuration table for the station code
THEN:
- • The system retrieves the corresponding station data if found, or proceeds to validation checks if not found
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when station has been found in the station configuration table.
Trigger Criteria:
- Context: A station has been found in the station configuration table
- Applied to: Station Code = '0000'?
- Action: The station code equals '0000'
Logic Flow:
IF A station has been found in the station configuration table
AND The station code equals '0000'
THEN:
- • The system sets a station validation error indicating invalid Canadian station code
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when station code was not found in the station configuration table.
Trigger Criteria:
- Context: A station code was not found in the station configuration table
- Applied to: Request Type = VERIFY?
- Action: The request type is VERIFY
Logic Flow:
IF A station code was not found in the station configuration table
AND The request type is VERIFY
THEN:
- • The system continues processing despite the missing station information
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when station code was not found in the station configuration table.
Trigger Criteria:
- Context: A station code was not found in the station configuration table
- Applied to: Set Station Validation Error
- Action: The request type is not VERIFY
Logic Flow:
IF A station code was not found in the station configuration table
AND The request type is not VERIFY
THEN:
- • The system sets a station validation error and fails the validation process
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when valid station has been found and station code is not '0000'.
Trigger Criteria:
- Context: A valid station has been found and station code is not '0000'
- Applied to: Auto-FAX Enabled?
- Action: The system checks the auto-FAX configuration for the station
Logic Flow:
IF A valid station has been found and station code is not '0000'
AND The system checks the auto-FAX configuration for the station
THEN:
- • If auto-FAX is enabled, the system validates FAX settings;
otherwise, station validation is successful
R-GCX146-cbl-00102 (+10) File: GCX146.cbl Business Rule: Train Record Management
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when train id is provided for processing.
Trigger Criteria:
- Context: A train ID is provided for processing
- Applied to: Check for Existing Train Records
- Action: The system checks the train records database
Logic Flow:
IF A train ID is provided for processing
AND The system checks the train records database
THEN:
- • The system determines whether a train record exists for the given train ID
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when train record exists in the database.
Trigger Criteria:
- Context: A train record exists in the database
- Applied to: Retrieve Existing Train Record
- Action: The system accesses the train record
Logic Flow:
IF A train record exists in the database
AND The system accesses the train record
THEN:
- • The complete train record details are retrieved including status and equipment information
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when existing train record is retrieved.
Trigger Criteria:
- Context: An existing train record is retrieved
- Applied to: Validate Record Status
- Action: The system examines the record status
Logic Flow:
IF An existing train record is retrieved
AND The system examines the record status
THEN:
- • The system determines if the record is active, deleted, or in another status state
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when train record exists with a status indicator.
Trigger Criteria:
- Context: A train record exists with a status indicator
- Applied to: Record Marked as Deleted?
- Action: The system checks the deletion status flag
Logic Flow:
IF A train record exists with a status indicator
AND The system checks the deletion status flag
THEN:
- • The system identifies whether the record is marked as deleted or active
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when train record is marked as deleted.
Trigger Criteria:
- Context: A train record is marked as deleted
- Applied to: Delete Existing Train Record
- Action: The system processes the deletion request
Logic Flow:
IF A train record is marked as deleted
AND The system processes the deletion request
THEN:
- • The train record is permanently removed from the database
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when deletion operation has been attempted on a train record.
Trigger Criteria:
- Context: A deletion operation has been attempted on a train record
- Applied to: Deletion Successful?
- Action: The system checks the deletion result
Logic Flow:
IF A deletion operation has been attempted on a train record
AND The system checks the deletion result
THEN:
- • The system confirms whether the deletion was successful or failed
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when no existing train record exists or an existing record has been successfully deleted.
Trigger Criteria:
- Context: No existing train record exists or an existing record has been successfully deleted
- Applied to: Create New Train Record
- Action: The system creates a new train record
Logic Flow:
IF No existing train record exists or an existing record has been successfully deleted
AND The system creates a new train record
THEN:
- • A new train record is inserted with status 'SENT' and all required train information
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when new train record has been created.
Trigger Criteria:
- Context: A new train record has been created
- Applied to: Insert Equipment Details
- Action: The system processes equipment details for the train
Logic Flow:
IF A new train record has been created
AND The system processes equipment details for the train
THEN:
- • All equipment information is inserted and associated with the train record
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment details insertion has been attempted.
Trigger Criteria:
- Context: Equipment details insertion has been attempted
- Applied to: Insert Successful?
- Action: The system checks the insertion result
Logic Flow:
IF Equipment details insertion has been attempted
AND The system checks the insertion result
THEN:
- • The system confirms whether the equipment insertion was successful or failed
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when database operation has failed during train record processing.
Trigger Criteria:
- Context: A database operation has failed during train record processing
- Applied to: Handle Database Error
- Action: The system encounters the database error
Logic Flow:
IF A database operation has failed during train record processing
AND The system encounters the database error
THEN:
- • The system initiates error handling procedures to manage the failure
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when critical database error has occurred that cannot be recovered.
Trigger Criteria:
- Context: A critical database error has occurred that cannot be recovered
- Applied to: Log Error and Abort
- Action: The system processes the error condition
Logic Flow:
IF A critical database error has occurred that cannot be recovered
AND The system processes the error condition
THEN:
- • The error is logged and processing is aborted to prevent data corruption
R-GCX146-cbl-00113 (+14) File: GCX146.cbl Business Rule: Equipment Data Extraction
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when consist data contains equipment information with car id and position details.
Trigger Criteria:
- Context: Consist data contains equipment information with car ID and position details
- Applied to: Extract Equipment ID from Consist Data
- Action: Processing equipment data from consist input
Logic Flow:
IF Consist data contains equipment information with car ID and position details
AND Processing equipment data from consist input
THEN:
- • Equipment ID is extracted and stored for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when raw equipment id from consist data.
Trigger Criteria:
- Context: Raw equipment ID from consist data
- Applied to: Format Equipment Car ID
- Action: Equipment ID needs to be formatted for system use
Logic Flow:
IF Raw equipment ID from consist data
AND Equipment ID needs to be formatted for system use
THEN:
- • Equipment ID is formatted using GCCCARFM utility to 12-character standard format
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment data with type indicators and characteristics.
Trigger Criteria:
- Context: Equipment data with type indicators and characteristics
- Applied to: Determine Equipment Type
- Action: Equipment type needs to be determined
Logic Flow:
IF Equipment data with type indicators and characteristics
AND Equipment type needs to be determined
THEN:
- • Equipment is classified as Unit (L,P,D,U), Van (V), SBU (S), ETU (E), or regular car based on type code
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment identified as container type on flat car.
Trigger Criteria:
- Context: Equipment identified as container type on flat car
- Applied to: Container Equipment
- Action: Processing container equipment
Logic Flow:
IF Equipment identified as container type on flat car
AND Processing container equipment
THEN:
- • Container cross-reference data is processed through FWIQ inquiry and container IDs are extracted from waybill bottom lines
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment identified as trailer type.
Trigger Criteria:
- Context: Equipment identified as trailer type
- Applied to: Trailer Equipment
- Action: Processing trailer equipment
Logic Flow:
IF Equipment identified as trailer type
AND Processing trailer equipment
THEN:
- • Trailer is processed with standard equipment handling procedures
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment identified as standard rail car.
Trigger Criteria:
- Context: Equipment identified as standard rail car
- Applied to: Rail Car Equipment
- Action: Processing rail car equipment
Logic Flow:
IF Equipment identified as standard rail car
AND Processing rail car equipment
THEN:
- • Rail car is processed through standard equipment handling workflow
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when consist input data contains load/empty status indicator.
Trigger Criteria:
- Context: Consist input data contains load/empty status indicator
- Applied to: Extract Load/Empty Status from Input
- Action: Processing equipment status information
Logic Flow:
IF Consist input data contains load/empty status indicator
AND Processing equipment status information
THEN:
- • Load/empty status is extracted and stored as 'L' for loaded or 'E' for empty
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has load/empty status from input and waybill data is available.
Trigger Criteria:
- Context: Equipment has load/empty status from input and waybill data is available
- Applied to: Validate Load/Empty Status Against Waybill
- Action: Validating status consistency
Logic Flow:
IF Equipment has load/empty status from input and waybill data is available
AND Validating status consistency
THEN:
- • Status is verified against waybill data and inconsistencies are flagged for loaded cars marked as empty
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment status validation confirms loaded condition.
Trigger Criteria:
- Context: Equipment status validation confirms loaded condition
- Applied to: Set Load Status Flag
- Action: Status is consistent between input and waybill
Logic Flow:
IF Equipment status validation confirms loaded condition
AND Status is consistent between input and waybill
THEN:
- • Load status flag is set to indicate loaded equipment
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment status validation confirms empty condition or detects loaded car marked as empty.
Trigger Criteria:
- Context: Equipment status validation confirms empty condition or detects loaded car marked as empty
- Applied to: Set Empty Status Flag
- Action: Status inconsistency is detected or equipment is confirmed empty
Logic Flow:
IF Equipment status validation confirms empty condition or detects loaded car marked as empty
AND Status inconsistency is detected or equipment is confirmed empty
THEN:
- • Empty status flag is set to indicate empty equipment
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment has been classified and status determined.
Trigger Criteria:
- Context: Equipment has been classified and status determined
- Applied to: Process Equipment Segment
- Action: Processing equipment segment for train consist
Logic Flow:
IF Equipment has been classified and status determined
AND Processing equipment segment for train consist
THEN:
- • Equipment segment data is processed including waybill lookup, CCN validation, and status determination
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment data has been extracted, formatted, classified, and validated.
Trigger Criteria:
- Context: Equipment data has been extracted, formatted, classified, and validated
- Applied to: Build Equipment Record
- Action: Building final equipment record
Logic Flow:
IF Equipment data has been extracted, formatted, classified, and validated
AND Building final equipment record
THEN:
- • Complete equipment record is constructed with ID, type, status, waybill information, and validation results
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when complete equipment record has been built.
Trigger Criteria:
- Context: Complete equipment record has been built
- Applied to: Add to Equipment List
- Action: Adding equipment to train consist list
Logic Flow:
IF Complete equipment record has been built
AND Adding equipment to train consist list
THEN:
- • Equipment record is added to the equipment list and equipment counter is incremented
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when current equipment has been processed and added to equipment list.
Trigger Criteria:
- Context: Current equipment has been processed and added to equipment list
- Applied to: More Equipment in Consist?
- Action: Checking for additional equipment in consist
Logic Flow:
IF Current equipment has been processed and added to equipment list
AND Checking for additional equipment in consist
THEN:
- • If more equipment exists in consist, processing continues with next equipment item,
otherwise equipment extraction is completed
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all equipment in consist has been processed and added to equipment list.
Trigger Criteria:
- Context: All equipment in consist has been processed and added to equipment list
- Applied to: Equipment Extraction Complete
- Action: No more equipment remains in consist
Logic Flow:
IF All equipment in consist has been processed and added to equipment list
AND No more equipment remains in consist
THEN:
- • Equipment extraction process is completed and control returns to main processing flow
R-GCX146-cbl-00128 (+6) File: GCX146.cbl Business Rule: Waybill Lookup Processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment id is provided for waybill lookup.
Trigger Criteria:
- Context: An equipment ID is provided for waybill lookup
- Applied to: Primary Waybill Lookup
- Action: The system searches the primary waybill database (FWIIROOT) using the equipment ID
Logic Flow:
IF An equipment ID is provided for waybill lookup
AND The system searches the primary waybill database (FWIIROOT) using the equipment ID
THEN:
- • The system retrieves waybill data if found or proceeds to enhanced search if not found
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when primary waybill lookup has failed to find waybill data.
Trigger Criteria:
- Context: Primary waybill lookup has failed to find waybill data
- Applied to: Enhanced Waybill Search
- Action: The system searches the enhanced waybill database (SHIPROOT) using FWCARGET with multiple search criteria
Logic Flow:
IF Primary waybill lookup has failed to find waybill data
AND The system searches the enhanced waybill database (SHIPROOT) using FWCARGET with multiple search criteria
THEN:
- • The system retrieves waybill information if available or proceeds to inquiry database search
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when both primary and enhanced waybill searches have failed.
Trigger Criteria:
- Context: Both primary and enhanced waybill searches have failed
- Applied to: Inquiry Database Access
- Action: The system accesses the inquiry database (FW-IQ) for waybill information
Logic Flow:
IF Both primary and enhanced waybill searches have failed
AND The system accesses the inquiry database (FW-IQ) for waybill information
THEN:
- • The system searches for waybill data in the inquiry database or marks waybill as not found
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when waybill data has been found in any of the searched databases. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Waybill data has been found in any of the searched databases
- Applied to: Set WS-WAYBILL-FOUND Flag
- Action: The system processes the successful waybill lookup result
Logic Flow:
IF Waybill data has been found in any of the searched databases
AND The system processes the successful waybill lookup result
THEN:
- • The system sets the waybill found flag to indicate successful retrieval
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when all waybill database searches (primary, enhanced, and inquiry) have been exhausted. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: All waybill database searches (primary, enhanced, and inquiry) have been exhausted
- Applied to: Set WS-WAYBILL-NOT-FOUND Flag
- Action: No waybill data is found for the equipment ID in any database
Logic Flow:
IF All waybill database searches (primary, enhanced, and inquiry) have been exhausted
AND No waybill data is found for the equipment ID in any database
THEN:
- • The system sets the waybill not found flag to indicate unsuccessful retrieval
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill data has been successfully located in one of the databases.
Trigger Criteria:
- Context: Waybill data has been successfully located in one of the databases
- Applied to: Extract Waybill Information
- Action: The system processes the retrieved waybill record
Logic Flow:
IF Waybill data has been successfully located in one of the databases
AND The system processes the retrieved waybill record
THEN:
- • The system extracts relevant waybill information and prepares it for downstream processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment id requires waybill lookup.
Trigger Criteria:
- Context: Equipment ID requires waybill lookup
- Applied to: Search FWIIROOT using Equipment ID
- Action: The system initiates waybill search process
Logic Flow:
IF Equipment ID requires waybill lookup
AND The system initiates waybill search process
THEN:
- • The system searches databases in sequence: primary (FWIIROOT),
then enhanced (SHIPROOT),
then inquiry (FW-IQ) until waybill is found or all options exhausted
R-GCX146-cbl-00135 (+8) File: GCX146.cbl Business Rule: Equipment Type Classification
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment data with equipment id and type code is available. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Equipment data with equipment ID and type code is available
- Applied to: Call GCCCARTP Module for Type Classification
- Action: Equipment type classification is required
Logic Flow:
IF Equipment data with equipment ID and type code is available
AND Equipment type classification is required
THEN:
- • GCCCARTP module is called to classify equipment type and return classification results
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment has been classified as container type.
Trigger Criteria:
- Context: Equipment has been classified as container type
- Applied to: Container Type Processing
- Action: Container type processing is initiated
Logic Flow:
IF Equipment has been classified as container type
AND Container type processing is initiated
THEN:
- • Container-specific processing flags are set and container handling requirements are established
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has been classified as trailer type.
Trigger Criteria:
- Context: Equipment has been classified as trailer type
- Applied to: Trailer Type Processing
- Action: Trailer type processing is initiated
Logic Flow:
IF Equipment has been classified as trailer type
AND Trailer type processing is initiated
THEN:
- • Trailer-specific processing flags are set and trailer handling requirements are established
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment has been classified as car type.
Trigger Criteria:
- Context: Equipment has been classified as car type
- Applied to: Car Type Processing
- Action: Car type processing is initiated
Logic Flow:
IF Equipment has been classified as car type
AND Car type processing is initiated
THEN:
- • Car-specific processing flags are set and car handling requirements are established
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment is classified as container type. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Equipment is classified as container type
- Applied to: Check for Multiple Containers on Flat Car
- Action: System checks for multiple containers on the same flat car
Logic Flow:
IF Equipment is classified as container type
AND System checks for multiple containers on the same flat car
THEN:
- • If multiple containers are detected, WS-FLAT-CAR flag is set to indicate special flat car processing requirements
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment is classified as car type with a car type code.
Trigger Criteria:
- Context: Equipment is classified as car type with a car type code
- Applied to: Validate Car Type Code
- Action: Car type code validation is performed
Logic Flow:
IF Equipment is classified as car type with a car type code
AND Car type code validation is performed
THEN:
- • System verifies the car type code is valid and exists in the reference data
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid car type code has been confirmed.
Trigger Criteria:
- Context: Valid car type code has been confirmed
- Applied to: Get Car Type Description from VI Segment
- Action: Car type description is needed for processing or reporting
Logic Flow:
IF Valid car type code has been confirmed
AND Car type description is needed for processing or reporting
THEN:
- • System retrieves car type description from VI segment using the car type code
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment type has been classified and processing requirements determined.
Trigger Criteria:
- Context: Equipment type has been classified and processing requirements determined
- Applied to: Assign Type Code for Train Manifest
- Action: Train manifest requires equipment type code
Logic Flow:
IF Equipment type has been classified and processing requirements determined
AND Train manifest requires equipment type code
THEN:
- • System assigns the appropriate equipment type code based on the equipment classification for manifest reporting
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment type code has been assigned for train manifest.
Trigger Criteria:
- Context: Equipment type code has been assigned for train manifest
- Applied to: Set Load/Empty Processing Requirements
- Action: Load/empty status processing requirements need to be established
Logic Flow:
IF Equipment type code has been assigned for train manifest
AND Load/empty status processing requirements need to be established
THEN:
- • System sets appropriate processing requirements based on whether the equipment is loaded or empty
R-GCX146-cbl-00144 (+18) File: GCX146.cbl Business Rule: Load/Empty Status Processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment record requires load/empty status determination.
Trigger Criteria:
- Context: An equipment record requires load/empty status determination
- Applied to: Retrieve Equipment Waybill Data
- Action: The system processes the equipment for waybill data retrieval
Logic Flow:
IF An equipment record requires load/empty status determination
AND The system processes the equipment for waybill data retrieval
THEN:
- • The system attempts to locate waybill information using the equipment identifier and sets waybill availability flag accordingly
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment waybill data retrieval has been attempted.
Trigger Criteria:
- Context: Equipment waybill data retrieval has been attempted
- Applied to: Waybill Data Available?
- Action: The system checks if waybill data is available for the equipment
Logic Flow:
IF Equipment waybill data retrieval has been attempted
AND The system checks if waybill data is available for the equipment
THEN:
- • If waybill data exists, proceed with cargo analysis; if no waybill data exists, use default empty status processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when waybill data is available for equipment.
Trigger Criteria:
- Context: Waybill data is available for equipment
- Applied to: Analyze Cargo Origin Information
- Action: The system processes cargo origin information from the waybill
Logic Flow:
IF Waybill data is available for equipment
AND The system processes cargo origin information from the waybill
THEN:
- • The system extracts and analyzes origin station, shipper information, and cargo classification data for load status determination
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo origin information has been analyzed.
Trigger Criteria:
- Context: Cargo origin information has been analyzed
- Applied to: Analyze Cargo Destination Information
- Action: The system processes cargo destination information from the waybill
Logic Flow:
IF Cargo origin information has been analyzed
AND The system processes cargo destination information from the waybill
THEN:
- • The system extracts and analyzes destination station, consignee information, and delivery requirements for load status determination
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when cargo origin and destination information has been analyzed.
Trigger Criteria:
- Context: Cargo origin and destination information has been analyzed
- Applied to: Check Equipment Type Classification
- Action: The system checks the equipment type classification
Logic Flow:
IF Cargo origin and destination information has been analyzed
AND The system checks the equipment type classification
THEN:
- • The system categorizes equipment as container, trailer, or rail car type for specific processing rules
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment type classification check has been performed.
Trigger Criteria:
- Context: Equipment type classification check has been performed
- Applied to: Container Equipment?
- Action: The system evaluates if equipment is container type
Logic Flow:
IF Equipment type classification check has been performed
AND The system evaluates if equipment is container type
THEN:
- • If equipment is container type, proceed with container-specific load status determination;
otherwise check for trailer type
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment is not container type.
Trigger Criteria:
- Context: Equipment is not container type
- Applied to: Trailer Equipment?
- Action: The system evaluates if equipment is trailer type
Logic Flow:
IF Equipment is not container type
AND The system evaluates if equipment is trailer type
THEN:
- • If equipment is trailer type, proceed with trailer-specific load status determination;
otherwise treat as rail car equipment
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment is not container or trailer type.
Trigger Criteria:
- Context: Equipment is not container or trailer type
- Applied to: Rail Car Equipment?
- Action: The system evaluates if equipment is rail car type
Logic Flow:
IF Equipment is not container or trailer type
AND The system evaluates if equipment is rail car type
THEN:
- • If equipment is rail car type, proceed with rail car-specific load status determination
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment is identified as container type with available waybill data.
Trigger Criteria:
- Context: Equipment is identified as container type with available waybill data
- Applied to: Determine Container Load Status
- Action: The system processes container-specific load status determination
Logic Flow:
IF Equipment is identified as container type with available waybill data
AND The system processes container-specific load status determination
THEN:
- • The system analyzes container cargo content, weight information, and commodity details to determine if container is loaded or empty
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment is identified as trailer type with available waybill data.
Trigger Criteria:
- Context: Equipment is identified as trailer type with available waybill data
- Applied to: Determine Trailer Load Status
- Action: The system processes trailer-specific load status determination
Logic Flow:
IF Equipment is identified as trailer type with available waybill data
AND The system processes trailer-specific load status determination
THEN:
- • The system analyzes trailer cargo content, weight information, and commodity details to determine if trailer is loaded or empty
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment is identified as rail car type with available waybill data.
Trigger Criteria:
- Context: Equipment is identified as rail car type with available waybill data
- Applied to: Determine Rail Car Load Status
- Action: The system processes rail car-specific load status determination
Logic Flow:
IF Equipment is identified as rail car type with available waybill data
AND The system processes rail car-specific load status determination
THEN:
- • The system analyzes rail car cargo content, weight information, and commodity details to determine if rail car is loaded or empty
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when load/empty status has been determined for the equipment.
Trigger Criteria:
- Context: Load/empty status has been determined for the equipment
- Applied to: Validate Against Input Specifications
- Action: The system validates the determined status against input specifications
Logic Flow:
IF Load/empty status has been determined for the equipment
AND The system validates the determined status against input specifications
THEN:
- • The system compares the calculated load/empty status with the input-provided status for consistency verification
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when load/empty status validation has been performed.
Trigger Criteria:
- Context: Load/empty status validation has been performed
- Applied to: Status Matches Input?
- Action: The system checks if determined status matches input specifications
Logic Flow:
IF Load/empty status validation has been performed
AND The system checks if determined status matches input specifications
THEN:
- • If status matches input, set appropriate load flag; if status does not match, generate validation error and use empty status
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment status validation confirms loaded status.
Trigger Criteria:
- Context: Equipment status validation confirms loaded status
- Applied to: Set LOAD Flag
- Action: The system processes load flag assignment
Logic Flow:
IF Equipment status validation confirms loaded status
AND The system processes load flag assignment
THEN:
- • The system sets the load indicator flag to indicate equipment carries cargo
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment status validation confirms empty status or status validation error occurs or no waybill data available.
Trigger Criteria:
- Context: Equipment status validation confirms empty status OR status validation error occurs OR no waybill data available
- Applied to: Set EMPTY Flag
- Action: The system processes empty flag assignment
Logic Flow:
IF Equipment status validation confirms empty status OR status validation error occurs OR no waybill data available
AND The system processes empty flag assignment
THEN:
- • The system sets the empty indicator flag to indicate equipment does not carry cargo
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when either load flag or empty flag has been set.
Trigger Criteria:
- Context: Either load flag or empty flag has been set
- Applied to: Assign Load/Empty Status Indicator
- Action: The system processes status indicator assignment
Logic Flow:
IF Either load flag or empty flag has been set
AND The system processes status indicator assignment
THEN:
- • The system assigns the appropriate load/empty status indicator to the equipment record
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when load/empty status indicator has been assigned.
Trigger Criteria:
- Context: Load/empty status indicator has been assigned
- Applied to: Update Equipment Record Status
- Action: The system processes equipment record update
Logic Flow:
IF Load/empty status indicator has been assigned
AND The system processes equipment record update
THEN:
- • The system updates the equipment record with the final load/empty status for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when determined load/empty status does not match input specifications.
Trigger Criteria:
- Context: Determined load/empty status does not match input specifications
- Applied to: Generate Status Validation Error
- Action: The system processes status validation error
Logic Flow:
IF Determined load/empty status does not match input specifications
AND The system processes status validation error
THEN:
- • The system generates a status validation error and defaults to empty status processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when no waybill data is available for the equipment.
Trigger Criteria:
- Context: No waybill data is available for the equipment
- Applied to: Use Default Empty Status
- Action: The system processes default status assignment
Logic Flow:
IF No waybill data is available for the equipment
AND The system processes default status assignment
THEN:
- • The system assigns default empty status to the equipment and proceeds with empty flag processing
R-GCX146-cbl-00163 (+8) File: GCX146.cbl Business Rule: Commodity Code Processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment requires commodity code validation and waybill data sources are available.
Trigger Criteria:
- Context: Equipment requires commodity code validation and waybill data sources are available
- Applied to: Access Waybill Record
- Action: System attempts to access waybill record using equipment identifier
Logic Flow:
IF Equipment requires commodity code validation and waybill data sources are available
AND System attempts to access waybill record using equipment identifier
THEN:
- • System retrieves waybill data from FWIIROOT, SHIPROOT, or FW-IQ inquiry database in hierarchical order
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when system has attempted to access waybill record for equipment.
Trigger Criteria:
- Context: System has attempted to access waybill record for equipment
- Applied to: Waybill Data Available?
- Action: Waybill lookup is performed against available data sources
Logic Flow:
IF System has attempted to access waybill record for equipment
AND Waybill lookup is performed against available data sources
THEN:
- • System determines if valid waybill data is available for commodity processing or proceeds with default handling
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when valid waybill data is available for equipment.
Trigger Criteria:
- Context: Valid waybill data is available for equipment
- Applied to: Extract Commodity Code from Waybill
- Action: System processes waybill record for commodity information
Logic Flow:
IF Valid waybill data is available for equipment
AND System processes waybill record for commodity information
THEN:
- • System extracts commodity code from waybill data fields for validation processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when commodity code extraction has been attempted from waybill data.
Trigger Criteria:
- Context: Commodity code extraction has been attempted from waybill data
- Applied to: Commodity Code Present?
- Action: System evaluates extracted commodity code field
Logic Flow:
IF Commodity code extraction has been attempted from waybill data
AND System evaluates extracted commodity code field
THEN:
- • System determines if commodity code is present and not empty or proceeds with default commodity handling
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when commodity code is present in waybill data.
Trigger Criteria:
- Context: Commodity code is present in waybill data
- Applied to: Validate Commodity Code Format
- Action: System validates commodity code format against standard requirements
Logic Flow:
IF Commodity code is present in waybill data
AND System validates commodity code format against standard requirements
THEN:
- • System confirms commodity code format is valid or identifies format violations for error handling
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when commodity code has valid format structure.
Trigger Criteria:
- Context: Commodity code has valid format structure
- Applied to: Validate Against Commodity Standards
- Action: System checks commodity code against commodity standards and reference data
Logic Flow:
IF Commodity code has valid format structure
AND System checks commodity code against commodity standards and reference data
THEN:
- • System confirms commodity code is valid according to standards or identifies invalid commodity codes
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when commodity code has passed all validation checks.
Trigger Criteria:
- Context: Commodity code has passed all validation checks
- Applied to: Set Commodity Code for Processing
- Action: System processes validated commodity code
Logic Flow:
IF Commodity code has passed all validation checks
AND System processes validated commodity code
THEN:
- • System sets commodity code for equipment record and continues with processing workflow
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill data is unavailable or commodity code is not present in waybill.
Trigger Criteria:
- Context: Waybill data is unavailable OR commodity code is not present in waybill
- Applied to: Set Default/Empty Commodity Code
- Action: System cannot extract valid commodity code
Logic Flow:
IF Waybill data is unavailable OR commodity code is not present in waybill
AND System cannot extract valid commodity code
THEN:
- • System sets default or empty commodity code value and continues equipment processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when commodity code format validation fails or commodity standards validation fails.
Trigger Criteria:
- Context: Commodity code format validation fails OR commodity standards validation fails
- Applied to: Log Commodity Code Validation Error
- Action: System encounters commodity code validation errors
Logic Flow:
IF Commodity code format validation fails OR commodity standards validation fails
AND System encounters commodity code validation errors
THEN:
- • System logs commodity code validation error and continues with equipment processing using default handling
R-GCX146-cbl-00172 (+17) File: GCX146.cbl Business Rule: CCN Database Lookup
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when train manifest contains equipment records with equipment ids.
Trigger Criteria:
- Context: A train manifest contains equipment records with equipment IDs
- Applied to: Extract Equipment ID from Train Manifest
- Action: The system processes equipment for CCN lookup
Logic Flow:
IF A train manifest contains equipment records with equipment IDs
AND The system processes equipment for CCN lookup
THEN:
- • The equipment ID is extracted and prepared for database search key construction
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment id and waybill data are available.
Trigger Criteria:
- Context: Equipment ID and waybill data are available
- Applied to: Build CCN Search Key
- Action: The system needs to search for CCN records
Logic Flow:
IF Equipment ID and waybill data are available
AND The system needs to search for CCN records
THEN:
- • A properly formatted search key is constructed for database lookup
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when formatted ccn search key exists.
Trigger Criteria:
- Context: A formatted CCN search key exists
- Applied to: Search GCCCRT Database
- Action: The system performs database lookup in GCCCRT
Logic Flow:
IF A formatted CCN search key exists
AND The system performs database lookup in GCCCRT
THEN:
- • The database is searched for matching CCN records
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when database search has been performed for ccn records.
Trigger Criteria:
- Context: A database search has been performed for CCN records
- Applied to: CCN Record Found?
- Action: The system evaluates search results
Logic Flow:
IF A database search has been performed for CCN records
AND The system evaluates search results
THEN:
- • The system determines if a matching CCN record was found or not found
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn record exists for the equipment.
Trigger Criteria:
- Context: A CCN record exists for the equipment
- Applied to: Retrieve CCN Details
- Action: The system has located a matching CCN record
Logic Flow:
IF A CCN record exists for the equipment
AND The system has located a matching CCN record
THEN:
- • Complete CCN record details are retrieved from the database
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn record has been retrieved with equipment id and waybill information.
Trigger Criteria:
- Context: A CCN record has been retrieved with equipment ID and waybill information
- Applied to: Check CCN Usability Flag
- Action: The system validates CCN usability
Logic Flow:
IF A CCN record has been retrieved with equipment ID and waybill information
AND The system validates CCN usability
THEN:
- • The CCN is determined usable if equipment ID matches and either waybill number matches or new bond created flag is set to 'Y'
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn usability validation has been performed.
Trigger Criteria:
- Context: CCN usability validation has been performed
- Applied to: CCN Usable?
- Action: The system evaluates usability results
Logic Flow:
IF CCN usability validation has been performed
AND The system evaluates usability results
THEN:
- • The CCN is classified as either usable or unusable for processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when usable ccn record exists with a current status.
Trigger Criteria:
- Context: A usable CCN record exists with a current status
- Applied to: Validate CCN Status
- Action: The system validates CCN status
Logic Flow:
IF A usable CCN record exists with a current status
AND The system validates CCN status
THEN:
- • The CCN status must be one of: 'SENT', 'RETURN', 'MANUAL', 'RELEASE', 'ACK', or 'CSA-DLV' to be considered valid
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn status validation has been performed.
Trigger Criteria:
- Context: CCN status validation has been performed
- Applied to: Status Valid?
- Action: The system evaluates status validation results
Logic Flow:
IF CCN status validation has been performed
AND The system evaluates status validation results
THEN:
- • The CCN status is classified as either valid or invalid for business processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn record with valid status exists.
Trigger Criteria:
- Context: A CCN record with valid status exists
- Applied to: Extract CCN Information
- Action: The system processes the CCN record
Logic Flow:
IF A CCN record with valid status exists
AND The system processes the CCN record
THEN:
- • Relevant CCN information is extracted and prepared for equipment record integration
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn information has been successfully extracted.
Trigger Criteria:
- Context: CCN information has been successfully extracted
- Applied to: Set CCN Found Flag
- Action: The system updates processing status
Logic Flow:
IF CCN information has been successfully extracted
AND The system updates processing status
THEN:
- • The CCN found flag is set to indicate successful CCN lookup
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when valid ccn information exists and ccn found flag is set.
Trigger Criteria:
- Context: Valid CCN information exists and CCN found flag is set
- Applied to: Add CCN to Equipment Record
- Action: The system updates equipment records
Logic Flow:
IF Valid CCN information exists and CCN found flag is set
AND The system updates equipment records
THEN:
- • CCN information is added to the equipment record for customs processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn has been successfully added to equipment record.
Trigger Criteria:
- Context: CCN has been successfully added to equipment record
- Applied to: CCN Lookup Complete
- Action: The CCN lookup process concludes
Logic Flow:
IF CCN has been successfully added to equipment record
AND The CCN lookup process concludes
THEN:
- • The CCN lookup is marked as complete and processing continues
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when database search returned no matching ccn records.
Trigger Criteria:
- Context: Database search returned no matching CCN records
- Applied to: Set CCN Not Found Flag
- Action: The system processes the no-match condition
Logic Flow:
IF Database search returned no matching CCN records
AND The system processes the no-match condition
THEN:
- • The CCN not found flag is set to indicate absence of CCN record
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn not found flag has been set.
Trigger Criteria:
- Context: CCN not found flag has been set
- Applied to: CCN Not Found
- Action: The system updates status messaging
Logic Flow:
IF CCN not found flag has been set
AND The system updates status messaging
THEN:
- • A status message indicating 'CCN Not Found' is added to the equipment processing record
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn record exists but fails usability validation or has invalid status.
Trigger Criteria:
- Context: A CCN record exists but fails usability validation or has invalid status
- Applied to: Set CCN Unusable Flag
- Action: The system processes the unusable condition
Logic Flow:
IF A CCN record exists but fails usability validation or has invalid status
AND The system processes the unusable condition
THEN:
- • The CCN unusable flag is set to indicate the CCN cannot be used for processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn unusable flag has been set.
Trigger Criteria:
- Context: CCN unusable flag has been set
- Applied to: CCN Found Not Usable
- Action: The system updates status messaging
Logic Flow:
IF CCN unusable flag has been set
AND The system updates status messaging
THEN:
- • A status message indicating 'CCN Found Not Usable' is added to the equipment processing record
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn lookup process has completed with any outcome (found, not found, or unusable).
Trigger Criteria:
- Context: CCN lookup process has completed with any outcome (found, not found, or unusable)
- Applied to: Continue Processing
- Action: The system proceeds with equipment processing
Logic Flow:
IF CCN lookup process has completed with any outcome (found, not found, or unusable)
AND The system proceeds with equipment processing
THEN:
- • Equipment processing continues with appropriate CCN status and messaging
R-GCX146-cbl-00190 (+20) File: GCX146.cbl Business Rule: CCN Status Validation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn number needs to be validated for processing.
Trigger Criteria:
- Context: A CCN number needs to be validated for processing
- Applied to: Retrieve CCN Record from Database
- Action: The system attempts to retrieve the CCN record from the GCCCRT database
Logic Flow:
IF A CCN number needs to be validated for processing
AND The system attempts to retrieve the CCN record from the GCCCRT database
THEN:
- • The CCN record is retrieved if it exists in the database
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn lookup has been performed in the database.
Trigger Criteria:
- Context: A CCN lookup has been performed in the database
- Applied to: CCN Record Found?
- Action: The system checks if a CCN record was found
Logic Flow:
IF A CCN lookup has been performed in the database
AND The system checks if a CCN record was found
THEN:
- • If no CCN record is found, the CCN is marked as unusable and validation stops
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn record exists in the database.
Trigger Criteria:
- Context: A CCN record exists in the database
- Applied to: Check CCN Usability Flag
- Action: The system evaluates the CCN usability flag
Logic Flow:
IF A CCN record exists in the database
AND The system evaluates the CCN usability flag
THEN:
- • The usability status is determined based on the flag value
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn record is being evaluated for usability.
Trigger Criteria:
- Context: A CCN record is being evaluated for usability
- Applied to: Bond Created Flag = 'Y'?
- Action: The bond created flag equals 'Y'
Logic Flow:
IF A CCN record is being evaluated for usability
AND The bond created flag equals 'Y'
THEN:
- • The CCN is marked as unusable and cannot be processed further
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn fails validation criteria (record not found or bond created flag is 'y').
Trigger Criteria:
- Context: A CCN fails validation criteria (record not found or bond created flag is 'Y')
- Applied to: CCN Marked as Unusable
- Action: The system determines the CCN cannot be processed
Logic Flow:
IF A CCN fails validation criteria (record not found or bond created flag is 'Y')
AND The system determines the CCN cannot be processed
THEN:
- • The CCN is marked as unusable for customs processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn is determined to be usable for processing.
Trigger Criteria:
- Context: A CCN is determined to be usable for processing
- Applied to: Check Current CCN Status
- Action: The system checks the current CCN status
Logic Flow:
IF A CCN is determined to be usable for processing
AND The system checks the current CCN status
THEN:
- • The current status is evaluated to determine the appropriate status mapping
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn has a current status that needs evaluation.
Trigger Criteria:
- Context: A CCN has a current status that needs evaluation
- Applied to: Status = RELEASE?
- Action: The CCN status equals 'RELEASE'
Logic Flow:
IF A CCN has a current status that needs evaluation
AND The CCN status equals 'RELEASE'
THEN:
- • The system proceeds to check transit status for further status refinement
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn has release status.
Trigger Criteria:
- Context: A CCN has RELEASE status
- Applied to: Check Transit Status
- Action: The system checks the transit status
Logic Flow:
IF A CCN has RELEASE status
AND The system checks the transit status
THEN:
- • The transit status is evaluated to determine the appropriate final status
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn has release status and transit status is being evaluated.
Trigger Criteria:
- Context: A CCN has RELEASE status and transit status is being evaluated
- Applied to: Transit Status = E or Z?
- Action: The transit status equals 'E' or 'Z'
Logic Flow:
IF A CCN has RELEASE status and transit status is being evaluated
AND The transit status equals 'E' or 'Z'
THEN:
- • The CCN status is set to 'EXPORT'
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn has release status and transit status of 'e' or 'z'.
Trigger Criteria:
- Context: A CCN has RELEASE status and transit status of 'E' or 'Z'
- Applied to: Set Status to EXPORT
- Action: The system determines export status mapping is required
Logic Flow:
IF A CCN has RELEASE status and transit status of 'E' or 'Z'
AND The system determines export status mapping is required
THEN:
- • The CCN status is set to 'EXPORT'
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn has release status and transit status is not 'e' or 'z'.
Trigger Criteria:
- Context: A CCN has RELEASE status and transit status is not 'E' or 'Z'
- Applied to: Transit Status = S.A.R.?
- Action: The transit status equals 'S.A.R.'
Logic Flow:
IF A CCN has RELEASE status and transit status is not 'E' or 'Z'
AND The transit status equals 'S.A.R.'
THEN:
- • The CCN status is set to 'S.A.R.'
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn has release status and transit status of 's.a.r.'.
Trigger Criteria:
- Context: A CCN has RELEASE status and transit status of 'S.A.R.'
- Applied to: Set Status to S.A.R.
- Action: The system determines SAR status mapping is required
Logic Flow:
IF A CCN has RELEASE status and transit status of 'S.A.R.'
AND The system determines SAR status mapping is required
THEN:
- • The CCN status is set to 'S.A.R.'
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn has release status and transit status is not 'e', 'z', or 's.a.r.'.
Trigger Criteria:
- Context: A CCN has RELEASE status and transit status is not 'E', 'Z', or 'S.A.R.'
- Applied to: Keep Status as RELEASE
- Action: No special status mapping is required
Logic Flow:
IF A CCN has RELEASE status and transit status is not 'E', 'Z', or 'S.A.R.'
AND No special status mapping is required
THEN:
- • The CCN status remains as 'RELEASE'
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn does not have release status.
Trigger Criteria:
- Context: A CCN does not have RELEASE status
- Applied to: Transit Status = T?
- Action: The transit status equals 'T'
Logic Flow:
IF A CCN does not have RELEASE status
AND The transit status equals 'T'
THEN:
- • The CCN status is set to 'TRANSIT'
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn has transit status 't'.
Trigger Criteria:
- Context: A CCN has transit status 'T'
- Applied to: Set Status to TRANSIT
- Action: The system determines transit status mapping is required
Logic Flow:
IF A CCN has transit status 'T'
AND The system determines transit status mapping is required
THEN:
- • The CCN status is set to 'TRANSIT'
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn does not have release status and transit status is not 't'.
Trigger Criteria:
- Context: A CCN does not have RELEASE status and transit status is not 'T'
- Applied to: Transit Status = R?
- Action: The transit status equals 'R'
Logic Flow:
IF A CCN does not have RELEASE status and transit status is not 'T'
AND The transit status equals 'R'
THEN:
- • The CCN status is set to 'RETURN'
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn has transit status 'r'.
Trigger Criteria:
- Context: A CCN has transit status 'R'
- Applied to: Set Status to RETURN
- Action: The system determines return status mapping is required
Logic Flow:
IF A CCN has transit status 'R'
AND The system determines return status mapping is required
THEN:
- • The CCN status is set to 'RETURN'
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn does not match any specific status mapping criteria.
Trigger Criteria:
- Context: A CCN does not match any specific status mapping criteria
- Applied to: Keep Current Status
- Action: No status transformation is required
Logic Flow:
IF A CCN does not match any specific status mapping criteria
AND No status transformation is required
THEN:
- • The CCN retains its current status
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn has been processed through status validation logic.
Trigger Criteria:
- Context: A CCN has been processed through status validation logic
- Applied to: CCN Status Validated
- Action: Status mapping is complete
Logic Flow:
IF A CCN has been processed through status validation logic
AND Status mapping is complete
THEN:
- • The CCN has a validated status for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn has been marked as unusable.
Trigger Criteria:
- Context: A CCN has been marked as unusable
- Applied to: Add Unusable Status Message
- Action: The system needs to communicate the unusable status
Logic Flow:
IF A CCN has been marked as unusable
AND The system needs to communicate the unusable status
THEN:
- • An unusable status message is added to the processing results
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn has been processed through all validation steps.
Trigger Criteria:
- Context: A CCN has been processed through all validation steps
- Applied to: CCN Status Validation Complete
- Action: All validation logic has been executed
Logic Flow:
IF A CCN has been processed through all validation steps
AND All validation logic has been executed
THEN:
- • The CCN status validation process is complete
R-GCX146-cbl-00211 (+10) File: GCX146.cbl Business Rule: Train Assignment Validation
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn key exists for equipment being processed.
Trigger Criteria:
- Context: A CCN key exists for equipment being processed
- Applied to: Retrieve CCN Record from Database
- Action: The system attempts to retrieve the CCN record from the GCCCRT database
Logic Flow:
IF A CCN key exists for equipment being processed
AND The system attempts to retrieve the CCN record from the GCCCRT database
THEN:
- • The CCN record is successfully retrieved or marked as not found for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn retrieval operation has been performed.
Trigger Criteria:
- Context: A CCN retrieval operation has been performed
- Applied to: CCN Record Found?
- Action: The system checks if a CCN record was found in the database
Logic Flow:
IF A CCN retrieval operation has been performed
AND The system checks if a CCN record was found in the database
THEN:
- • If no CCN record exists, the validation process ends; if CCN record exists, proceed to check current train assignment
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when valid ccn record exists in the database.
Trigger Criteria:
- Context: A valid CCN record exists in the database
- Applied to: Check Current Train Assignment
- Action: The system checks the current train assignment field in the CCN record
Logic Flow:
IF A valid CCN record exists in the database
AND The system checks the current train assignment field in the CCN record
THEN:
- • The system identifies whether the CCN is currently assigned to any train and retrieves the train identification
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn record has a current train assignment.
Trigger Criteria:
- Context: A CCN record has a current train assignment
- Applied to: CCN Already Assigned to Different Train?
- Action: The system compares the existing train assignment with the current train being processed
Logic Flow:
IF A CCN record has a current train assignment
AND The system compares the existing train assignment with the current train being processed
THEN:
- • If the CCN is assigned to a different train, proceed to validate assignment conflict; if not assigned to a different train, check CCN transit status
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn record exists and is not assigned to a different train.
Trigger Criteria:
- Context: A CCN record exists and is not assigned to a different train
- Applied to: Check CCN Transit Status
- Action: The system examines the transit status field of the CCN
Logic Flow:
IF A CCN record exists and is not assigned to a different train
AND The system examines the transit status field of the CCN
THEN:
- • The system determines if the CCN has transit status 'T' and proceeds accordingly
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn record has been checked for transit status.
Trigger Criteria:
- Context: A CCN record has been checked for transit status
- Applied to: CCN in Transit Status 'T'?
- Action: The CCN has transit status 'T'
Logic Flow:
IF A CCN record has been checked for transit status
AND The CCN has transit status 'T'
THEN:
- • Proceed to validate assignment conflict;
otherwise set CCN assignment status
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn is either assigned to a different train or has transit status 't'.
Trigger Criteria:
- Context: A CCN is either assigned to a different train or has transit status 'T'
- Applied to: Validate Assignment Conflict
- Action: The system evaluates the combination of train assignment and transit status
Logic Flow:
IF A CCN is either assigned to a different train or has transit status 'T'
AND The system evaluates the combination of train assignment and transit status
THEN:
- • Determine if a business rule violation exists that prevents the assignment
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when assignment conflict validation has been performed.
Trigger Criteria:
- Context: Assignment conflict validation has been performed
- Applied to: Assignment Conflict Exists?
- Action: The system evaluates whether a legitimate conflict exists
Logic Flow:
IF Assignment conflict validation has been performed
AND The system evaluates whether a legitimate conflict exists
THEN:
- • If conflict exists, generate assignment conflict error;
otherwise set CCN assignment status and allow assignment
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when legitimate assignment conflict has been identified.
Trigger Criteria:
- Context: A legitimate assignment conflict has been identified
- Applied to: Generate Assignment Conflict Error
- Action: The CCN cannot be assigned to the current train due to existing assignments
Logic Flow:
IF A legitimate assignment conflict has been identified
AND The CCN cannot be assigned to the current train due to existing assignments
THEN:
- • Generate error 13 indicating the car is already on another train and terminate the validation process
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when no assignment conflicts have been detected for the ccn.
Trigger Criteria:
- Context: No assignment conflicts have been detected for the CCN
- Applied to: Set CCN Assignment Status
- Action: The CCN is eligible for assignment to the current train
Logic Flow:
IF No assignment conflicts have been detected for the CCN
AND The CCN is eligible for assignment to the current train
THEN:
- • Update the CCN record with the current train assignment information
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn assignment status has been successfully updated.
Trigger Criteria:
- Context: CCN assignment status has been successfully updated
- Applied to: Allow CCN Assignment to Current Train
- Action: All validation checks have passed without conflicts
Logic Flow:
IF CCN assignment status has been successfully updated
AND All validation checks have passed without conflicts
THEN:
- • Allow the CCN to be assigned to the current train and proceed with normal processing
R-GCX146-cbl-00222 (+3) File: GCX146.cbl Business Rule: Ocean vs Rail Manifest Detection
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo manifest with manifest type code.
Trigger Criteria:
- Context: A cargo manifest with manifest type code
- Applied to: Ocean vs Rail Manifest Detection - Identify and validate manifest types
- Action: The manifest type code equals '9' (ocean manifest)
Logic Flow:
IF A cargo manifest with manifest type code
AND The manifest type code equals '9' (ocean manifest)
THEN:
- • The system sets ocean manifest flag to true and tracks ocean manifest presence
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo manifest with manifest type code.
Trigger Criteria:
- Context: A cargo manifest with manifest type code
- Applied to: Ocean vs Rail Manifest Detection - Identify and validate manifest types
- Action: The manifest type code equals '6' (rail manifest)
Logic Flow:
IF A cargo manifest with manifest type code
AND The manifest type code equals '6' (rail manifest)
THEN:
- • The system sets rail manifest flag to true and processes as rail cargo
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when processing has completed for all equipment on a train and ocean manifest flag is set to true and rail manifest flag is set to false.
Trigger Criteria:
- Context: Processing has completed for all equipment on a train AND ocean manifest flag is set to true AND rail manifest flag is set to false
- Applied to: Ocean vs Rail Manifest Detection - Identify and validate manifest types
- Action: The validation check for manifest completeness is performed
Logic Flow:
IF Processing has completed for all equipment on a train AND ocean manifest flag is set to true AND rail manifest flag is set to false
AND The validation check for manifest completeness is performed
THEN:
- • The system generates error 39 indicating ocean manifest without corresponding rail manifest
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when new train processing session is starting.
Trigger Criteria:
- Context: A new train processing session is starting
- Applied to: Ocean vs Rail Manifest Detection - Identify and validate manifest types
- Action: The system begins processing equipment for manifest type detection
Logic Flow:
IF A new train processing session is starting
AND The system begins processing equipment for manifest type detection
THEN:
- • The system sets both ocean manifest flag and rail manifest flag to false as initial state
R-GCX146-cbl-00226 (+17) File: GCX146.cbl Business Rule: Container Processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when flat car equipment record is being processed.
Trigger Criteria:
- Context: A flat car equipment record is being processed
- Applied to: Access Flat Car Container Records
- Action: The system needs to identify containers on the flat car
Logic Flow:
IF A flat car equipment record is being processed
AND The system needs to identify containers on the flat car
THEN:
- • Container records are accessed from the flat car container database using the equipment ID
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when container record lookup has been performed for a flat car.
Trigger Criteria:
- Context: Container record lookup has been performed for a flat car
- Applied to: Container Records Found?
- Action: The system evaluates the lookup results
Logic Flow:
IF Container record lookup has been performed for a flat car
AND The system evaluates the lookup results
THEN:
- • Processing continues with container handling if records are found,
otherwise container processing is skipped
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when container records have been found for a flat car.
Trigger Criteria:
- Context: Container records have been found for a flat car
- Applied to: Set Flat Car Processing Flag
- Action: The system begins container processing
Logic Flow:
IF Container records have been found for a flat car
AND The system begins container processing
THEN:
- • A flat car processing flag is set to track the processing state
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when flat car container records are available.
Trigger Criteria:
- Context: Flat car container records are available
- Applied to: Extract Container IDs from T/C XREF
- Action: The system processes the cross-reference data
Logic Flow:
IF Flat car container records are available
AND The system processes the cross-reference data
THEN:
- • Individual container IDs are extracted from the T/C XREF records for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when container ids have been extracted from cross-reference records.
Trigger Criteria:
- Context: Container IDs have been extracted from cross-reference records
- Applied to: Process First Container
- Action: The system starts individual container processing
Logic Flow:
IF Container IDs have been extracted from cross-reference records
AND The system starts individual container processing
THEN:
- • The first container in the sequence is selected for processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container is being processed.
Trigger Criteria:
- Context: A container is being processed
- Applied to: Validate Container CCN
- Action: The system checks for CCN validity
Logic Flow:
IF A container is being processed
AND The system checks for CCN validity
THEN:
- • The container CCN is validated against customs database records
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when container ccn validation has been performed.
Trigger Criteria:
- Context: Container CCN validation has been performed
- Applied to: CCN Valid?
- Action: The system evaluates the validation results
Logic Flow:
IF Container CCN validation has been performed
AND The system evaluates the validation results
THEN:
- • Processing continues with waybill data if CCN is valid,
otherwise inquiry database lookup is performed
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when container has a valid ccn.
Trigger Criteria:
- Context: A container has a valid CCN
- Applied to: Process Container Waybill Data
- Action: The system processes container details
Logic Flow:
IF A container has a valid CCN
AND The system processes container details
THEN:
- • Waybill data is retrieved and processed for the container
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container waybill data has been processed.
Trigger Criteria:
- Context: Container waybill data has been processed
- Applied to: Set Container Load/Empty Status
- Action: The system evaluates container contents
Logic Flow:
IF Container waybill data has been processed
AND The system evaluates container contents
THEN:
- • Container status is set as either loaded or empty based on waybill information
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when one container has been processed on a flat car.
Trigger Criteria:
- Context: One container has been processed on a flat car
- Applied to: More Containers on Flat Car?
- Action: The system checks for additional containers
Logic Flow:
IF One container has been processed on a flat car
AND The system checks for additional containers
THEN:
- • Processing continues with next container if more exist,
otherwise totals are updated
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when multiple containers exist on a flat car.
Trigger Criteria:
- Context: Multiple containers exist on a flat car
- Applied to: Get Next Container in Sequence
- Action: The system needs to process the next container
Logic Flow:
IF Multiple containers exist on a flat car
AND The system needs to process the next container
THEN:
- • The next container in sequence is retrieved for processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when subsequent container has been retrieved.
Trigger Criteria:
- Context: A subsequent container has been retrieved
- Applied to: Process Additional Container
- Action: The system processes the additional container
Logic Flow:
IF A subsequent container has been retrieved
AND The system processes the additional container
THEN:
- • The container undergoes the same validation and processing as the first container
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when all containers on a flat car have been processed.
Trigger Criteria:
- Context: All containers on a flat car have been processed
- Applied to: Update Container Totals
- Action: The system finalizes container processing
Logic Flow:
IF All containers on a flat car have been processed
AND The system finalizes container processing
THEN:
- • Container totals are updated to reflect all processed containers
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when all containers have been processed and totals updated.
Trigger Criteria:
- Context: All containers have been processed and totals updated
- Applied to: Complete Flat Car Processing
- Action: The system finalizes flat car processing
Logic Flow:
IF All containers have been processed and totals updated
AND The system finalizes flat car processing
THEN:
- • Flat car processing is marked as complete
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container ccn is not valid in the primary system.
Trigger Criteria:
- Context: A container CCN is not valid in the primary system
- Applied to: Container Inquiry Database Lookup
- Action: The system needs alternative container data
Logic Flow:
IF A container CCN is not valid in the primary system
AND The system needs alternative container data
THEN:
- • Container inquiry database is accessed for additional information
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when inquiry database lookup has been performed.
Trigger Criteria:
- Context: Inquiry database lookup has been performed
- Applied to: Inquiry Data Found?
- Action: The system evaluates lookup results
Logic Flow:
IF Inquiry database lookup has been performed
AND The system evaluates lookup results
THEN:
- • Primary container data is used if found,
otherwise container is marked as not found
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when container data has been found in inquiry database.
Trigger Criteria:
- Context: Container data has been found in inquiry database
- Applied to: Use Primary Container Data
- Action: The system processes the container information
Logic Flow:
IF Container data has been found in inquiry database
AND The system processes the container information
THEN:
- • Primary container data from inquiry database is used for processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when no container data is found in either primary or inquiry databases.
Trigger Criteria:
- Context: No container data is found in either primary or inquiry databases
- Applied to: Mark Container as Not Found
- Action: The system cannot locate container information
Logic Flow:
IF No container data is found in either primary or inquiry databases
AND The system cannot locate container information
THEN:
- • Container is marked as not found and processing continues
R-GCX146-cbl-00244 (+10) File: GCX146.cbl Business Rule: Empty/Exempted Equipment Processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment is being processed for customs validation.
Trigger Criteria:
- Context: Equipment is being processed for customs validation
- Applied to: Check Load/Empty Status
- Action: The equipment load/empty indicator is 'E' (Empty)
Logic Flow:
IF Equipment is being processed for customs validation
AND The equipment load/empty indicator is 'E' (Empty)
THEN:
- • The equipment is classified as empty and flagged to skip CCN validation requirements
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment is not classified as empty and requires type validation.
Trigger Criteria:
- Context: Equipment is not classified as empty and requires type validation
- Applied to: Check Equipment Type Code
- Action: The equipment type code indicates idler equipment (specific type codes for non-revenue equipment)
Logic Flow:
IF Equipment is not classified as empty and requires type validation
AND The equipment type code indicates idler equipment (specific type codes for non-revenue equipment)
THEN:
- • The equipment is classified as idler equipment and marked for exemption from CCN validation
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment is not empty and not idler equipment.
Trigger Criteria:
- Context: Equipment is not empty and not idler equipment
- Applied to: Check Exemption Rules
- Action: The equipment meets specific exemption criteria (certain car types, special handling codes, or regulatory exemptions)
Logic Flow:
IF Equipment is not empty and not idler equipment
AND The equipment meets specific exemption criteria (certain car types, special handling codes, or regulatory exemptions)
THEN:
- • The equipment is marked as exempted from CCN validation requirements
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment has been determined to be empty based on load/empty indicator.
Trigger Criteria:
- Context: Equipment has been determined to be empty based on load/empty indicator
- Applied to: Set Empty Equipment Flag
- Action: The empty classification is confirmed
Logic Flow:
IF Equipment has been determined to be empty based on load/empty indicator
AND The empty classification is confirmed
THEN:
- • The empty equipment flag is set to indicate this equipment should skip CCN validation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment has been determined to be idler equipment based on equipment type code.
Trigger Criteria:
- Context: Equipment has been determined to be idler equipment based on equipment type code
- Applied to: Set Idler Equipment Flag
- Action: The idler classification is confirmed
Logic Flow:
IF Equipment has been determined to be idler equipment based on equipment type code
AND The idler classification is confirmed
THEN:
- • The idler equipment flag is set to indicate this equipment should skip CCN validation
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has been determined to qualify for ccn exemption based on exemption rules.
Trigger Criteria:
- Context: Equipment has been determined to qualify for CCN exemption based on exemption rules
- Applied to: Set Exempted Equipment Flag
- Action: The exemption qualification is confirmed
Logic Flow:
IF Equipment has been determined to qualify for CCN exemption based on exemption rules
AND The exemption qualification is confirmed
THEN:
- • The exempted equipment flag is set to indicate this equipment should skip CCN validation
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has been flagged as empty, idler, or exempted from ccn requirements.
Trigger Criteria:
- Context: Equipment has been flagged as empty, idler, or exempted from CCN requirements
- Applied to: Skip CCN Validation
- Action: The equipment processing continues
Logic Flow:
IF Equipment has been flagged as empty, idler, or exempted from CCN requirements
AND The equipment processing continues
THEN:
- • CCN validation steps are bypassed and the equipment proceeds to manifest generation without CCN checks
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has been processed and classified as empty, idler, or exempted.
Trigger Criteria:
- Context: Equipment has been processed and classified as empty, idler, or exempted
- Applied to: Update Equipment Status Totals
- Action: The equipment processing is complete
Logic Flow:
IF Equipment has been processed and classified as empty, idler, or exempted
AND The equipment processing is complete
THEN:
- • The appropriate equipment status totals are incremented (total equipment count, empty count, exempted count) for reporting purposes
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has been processed and flagged to skip ccn validation.
Trigger Criteria:
- Context: Equipment has been processed and flagged to skip CCN validation
- Applied to: Generate Equipment Record for Manifest
- Action: Manifest generation is required
Logic Flow:
IF Equipment has been processed and flagged to skip CCN validation
AND Manifest generation is required
THEN:
- • A manifest record is created for the equipment with appropriate status indicators showing it as empty, idler, or exempted
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment has been classified and processed without ccn validation.
Trigger Criteria:
- Context: Equipment has been classified and processed without CCN validation
- Applied to: Set Equipment Type Message
- Action: Status reporting is required
Logic Flow:
IF Equipment has been classified and processed without CCN validation
AND Status reporting is required
THEN:
- • The appropriate equipment type message is set (EMPTY, IDLER, or EXEMPTED) for display in reports and status inquiries
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment has been processed and classified as not requiring ccn validation.
Trigger Criteria:
- Context: Equipment has been processed and classified as not requiring CCN validation
- Applied to: Add to Trip Sheet without CCN
- Action: Trip sheet generation is performed
Logic Flow:
IF Equipment has been processed and classified as not requiring CCN validation
AND Trip sheet generation is performed
THEN:
- • The equipment is added to the trip sheet with appropriate status indicators but without CCN information
R-GCX146-cbl-00255 (+9) File: GCX146.cbl Business Rule: Equipment Status Totals Compilation
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when verify operation is being performed on a train.
Trigger Criteria:
- Context: A VERIFY operation is being performed on a train
- Applied to: Initialize Status Counters
- Action: The equipment status totals compilation process begins
Logic Flow:
IF A VERIFY operation is being performed on a train
AND The equipment status totals compilation process begins
THEN:
- • All status counters (TOTAL-EQUIP, TOTAL-RELEASE, TOTAL-HAULAGE, TOTAL-HELD-CCRA, TOTAL-PROCEED, TOTAL-HELD-DOCS, TOTAL-DOCS-NR) are set to zero
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment status totals are being compiled for a train.
Trigger Criteria:
- Context: Equipment status totals are being compiled for a train
- Applied to: Equipment Record Available?
- Action: The system checks for the next equipment record
Logic Flow:
IF Equipment status totals are being compiled for a train
AND The system checks for the next equipment record
THEN:
- • If equipment records exist, continue processing;
otherwise proceed to generate totals summary
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment record is being processed for status totals.
Trigger Criteria:
- Context: An equipment record is being processed for status totals
- Applied to: Increment TOTAL-RELEASE Counter
- Action: The equipment has CCN status of 'RELEASE' or 'CSA-DLV'
Logic Flow:
IF An equipment record is being processed for status totals
AND The equipment has CCN status of 'RELEASE' or 'CSA-DLV'
THEN:
- • The TOTAL-RELEASE counter is incremented by one
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment record is being processed for status totals.
Trigger Criteria:
- Context: An equipment record is being processed for status totals
- Applied to: Increment TOTAL-HAULAGE Counter
- Action: The equipment has haulage flag set to 'Y' or manual haulage flag set to 'Y'
Logic Flow:
IF An equipment record is being processed for status totals
AND The equipment has haulage flag set to 'Y' or manual haulage flag set to 'Y'
THEN:
- • The TOTAL-HAULAGE counter is incremented by one
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment record is being processed for status totals.
Trigger Criteria:
- Context: An equipment record is being processed for status totals
- Applied to: Increment TOTAL-HELD-CCRA Counter
- Action: The equipment has CCN status of 'HOLD' or 'AGI-HOLD'
Logic Flow:
IF An equipment record is being processed for status totals
AND The equipment has CCN status of 'HOLD' or 'AGI-HOLD'
THEN:
- • The TOTAL-HELD-CCRA counter is incremented by one
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment record is being processed for status totals.
Trigger Criteria:
- Context: An equipment record is being processed for status totals
- Applied to: Increment TOTAL-PROCEED Counter
- Action: The equipment has CCN status of 'RETURN' or the manifest from station differs from the manifest to station and the status is not error, reject, or deleted
Logic Flow:
IF An equipment record is being processed for status totals
AND The equipment has CCN status of 'RETURN' or the manifest from station differs from the manifest to station and the status is not error, reject, or deleted
THEN:
- • The TOTAL-PROCEED counter is incremented by one
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment record is being processed for status totals.
Trigger Criteria:
- Context: An equipment record is being processed for status totals
- Applied to: Increment TOTAL-HELD-DOCS Counter
- Action: The equipment's manifest from station equals the manifest to station and the broker entry field is empty
Logic Flow:
IF An equipment record is being processed for status totals
AND The equipment's manifest from station equals the manifest to station and the broker entry field is empty
THEN:
- • The TOTAL-HELD-DOCS counter is incremented by one
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment record with valid ccn is being processed and it's not a loaded/empty car.
Trigger Criteria:
- Context: An equipment record with valid CCN is being processed and it's not a loaded/empty car
- Applied to: Update Equipment Status Report Line
- Action: The equipment status totals are being compiled for a VERIFY operation
Logic Flow:
IF An equipment record with valid CCN is being processed and it's not a loaded/empty car
AND The equipment status totals are being compiled for a VERIFY operation
THEN:
- • A detailed status report line is generated including manifest station names and transit status if in-transit status is 'T'
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment record has been categorized and its specific counter incremented.
Trigger Criteria:
- Context: An equipment record has been categorized and its specific counter incremented
- Applied to: Calculate Running Totals
- Action: The equipment processing continues to the next record
Logic Flow:
IF An equipment record has been categorized and its specific counter incremented
AND The equipment processing continues to the next record
THEN:
- • The TOTAL-EQUIP counter is incremented by one and all category totals are maintained
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when all equipment records in the train have been processed and categorized.
Trigger Criteria:
- Context: All equipment records in the train have been processed and categorized
- Applied to: Generate Equipment Totals Summary
- Action: No more equipment records remain to be processed
Logic Flow:
IF All equipment records in the train have been processed and categorized
AND No more equipment records remain to be processed
THEN:
- • A summary report is generated showing TOTAL-EQUIP, TOTAL-RELEASE, TOTAL-HAULAGE, TOTAL-HELD-CCRA, TOTAL-PROCEED, TOTAL-HELD-DOCS, and TOTAL-DOCS-NR counts
R-GCX146-cbl-00265 (+13) File: GCX146.cbl Business Rule: EDI Transmission Processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment record needs to be processed for edi transmission. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: An equipment record needs to be processed for EDI transmission
- Applied to: Call GCCCARTP Module for Equipment Type
- Action: The system calls the GCCCARTP module to determine equipment type
Logic Flow:
IF An equipment record needs to be processed for EDI transmission
AND The system calls the GCCCARTP module to determine equipment type
THEN:
- • The equipment type is classified and returned for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has been determined to be a container type.
Trigger Criteria:
- Context: Equipment has been determined to be a container type
- Applied to: Set Container Equipment Type Code
- Action: The system processes the equipment for EDI transmission
Logic Flow:
IF Equipment has been determined to be a container type
AND The system processes the equipment for EDI transmission
THEN:
- • The equipment type code is set to container classification for EDI record
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has been determined to be a trailer type.
Trigger Criteria:
- Context: Equipment has been determined to be a trailer type
- Applied to: Set Trailer Equipment Type Code
- Action: The system processes the equipment for EDI transmission
Logic Flow:
IF Equipment has been determined to be a trailer type
AND The system processes the equipment for EDI transmission
THEN:
- • The equipment type code is set to trailer classification for EDI record
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has been determined to be a rail car type.
Trigger Criteria:
- Context: Equipment has been determined to be a rail car type
- Applied to: Set Car Equipment Type Code
- Action: The system processes the equipment for EDI transmission
Logic Flow:
IF Equipment has been determined to be a rail car type
AND The system processes the equipment for EDI transmission
THEN:
- • The equipment type code is set to car classification for EDI record
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment type has been determined for edi processing.
Trigger Criteria:
- Context: Equipment type has been determined for EDI processing
- Applied to: Assign Load/Empty Status Indicator
- Action: The system evaluates the cargo content status of the equipment
Logic Flow:
IF Equipment type has been determined for EDI processing
AND The system evaluates the cargo content status of the equipment
THEN:
- • The load/empty status indicator is assigned to reflect whether equipment is loaded or empty
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment has load/empty status assigned for edi processing.
Trigger Criteria:
- Context: Equipment has load/empty status assigned for EDI processing
- Applied to: Set CCN Key for EDI Manifest
- Action: The system prepares the EDI manifest record
Logic Flow:
IF Equipment has load/empty status assigned for EDI processing
AND The system prepares the EDI manifest record
THEN:
- • The CCN key is set in the EDI equipment record for customs identification
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment type, status, and ccn key have been determined.
Trigger Criteria:
- Context: Equipment type, status, and CCN key have been determined
- Applied to: Build EDI Equipment Record Structure
- Action: The system builds the EDI equipment record
Logic Flow:
IF Equipment type, status, and CCN key have been determined
AND The system builds the EDI equipment record
THEN:
- • A complete EDI record structure is created with all required data elements populated
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when edi equipment record has been built.
Trigger Criteria:
- Context: An EDI equipment record has been built
- Applied to: Validate EDI Record Completeness
- Action: The system validates the record for completeness
Logic Flow:
IF An EDI equipment record has been built
AND The system validates the record for completeness
THEN:
- • The record is confirmed to contain all mandatory data elements required for customs transmission
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when edi equipment record has been validated as complete.
Trigger Criteria:
- Context: An EDI equipment record has been validated as complete
- Applied to: Queue EDI Record for Transmission
- Action: The system processes the valid record
Logic Flow:
IF An EDI equipment record has been validated as complete
AND The system processes the valid record
THEN:
- • The EDI record is queued for transmission to customs
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when current equipment record has been queued for edi transmission.
Trigger Criteria:
- Context: Current equipment record has been queued for EDI transmission
- Applied to: Prepare Next Equipment Record
- Action: The system continues processing the train consist
Logic Flow:
IF Current equipment record has been queued for EDI transmission
AND The system continues processing the train consist
THEN:
- • The next equipment record is prepared for EDI processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when current equipment record has been processed.
Trigger Criteria:
- Context: Current equipment record has been processed
- Applied to: More Equipment?
- Action: The system checks for remaining equipment in the train consist
Logic Flow:
IF Current equipment record has been processed
AND The system checks for remaining equipment in the train consist
THEN:
- • Processing continues if more equipment exists or proceeds to transmission if complete
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when all equipment records have been processed and queued.
Trigger Criteria:
- Context: All equipment records have been processed and queued
- Applied to: Transmit EDI Data to Customs
- Action: The system initiates EDI transmission to customs
Logic Flow:
IF All equipment records have been processed and queued
AND The system initiates EDI transmission to customs
THEN:
- • All queued EDI records are transmitted to customs authorities
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when edi data has been transmitted to customs.
Trigger Criteria:
- Context: EDI data has been transmitted to customs
- Applied to: Log EDI Transmission Status
- Action: The system completes the transmission process
Logic Flow:
IF EDI data has been transmitted to customs
AND The system completes the transmission process
THEN:
- • The transmission status is logged for audit and monitoring purposes
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when error occurs during edi record validation or transmission.
Trigger Criteria:
- Context: An error occurs during EDI record validation or transmission
- Applied to: Handle EDI Transmission Error
- Action: The system encounters the error condition
Logic Flow:
IF An error occurs during EDI record validation or transmission
AND The system encounters the error condition
THEN:
- • Appropriate error handling procedures are executed to manage the failure
R-GCX146-cbl-00279 (+16) File: GCX146.cbl Business Rule: AEI Logging
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when aei train send process is initiated for a specific station.
Trigger Criteria:
- Context: An AEI train send process is initiated for a specific station
- Applied to: Retrieve Email User Lists from Station Configuration
- Action: The system needs to determine email recipients for the AEI report
Logic Flow:
IF An AEI train send process is initiated for a specific station
AND The system needs to determine email recipients for the AEI report
THEN:
- • The system retrieves email user lists from station configuration tables (GCSTBRT and AECWRKTB) based on the station code
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when aei report has been generated with equipment identification data.
Trigger Criteria:
- Context: An AEI report has been generated with equipment identification data
- Applied to: Check Report Size
- Action: The system prepares to send the report via email
Logic Flow:
IF An AEI report has been generated with equipment identification data
AND The system prepares to send the report via email
THEN:
- • The system counts the total number of lines in the report to determine if continuation logic is needed
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when aei report has been prepared for email transmission.
Trigger Criteria:
- Context: An AEI report has been prepared for email transmission
- Applied to: Report > 699 Lines?
- Action: The report contains more than 699 lines
Logic Flow:
IF An AEI report has been prepared for email transmission
AND The report contains more than 699 lines
THEN:
- • The system activates continuation logic to split the report into multiple email messages
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when aei report contains 699 lines or fewer.
Trigger Criteria:
- Context: An AEI report contains 699 lines or fewer
- Applied to: Prepare Standard AEI Report
- Action: The system prepares the report for email transmission
Logic Flow:
IF An AEI report contains 699 lines or fewer
AND The system prepares the report for email transmission
THEN:
- • The system formats the report as a single email message without continuation headers
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when aei report contains more than 699 lines.
Trigger Criteria:
- Context: An AEI report contains more than 699 lines
- Applied to: Prepare Report with Continuation Logic
- Action: The system prepares the report for email transmission
Logic Flow:
IF An AEI report contains more than 699 lines
AND The system prepares the report for email transmission
THEN:
- • The system splits the report into batches of 699 lines or fewer with continuation headers
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when batch of aei report data has been prepared for transmission.
Trigger Criteria:
- Context: A batch of AEI report data has been prepared for transmission
- Applied to: Send Current Report Batch
- Action: The system processes the current batch
Logic Flow:
IF A batch of AEI report data has been prepared for transmission
AND The system processes the current batch
THEN:
- • The system transmits the batch via EMCSEND3 email service to the configured recipients
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when batch of aei report data has been successfully sent.
Trigger Criteria:
- Context: A batch of AEI report data has been successfully sent
- Applied to: Reset Message Buffer
- Action: The system prepares for the next batch of data
Logic Flow:
IF A batch of AEI report data has been successfully sent
AND The system prepares for the next batch of data
THEN:
- • The system clears the message buffer and resets line counters for the next batch
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when aei report requires multiple email messages due to size.
Trigger Criteria:
- Context: An AEI report requires multiple email messages due to size
- Applied to: Add Continuation Header
- Action: The system prepares a continuation batch after the first message
Logic Flow:
IF An AEI report requires multiple email messages due to size
AND The system prepares a continuation batch after the first message
THEN:
- • The system adds the header 'CONTINUATION OF REPORT....' to identify the message as a continuation
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when batch of aei report data has been processed.
Trigger Criteria:
- Context: A batch of AEI report data has been processed
- Applied to: More Lines to Process?
- Action: The system checks for remaining report content
Logic Flow:
IF A batch of AEI report data has been processed
AND The system checks for remaining report content
THEN:
- • The system determines if more lines exist that require additional batch processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when additional lines remain in the aei report after sending a batch.
Trigger Criteria:
- Context: Additional lines remain in the AEI report after sending a batch
- Applied to: Process Next Batch
- Action: The system processes the next batch
Logic Flow:
IF Additional lines remain in the AEI report after sending a batch
AND The system processes the next batch
THEN:
- • The system prepares up to 699 lines for the next email message with appropriate continuation headers
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when aei report batch has been prepared for transmission.
Trigger Criteria:
- Context: An AEI report batch has been prepared for transmission
- Applied to: Send AEI Report via EMCSEND3
- Action: The system initiates email transmission
Logic Flow:
IF An AEI report batch has been prepared for transmission
AND The system initiates email transmission
THEN:
- • The system calls EMCSEND3 service to deliver the report to the configured email recipients
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when aei report has been sent via emcsend3 email service.
Trigger Criteria:
- Context: An AEI report has been sent via EMCSEND3 email service
- Applied to: Email Send Successful?
- Action: The system receives the transmission response
Logic Flow:
IF An AEI report has been sent via EMCSEND3 email service
AND The system receives the transmission response
THEN:
- • The system evaluates the response to determine if the email was successfully delivered
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when primary aei report email transmission has failed.
Trigger Criteria:
- Context: The primary AEI report email transmission has failed
- Applied to: Use Fallback Email Recipients
- Action: The system needs to ensure report delivery
Logic Flow:
IF The primary AEI report email transmission has failed
AND The system needs to ensure report delivery
THEN:
- • The system configures fallback recipients (OM01247 and AEI9999) for report transmission
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when primary aei report email transmission has failed.
Trigger Criteria:
- Context: Primary AEI report email transmission has failed
- Applied to: Send to OM01247/AEI9999
- Action: The system uses fallback recipients
Logic Flow:
IF Primary AEI report email transmission has failed
AND The system uses fallback recipients
THEN:
- • The system sends the AEI report to OM01247 and AEI9999 as backup recipients
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when aei report email transmission has failed.
Trigger Criteria:
- Context: An AEI report email transmission has failed
- Applied to: Handle Email Failure
- Action: The system processes the failure
Logic Flow:
IF An AEI report email transmission has failed
AND The system processes the failure
THEN:
- • The system logs the failure and initiates fallback transmission procedures
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when aei train send process has been completed (successful or failed).
Trigger Criteria:
- Context: An AEI train send process has been completed (successful or failed)
- Applied to: Log AEI Train Send Activity
- Action: The system finalizes the AEI process
Logic Flow:
IF An AEI train send process has been completed (successful or failed)
AND The system finalizes the AEI process
THEN:
- • The system logs the train send activity with timestamp, user information, and transmission status
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when aei train send operation has been logged.
Trigger Criteria:
- Context: An AEI train send operation has been logged
- Applied to: Create Audit Trail Entry
- Action: The system creates audit records
Logic Flow:
IF An AEI train send operation has been logged
AND The system creates audit records
THEN:
- • The system generates detailed audit trail entries in the audit database with transaction details, user identification, and processing results
R-GCX146-cbl-00296 (+13) File: GCX146.cbl Business Rule: Confirmation Message Generation
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when train processing operation has completed.
Trigger Criteria:
- Context: A train processing operation has completed
- Applied to: Determine Message Type
- Action: The system evaluates the processing outcome
Logic Flow:
IF A train processing operation has completed
AND The system evaluates the processing outcome
THEN:
- • The system selects success confirmation message type if no errors occurred,
otherwise selects error confirmation message type
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when train processing has completed successfully with no validation errors.
Trigger Criteria:
- Context: Train processing has completed successfully with no validation errors
- Applied to: Create Success Confirmation Message
- Action: The system creates a confirmation message
Logic Flow:
IF Train processing has completed successfully with no validation errors
AND The system creates a confirmation message
THEN:
- • The system generates a GCT1051E success message with train processing details
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when train processing has failed due to validation errors or system issues.
Trigger Criteria:
- Context: Train processing has failed due to validation errors or system issues
- Applied to: Create Error Confirmation Message
- Action: The system creates a confirmation message
Logic Flow:
IF Train processing has failed due to validation errors or system issues
AND The system creates a confirmation message
THEN:
- • The system generates either a GCT1011E error message or customer report message depending on the error type
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when confirmation message type has been determined.
Trigger Criteria:
- Context: A confirmation message type has been determined
- Applied to: Format Message Content
- Action: The system formats the message content
Logic Flow:
IF A confirmation message type has been determined
AND The system formats the message content
THEN:
- • The system includes train identification, processing status, error details if applicable, and relevant business data in the message format
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when formatted confirmation message is ready for delivery.
Trigger Criteria:
- Context: A formatted confirmation message is ready for delivery
- Applied to: Set Message Routing
- Action: The system sets message routing parameters
Logic Flow:
IF A formatted confirmation message is ready for delivery
AND The system sets message routing parameters
THEN:
- • The system assigns ALT-PCB routing, sets message priority, and determines recipient terminals based on message type and business requirements
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when confirmation message with routing parameters is ready.
Trigger Criteria:
- Context: A confirmation message with routing parameters is ready
- Applied to: Queue Message via CSISER
- Action: The system queues the message via CSISER
Logic Flow:
IF A confirmation message with routing parameters is ready
AND The system queues the message via CSISER
THEN:
- • The system adds the message to the processing queue using the appropriate CSISER interface methods
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when messages need to be processed through cims.
Trigger Criteria:
- Context: Messages need to be processed through CIMS
- Applied to: Initialize CIMS Interface
- Action: The system initializes the CIMS interface
Logic Flow:
IF Messages need to be processed through CIMS
AND The system initializes the CIMS interface
THEN:
- • The system establishes connection to CIMS and prepares for message command processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when message is ready for processing through cims.
Trigger Criteria:
- Context: A message is ready for processing through CIMS
- Applied to: Add Message Command to Queue
- Action: The system adds the message command to the queue
Logic Flow:
IF A message is ready for processing through CIMS
AND The system adds the message command to the queue
THEN:
- • The system queues the appropriate operation (CHNG for changes, WRITMSGL for message logging, or PURG for purging) based on message type and processing requirements
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when message command has been added to the processing queue.
Trigger Criteria:
- Context: A message command has been added to the processing queue
- Applied to: Validate Message Parameters
- Action: The system validates message parameters
Logic Flow:
IF A message command has been added to the processing queue
AND The system validates message parameters
THEN:
- • The system checks for valid parameters, proper formatting, and required data elements, marking the message as valid or invalid
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when message parameters have been validated successfully.
Trigger Criteria:
- Context: Message parameters have been validated successfully
- Applied to: Process Queued Commands
- Action: The system processes queued commands
Logic Flow:
IF Message parameters have been validated successfully
AND The system processes queued commands
THEN:
- • The system executes all queued CIMS commands in sequence for message delivery and processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when queued commands have been processed successfully.
Trigger Criteria:
- Context: Queued commands have been processed successfully
- Applied to: Send Message to Recipients
- Action: The system sends the message to recipients
Logic Flow:
IF Queued commands have been processed successfully
AND The system sends the message to recipients
THEN:
- • The system delivers the confirmation message to all specified terminals and recipients according to the established routing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when message has been sent to recipients.
Trigger Criteria:
- Context: A message has been sent to recipients
- Applied to: Update Message Status
- Action: The system updates message status
Logic Flow:
IF A message has been sent to recipients
AND The system updates message status
THEN:
- • The system records the delivery status, timestamp, and any delivery confirmation information
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when confirmation message has been processed and status updated.
Trigger Criteria:
- Context: A confirmation message has been processed and status updated
- Applied to: Log Confirmation Activity
- Action: The system logs confirmation activity
Logic Flow:
IF A confirmation message has been processed and status updated
AND The system logs confirmation activity
THEN:
- • The system creates audit trail entries with message details, processing timestamps, and delivery status for compliance and tracking
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when message processing encounters an error condition.
Trigger Criteria:
- Context: Message processing encounters an error condition
- Applied to: Handle Message Errors
- Action: The system handles message errors
Logic Flow:
IF Message processing encounters an error condition
AND The system handles message errors
THEN:
- • The system identifies the error type (invalid parameters, queue full, or system error) and routes to appropriate error handling procedures
R-GCX146-cbl-00310 (+16) File: GCX146.cbl Business Rule: Canada Customs Trip Sheet Generation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when canada customs trip sheet needs to be generated.
Trigger Criteria:
- Context: A Canada Customs trip sheet needs to be generated
- Applied to: Initialize Trip Sheet Header
- Action: The trip sheet generation process begins
Logic Flow:
IF A Canada Customs trip sheet needs to be generated
AND The trip sheet generation process begins
THEN:
- • The header structure is initialized with proper formatting and line counters are reset
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when trip sheet header has been initialized.
Trigger Criteria:
- Context: Trip sheet header has been initialized
- Applied to: Set Report Parameters
- Action: Report parameters need to be established
Logic Flow:
IF Trip sheet header has been initialized
AND Report parameters need to be established
THEN:
- • Maximum line limits are set and report formatting parameters are configured
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when train data is available for processing.
Trigger Criteria:
- Context: Train data is available for processing
- Applied to: Format Train Information
- Action: Train information needs to be formatted for the trip sheet
Logic Flow:
IF Train data is available for processing
AND Train information needs to be formatted for the trip sheet
THEN:
- • Train ID, date, and customs train ID are formatted and added to the report header
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when train information has been formatted.
Trigger Criteria:
- Context: Train information has been formatted
- Applied to: Add Station Details
- Action: Station details need to be added to the trip sheet
Logic Flow:
IF Train information has been formatted
AND Station details need to be added to the trip sheet
THEN:
- • From station, to station, and route information are formatted and included in the header
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when station details have been added to the trip sheet.
Trigger Criteria:
- Context: Station details have been added to the trip sheet
- Applied to: Process Equipment List
- Action: Equipment processing begins
Logic Flow:
IF Station details have been added to the trip sheet
AND Equipment processing begins
THEN:
- • Each equipment piece is processed sequentially for inclusion in the trip sheet
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment piece is being processed.
Trigger Criteria:
- Context: An equipment piece is being processed
- Applied to: Format Equipment Entry
- Action: Equipment entry formatting is required
Logic Flow:
IF An equipment piece is being processed
AND Equipment entry formatting is required
THEN:
- • Equipment ID is extracted, car number is formatted, and load/empty status is determined
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment entry has been formatted.
Trigger Criteria:
- Context: Equipment entry has been formatted
- Applied to: Determine Equipment Type
- Action: Equipment type needs to be determined
Logic Flow:
IF Equipment entry has been formatted
AND Equipment type needs to be determined
THEN:
- • Car type is analyzed to classify as Unit, Van, SBU, or regular car for appropriate processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment type has been determined.
Trigger Criteria:
- Context: Equipment type has been determined
- Applied to: Container on Flat Car?
- Action: Container processing check is performed
Logic Flow:
IF Equipment type has been determined
AND Container processing check is performed
THEN:
- • If equipment is a flat car with containers, container processing is initiated,
otherwise standard equipment processing continues
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment is identified as a flat car with containers.
Trigger Criteria:
- Context: Equipment is identified as a flat car with containers
- Applied to: Process Individual Container
- Action: Container processing is initiated
Logic Flow:
IF Equipment is identified as a flat car with containers
AND Container processing is initiated
THEN:
- • Each container is processed individually with proper identification and cross-reference handling
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when individual container is being processed.
Trigger Criteria:
- Context: Individual container is being processed
- Applied to: Format Container Details
- Action: Container details need formatting
Logic Flow:
IF Individual container is being processed
AND Container details need formatting
THEN:
- • Container ID is formatted using 12-character format and container details are prepared for display
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment or container details have been formatted.
Trigger Criteria:
- Context: Equipment or container details have been formatted
- Applied to: Add Equipment Car Type Description
- Action: Car type description is needed
Logic Flow:
IF Equipment or container details have been formatted
AND Car type description is needed
THEN:
- • Car type description is retrieved from the VI table and added to the equipment information
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment car type description has been added.
Trigger Criteria:
- Context: Equipment car type description has been added
- Applied to: Assign Status Information
- Action: Status assignment is required
Logic Flow:
IF Equipment car type description has been added
AND Status assignment is required
THEN:
- • CCN status is evaluated, transit status is determined, and appropriate status is assigned (EXPORT for RELEASE with E/Z transit, S.A.R. for RELEASE with S.A.R., TRANSIT for T status, RETURN for R status, or current status
otherwise)
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when current equipment status has been assigned.
Trigger Criteria:
- Context: Current equipment status has been assigned
- Applied to: More Equipment?
- Action: Equipment processing continuation check is performed
Logic Flow:
IF Current equipment status has been assigned
AND Equipment processing continuation check is performed
THEN:
- • If more equipment exists, processing returns to equipment list processing,
otherwise equipment totals calculation begins
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when all equipment has been processed.
Trigger Criteria:
- Context: All equipment has been processed
- Applied to: Calculate Equipment Totals
- Action: Equipment totals calculation is initiated
Logic Flow:
IF All equipment has been processed
AND Equipment totals calculation is initiated
THEN:
- • Totals are calculated for released equipment (RELEASE/CSA-DLV status), transit equipment (T status), held equipment (HOLD/AGI-HOLD status), and proceeding equipment (different from/to stations)
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment totals have been calculated.
Trigger Criteria:
- Context: Equipment totals have been calculated
- Applied to: Add Summary Totals
- Action: Summary totals need to be added to the trip sheet
Logic Flow:
IF Equipment totals have been calculated
AND Summary totals need to be added to the trip sheet
THEN:
- • Total counts for each equipment category are formatted and added to the trip sheet with appropriate labels
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when summary totals have been added to the trip sheet.
Trigger Criteria:
- Context: Summary totals have been added to the trip sheet
- Applied to: Format Final Report
- Action: Final report formatting is required
Logic Flow:
IF Summary totals have been added to the trip sheet
AND Final report formatting is required
THEN:
- • The complete trip sheet is formatted with proper spacing, headers, and structure for final output
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when final report formatting has been completed.
Trigger Criteria:
- Context: Final report formatting has been completed
- Applied to: Trip Sheet Complete
- Action: Trip sheet generation process concludes
Logic Flow:
IF Final report formatting has been completed
AND Trip sheet generation process concludes
THEN:
- • The completed Canada Customs trip sheet is ready for distribution and the generation process is marked as complete
R-GCX146-cbl-00327 (+14) File: GCX146.cbl Business Rule: Status Report Generation
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when verify operation is being processed for a train.
Trigger Criteria:
- Context: A VERIFY operation is being processed for a train
- Applied to: Initialize Status Report Header
- Action: The status report generation begins
Logic Flow:
IF A VERIFY operation is being processed for a train
AND The status report generation begins
THEN:
- • The report header is initialized with train ID, date, time, and column headers for equipment status display
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment records exist for the train being verified.
Trigger Criteria:
- Context: Equipment records exist for the train being verified
- Applied to: Process Equipment Status Records
- Action: Processing equipment status records
Logic Flow:
IF Equipment records exist for the train being verified
AND Processing equipment status records
THEN:
- • Each equipment record is processed to extract CCN status, equipment details, and manifest information
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has manifest from and to station codes.
Trigger Criteria:
- Context: Equipment has manifest from and to station codes
- Applied to: Populate Manifest Station Names
- Action: Processing equipment for status report
Logic Flow:
IF Equipment has manifest from and to station codes
AND Processing equipment for status report
THEN:
- • Station names are retrieved and populated for manifest from and to locations using station code lookup
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has an in-transit status indicator.
Trigger Criteria:
- Context: Equipment has an in-transit status indicator
- Applied to: Equipment Has Transit Status?
- Action: The in-transit status is 'T'
Logic Flow:
IF Equipment has an in-transit status indicator
AND The in-transit status is 'T'
THEN:
- • The equipment status is set to 'TRANSIT' for display purposes
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has an in-transit status indicator.
Trigger Criteria:
- Context: Equipment has an in-transit status indicator
- Applied to: Keep Original Status
- Action: The in-transit status is not 'T'
Logic Flow:
IF Equipment has an in-transit status indicator
AND The in-transit status is not 'T'
THEN:
- • The original equipment status is preserved for display
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has us customs status messages available.
Trigger Criteria:
- Context: Equipment has US customs status messages available
- Applied to: Process US Status Messages
- Action: Processing status messages for the report
Logic Flow:
IF Equipment has US customs status messages available
AND Processing status messages for the report
THEN:
- • US status messages are processed and included in the report up to a maximum of 90 lines
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when status report is being generated with multiple equipment entries.
Trigger Criteria:
- Context: Status report is being generated with multiple equipment entries
- Applied to: Line Limit Reached?
- Action: The maximum number of report lines is reached
Logic Flow:
IF Status report is being generated with multiple equipment entries
AND The maximum number of report lines is reached
THEN:
- • The MAX-LINES-REACHED flag is set to prevent report overflow
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment records are being processed for status totals.
Trigger Criteria:
- Context: Equipment records are being processed for status totals
- Applied to: Calculate Total Released Equipment
- Action: Equipment has status 'RELEASE' or 'CSA-DLV'
Logic Flow:
IF Equipment records are being processed for status totals
AND Equipment has status 'RELEASE' or 'CSA-DLV'
THEN:
- • The TOTAL-RELEASE counter is incremented by one
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment records are being processed for status totals.
Trigger Criteria:
- Context: Equipment records are being processed for status totals
- Applied to: Calculate Total Haulage Equipment
- Action: Equipment has haulage flag set or manual haulage flag set
Logic Flow:
IF Equipment records are being processed for status totals
AND Equipment has haulage flag set or manual haulage flag set
THEN:
- • The TOTAL-HAULAGE counter is incremented by one
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment records are being processed for status totals.
Trigger Criteria:
- Context: Equipment records are being processed for status totals
- Applied to: Calculate Total Held by CCRA
- Action: Equipment has status 'HOLD' or 'AGI-HOLD'
Logic Flow:
IF Equipment records are being processed for status totals
AND Equipment has status 'HOLD' or 'AGI-HOLD'
THEN:
- • The TOTAL-HELD-CCRA counter is incremented by one
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment records are being processed for status totals.
Trigger Criteria:
- Context: Equipment records are being processed for status totals
- Applied to: Calculate Total Proceeding Equipment
- Action: Equipment has status 'RETURN' or manifest from station differs from manifest to station and status is not error, reject, or deleted
Logic Flow:
IF Equipment records are being processed for status totals
AND Equipment has status 'RETURN' or manifest from station differs from manifest to station and status is not error, reject, or deleted
THEN:
- • The TOTAL-PROCEED counter is incremented by one
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment records are being processed for status totals.
Trigger Criteria:
- Context: Equipment records are being processed for status totals
- Applied to: Calculate Total Held for Documentation
- Action: Equipment manifest from station equals manifest to station and broker entry is empty
Logic Flow:
IF Equipment records are being processed for status totals
AND Equipment manifest from station equals manifest to station and broker entry is empty
THEN:
- • The TOTAL-HELD-DOCS counter is incremented by one
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment status information has been processed.
Trigger Criteria:
- Context: Equipment status information has been processed
- Applied to: Format Status Report Lines
- Action: Formatting the status report
Logic Flow:
IF Equipment status information has been processed
AND Formatting the status report
THEN:
- • Equipment details are formatted into structured report lines with proper spacing and alignment
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment status lines have been formatted.
Trigger Criteria:
- Context: Equipment status lines have been formatted
- Applied to: Add Equipment Details to Report
- Action: Building the complete status report
Logic Flow:
IF Equipment status lines have been formatted
AND Building the complete status report
THEN:
- • Formatted equipment details are added to the report output including CCN, status, and manifest information
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when all equipment has been processed and totals calculated.
Trigger Criteria:
- Context: All equipment has been processed and totals calculated
- Applied to: Generate Final Status Report
- Action: Finalizing the status report
Logic Flow:
IF All equipment has been processed and totals calculated
AND Finalizing the status report
THEN:
- • The complete status report is generated with equipment details, status totals, and summary information
R-GCX146-cbl-00342 (+15) File: GCX146.cbl Business Rule: Error Message Processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when processing error has been detected during train processing. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A processing error has been detected during train processing
- Applied to: Set Error Code in WS-ERROR-NB
- Action: The system identifies the specific type of error that occurred
Logic Flow:
IF A processing error has been detected during train processing
AND The system identifies the specific type of error that occurred
THEN:
- • The system assigns the corresponding error code to WS-ERROR-NB for tracking and reporting purposes
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when error has been detected that requires transaction rollback. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: An error has been detected that requires transaction rollback
- Applied to: Set Rollback Flag WS-ROLB
- Action: The error processing begins
Logic Flow:
IF An error has been detected that requires transaction rollback
AND The error processing begins
THEN:
- • The system sets WS-ROLB flag to 'Y' to indicate that transaction rollback is required
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when user is attempting to perform train operations.
Trigger Criteria:
- Context: A user is attempting to perform train operations
- Applied to: Generate SCAC Access Error 36
- Action: The user's SCAC access is invalid AND the operation is not an AEI train send
Logic Flow:
IF A user is attempting to perform train operations
AND The user's SCAC access is invalid AND the operation is not an AEI train send
THEN:
- • The system generates error code 36 for SCAC access violation
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when eta date has been provided for train processing.
Trigger Criteria:
- Context: An ETA date has been provided for train processing
- Applied to: Generate ETA Range Error 25/35
- Action: The ETA date is outside the acceptable range for the user type (30 days before to 5 days after for supervisors, or 2 days before to 2 days after for others)
Logic Flow:
IF An ETA date has been provided for train processing
AND The ETA date is outside the acceptable range for the user type (30 days before to 5 days after for supervisors, or 2 days before to 2 days after for others)
THEN:
- • The system generates error 25 for supervisor users or error 35 for other users
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when station information is being validated during train processing.
Trigger Criteria:
- Context: Station information is being validated during train processing
- Applied to: Generate Station Validation Error
- Action: Station codes are invalid, missing, or fail validation rules
Logic Flow:
IF Station information is being validated during train processing
AND Station codes are invalid, missing, or fail validation rules
THEN:
- • The system generates appropriate station validation error codes
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment requires waybill validation during processing.
Trigger Criteria:
- Context: Equipment requires waybill validation during processing
- Applied to: Generate Waybill Lookup Error
- Action: Waybill lookup fails for loaded cars or waybill data is invalid
Logic Flow:
IF Equipment requires waybill validation during processing
AND Waybill lookup fails for loaded cars or waybill data is invalid
THEN:
- • The system generates error 21 for loaded cars without waybills or other waybill-related error codes
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn validation is being performed for equipment.
Trigger Criteria:
- Context: CCN validation is being performed for equipment
- Applied to: Generate CCN Validation Error
- Action: CCN status is invalid, CCN is assigned to another train, or CCN validation rules are violated
Logic Flow:
IF CCN validation is being performed for equipment
AND CCN status is invalid, CCN is assigned to another train, or CCN validation rules are violated
THEN:
- • The system generates error 24 for invalid status, error 13 for duplicate train assignment, or other CCN-related error codes
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when processing error has occurred during train operations.
Trigger Criteria:
- Context: A processing error has occurred during train operations
- Applied to: Generate Other Processing Error
- Action: The error is not related to SCAC access, ETA range, station validation, waybill lookup, or CCN validation
Logic Flow:
IF A processing error has occurred during train operations
AND The error is not related to SCAC access, ETA range, station validation, waybill lookup, or CCN validation
THEN:
- • The system generates the appropriate general processing error code based on the specific issue encountered
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when error code has been assigned for a processing issue.
Trigger Criteria:
- Context: An error code has been assigned for a processing issue
- Applied to: Format Error Message
- Action: The error message needs to be prepared for distribution
Logic Flow:
IF An error code has been assigned for a processing issue
AND The error message needs to be prepared for distribution
THEN:
- • The system formats the error message with error code, description, and relevant context information
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when error message has been formatted for distribution.
Trigger Criteria:
- Context: An error message has been formatted for distribution
- Applied to: Identify Distribution Recipients
- Action: The system needs to determine who should receive the error notification
Logic Flow:
IF An error message has been formatted for distribution
AND The system needs to determine who should receive the error notification
THEN:
- • The system identifies appropriate recipients based on error type, user roles, and notification requirements
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when error distribution recipients are being identified.
Trigger Criteria:
- Context: Error distribution recipients are being identified
- Applied to: Add Supervisor IDs
- Action: The system is building the distribution list for error notifications
Logic Flow:
IF Error distribution recipients are being identified
AND The system is building the distribution list for error notifications
THEN:
- • The system adds supervisor IDs from GCSTBRT configuration to the distribution list
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when supervisor ids have been added to the error distribution list.
Trigger Criteria:
- Context: Supervisor IDs have been added to the error distribution list
- Applied to: Add Designated Personnel
- Action: Additional designated personnel need to be notified based on error type
Logic Flow:
IF Supervisor IDs have been added to the error distribution list
AND Additional designated personnel need to be notified based on error type
THEN:
- • The system adds designated personnel IDs to the error distribution list based on operational requirements
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when error message recipients have been identified and the message is formatted.
Trigger Criteria:
- Context: Error message recipients have been identified and the message is formatted
- Applied to: Queue Error Message
- Action: The error message is ready for distribution
Logic Flow:
IF Error message recipients have been identified and the message is formatted
AND The error message is ready for distribution
THEN:
- • The system queues the error message in IMS message queues for delivery to all identified recipients
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when error messages have been queued for distribution.
Trigger Criteria:
- Context: Error messages have been queued for distribution
- Applied to: Distribute via Message Queues
- Action: The messaging system processes the queued messages
Logic Flow:
IF Error messages have been queued for distribution
AND The messaging system processes the queued messages
THEN:
- • The system distributes error messages to all identified recipients via IMS message queues
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when error has been processed and distributed.
Trigger Criteria:
- Context: An error has been processed and distributed
- Applied to: Log Error for Audit Trail
- Action: The error processing is being completed
Logic Flow:
IF An error has been processed and distributed
AND The error processing is being completed
THEN:
- • The system logs the error details in the audit trail for compliance and tracking purposes
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when rollback flag ws-rolb has been set to 'y' due to an error. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: The rollback flag WS-ROLB has been set to 'Y' due to an error
- Applied to: Rollback Transaction
- Action: Error processing is being completed
Logic Flow:
IF The rollback flag WS-ROLB has been set to 'Y' due to an error
AND Error processing is being completed
THEN:
- • The system executes transaction rollback to undo any partial changes and maintain data integrity
R-GCX146-cbl-00358 (+20) File: GCX146.cbl Business Rule: Email/FAX Distribution
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when station configuration exists for the current station.
Trigger Criteria:
- Context: A station configuration exists for the current station
- Applied to: Check Station Configuration
- Action: The system needs to determine distribution methods for reports
Logic Flow:
IF A station configuration exists for the current station
AND The system needs to determine distribution methods for reports
THEN:
- • The system should identify if auto-FAX is enabled for the station
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when station configuration has been retrieved.
Trigger Criteria:
- Context: Station configuration has been retrieved
- Applied to: Auto-FAX Enabled?
- Action: Auto-FAX flag is set to enabled in station settings
Logic Flow:
IF Station configuration has been retrieved
AND Auto-FAX flag is set to enabled in station settings
THEN:
- • The system should proceed with FAX routing setup,
otherwise proceed to email user lookup
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when auto-fax is enabled for the station. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Auto-FAX is enabled for the station
- Applied to: Setup FAX Routing
- Action: FAX routing needs to be established
Logic Flow:
IF Auto-FAX is enabled for the station
AND FAX routing needs to be established
THEN:
- • The system should configure FAX routing parameters and proceed to set copy IDs
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when auto-fax is not enabled or fax routing is complete.
Trigger Criteria:
- Context: Auto-FAX is not enabled or FAX routing is complete
- Applied to: Get Email User Lists
- Action: Email distribution is required
Logic Flow:
IF Auto-FAX is not enabled or FAX routing is complete
AND Email distribution is required
THEN:
- • The system should lookup email addresses from CUSEMAIL table using station code
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when email user lookup has been performed.
Trigger Criteria:
- Context: Email user lookup has been performed
- Applied to: Email Users Found?
- Action: Email addresses are found for the station
Logic Flow:
IF Email user lookup has been performed
AND Email addresses are found for the station
THEN:
- • The system should proceed with AEI report email distribution,
otherwise proceed to Merlin transmission
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when valid email users exist for the station.
Trigger Criteria:
- Context: Valid email users exist for the station
- Applied to: Send AEI Report via Email
- Action: AEI report needs to be distributed
Logic Flow:
IF Valid email users exist for the station
AND AEI report needs to be distributed
THEN:
- • The system should send the report via email using EMCSEND3 utility
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when aei report is being prepared for email distribution.
Trigger Criteria:
- Context: An AEI report is being prepared for email distribution
- Applied to: Report Size > 699 Lines?
- Action: The report contains more than 699 lines
Logic Flow:
IF An AEI report is being prepared for email distribution
AND The report contains more than 699 lines
THEN:
- • The system should split the report and send with continuation headers,
otherwise send as complete report
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when report size is 699 lines or fewer.
Trigger Criteria:
- Context: Report size is 699 lines or fewer
- Applied to: Send Complete Report
- Action: Email distribution is initiated
Logic Flow:
IF Report size is 699 lines or fewer
AND Email distribution is initiated
THEN:
- • The system should send the complete report in a single email message
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when report size exceeds 699 lines.
Trigger Criteria:
- Context: Report size exceeds 699 lines
- Applied to: Send Report with Continuation
- Action: Email distribution is initiated
Logic Flow:
IF Report size exceeds 699 lines
AND Email distribution is initiated
THEN:
- • The system should split the report and prepare continuation messages
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when report is being split into multiple email messages.
Trigger Criteria:
- Context: A report is being split into multiple email messages
- Applied to: Add Continuation Header
- Action: Continuation messages are created
Logic Flow:
IF A report is being split into multiple email messages
AND Continuation messages are created
THEN:
- • The system should add 'CONTINUATION OF REPORT....' header to each continuation message
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when continuation header has been added.
Trigger Criteria:
- Context: Continuation header has been added
- Applied to: Send Remaining Lines
- Action: Remaining report lines need to be sent
Logic Flow:
IF Continuation header has been added
AND Remaining report lines need to be sent
THEN:
- • The system should send the remaining lines in subsequent email messages with proper headers
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when email distribution has been attempted.
Trigger Criteria:
- Context: Email distribution has been attempted
- Applied to: Primary Email Failed?
- Action: Primary email delivery fails
Logic Flow:
IF Email distribution has been attempted
AND Primary email delivery fails
THEN:
- • The system should use fallback email addresses,
otherwise proceed to Merlin transmission
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when primary email distribution has failed.
Trigger Criteria:
- Context: Primary email distribution has failed
- Applied to: Use Fallback Email
- Action: Fallback email is needed
Logic Flow:
IF Primary email distribution has failed
AND Fallback email is needed
THEN:
- • The system should configure fallback email settings
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when fallback email has been configured.
Trigger Criteria:
- Context: Fallback email has been configured
- Applied to: Send to OM01247/AEI9999
- Action: Report needs to be delivered despite email failure
Logic Flow:
IF Fallback email has been configured
AND Report needs to be delivered despite email failure
THEN:
- • The system should send the report to support team addresses OM01247 and AEI9999
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when email distribution is complete or not available.
Trigger Criteria:
- Context: Email distribution is complete or not available
- Applied to: Setup Merlin Transmission
- Action: Merlin transmission is required
Logic Flow:
IF Email distribution is complete or not available
AND Merlin transmission is required
THEN:
- • The system should setup Merlin transmission parameters
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when merlin transmission setup is complete.
Trigger Criteria:
- Context: Merlin transmission setup is complete
- Applied to: FAX Configuration Valid?
- Action: FAX configuration needs validation
Logic Flow:
IF Merlin transmission setup is complete
AND FAX configuration needs validation
THEN:
- • The system should verify FAX configuration is valid and proceed to external FAX setup if valid,
otherwise proceed directly to Merlin system send
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when fax configuration is valid.
Trigger Criteria:
- Context: FAX configuration is valid
- Applied to: Configure External FAX
- Action: External FAX needs to be configured
Logic Flow:
IF FAX configuration is valid
AND External FAX needs to be configured
THEN:
- • The system should configure external FAX parameters
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when fax routing or external fax configuration is complete. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: FAX routing or external FAX configuration is complete
- Applied to: Set Copy IDs for FAX
- Action: Copy IDs need to be assigned for FAX distribution
Logic Flow:
IF FAX routing or external FAX configuration is complete
AND Copy IDs need to be assigned for FAX distribution
THEN:
- • The system should set appropriate copy IDs for FAX transmission
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when merlin transmission is configured and copy ids are set if needed. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Merlin transmission is configured and copy IDs are set if needed
- Applied to: Send via Merlin System
- Action: Report distribution via Merlin is initiated
Logic Flow:
IF Merlin transmission is configured and copy IDs are set if needed
AND Report distribution via Merlin is initiated
THEN:
- • The system should send the report through Merlin messaging system
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all distribution methods have been processed.
Trigger Criteria:
- Context: All distribution methods have been processed
- Applied to: Distribution Complete
- Action: Distribution is successful
Logic Flow:
IF All distribution methods have been processed
AND Distribution is successful
THEN:
- • The system should mark the distribution as complete
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when error occurs during email or merlin distribution.
Trigger Criteria:
- Context: An error occurs during email or Merlin distribution
- Applied to: Distribution Error
- Action: Distribution fails
Logic Flow:
IF An error occurs during email or Merlin distribution
AND Distribution fails
THEN:
- • The system should handle the error and still complete the distribution process
R-GCX146-cbl-00379 (+16) File: GCX146.cbl Business Rule: US Trip Sheet Generation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when us trip sheet generation process is starting.
Trigger Criteria:
- Context: A US trip sheet generation process is starting
- Applied to: Initialize US Trip Sheet Equipment Records
- Action: The system begins processing equipment records
Logic Flow:
IF A US trip sheet generation process is starting
AND The system begins processing equipment records
THEN:
- • Equipment record counter is set to zero and data structures are cleared
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment records exist for the train.
Trigger Criteria:
- Context: Equipment records exist for the train
- Applied to: Prepare Equipment and Cargo Data
- Action: The system processes each equipment item
Logic Flow:
IF Equipment records exist for the train
AND The system processes each equipment item
THEN:
- • Equipment details, waybill information, and cargo data are extracted and formatted for customs reporting
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment data has been prepared.
Trigger Criteria:
- Context: Equipment data has been prepared
- Applied to: Format Equipment Type Messages
- Action: The system formats the equipment information
Logic Flow:
IF Equipment data has been prepared
AND The system formats the equipment information
THEN:
- • Equipment details are structured according to US customs trip sheet message format requirements
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment record with type information.
Trigger Criteria:
- Context: An equipment record with type information
- Applied to: Equipment Type?
- Action: The system evaluates the equipment type
Logic Flow:
IF An equipment record with type information
AND The system evaluates the equipment type
THEN:
- • Equipment is classified as IDLER, UNIT, VAN, ETU, or Other type for specialized processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment is classified as idler type.
Trigger Criteria:
- Context: Equipment is classified as IDLER type
- Applied to: Process IDLER Equipment
- Action: The system processes the IDLER equipment
Logic Flow:
IF Equipment is classified as IDLER type
AND The system processes the IDLER equipment
THEN:
- • IDLER equipment is formatted with appropriate customs codes and status information
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment is classified as unit type (l, p, d, u).
Trigger Criteria:
- Context: Equipment is classified as UNIT type (L, P, D, U)
- Applied to: Process UNIT Equipment
- Action: The system processes the UNIT equipment
Logic Flow:
IF Equipment is classified as UNIT type (L, P, D, U)
AND The system processes the UNIT equipment
THEN:
- • UNIT equipment is formatted with cargo details, waybill information, and customs status
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment is classified as van type.
Trigger Criteria:
- Context: Equipment is classified as VAN type
- Applied to: Process VAN Equipment
- Action: The system processes the VAN equipment
Logic Flow:
IF Equipment is classified as VAN type
AND The system processes the VAN equipment
THEN:
- • VAN equipment is formatted with container information and customs documentation
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment is classified as etu type.
Trigger Criteria:
- Context: Equipment is classified as ETU type
- Applied to: Process ETU Equipment
- Action: The system processes the ETU equipment
Logic Flow:
IF Equipment is classified as ETU type
AND The system processes the ETU equipment
THEN:
- • ETU equipment is formatted with empty status and appropriate customs codes
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment does not match idler, unit, van, or etu classifications.
Trigger Criteria:
- Context: Equipment does not match IDLER, UNIT, VAN, or ETU classifications
- Applied to: Process Other Equipment Types
- Action: The system processes the other equipment type
Logic Flow:
IF Equipment does not match IDLER, UNIT, VAN, or ETU classifications
AND The system processes the other equipment type
THEN:
- • Equipment is formatted using standard customs reporting format with available information
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment data has been processed and formatted.
Trigger Criteria:
- Context: Equipment data has been processed and formatted
- Applied to: Build Merlin Transmission Lines
- Action: The system builds transmission lines
Logic Flow:
IF Equipment data has been processed and formatted
AND The system builds transmission lines
THEN:
- • Message lines are constructed in Merlin format with proper headers and equipment details
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when all equipment has been processed and transmission lines built.
Trigger Criteria:
- Context: All equipment has been processed and transmission lines built
- Applied to: Format Trip Sheet Data for US Customs
- Action: The system formats the complete trip sheet
Logic Flow:
IF All equipment has been processed and transmission lines built
AND The system formats the complete trip sheet
THEN:
- • Trip sheet data is structured according to US customs specifications with all required fields populated
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when formatted trip sheet message.
Trigger Criteria:
- Context: A formatted trip sheet message
- Applied to: Message Size Check
- Action: The system checks the message size
Logic Flow:
IF A formatted trip sheet message
AND The system checks the message size
THEN:
- • Message is classified as either normal size for direct transmission or large message requiring segmentation
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when trip sheet message exceeds maximum transmission size.
Trigger Criteria:
- Context: A trip sheet message exceeds maximum transmission size
- Applied to: Segment Large Messages
- Action: The system segments the message
Logic Flow:
IF A trip sheet message exceeds maximum transmission size
AND The system segments the message
THEN:
- • Message is divided into multiple segments with proper sequencing and continuation headers
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when trip sheet data is properly formatted and sized for transmission.
Trigger Criteria:
- Context: Trip sheet data is properly formatted and sized for transmission
- Applied to: Transmit via Merlin Communication
- Action: The system initiates transmission via Merlin
Logic Flow:
IF Trip sheet data is properly formatted and sized for transmission
AND The system initiates transmission via Merlin
THEN:
- • Trip sheet data is sent through Merlin communication system to designated US customs recipients
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when trip sheet transmission has been attempted.
Trigger Criteria:
- Context: A trip sheet transmission has been attempted
- Applied to: Transmission Successful?
- Action: The system evaluates the transmission result
Logic Flow:
IF A trip sheet transmission has been attempted
AND The system evaluates the transmission result
THEN:
- • Transmission status is determined as either successful or failed based on system response
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when trip sheet transmission was successful.
Trigger Criteria:
- Context: Trip sheet transmission was successful
- Applied to: Generate Transmission Confirmation
- Action: The system generates confirmation
Logic Flow:
IF Trip sheet transmission was successful
AND The system generates confirmation
THEN:
- • Confirmation message is created indicating successful transmission with timestamp and reference information
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when trip sheet transmission failed.
Trigger Criteria:
- Context: Trip sheet transmission failed
- Applied to: Handle Transmission Error
- Action: The system handles the transmission error
Logic Flow:
IF Trip sheet transmission failed
AND The system handles the transmission error
THEN:
- • Error is logged, appropriate notifications are sent, and retry or alternative delivery methods are initiated
R-GCX146-cbl-00396 File: GCX146.cbl Business Rule: Cargo Arrival Detection
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when cobol code summary is provided for analysis.
Trigger Criteria:
- Context: The COBOL code summary is provided for analysis
- Applied to: Cargo Arrival Detection - Identify cargo arrived at final destination
- Action: Attempting to extract business rules for cargo arrival detection
Logic Flow:
IF The COBOL code summary is provided for analysis
AND Attempting to extract business rules for cargo arrival detection
THEN:
- • No specific implementation details are available to generate business rules
R-GCX146-cbl-00397 (+5) File: GCX146.cbl Business Rule: Cargo Arrival Notification
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when cargo item exists on the train with manifest destination information.
Trigger Criteria:
- Context: A cargo item exists on the train with manifest destination information
- Applied to: Check Cargo Status
- Action: The system processes cargo for arrival notifications
Logic Flow:
IF A cargo item exists on the train with manifest destination information
AND The system processes cargo for arrival notifications
THEN:
- • The cargo is identified for notification if manifest destination matches train destination and is not ocean manifest type
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo exists with manifest from and to station codes.
Trigger Criteria:
- Context: Cargo exists with manifest from and to station codes
- Applied to: Cargo Arrived at Destination?
- Action: The system checks if cargo has arrived at destination
Logic Flow:
IF Cargo exists with manifest from and to station codes
AND The system checks if cargo has arrived at destination
THEN:
- • Cargo is considered arrived if manifest to-station matches current train location and manifest type is not ocean (type 9)
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo has been identified as arrived at destination.
Trigger Criteria:
- Context: Cargo has been identified as arrived at destination
- Applied to: Generate Arrival Notice
- Action: The system generates arrival notice
Logic Flow:
IF Cargo has been identified as arrived at destination
AND The system generates arrival notice
THEN:
- • A GCT1481E transaction is spawned with cargo details including CCN key and arrival information
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when arrival notice transaction has been generated.
Trigger Criteria:
- Context: An arrival notice transaction has been generated
- Applied to: Send Notification
- Action: The system sends the notification
Logic Flow:
IF An arrival notice transaction has been generated
AND The system sends the notification
THEN:
- • The GCT1481E transaction is queued for transmission to customs processing system
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when arrival notification has been sent.
Trigger Criteria:
- Context: An arrival notification has been sent
- Applied to: Log Notification Activity
- Action: The system logs the notification activity
Logic Flow:
IF An arrival notification has been sent
AND The system logs the notification activity
THEN:
- • The spawn counter is incremented and transaction details are recorded for audit purposes
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo exists but has not arrived at destination or is ocean manifest type.
Trigger Criteria:
- Context: Cargo exists but has not arrived at destination or is ocean manifest type
- Applied to: No Action Required
- Action: The system evaluates cargo for arrival processing
Logic Flow:
IF Cargo exists but has not arrived at destination or is ocean manifest type
AND The system evaluates cargo for arrival processing
THEN:
- • No arrival notification is generated and processing continues to next cargo item
R-GCX146-cbl-00403 (+12) File: GCX146.cbl Business Rule: Return CCN Creation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo shipment with origin and destination information.
Trigger Criteria:
- Context: A cargo shipment with origin and destination information
- Applied to: Identify Canadian Goods Returning from US
- Action: The system evaluates the cargo movement pattern
Logic Flow:
IF A cargo shipment with origin and destination information
AND The system evaluates the cargo movement pattern
THEN:
- • The cargo is classified as Canadian goods returning if it originated in Canada and is returning from the US
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when canadian goods returning from us requiring ccn creation.
Trigger Criteria:
- Context: Canadian goods returning from US requiring CCN creation
- Applied to: Build Return CCN Number
- Action: The system builds the return CCN number
Logic Flow:
IF Canadian goods returning from US requiring CCN creation
AND The system builds the return CCN number
THEN:
- • The CCN number is constructed using format: '6' + '105' + 'E' + equipment_id + waybill_date + sequence_number
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when return ccn being created for canadian goods.
Trigger Criteria:
- Context: A return CCN being created for Canadian goods
- Applied to: Set CCN Prefix to '6105E'
- Action: The system sets the CCN prefix
Logic Flow:
IF A return CCN being created for Canadian goods
AND The system sets the CCN prefix
THEN:
- • The CCN prefix is set to '6105E' to identify it as a return customs control number
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when return ccn being constructed with equipment information available.
Trigger Criteria:
- Context: A return CCN being constructed with equipment information available
- Applied to: Append Equipment ID to CCN
- Action: The system appends the equipment ID to the CCN
Logic Flow:
IF A return CCN being constructed with equipment information available
AND The system appends the equipment ID to the CCN
THEN:
- • The equipment ID is included in the CCN number to ensure unique identification per equipment piece
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when return ccn being created with associated waybill information.
Trigger Criteria:
- Context: A return CCN being created with associated waybill information
- Applied to: Append Waybill Date to CCN
- Action: The system appends the waybill date to the CCN
Logic Flow:
IF A return CCN being created with associated waybill information
AND The system appends the waybill date to the CCN
THEN:
- • The waybill date is included in the CCN number to provide temporal context and ensure uniqueness
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn being created for canadian goods returning from us.
Trigger Criteria:
- Context: A CCN being created for Canadian goods returning from US
- Applied to: Set CCN Status to 'RETURN'
- Action: The system sets the CCN status
Logic Flow:
IF A CCN being created for Canadian goods returning from US
AND The system sets the CCN status
THEN:
- • The CCN status is set to 'RETURN' to indicate the cargo is returning to Canada
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when return ccn being created with status information.
Trigger Criteria:
- Context: A return CCN being created with status information
- Applied to: Set Transit Status to 'R'
- Action: The system sets the transit status
Logic Flow:
IF A return CCN being created with status information
AND The system sets the transit status
THEN:
- • The transit status is set to 'R' to indicate return movement
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when return ccn being created with available waybill data containing shipper information.
Trigger Criteria:
- Context: A return CCN being created with available waybill data containing shipper information
- Applied to: Populate Shipper Information from Waybill
- Action: The system populates shipper information
Logic Flow:
IF A return CCN being created with available waybill data containing shipper information
AND The system populates shipper information
THEN:
- • Shipper name, address, and other relevant details are extracted from the waybill and stored in the CCN record
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when return ccn being created with available waybill data containing consignee information.
Trigger Criteria:
- Context: A return CCN being created with available waybill data containing consignee information
- Applied to: Populate Consignee Information from Waybill
- Action: The system populates consignee information
Logic Flow:
IF A return CCN being created with available waybill data containing consignee information
AND The system populates consignee information
THEN:
- • Consignee name, address, and other relevant details are extracted from the waybill and stored in the CCN record
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when all return ccn information has been populated and validated.
Trigger Criteria:
- Context: All return CCN information has been populated and validated
- Applied to: Insert Return CCN Record
- Action: The system inserts the return CCN record
Logic Flow:
IF All return CCN information has been populated and validated
AND The system inserts the return CCN record
THEN:
- • A new CCN record is created in the customs database with all populated information and return status
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when return ccn record insertion has been attempted.
Trigger Criteria:
- Context: A return CCN record insertion has been attempted
- Applied to: CCN Creation Successful?
- Action: The system checks the creation result
Logic Flow:
IF A return CCN record insertion has been attempted
AND The system checks the creation result
THEN:
- • If the CCN record was successfully created, the process continues with success confirmation,
otherwise error handling is initiated
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when return ccn record has been successfully inserted into the database.
Trigger Criteria:
- Context: A return CCN record has been successfully inserted into the database
- Applied to: Return CCN Created Successfully
- Action: The system processes the successful creation
Logic Flow:
IF A return CCN record has been successfully inserted into the database
AND The system processes the successful creation
THEN:
- • The return CCN creation is marked as complete and the process proceeds to completion
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when error occurred during return ccn record creation.
Trigger Criteria:
- Context: An error occurred during return CCN record creation
- Applied to: Handle CCN Creation Error
- Action: The system handles the CCN creation error
Logic Flow:
IF An error occurred during return CCN record creation
AND The system handles the CCN creation error
THEN:
- • Appropriate error logging and recovery procedures are executed to manage the failed CCN creation
R-GCX146-cbl-00416 (+12) File: GCX146.cbl Business Rule: Broker Notification Processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn key starts with '6105' and cargo type is not 'i' and current status is not 'return' or 'manual'.
Trigger Criteria:
- Context: A CCN key starts with '6105' and cargo type is not 'I' and current status is not 'RETURN' or 'MANUAL'
- Applied to: Primary Broker Notification
- Action: The system processes broker notifications for the cargo
Logic Flow:
IF A CCN key starts with '6105' and cargo type is not 'I' and current status is not 'RETURN' or 'MANUAL'
AND The system processes broker notifications for the cargo
THEN:
- • The system should send notifications to the primary broker using their configured communication channels
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when primary broker notification has been processed and a secondary broker is configured for the cargo.
Trigger Criteria:
- Context: Primary broker notification has been processed and a secondary broker is configured for the cargo
- Applied to: Secondary Broker Notification
- Action: The system continues broker notification processing
Logic Flow:
IF Primary broker notification has been processed and a secondary broker is configured for the cargo
AND The system continues broker notification processing
THEN:
- • The system should send notifications to the secondary broker using their configured communication channels
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when broker notification needs to be sent and broker configuration exists.
Trigger Criteria:
- Context: A broker notification needs to be sent and broker configuration exists
- Applied to: X12 EDI Channel Available?
- Action: The system evaluates available communication channels
Logic Flow:
IF A broker notification needs to be sent and broker configuration exists
AND The system evaluates available communication channels
THEN:
- • The system should use X12 EDI channel if the broker has X12 EDI capability configured
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when x12 edi channel is available and selected for broker notification.
Trigger Criteria:
- Context: X12 EDI channel is available and selected for broker notification
- Applied to: Send X12 EDI Notification via GCCS309C
- Action: The system processes the notification transmission
Logic Flow:
IF X12 EDI channel is available and selected for broker notification
AND The system processes the notification transmission
THEN:
- • The system should invoke GCCS309C to send the notification in X12 EDI format to the broker
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when x12 edi channel processing is complete and broker configuration exists.
Trigger Criteria:
- Context: X12 EDI channel processing is complete and broker configuration exists
- Applied to: Merlin Channel Available?
- Action: The system evaluates remaining communication channels
Logic Flow:
IF X12 EDI channel processing is complete and broker configuration exists
AND The system evaluates remaining communication channels
THEN:
- • The system should use Merlin channel if the broker has Merlin communication capability configured
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when merlin channel is available and selected for broker notification.
Trigger Criteria:
- Context: Merlin channel is available and selected for broker notification
- Applied to: Send Merlin Notification via GCX019
- Action: The system processes the notification transmission
Logic Flow:
IF Merlin channel is available and selected for broker notification
AND The system processes the notification transmission
THEN:
- • The system should invoke GCX019 to send the notification through Merlin system to the broker
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when merlin channel processing is complete and broker configuration exists.
Trigger Criteria:
- Context: Merlin channel processing is complete and broker configuration exists
- Applied to: Internet Channel Available?
- Action: The system evaluates remaining communication channels
Logic Flow:
IF Merlin channel processing is complete and broker configuration exists
AND The system evaluates remaining communication channels
THEN:
- • The system should use Internet channel if the broker has Internet communication capability configured
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when internet channel is available and selected for broker notification.
Trigger Criteria:
- Context: Internet channel is available and selected for broker notification
- Applied to: Send Internet Notification via GCX019
- Action: The system processes the notification transmission
Logic Flow:
IF Internet channel is available and selected for broker notification
AND The system processes the notification transmission
THEN:
- • The system should invoke GCX019 to send the notification via Internet to the broker
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when internet channel processing is complete and broker configuration exists.
Trigger Criteria:
- Context: Internet channel processing is complete and broker configuration exists
- Applied to: FAX Channel Available?
- Action: The system evaluates remaining communication channels
Logic Flow:
IF Internet channel processing is complete and broker configuration exists
AND The system evaluates remaining communication channels
THEN:
- • The system should use FAX channel if the broker has FAX communication capability configured
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when fax channel is available and selected for broker notification.
Trigger Criteria:
- Context: FAX channel is available and selected for broker notification
- Applied to: Send FAX Notification via GCX019
- Action: The system processes the notification transmission
Logic Flow:
IF FAX channel is available and selected for broker notification
AND The system processes the notification transmission
THEN:
- • The system should invoke GCX019 to send the notification via FAX to the broker
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when fax channel processing is complete and broker configuration exists.
Trigger Criteria:
- Context: FAX channel processing is complete and broker configuration exists
- Applied to: Paper Channel Available?
- Action: The system evaluates remaining communication channels
Logic Flow:
IF FAX channel processing is complete and broker configuration exists
AND The system evaluates remaining communication channels
THEN:
- • The system should use Paper channel if the broker has Paper communication capability configured
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when paper channel is available and selected for broker notification. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Paper channel is available and selected for broker notification
- Applied to: Send Paper Notification via Batch Print Call Letters
- Action: The system processes the notification generation
Logic Flow:
IF Paper channel is available and selected for broker notification
AND The system processes the notification generation
THEN:
- • The system should generate paper notification through batch print call letters system for the broker
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all configured communication channels have been processed for broker notification.
Trigger Criteria:
- Context: All configured communication channels have been processed for broker notification
- Applied to: Multi-Channel Distribution Complete
- Action: The system completes the distribution process
Logic Flow:
IF All configured communication channels have been processed for broker notification
AND The system completes the distribution process
THEN:
- • The system should mark the multi-channel distribution as complete and proceed to finalize broker notification processing
R-GCX146-cbl-00429 (+19) File: GCX146.cbl Business Rule: US Customs Status Processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when request to process us customs status for equipment.
Trigger Criteria:
- Context: A request to process US customs status for equipment
- Applied to: Access GCSUSRT Database
- Action: The system accesses the GCSUSRT database using equipment information
Logic Flow:
IF A request to process US customs status for equipment
AND The system accesses the GCSUSRT database using equipment information
THEN:
- • The system retrieves the corresponding US route record if it exists
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when system has attempted to retrieve a us route record from gcsusrt database.
Trigger Criteria:
- Context: The system has attempted to retrieve a US route record from GCSUSRT database
- Applied to: US Route Record Found?
- Action: The database lookup is completed
Logic Flow:
IF The system has attempted to retrieve a US route record from GCSUSRT database
AND The database lookup is completed
THEN:
- • The system determines if a valid US route record was found and proceeds with appropriate processing path
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when valid us route record has been found in the gcsusrt database.
Trigger Criteria:
- Context: A valid US route record has been found in the GCSUSRT database
- Applied to: Extract Bond Type Information
- Action: The system processes the route record
Logic Flow:
IF A valid US route record has been found in the GCSUSRT database
AND The system processes the route record
THEN:
- • The system extracts bond type, cargo status, vessel information, and location data from the record
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when bond type information has been extracted from the us route record.
Trigger Criteria:
- Context: Bond type information has been extracted from the US route record
- Applied to: Validate Bond Type
- Action: The system validates the bond type
Logic Flow:
IF Bond type information has been extracted from the US route record
AND The system validates the bond type
THEN:
- • The system confirms the bond type is valid for further processing or flags it as invalid
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when valid bond type has been identified from the us route record.
Trigger Criteria:
- Context: A valid bond type has been identified from the US route record
- Applied to: IT/TR/TE/MT
- Action: The bond type is IT (In-Transit), TR (Transportation), TE (Temporary Export), or MT (Merchandise Transfer)
Logic Flow:
IF A valid bond type has been identified from the US route record
AND The bond type is IT (In-Transit), TR (Transportation), TE (Temporary Export), or MT (Merchandise Transfer)
THEN:
- • The system applies specific processing rules and validations appropriate for each bond type
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when bond type information has been processed.
Trigger Criteria:
- Context: Bond type information has been processed
- Applied to: Validate In-Transit Status
- Action: The system checks the cargo's in-transit status
Logic Flow:
IF Bond type information has been processed
AND The system checks the cargo's in-transit status
THEN:
- • The system validates whether the cargo is properly documented as in-transit or not
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when in-transit status has been validated.
Trigger Criteria:
- Context: The in-transit status has been validated
- Applied to: Cargo In-Transit?
- Action: The system evaluates the cargo's current transit state
Logic Flow:
IF The in-transit status has been validated
AND The system evaluates the cargo's current transit state
THEN:
- • The system determines if the cargo is in-transit and routes processing accordingly
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has been determined to be in-transit.
Trigger Criteria:
- Context: Cargo has been determined to be in-transit
- Applied to: Validate Location Information
- Action: The system validates location information from the US route record
Logic Flow:
IF Cargo has been determined to be in-transit
AND The system validates location information from the US route record
THEN:
- • The system confirms location data is accurate and complete for customs processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when location information has been validated for in-transit cargo.
Trigger Criteria:
- Context: Location information has been validated for in-transit cargo
- Applied to: Location Valid?
- Action: The system evaluates location validity
Logic Flow:
IF Location information has been validated for in-transit cargo
AND The system evaluates location validity
THEN:
- • The system determines if location information is valid and proceeds with appropriate processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when valid location information has been confirmed.
Trigger Criteria:
- Context: Valid location information has been confirmed
- Applied to: Check Vessel Name
- Action: The system checks the vessel name in the US route record
Logic Flow:
IF Valid location information has been confirmed
AND The system checks the vessel name in the US route record
THEN:
- • The system validates the vessel name for transportation mode consistency
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when vessel name has been validated from the us route record.
Trigger Criteria:
- Context: Vessel name has been validated from the US route record
- Applied to: Vessel = 'TRAIN'?
- Action: The system checks if the vessel name equals 'TRAIN'
Logic Flow:
IF Vessel name has been validated from the US route record
AND The system checks if the vessel name equals 'TRAIN'
THEN:
- • The system determines the transportation mode and applies train-specific or other vessel processing rules
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when vessel has been identified as 'train'.
Trigger Criteria:
- Context: The vessel has been identified as 'TRAIN'
- Applied to: Generate Train-Specific Status
- Action: The system generates customs status
Logic Flow:
IF The vessel has been identified as 'TRAIN'
AND The system generates customs status
THEN:
- • The system creates train-specific status information with appropriate customs codes and descriptions
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when vessel has been identified as something other than 'train'.
Trigger Criteria:
- Context: The vessel has been identified as something other than 'TRAIN'
- Applied to: Generate Other Vessel Status
- Action: The system generates customs status
Logic Flow:
IF The vessel has been identified as something other than 'TRAIN'
AND The system generates customs status
THEN:
- • The system creates vessel-specific status information appropriate for the transportation mode
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when vessel-specific status has been generated.
Trigger Criteria:
- Context: Vessel-specific status has been generated
- Applied to: Check Cargo Conditions
- Action: The system checks cargo conditions from the US route record
Logic Flow:
IF Vessel-specific status has been generated
AND The system checks cargo conditions from the US route record
THEN:
- • The system evaluates conditions such as bond dates, cargo types, and special requirements
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo conditions have been assessed.
Trigger Criteria:
- Context: Cargo conditions have been assessed
- Applied to: Special Conditions?
- Action: The system evaluates for special conditions such as IT bond warnings, vessel mismatches, or date discrepancies
Logic Flow:
IF Cargo conditions have been assessed
AND The system evaluates for special conditions such as IT bond warnings, vessel mismatches, or date discrepancies
THEN:
- • The system determines if special conditions exist and routes to appropriate warning generation or normal processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when special conditions have been detected in the cargo.
Trigger Criteria:
- Context: Special conditions have been detected in the cargo
- Applied to: Generate Warning Messages
- Action: The system generates warning messages
Logic Flow:
IF Special conditions have been detected in the cargo
AND The system generates warning messages
THEN:
- • The system creates appropriate warning messages for conditions such as IT bond type warnings, train vessel warnings, location mismatches, or TIB date warnings
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when all cargo conditions have been processed and any necessary warnings generated.
Trigger Criteria:
- Context: All cargo conditions have been processed and any necessary warnings generated
- Applied to: Set US Customs Status
- Action: The system sets the US customs status
Logic Flow:
IF All cargo conditions have been processed and any necessary warnings generated
AND The system sets the US customs status
THEN:
- • The system assigns the appropriate customs status reflecting the cargo's current state and compliance requirements
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when us customs status has been set.
Trigger Criteria:
- Context: The US customs status has been set
- Applied to: Update Status Information
- Action: The system updates status information
Logic Flow:
IF The US customs status has been set
AND The system updates status information
THEN:
- • The system records the customs status, warning messages, and related information in the equipment record for reporting and further processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when invalid bond type, location information, or other critical data has been detected.
Trigger Criteria:
- Context: Invalid bond type, location information, or other critical data has been detected
- Applied to: Generate Error Message
- Action: The system encounters validation failures
Logic Flow:
IF Invalid bond type, location information, or other critical data has been detected
AND The system encounters validation failures
THEN:
- • The system generates appropriate error messages indicating the specific validation failure
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when no us route record was found or validation errors occurred.
Trigger Criteria:
- Context: No US route record was found or validation errors occurred
- Applied to: Set Default Status
- Action: The system needs to assign a status
Logic Flow:
IF No US route record was found or validation errors occurred
AND The system needs to assign a status
THEN:
- • The system sets a default status indicating no US customs information is available
R-GCX146-cbl-00449 (+6) File: GCX146.cbl Business Rule: Special Manifest Processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when special manifest processing request is initiated.
Trigger Criteria:
- Context: A special manifest processing request is initiated
- Applied to: Set Security Byte to HIGH-VALUES
- Action: The system begins special manifest creation
Logic Flow:
IF A special manifest processing request is initiated
AND The system begins special manifest creation
THEN:
- • The security byte must be set to HIGH-VALUES to ensure maximum security level
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when special manifest is being created for canadian customs processing.
Trigger Criteria:
- Context: A special manifest is being created for Canadian customs processing
- Applied to: Set Record Type Code to 'CA'
- Action: The system sets the record type for the manifest
Logic Flow:
IF A special manifest is being created for Canadian customs processing
AND The system sets the record type for the manifest
THEN:
- • The record type code must be set to 'CA' to identify it as a Canadian manifest
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when train data exists in gcwb4tl with border information.
Trigger Criteria:
- Context: Train data exists in GCWB4TL with border information
- Applied to: Extract Border Information from GCWB4TL
- Action: Special manifest processing requires border details
Logic Flow:
IF Train data exists in GCWB4TL with border information
AND Special manifest processing requires border details
THEN:
- • The system must extract border code and station name from the train data
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when special manifest transaction is being created.
Trigger Criteria:
- Context: A special manifest transaction is being created
- Applied to: Increment Spawn Counter
- Action: The system processes the manifest creation
Logic Flow:
IF A special manifest transaction is being created
AND The system processes the manifest creation
THEN:
- • The spawn counter must be incremented by 1 to track the transaction
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn key exists for the cargo being processed.
Trigger Criteria:
- Context: A CCN key exists for the cargo being processed
- Applied to: Store CCN Key in Special Manifest
- Action: A special manifest is being created
Logic Flow:
IF A CCN key exists for the cargo being processed
AND A special manifest is being created
THEN:
- • The CCN key must be stored in the special manifest record for cargo identification
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when border information, ccn key, and record type are available.
Trigger Criteria:
- Context: Border information, CCN key, and record type are available
- Applied to: Build Special Manifest Input
- Action: The system builds the special manifest input structure
Logic Flow:
IF Border information, CCN key, and record type are available
AND The system builds the special manifest input structure
THEN:
- • All required data elements must be assembled into the proper input format for manifest processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when complete special manifest input structure is built.
Trigger Criteria:
- Context: A complete special manifest input structure is built
- Applied to: Queue Special Manifest Transaction
- Action: The system processes the special manifest
Logic Flow:
IF A complete special manifest input structure is built
AND The system processes the special manifest
THEN:
- • The transaction must be queued for subsequent processing
R-GCX146-cbl-00456 (+6) File: GCX146.cbl Business Rule: CCN Usability Validation
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn usability validation is requested for specific equipment.
Trigger Criteria:
- Context: A CCN usability validation is requested for specific equipment
- Applied to: Search GCCCRT Database
- Action: The system searches the GCCCRT database using equipment ID and waybill key
Logic Flow:
IF A CCN usability validation is requested for specific equipment
AND The system searches the GCCCRT database using equipment ID and waybill key
THEN:
- • The system retrieves CCN records matching the search criteria
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when search has been performed in the gcccrt database.
Trigger Criteria:
- Context: A search has been performed in the GCCCRT database
- Applied to: CCN Record Found?
- Action: The system evaluates the search results
Logic Flow:
IF A search has been performed in the GCCCRT database
AND The system evaluates the search results
THEN:
- • If a CCN record is found, proceed to bond creation flag check,
otherwise continue processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn record exists for the equipment.
Trigger Criteria:
- Context: A CCN record exists for the equipment
- Applied to: Bond Created Flag = 'Y'?
- Action: The system checks the bond creation flag value
Logic Flow:
IF A CCN record exists for the equipment
AND The system checks the bond creation flag value
THEN:
- • If bond created flag equals 'Y', mark CCN as not usable,
otherwise mark CCN as usable
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn record exists and bond created flag equals 'y'.
Trigger Criteria:
- Context: A CCN record exists and bond created flag equals 'Y'
- Applied to: CCN is Not Usable
- Action: The system evaluates CCN usability
Logic Flow:
IF A CCN record exists and bond created flag equals 'Y'
AND The system evaluates CCN usability
THEN:
- • The CCN is marked as not usable for train processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn record exists and bond created flag does not equal 'y'.
Trigger Criteria:
- Context: A CCN record exists and bond created flag does not equal 'Y'
- Applied to: CCN is Usable
- Action: The system evaluates CCN usability
Logic Flow:
IF A CCN record exists and bond created flag does not equal 'Y'
AND The system evaluates CCN usability
THEN:
- • The CCN is marked as usable for train processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn is marked as not usable and request type is verify.
Trigger Criteria:
- Context: CCN is marked as not usable and request type is VERIFY
- Applied to: Add 'CCN FOUND NOT USABLE' Status Message
- Action: The system processes the unusable CCN for VERIFY operation
Logic Flow:
IF CCN is marked as not usable and request type is VERIFY
AND The system processes the unusable CCN for VERIFY operation
THEN:
- • The system adds 'CCN FOUND NOT USABLE' status message to the response
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn has been determined as not usable.
Trigger Criteria:
- Context: CCN has been determined as not usable
- Applied to: Request Type = VERIFY?
- Action: The system checks the request type
Logic Flow:
IF CCN has been determined as not usable
AND The system checks the request type
THEN:
- • If request type is VERIFY, add status message,
otherwise continue processing without message
R-GCX146-cbl-00463 (+11) File: GCX146.cbl Business Rule: Customer Report Generation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when customer report generation request is initiated.
Trigger Criteria:
- Context: A customer report generation request is initiated
- Applied to: Initialize Customer Report Message
- Action: The system begins customer report processing
Logic Flow:
IF A customer report generation request is initiated
AND The system begins customer report processing
THEN:
- • The customer report message structure is initialized with default values and proper message formatting
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when customer report message is being prepared.
Trigger Criteria:
- Context: A customer report message is being prepared
- Applied to: Set Report Format to GCT1401E
- Action: The system configures the report format
Logic Flow:
IF A customer report message is being prepared
AND The system configures the report format
THEN:
- • The report format is set to GCT1401E transaction type for customer advice processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when customer report is ready for distribution.
Trigger Criteria:
- Context: A customer report is ready for distribution
- Applied to: Configure Message Queue Routing
- Action: The system configures message queue routing
Logic Flow:
IF A customer report is ready for distribution
AND The system configures message queue routing
THEN:
- • The message routing is configured to use ALT-PCB2 queue for proper customer report delivery
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when customer report content is available in gcx140-input data structure.
Trigger Criteria:
- Context: Customer report content is available in GCX140-INPUT data structure
- Applied to: Move Report Content to Message Buffer
- Action: The system prepares the report for transmission
Logic Flow:
IF Customer report content is available in GCX140-INPUT data structure
AND The system prepares the report for transmission
THEN:
- • The report content is moved to the message buffer for processing and distribution
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when customer report message is prepared in the message buffer.
Trigger Criteria:
- Context: Customer report message is prepared in the message buffer
- Applied to: Execute CIMS CHNG Operation
- Action: The system executes CIMS change operation
Logic Flow:
IF Customer report message is prepared in the message buffer
AND The system executes CIMS change operation
THEN:
- • The CIMS CHNG operation is performed to process the customer report message
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when cims change operation has been executed for customer report.
Trigger Criteria:
- Context: CIMS change operation has been executed for customer report
- Applied to: CHNG Successful?
- Action: The system checks the operation result
Logic Flow:
IF CIMS change operation has been executed for customer report
AND The system checks the operation result
THEN:
- • If CIMS change operation is successful, proceed to write message;
otherwise handle error
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when cims change operation completed successfully.
Trigger Criteria:
- Context: CIMS change operation completed successfully
- Applied to: Execute WRITMSGL Operation
- Action: The system executes write message operation
Logic Flow:
IF CIMS change operation completed successfully
AND The system executes write message operation
THEN:
- • The WRITMSGL operation is performed to send the customer report message
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when write message operation has been executed for customer report.
Trigger Criteria:
- Context: Write message operation has been executed for customer report
- Applied to: Write Successful?
- Action: The system checks the write operation result
Logic Flow:
IF Write message operation has been executed for customer report
AND The system checks the write operation result
THEN:
- • If write operation is successful, proceed to purge operation;
otherwise handle error
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when customer report message has been successfully written to queue.
Trigger Criteria:
- Context: Customer report message has been successfully written to queue
- Applied to: Execute PURG Operation
- Action: The system executes purge operation
Logic Flow:
IF Customer report message has been successfully written to queue
AND The system executes purge operation
THEN:
- • The PURG operation is performed to clean up the message queue
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when purge operation has been executed for customer report message.
Trigger Criteria:
- Context: Purge operation has been executed for customer report message
- Applied to: Purge Successful?
- Action: The system checks the purge operation result
Logic Flow:
IF Purge operation has been executed for customer report message
AND The system checks the purge operation result
THEN:
- • If purge operation is successful, customer report generation is complete;
otherwise handle error
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when all customer report operations (chng, writmsgl, purg) have completed successfully.
Trigger Criteria:
- Context: All customer report operations (CHNG, WRITMSGL, PURG) have completed successfully
- Applied to: Customer Report Generated Successfully
- Action: The system finalizes the customer report generation process
Logic Flow:
IF All customer report operations (CHNG, WRITMSGL, PURG) have completed successfully
AND The system finalizes the customer report generation process
THEN:
- • The customer report is marked as successfully generated and distributed
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when error occurs during customer report generation (chng, writmsgl, or purg operation fails).
Trigger Criteria:
- Context: An error occurs during customer report generation (CHNG, WRITMSGL, or PURG operation fails)
- Applied to: Handle Report Generation Error
- Action: The system detects the error condition
Logic Flow:
IF An error occurs during customer report generation (CHNG, WRITMSGL, or PURG operation fails)
AND The system detects the error condition
THEN:
- • The error is handled appropriately and the customer report generation process is terminated
R-GCX146-cbl-00475 (+2) File: GCX146.cbl Business Rule: Audit Trail Logging
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo processing activity has occurred that requires audit logging.
Trigger Criteria:
- Context: A cargo processing activity has occurred that requires audit logging
- Applied to: Create Audit Record
- Action: The system needs to create an audit trail record
Logic Flow:
IF A cargo processing activity has occurred that requires audit logging
AND The system needs to create an audit trail record
THEN:
- • The system spawns a GCT1051E audit transaction using the GCX105-INPUT data structure and handles the transaction queuing process
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when audit trail record needs to be created for a cargo processing activity.
Trigger Criteria:
- Context: An audit trail record needs to be created for a cargo processing activity
- Applied to: Capture Transaction Details
- Action: The system prepares to log the audit information
Logic Flow:
IF An audit trail record needs to be created for a cargo processing activity
AND The system prepares to log the audit information
THEN:
- • The system populates the GCX105-INPUT structure with transaction details including user information, timestamps, and activity data
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when audit transaction has been spawned successfully.
Trigger Criteria:
- Context: An audit transaction has been spawned successfully
- Applied to: Store Audit Trail
- Action: The audit record creation process needs to be completed
Logic Flow:
IF An audit transaction has been spawned successfully
AND The audit record creation process needs to be completed
THEN:
- • The system handles message queuing operations and purges completed audit transactions to finalize the audit trail storage
R-GCX146-cbl-00478 (+9) File: GCX146.cbl Business Rule: ETA Date Range Validation by User Type
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when user is processing a train with eta information.
Trigger Criteria:
- Context: A user is processing a train with ETA information
- Applied to: Check User Access Level from GCSTBRT-US-CTF-ADD
- Action: The system needs to validate ETA date ranges
Logic Flow:
IF A user is processing a train with ETA information
AND The system needs to validate ETA date ranges
THEN:
- • The user access level is retrieved from GCSTBRT user configuration to determine validation parameters
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when user access level has been retrieved from gcstbrt configuration.
Trigger Criteria:
- Context: User access level has been retrieved from GCSTBRT configuration
- Applied to: User Type = 'S' Special User?
- Action: The system checks if GCSTBRT-US-CTF-ADD equals 'S'
Logic Flow:
IF User access level has been retrieved from GCSTBRT configuration
AND The system checks if GCSTBRT-US-CTF-ADD equals 'S'
THEN:
- • User is classified as Special User with extended ETA date range privileges
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when user is classified as standard user (ctf add access level is not 's').
Trigger Criteria:
- Context: User is classified as Standard User (CTF ADD access level is not 'S')
- Applied to: Apply Standard User Range -2 to +2 days from current date
- Action: ETA date validation is performed
Logic Flow:
IF User is classified as Standard User (CTF ADD access level is not 'S')
AND ETA date validation is performed
THEN:
- • ETA date must fall between 2 days before current date and 2 days after current date
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when user is classified as special user (ctf add access level equals 's').
Trigger Criteria:
- Context: User is classified as Special User (CTF ADD access level equals 'S')
- Applied to: Apply Special User Range -30 to +5 days from current date
- Action: ETA date validation is performed
Logic Flow:
IF User is classified as Special User (CTF ADD access level equals 'S')
AND ETA date validation is performed
THEN:
- • ETA date must fall between 30 days before current date and 5 days after current date
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when eta date has been provided for validation.
Trigger Criteria:
- Context: An ETA date has been provided for validation
- Applied to: Validate ETA Date using ISDATECV
- Action: Date format validation is performed using ISDATECV utility
Logic Flow:
IF An ETA date has been provided for validation
AND Date format validation is performed using ISDATECV utility
THEN:
- • ETA date must be in valid date format and represent an actual calendar date
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when eta date format is valid and user-specific date range has been determined.
Trigger Criteria:
- Context: ETA date format is valid and user-specific date range has been determined
- Applied to: ETA Date within allowed range?
- Action: Date range validation is performed
Logic Flow:
IF ETA date format is valid and user-specific date range has been determined
AND Date range validation is performed
THEN:
- • ETA date must fall within the calculated minimum and maximum allowed dates for the user type
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when eta time has been provided along with valid eta date.
Trigger Criteria:
- Context: An ETA time has been provided along with valid ETA date
- Applied to: MM
- Action: Time format validation is performed
Logic Flow:
IF An ETA time has been provided along with valid ETA date
AND Time format validation is performed
THEN:
- • ETA time must be in HH:MM format where HH represents hours and MM represents minutes
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when eta time is in proper hh:mm format.
Trigger Criteria:
- Context: ETA time is in proper HH:MM format
- Applied to: Time within valid range?
- Action: Time range validation is performed
Logic Flow:
IF ETA time is in proper HH:MM format
AND Time range validation is performed
THEN:
- • Hours must be between 00-23 and minutes must be between 00-59
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when user is standard user and eta date is outside -2 to +2 days range.
Trigger Criteria:
- Context: User is Standard User and ETA date is outside -2 to +2 days range
- Applied to: Generate Error 35 Standard User Date Out of Range
- Action: Date range validation fails for standard user
Logic Flow:
IF User is Standard User and ETA date is outside -2 to +2 days range
AND Date range validation fails for standard user
THEN:
- • Error 35 is generated indicating date is out of range for standard user privileges
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when user is special user and eta date is outside -30 to +5 days range.
Trigger Criteria:
- Context: User is Special User and ETA date is outside -30 to +5 days range
- Applied to: Generate Error 25 Special User Date Out of Range
- Action: Date range validation fails for special user
Logic Flow:
IF User is Special User and ETA date is outside -30 to +5 days range
AND Date range validation fails for special user
THEN:
- • Error 25 is generated indicating date is out of range even for special user privileges
R-GCX146-cbl-00488 (+8) File: GCX146.cbl Business Rule: Train Record Deletion Processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when train record deletion process is initiated.
Trigger Criteria:
- Context: A train record deletion process is initiated
- Applied to: Retrieve Existing Train Record
- Action: The system attempts to retrieve an existing train record from the database
Logic Flow:
IF A train record deletion process is initiated
AND The system attempts to retrieve an existing train record from the database
THEN:
- • The system determines whether the train record exists or not
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when train record exists in the database.
Trigger Criteria:
- Context: A train record exists in the database
- Applied to: Check Record Status
- Action: The system checks the record status
Logic Flow:
IF A train record exists in the database
AND The system checks the record status
THEN:
- • The system identifies whether the record is marked as deleted or active
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when train record is marked as deleted.
Trigger Criteria:
- Context: A train record is marked as deleted
- Applied to: Confirm Deletion Authorization
- Action: The system confirms deletion authorization
Logic Flow:
IF A train record is marked as deleted
AND The system confirms deletion authorization
THEN:
- • The system either grants or denies deletion permission based on authorization rules
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when deletion is authorized for a train record.
Trigger Criteria:
- Context: Deletion is authorized for a train record
- Applied to: Delete Existing Train Record
- Action: The system executes the deletion operation
Logic Flow:
IF Deletion is authorized for a train record
AND The system executes the deletion operation
THEN:
- • The train record is permanently removed from the database
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when train record deletion operation has been executed.
Trigger Criteria:
- Context: A train record deletion operation has been executed
- Applied to: Deletion Successful?
- Action: The system checks the deletion result
Logic Flow:
IF A train record deletion operation has been executed
AND The system checks the deletion result
THEN:
- • The system confirms whether the deletion was successful or failed
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when train record has been successfully deleted.
Trigger Criteria:
- Context: A train record has been successfully deleted
- Applied to: Log Deletion Activity
- Action: The system logs the deletion activity
Logic Flow:
IF A train record has been successfully deleted
AND The system logs the deletion activity
THEN:
- • An audit trail entry is created with deletion details and timestamp
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when train record exists but is not marked as deleted.
Trigger Criteria:
- Context: A train record exists but is not marked as deleted
- Applied to: Skip Deletion - Record Not Deleted
- Action: The system processes the record status
Logic Flow:
IF A train record exists but is not marked as deleted
AND The system processes the record status
THEN:
- • The deletion process is skipped and processing continues to new record creation
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when train record deletion operation has failed.
Trigger Criteria:
- Context: A train record deletion operation has failed
- Applied to: Deletion Error - Abort Process
- Action: The system detects the deletion error
Logic Flow:
IF A train record deletion operation has failed
AND The system detects the deletion error
THEN:
- • The entire train processing operation is aborted and error handling is initiated
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when train record is marked for deletion but authorization is denied.
Trigger Criteria:
- Context: A train record is marked for deletion but authorization is denied
- Applied to: Authorization Failed - Skip Deletion
- Action: The system processes the authorization failure
Logic Flow:
IF A train record is marked for deletion but authorization is denied
AND The system processes the authorization failure
THEN:
- • The deletion is skipped and processing continues to new record creation
R-GCX146-cbl-00497 (+6) File: GCX146.cbl Business Rule: Equipment Type Determination
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment record with equipment id and type code is available. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: An equipment record with equipment ID and type code is available
- Applied to: Call GCCCARTP Module
- Action: The system needs to classify the equipment type
Logic Flow:
IF An equipment record with equipment ID and type code is available
AND The system needs to classify the equipment type
THEN:
- • The GCCCARTP module is called to determine equipment classification
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment has been processed by gcccartp module.
Trigger Criteria:
- Context: Equipment has been processed by GCCCARTP module
- Applied to: Set as Container Type
- Action: The module classifies the equipment as container type
Logic Flow:
IF Equipment has been processed by GCCCARTP module
AND The module classifies the equipment as container type
THEN:
- • The system sets the equipment type as container for processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment has been processed by gcccartp module.
Trigger Criteria:
- Context: Equipment has been processed by GCCCARTP module
- Applied to: Set as Trailer Type
- Action: The module classifies the equipment as trailer type
Logic Flow:
IF Equipment has been processed by GCCCARTP module
AND The module classifies the equipment as trailer type
THEN:
- • The system sets the equipment type as trailer for processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment has been processed by gcccartp module.
Trigger Criteria:
- Context: Equipment has been processed by GCCCARTP module
- Applied to: Set as Car Type
- Action: The module classifies the equipment as car type
Logic Flow:
IF Equipment has been processed by GCCCARTP module
AND The module classifies the equipment as car type
THEN:
- • The system sets the equipment type as car for processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has been classified as car type.
Trigger Criteria:
- Context: Equipment has been classified as car type
- Applied to: Retrieve Car Type Description from VI Segment
- Action: The system needs car type description information
Logic Flow:
IF Equipment has been classified as car type
AND The system needs car type description information
THEN:
- • The car type description is retrieved from the VI segment using the car type code
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment type has been determined as container, trailer, or car.
Trigger Criteria:
- Context: Equipment type has been determined as container, trailer, or car
- Applied to: Assign Equipment Type Code for Processing
- Action: The system needs to assign processing type code
Logic Flow:
IF Equipment type has been determined as container, trailer, or car
AND The system needs to assign processing type code
THEN:
- • The appropriate equipment type code is assigned based on the classification
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment type code has been assigned.
Trigger Criteria:
- Context: Equipment type code has been assigned
- Applied to: Set Processing Requirements Based on Type
- Action: The system needs to establish processing requirements
Logic Flow:
IF Equipment type code has been assigned
AND The system needs to establish processing requirements
THEN:
- • Processing requirements are set according to the specific equipment type (container, trailer, or car)
R-GCX146-cbl-00504 (+13) File: GCX146.cbl Business Rule: Flat Car Container Processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when flat car equipment type is being processed for train manifest.
Trigger Criteria:
- Context: A flat car equipment type is being processed for train manifest
- Applied to: Access Container Records on Flat Car
- Action: The system needs to identify containers loaded on the flat car
Logic Flow:
IF A flat car equipment type is being processed for train manifest
AND The system needs to identify containers loaded on the flat car
THEN:
- • The system accesses container records from the flat car's equipment data
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container records are being accessed for a flat car.
Trigger Criteria:
- Context: Container records are being accessed for a flat car
- Applied to: Container Record Found?
- Action: The system searches for container data associated with the flat car
Logic Flow:
IF Container records are being accessed for a flat car
AND The system searches for container data associated with the flat car
THEN:
- • The system determines if container records exist and proceeds with container processing if found, or completes flat car processing if no containers are found
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when container record has been found on the flat car.
Trigger Criteria:
- Context: A container record has been found on the flat car
- Applied to: Extract Container ID from Record
- Action: The system needs to identify the specific container
Logic Flow:
IF A container record has been found on the flat car
AND The system needs to identify the specific container
THEN:
- • The system extracts the container ID from the container record for individual container processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container id has been extracted from a flat car record.
Trigger Criteria:
- Context: A container ID has been extracted from a flat car record
- Applied to: Set Flat Car Processing Flag
- Action: The system begins processing containers on the flat car
Logic Flow:
IF A container ID has been extracted from a flat car record
AND The system begins processing containers on the flat car
THEN:
- • The system sets a flat car processing flag to track the current processing state
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when container id has been extracted and flat car processing flag is set.
Trigger Criteria:
- Context: A container ID has been extracted and flat car processing flag is set
- Applied to: Perform Container Waybill Lookup
- Action: The system needs to find waybill information for the container
Logic Flow:
IF A container ID has been extracted and flat car processing flag is set
AND The system needs to find waybill information for the container
THEN:
- • The system performs a waybill lookup using the container ID to retrieve associated shipping documentation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when waybill lookup has been performed for a container.
Trigger Criteria:
- Context: A waybill lookup has been performed for a container
- Applied to: Container Waybill Found?
- Action: The system evaluates the lookup results
Logic Flow:
IF A waybill lookup has been performed for a container
AND The system evaluates the lookup results
THEN:
- • The system determines if a waybill was found and proceeds with container validation if found, or uses inquiry database lookup if no waybill is found
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when no waybill was found for a container through primary lookup.
Trigger Criteria:
- Context: No waybill was found for a container through primary lookup
- Applied to: Use Inquiry Database for Container
- Action: The system needs alternative container information
Logic Flow:
IF No waybill was found for a container through primary lookup
AND The system needs alternative container information
THEN:
- • The system accesses the inquiry database to retrieve container information
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when inquiry database has been accessed for container information.
Trigger Criteria:
- Context: The inquiry database has been accessed for container information
- Applied to: Extract Container Information from T/C XREF
- Action: The system needs to extract specific container details
Logic Flow:
IF The inquiry database has been accessed for container information
AND The system needs to extract specific container details
THEN:
- • The system extracts container information from the T/C XREF (Trailer/Container Cross Reference) data
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container information has been retrieved either from waybill lookup or inquiry database.
Trigger Criteria:
- Context: Container information has been retrieved either from waybill lookup or inquiry database
- Applied to: Validate Individual Container
- Action: The system processes the container for train manifest inclusion
Logic Flow:
IF Container information has been retrieved either from waybill lookup or inquiry database
AND The system processes the container for train manifest inclusion
THEN:
- • The system validates the individual container against train manifest requirements and business rules
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when container has been validated successfully.
Trigger Criteria:
- Context: A container has been validated successfully
- Applied to: Process Container for Train Manifest
- Action: The container needs to be included in the train manifest
Logic Flow:
IF A container has been validated successfully
AND The container needs to be included in the train manifest
THEN:
- • The system processes the container for train manifest inclusion with all required container details
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when container has been processed for train manifest on a flat car.
Trigger Criteria:
- Context: A container has been processed for train manifest on a flat car
- Applied to: More Containers on Flat Car?
- Action: The system checks for additional containers on the same flat car
Logic Flow:
IF A container has been processed for train manifest on a flat car
AND The system checks for additional containers on the same flat car
THEN:
- • The system determines if more containers exist and continues processing if found, or completes flat car processing if no more containers exist
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when more containers exist on the flat car being processed.
Trigger Criteria:
- Context: More containers exist on the flat car being processed
- Applied to: Get Next Container Record
- Action: The system needs to process the next container
Logic Flow:
IF More containers exist on the flat car being processed
AND The system needs to process the next container
THEN:
- • The system retrieves the next container record from the flat car's container data
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when all containers on a flat car have been processed or no containers were found.
Trigger Criteria:
- Context: All containers on a flat car have been processed or no containers were found
- Applied to: Complete Flat Car Processing
- Action: The flat car processing workflow reaches completion
Logic Flow:
IF All containers on a flat car have been processed or no containers were found
AND The flat car processing workflow reaches completion
THEN:
- • The system completes flat car processing and finalizes all container-related data for the train manifest
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when error occurs during container record access or processing.
Trigger Criteria:
- Context: An error occurs during container record access or processing
- Applied to: Container Processing Error
- Action: The system encounters a container processing error
Logic Flow:
IF An error occurs during container record access or processing
AND The system encounters a container processing error
THEN:
- • The system handles the error appropriately and proceeds to complete flat car processing
R-GCX146-cbl-00518 (+13) File: GCX146.cbl Business Rule: Waybill Inquiry Database Processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when primary waybill lookup has failed for equipment.
Trigger Criteria:
- Context: Primary waybill lookup has failed for equipment
- Applied to: Initialize Inquiry Database Search
- Action: System initiates inquiry database search
Logic Flow:
IF Primary waybill lookup has failed for equipment
AND System initiates inquiry database search
THEN:
- • Initialize inquiry search parameters and clear previous search results
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment requires waybill information and primary lookup failed.
Trigger Criteria:
- Context: Equipment requires waybill information and primary lookup failed
- Applied to: Search SHIPROOT Inquiry Database
- Action: System searches SHIPROOT inquiry database
Logic Flow:
IF Equipment requires waybill information and primary lookup failed
AND System searches SHIPROOT inquiry database
THEN:
- • Execute inquiry search using equipment identification parameters
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when shiproot inquiry database search has been executed.
Trigger Criteria:
- Context: SHIPROOT inquiry database search has been executed
- Applied to: SHIPROOT Inquiry Found?
- Action: System evaluates search results
Logic Flow:
IF SHIPROOT inquiry database search has been executed
AND System evaluates search results
THEN:
- • If waybill record found in SHIPROOT
then proceed with data retrieval,
otherwise continue to FW-IQ database search
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when shiproot inquiry database contains waybill record for equipment.
Trigger Criteria:
- Context: SHIPROOT inquiry database contains waybill record for equipment
- Applied to: Retrieve Waybill Data from SHIPROOT-INQ
- Action: System retrieves waybill data
Logic Flow:
IF SHIPROOT inquiry database contains waybill record for equipment
AND System retrieves waybill data
THEN:
- • Extract waybill details from SHIPROOT-INQ record and prepare for processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when shiproot inquiry database search failed to find waybill information.
Trigger Criteria:
- Context: SHIPROOT inquiry database search failed to find waybill information
- Applied to: Search FW-IQ Database
- Action: System searches FW-IQ database
Logic Flow:
IF SHIPROOT inquiry database search failed to find waybill information
AND System searches FW-IQ database
THEN:
- • Execute equipment inquiry search in FW-IQ database using equipment parameters
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when fw-iq database search has been executed.
Trigger Criteria:
- Context: FW-IQ database search has been executed
- Applied to: FW-IQ Record Found?
- Action: System evaluates search results
Logic Flow:
IF FW-IQ database search has been executed
AND System evaluates search results
THEN:
- • If equipment record found in FW-IQ
then proceed with information extraction,
otherwise return waybill not found status
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when fw-iq database contains equipment record.
Trigger Criteria:
- Context: FW-IQ database contains equipment record
- Applied to: Extract Equipment Information
- Action: System extracts equipment information
Logic Flow:
IF FW-IQ database contains equipment record
AND System extracts equipment information
THEN:
- • Retrieve equipment details from FW-IQ record for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment information has been extracted from inquiry database.
Trigger Criteria:
- Context: Equipment information has been extracted from inquiry database
- Applied to: Check for Container on Flat Car
- Action: System evaluates equipment configuration
Logic Flow:
IF Equipment information has been extracted from inquiry database
AND System evaluates equipment configuration
THEN:
- • Check if equipment is flat car type with container loading configuration
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment configuration has been evaluated.
Trigger Criteria:
- Context: Equipment configuration has been evaluated
- Applied to: Is Flat Car with Containers?
- Action: System determines processing requirements
Logic Flow:
IF Equipment configuration has been evaluated
AND System determines processing requirements
THEN:
- • If equipment is flat car with containers
then initiate container T/C XREF processing,
otherwise proceed with standard waybill processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment is flat car with containers.
Trigger Criteria:
- Context: Equipment is flat car with containers
- Applied to: Process Container T/C XREF Records
- Action: System processes container cross-references
Logic Flow:
IF Equipment is flat car with containers
AND System processes container cross-references
THEN:
- • Access and process T/C XREF records to identify container details
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container t/c xref records are being processed.
Trigger Criteria:
- Context: Container T/C XREF records are being processed
- Applied to: Extract Container IDs from Inquiry
- Action: System extracts container identifiers
Logic Flow:
IF Container T/C XREF records are being processed
AND System extracts container identifiers
THEN:
- • Retrieve container ID numbers from inquiry database records
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when container ids have been extracted from inquiry records.
Trigger Criteria:
- Context: Container IDs have been extracted from inquiry records
- Applied to: Set Flat Car Processing Flag
- Action: System sets processing indicators
Logic Flow:
IF Container IDs have been extracted from inquiry records
AND System sets processing indicators
THEN:
- • Set flat car processing flag to indicate container handling requirements
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when waybill information has been successfully retrieved from inquiry database.
Trigger Criteria:
- Context: Waybill information has been successfully retrieved from inquiry database
- Applied to: Return Waybill Information Found
- Action: System completes inquiry processing
Logic Flow:
IF Waybill information has been successfully retrieved from inquiry database
AND System completes inquiry processing
THEN:
- • Return status indicating waybill information found and available for processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all inquiry database searches have failed to locate waybill information.
Trigger Criteria:
- Context: All inquiry database searches have failed to locate waybill information
- Applied to: Return Waybill Not Found
- Action: System completes inquiry processing
Logic Flow:
IF All inquiry database searches have failed to locate waybill information
AND System completes inquiry processing
THEN:
- • Return status indicating waybill information not found in inquiry databases
R-GCX146-cbl-00532 (+12) File: GCX146.cbl Business Rule: Equipment Load/Empty Status Validation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment has associated waybill data available.
Trigger Criteria:
- Context: Equipment has associated waybill data available
- Applied to: Extract Cargo Origin/Destination from Waybill
- Action: System processes equipment for load/empty status determination
Logic Flow:
IF Equipment has associated waybill data available
AND System processes equipment for load/empty status determination
THEN:
- • System extracts cargo origin and destination information from waybill to establish baseline load status
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment input contains load/empty status specifications.
Trigger Criteria:
- Context: Equipment input contains load/empty status specifications
- Applied to: Analyze Input Load/Empty Indicator
- Action: System analyzes input load/empty indicator
Logic Flow:
IF Equipment input contains load/empty status specifications
AND System analyzes input load/empty indicator
THEN:
- • System captures and processes the specified load/empty status for validation against waybill data
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment processing requires load/empty status determination.
Trigger Criteria:
- Context: Equipment processing requires load/empty status determination
- Applied to: Input Status Specified?
- Action: System checks if load/empty status is specified in input
Logic Flow:
IF Equipment processing requires load/empty status determination
AND System checks if load/empty status is specified in input
THEN:
- • System determines if explicit status specification exists or if default waybill status should be used
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when both input status specification and waybill status are available.
Trigger Criteria:
- Context: Both input status specification and waybill status are available
- Applied to: Compare Input vs Waybill Status
- Action: System compares input load/empty status against waybill status
Logic Flow:
IF Both input status specification and waybill status are available
AND System compares input load/empty status against waybill status
THEN:
- • System identifies matches or discrepancies between specified and waybill-derived status
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when input status and waybill status have been compared.
Trigger Criteria:
- Context: Input status and waybill status have been compared
- Applied to: Status Match?
- Action: System evaluates status match results
Logic Flow:
IF Input status and waybill status have been compared
AND System evaluates status match results
THEN:
- • System proceeds with cargo movement validation if statuses match or generates warning if they don't match
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment status matches between input and waybill data.
Trigger Criteria:
- Context: Equipment status matches between input and waybill data
- Applied to: Validate Against Cargo Movement Rules
- Action: System validates against cargo movement rules
Logic Flow:
IF Equipment status matches between input and waybill data
AND System validates against cargo movement rules
THEN:
- • System confirms status compliance with cargo movement regulations and business policies
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment status has been validated against cargo movement rules.
Trigger Criteria:
- Context: Equipment status has been validated against cargo movement rules
- Applied to: Movement Rules Valid?
- Action: System evaluates movement rules compliance
Logic Flow:
IF Equipment status has been validated against cargo movement rules
AND System evaluates movement rules compliance
THEN:
- • System sets appropriate validated load or empty status based on compliance results
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment status passes cargo movement rules validation.
Trigger Criteria:
- Context: Equipment status passes cargo movement rules validation
- Applied to: Set Validated Load Status
- Action: System assigns final status for loaded equipment
Logic Flow:
IF Equipment status passes cargo movement rules validation
AND System assigns final status for loaded equipment
THEN:
- • System sets validated load status indicating equipment carries cargo
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment status fails cargo movement rules validation.
Trigger Criteria:
- Context: Equipment status fails cargo movement rules validation
- Applied to: Set Validated Empty Status
- Action: System assigns final status for equipment
Logic Flow:
IF Equipment status fails cargo movement rules validation
AND System assigns final status for equipment
THEN:
- • System sets validated empty status indicating equipment carries no cargo
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when input load/empty status doesn't match waybill-derived status.
Trigger Criteria:
- Context: Input load/empty status doesn't match waybill-derived status
- Applied to: Generate Status Validation Warning
- Action: System processes status mismatch
Logic Flow:
IF Input load/empty status doesn't match waybill-derived status
AND System processes status mismatch
THEN:
- • System generates status validation warning and uses default waybill status
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when no input status specified or input status validation fails.
Trigger Criteria:
- Context: No input status specified or input status validation fails
- Applied to: Use Default Status from Waybill
- Action: System needs to determine equipment load/empty status
Logic Flow:
IF No input status specified or input status validation fails
AND System needs to determine equipment load/empty status
THEN:
- • System uses default load/empty status derived from waybill data
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when status validation process is complete.
Trigger Criteria:
- Context: Status validation process is complete
- Applied to: Assign Final Load/Empty Status
- Action: System assigns final load/empty status to equipment
Logic Flow:
IF Status validation process is complete
AND System assigns final load/empty status to equipment
THEN:
- • System sets definitive load/empty status from validated input, default waybill data, or validation results
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when final load/empty status has been determined.
Trigger Criteria:
- Context: Final load/empty status has been determined
- Applied to: Update Equipment Status Indicators
- Action: System updates equipment status indicators
Logic Flow:
IF Final load/empty status has been determined
AND System updates equipment status indicators
THEN:
- • System records final load/empty status in equipment data for subsequent processing
R-GCX146-cbl-00558 (+12) File: GCX146.cbl Business Rule: Container Waybill Inquiry Processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when container requires waybill information and primary waybill data is not available.
Trigger Criteria:
- Context: A container requires waybill information and primary waybill data is not available
- Applied to: Access FW-IQ Inquiry Database
- Action: The system needs to access container waybill data
Logic Flow:
IF A container requires waybill information and primary waybill data is not available
AND The system needs to access container waybill data
THEN:
- • The system accesses the FW-IQ inquiry database to retrieve container information
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when system has accessed the fw-iq inquiry database for a container.
Trigger Criteria:
- Context: The system has accessed the FW-IQ inquiry database for a container
- Applied to: Container Record Found?
- Action: The system searches for container records
Logic Flow:
IF The system has accessed the FW-IQ inquiry database for a container
AND The system searches for container records
THEN:
- • The system determines if a container record exists and proceeds with extraction if found, or skips processing if not found
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container record exists in the inquiry database.
Trigger Criteria:
- Context: A container record exists in the inquiry database
- Applied to: Extract Container ID from T/C XREF
- Action: The system processes the container record
Logic Flow:
IF A container record exists in the inquiry database
AND The system processes the container record
THEN:
- • The system extracts the container ID from the T/C XREF (Trailer/Container Cross Reference) data
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container id has been extracted from t/c xref records.
Trigger Criteria:
- Context: A container ID has been extracted from T/C XREF records
- Applied to: Retrieve Container Waybill Data
- Action: The system needs detailed waybill information for the container
Logic Flow:
IF A container ID has been extracted from T/C XREF records
AND The system needs detailed waybill information for the container
THEN:
- • The system retrieves container waybill data from the FWSWRWR container records
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when system has attempted to retrieve container waybill data.
Trigger Criteria:
- Context: The system has attempted to retrieve container waybill data
- Applied to: Waybill Data Available?
- Action: The system checks for waybill data availability
Logic Flow:
IF The system has attempted to retrieve container waybill data
AND The system checks for waybill data availability
THEN:
- • The system determines if waybill data is available and proceeds with processing if available, or marks as unavailable if not found
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container waybill data is available for processing.
Trigger Criteria:
- Context: Container waybill data is available for processing
- Applied to: Process Container Information
- Action: The system processes the container information
Logic Flow:
IF Container waybill data is available for processing
AND The system processes the container information
THEN:
- • The system extracts and processes relevant container business information including equipment details and waybill data
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when container information has been successfully processed.
Trigger Criteria:
- Context: Container information has been successfully processed
- Applied to: Set Flat Car Processing Flag
- Action: The system identifies equipment as a flat car with containers
Logic Flow:
IF Container information has been successfully processed
AND The system identifies equipment as a flat car with containers
THEN:
- • The system sets the flat car processing flag to enable special container handling procedures
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when flat car processing flag has been set for container equipment.
Trigger Criteria:
- Context: The flat car processing flag has been set for container equipment
- Applied to: Extract Equipment Details
- Action: The system extracts equipment details
Logic Flow:
IF The flat car processing flag has been set for container equipment
AND The system extracts equipment details
THEN:
- • The system retrieves detailed equipment information including container specifications and transportation data
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment details have been extracted for containers.
Trigger Criteria:
- Context: Equipment details have been extracted for containers
- Applied to: Validate Container Sequence
- Action: The system validates container sequence information
Logic Flow:
IF Equipment details have been extracted for containers
AND The system validates container sequence information
THEN:
- • The system verifies that container sequence numbers are valid and properly ordered for processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container sequence has been validated successfully.
Trigger Criteria:
- Context: Container sequence has been validated successfully
- Applied to: Build Container Equipment Record
- Action: The system builds the container equipment record
Logic Flow:
IF Container sequence has been validated successfully
AND The system builds the container equipment record
THEN:
- • The system creates a complete equipment record containing all validated container information, equipment details, and waybill data
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container equipment record has been successfully built or container was not found or waybill data was not available.
Trigger Criteria:
- Context: Container equipment record has been successfully built or container was not found or waybill data was not available
- Applied to: Container Processing Complete
- Action: The container processing reaches completion
Logic Flow:
IF Container equipment record has been successfully built or container was not found or waybill data was not available
AND The container processing reaches completion
THEN:
- • The system marks container waybill inquiry processing as complete and the container is ready for subsequent operations
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when system has searched for container records in the fw-iq inquiry database.
Trigger Criteria:
- Context: The system has searched for container records in the FW-IQ inquiry database
- Applied to: Container Not Found - Skip
- Action: No container record is found for the specified container
Logic Flow:
IF The system has searched for container records in the FW-IQ inquiry database
AND No container record is found for the specified container
THEN:
- • The system skips container processing and proceeds to completion without processing container information
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container id has been extracted but waybill data retrieval was attempted.
Trigger Criteria:
- Context: A container ID has been extracted but waybill data retrieval was attempted
- Applied to: Waybill Data Not Available
- Action: Waybill data is not available for the container
Logic Flow:
IF A container ID has been extracted but waybill data retrieval was attempted
AND Waybill data is not available for the container
THEN:
- • The system proceeds to completion without processing waybill information for the container
R-GCX146-cbl-00571 (+11) File: GCX146.cbl Business Rule: Equipment Car Type Determination
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment record with a car type code exists.
Trigger Criteria:
- Context: An equipment record with a car type code exists
- Applied to: Access VI Segment Table
- Action: The system needs to retrieve the car type description
Logic Flow:
IF An equipment record with a car type code exists
AND The system needs to retrieve the car type description
THEN:
- • The system accesses the VI segment table using the car type code and retrieves the corresponding car type description for display purposes
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when car type code from equipment information.
Trigger Criteria:
- Context: A car type code from equipment information
- Applied to: Car Type Code Found?
- Action: The system looks up the car type code in the VI segment table
Logic Flow:
IF A car type code from equipment information
AND The system looks up the car type code in the VI segment table
THEN:
- • If the car type code is found, continue with description retrieval,
otherwise flag as equipment type error
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment information with car type details retrieved from vi segment.
Trigger Criteria:
- Context: Equipment information with car type details retrieved from VI segment
- Applied to: Valid Equipment Type?
- Action: The system validates the equipment type classification
Logic Flow:
IF Equipment information with car type details retrieved from VI segment
AND The system validates the equipment type classification
THEN:
- • If the equipment type is valid and recognized, proceed with EDI code assignment,
otherwise flag as equipment type error
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when validated equipment type classification.
Trigger Criteria:
- Context: A validated equipment type classification
- Applied to: Set Equipment Type Code for EDI
- Action: The system needs to set EDI equipment type codes
Logic Flow:
IF A validated equipment type classification
AND The system needs to set EDI equipment type codes
THEN:
- • The system assigns the appropriate EDI equipment type code based on the car type classification for electronic transactions
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when valid equipment type with retrieved car type description.
Trigger Criteria:
- Context: Valid equipment type with retrieved car type description
- Applied to: Assign Car Type to Trip Sheet Display
- Action: The system generates trip sheet displays
Logic Flow:
IF Valid equipment type with retrieved car type description
AND The system generates trip sheet displays
THEN:
- • The system assigns the car type description to the trip sheet display fields for proper reporting
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment with validated type information.
Trigger Criteria:
- Context: Equipment with validated type information
- Applied to: Determine Processing Classification
- Action: The system needs to determine processing classification
Logic Flow:
IF Equipment with validated type information
AND The system needs to determine processing classification
THEN:
- • The system evaluates equipment characteristics to classify as container, trailer, or car type for appropriate processing workflow
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment undergoing processing classification.
Trigger Criteria:
- Context: Equipment undergoing processing classification
- Applied to: Container Type?
- Action: The system evaluates if the equipment is a container type
Logic Flow:
IF Equipment undergoing processing classification
AND The system evaluates if the equipment is a container type
THEN:
- • If equipment is identified as container type, set container processing flag,
otherwise continue to trailer type evaluation
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment that is not classified as container type.
Trigger Criteria:
- Context: Equipment that is not classified as container type
- Applied to: Trailer Type?
- Action: The system evaluates if the equipment is a trailer type
Logic Flow:
IF Equipment that is not classified as container type
AND The system evaluates if the equipment is a trailer type
THEN:
- • If equipment is identified as trailer type, set trailer processing flag,
otherwise continue to car type evaluation
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment that is not classified as container or trailer type.
Trigger Criteria:
- Context: Equipment that is not classified as container or trailer type
- Applied to: Car Type?
- Action: The system evaluates if the equipment is a car type
Logic Flow:
IF Equipment that is not classified as container or trailer type
AND The system evaluates if the equipment is a car type
THEN:
- • If equipment is identified as car type, set car processing flag,
otherwise flag as equipment type error
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment classified as container type.
Trigger Criteria:
- Context: Equipment classified as container type
- Applied to: Set Container Processing Flag
- Action: The system sets processing flags
Logic Flow:
IF Equipment classified as container type
AND The system sets processing flags
THEN:
- • The system sets the container processing flag to enable container-specific processing and completes equipment type determination
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment classified as trailer type.
Trigger Criteria:
- Context: Equipment classified as trailer type
- Applied to: Set Trailer Processing Flag
- Action: The system sets processing flags
Logic Flow:
IF Equipment classified as trailer type
AND The system sets processing flags
THEN:
- • The system sets the trailer processing flag to enable trailer-specific processing and completes equipment type determination
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment classified as car type.
Trigger Criteria:
- Context: Equipment classified as car type
- Applied to: Set Car Processing Flag
- Action: The system sets processing flags
Logic Flow:
IF Equipment classified as car type
AND The system sets processing flags
THEN:
- • The system sets the car processing flag to enable car-specific processing and completes equipment type determination
R-GCX146-cbl-00583 (+24) File: GCX146.cbl Business Rule: Multi
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when waybill record is being processed.
Trigger Criteria:
- Context: A waybill record is being processed
- Applied to: Identify Bunch Bill Waybill
- Action: The system checks the equipment sequence field in the waybill
Logic Flow:
IF A waybill record is being processed
AND The system checks the equipment sequence field in the waybill
THEN:
- • If sequence field contains numeric values greater than 1, the waybill is identified as a bunch bill containing multiple cars
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when bunch bill waybill has been identified with multiple equipment sequences.
Trigger Criteria:
- Context: A bunch bill waybill has been identified with multiple equipment sequences
- Applied to: Retrieve Next Equipment Record
- Action: The system processes equipment records sequentially using FWCMSGET
Logic Flow:
IF A bunch bill waybill has been identified with multiple equipment sequences
AND The system processes equipment records sequentially using FWCMSGET
THEN:
- • Each subsequent equipment record in the sequence is retrieved and processed until all cars in the bunch bill are handled
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment record is being processed from a bunch bill.
Trigger Criteria:
- Context: An equipment record is being processed from a bunch bill
- Applied to: Check for Additional Cars in Bunch Bill
- Action: The system checks the equipment sequence counter against the total sequence count
Logic Flow:
IF An equipment record is being processed from a bunch bill
AND The system checks the equipment sequence counter against the total sequence count
THEN:
- • If the current sequence number is less than the total sequence count, more cars exist to be processed
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment record is retrieved from the bunch bill sequence.
Trigger Criteria:
- Context: An equipment record is retrieved from the bunch bill sequence
- Applied to: Extract Car Identification
- Action: The system processes the equipment data
Logic Flow:
IF An equipment record is retrieved from the bunch bill sequence
AND The system processes the equipment data
THEN:
- • Car identification including car initial, car number, and equipment type is extracted and validated for completeness
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when multiple cars are identified in a bunch bill waybill.
Trigger Criteria:
- Context: Multiple cars are identified in a bunch bill waybill
- Applied to: Link Car to Original Waybill
- Action: Each car is processed individually
Logic Flow:
IF Multiple cars are identified in a bunch bill waybill
AND Each car is processed individually
THEN:
- • Each car maintains a reference to the original waybill number and sequence position for proper tracking and reporting
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when cars are being processed from a bunch bill waybill.
Trigger Criteria:
- Context: Cars are being processed from a bunch bill waybill
- Applied to: Update Equipment Totals
- Action: Each car is successfully processed and validated
Logic Flow:
IF Cars are being processed from a bunch bill waybill
AND Each car is successfully processed and validated
THEN:
- • Equipment totals including car count, loaded count, and empty count are incremented for each valid car in the sequence
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when bunch bill with multiple cars is being processed.
Trigger Criteria:
- Context: A bunch bill with multiple cars is being processed
- Applied to: Complete Bunch Bill Processing
- Action: All equipment records in the sequence have been retrieved and processed
Logic Flow:
IF A bunch bill with multiple cars is being processed
AND All equipment records in the sequence have been retrieved and processed
THEN:
- • The bunch bill processing is marked as complete and the system proceeds to the next waybill or operation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when broker notification needs to be sent and broker preferences are configured in the system.
Trigger Criteria:
- Context: A broker notification needs to be sent and broker preferences are configured in the system
- Applied to: Check Broker Preferences
- Action: The system checks the broker's communication channel preferences
Logic Flow:
IF A broker notification needs to be sent and broker preferences are configured in the system
AND The system checks the broker's communication channel preferences
THEN:
- • The system identifies which channels (X12 EDI, Merlin, Internet, FAX, Paper, Email) are available for this broker
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when broker notification is being processed.
Trigger Criteria:
- Context: A broker notification is being processed
- Applied to: X12 EDI Channel Available?
- Action: The system checks if X12 EDI channel is available for the broker
Logic Flow:
IF A broker notification is being processed
AND The system checks if X12 EDI channel is available for the broker
THEN:
- • The system returns true if X12 EDI is configured and available,
otherwise false
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when broker notification is being processed.
Trigger Criteria:
- Context: A broker notification is being processed
- Applied to: Merlin Channel Available?
- Action: The system checks if Merlin channel is available for the broker
Logic Flow:
IF A broker notification is being processed
AND The system checks if Merlin channel is available for the broker
THEN:
- • The system returns true if Merlin is configured and available,
otherwise false
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when broker notification is being processed.
Trigger Criteria:
- Context: A broker notification is being processed
- Applied to: Internet Channel Available?
- Action: The system checks if Internet channel is available for the broker
Logic Flow:
IF A broker notification is being processed
AND The system checks if Internet channel is available for the broker
THEN:
- • The system returns true if Internet is configured and available,
otherwise false
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when broker notification is being processed.
Trigger Criteria:
- Context: A broker notification is being processed
- Applied to: FAX Channel Available?
- Action: The system checks if FAX channel is available for the broker
Logic Flow:
IF A broker notification is being processed
AND The system checks if FAX channel is available for the broker
THEN:
- • The system returns true if FAX is configured and available,
otherwise false
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when broker notification is being processed.
Trigger Criteria:
- Context: A broker notification is being processed
- Applied to: Paper Channel Available?
- Action: The system checks if Paper channel is available for the broker
Logic Flow:
IF A broker notification is being processed
AND The system checks if Paper channel is available for the broker
THEN:
- • The system returns true if Paper is configured and available,
otherwise false
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when broker notification is being processed.
Trigger Criteria:
- Context: A broker notification is being processed
- Applied to: Email Channel Available?
- Action: The system checks if Email channel is available for the broker
Logic Flow:
IF A broker notification is being processed
AND The system checks if Email channel is available for the broker
THEN:
- • The system returns true if Email is configured and available,
otherwise false
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when x12 edi channel is available for the broker.
Trigger Criteria:
- Context: X12 EDI channel is available for the broker
- Applied to: Send X12 EDI Notification
- Action: The system processes the notification through X12 EDI
Logic Flow:
IF X12 EDI channel is available for the broker
AND The system processes the notification through X12 EDI
THEN:
- • The system invokes GCCS309C module to send the X12 EDI notification
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when merlin channel is available for the broker.
Trigger Criteria:
- Context: Merlin channel is available for the broker
- Applied to: Send Merlin Notification
- Action: The system processes the notification through Merlin
Logic Flow:
IF Merlin channel is available for the broker
AND The system processes the notification through Merlin
THEN:
- • The system invokes GCX019 module to send the Merlin notification
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when internet channel is available for the broker.
Trigger Criteria:
- Context: Internet channel is available for the broker
- Applied to: Send Internet Notification
- Action: The system processes the notification through Internet
Logic Flow:
IF Internet channel is available for the broker
AND The system processes the notification through Internet
THEN:
- • The system invokes GCX019 module to send the Internet notification
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when fax channel is available for the broker.
Trigger Criteria:
- Context: FAX channel is available for the broker
- Applied to: Send FAX Notification
- Action: The system processes the notification through FAX
Logic Flow:
IF FAX channel is available for the broker
AND The system processes the notification through FAX
THEN:
- • The system invokes GCX019 module to send the FAX notification
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when fax notification has been processed.
Trigger Criteria:
- Context: FAX notification has been processed
- Applied to: Auto-FAX Enabled?
- Action: The system checks the auto-FAX configuration setting
Logic Flow:
IF FAX notification has been processed
AND The system checks the auto-FAX configuration setting
THEN:
- • The system returns true if auto-FAX is enabled,
otherwise continues to next channel
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when auto-fax is enabled in system configuration. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Auto-FAX is enabled in system configuration
- Applied to: Setup FAX Routing
- Action: The system sets up FAX routing
Logic Flow:
IF Auto-FAX is enabled in system configuration
AND The system sets up FAX routing
THEN:
- • The system configures FAX routing parameters and copy IDs for automatic transmission
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when fax routing is configured with copy ids. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: FAX routing is configured with copy IDs
- Applied to: Send via FAX with Copy IDs
- Action: The system processes auto-FAX transmission
Logic Flow:
IF FAX routing is configured with copy IDs
AND The system processes auto-FAX transmission
THEN:
- • The system invokes EMCSEND module to send FAX with copy IDs
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when paper channel is available for the broker. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Paper channel is available for the broker
- Applied to: Generate Paper Notification
- Action: The system processes the notification for paper output
Logic Flow:
IF Paper channel is available for the broker
AND The system processes the notification for paper output
THEN:
- • The system generates paper notification using batch print call letters
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when email notification is being prepared.
Trigger Criteria:
- Context: An email notification is being prepared
- Applied to: Report Exceeds Line Limit?
- Action: The system checks the report size against the line limit
Logic Flow:
IF An email notification is being prepared
AND The system checks the report size against the line limit
THEN:
- • The system returns true if report exceeds 699 lines,
otherwise false
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when email report does not exceed 699 lines.
Trigger Criteria:
- Context: Email report does not exceed 699 lines
- Applied to: Send Standard Email
- Action: The system processes standard email transmission
Logic Flow:
IF Email report does not exceed 699 lines
AND The system processes standard email transmission
THEN:
- • The system invokes EMCSEND3 module to send the complete email notification
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when email report exceeds 699 lines.
Trigger Criteria:
- Context: Email report exceeds 699 lines
- Applied to: Send Email with Continuation
- Action: The system processes large email transmission
Logic Flow:
IF Email report exceeds 699 lines
AND The system processes large email transmission
THEN:
- • The system sends first 699 lines and creates continuation messages with header 'CONTINUATION OF REPORT...' for remaining content using EMCSEND3 module
R-GCX146-cbl-00590 (+11) File: GCX146.cbl Business Rule: Additional Car Processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when waybill record exists in the system.
Trigger Criteria:
- Context: A waybill record exists in the system
- Applied to: Check Waybill for Additional Cars
- Action: The system checks the waybill for additional car indicators
Logic Flow:
IF A waybill record exists in the system
AND The system checks the waybill for additional car indicators
THEN:
- • The system identifies if there are multiple cars associated with this waybill that require bunch bill processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill has been checked for additional cars.
Trigger Criteria:
- Context: A waybill has been checked for additional cars
- Applied to: Additional Cars Indicated?
- Action: Additional cars are indicated in the waybill
Logic Flow:
IF A waybill has been checked for additional cars
AND Additional cars are indicated in the waybill
THEN:
- • The system initiates bunch bill sequence processing,
otherwise skips to completion
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when additional cars have been detected on a waybill.
Trigger Criteria:
- Context: Additional cars have been detected on a waybill
- Applied to: Initialize Bunch Bill Sequence
- Action: Bunch bill processing is initiated
Logic Flow:
IF Additional cars have been detected on a waybill
AND Bunch bill processing is initiated
THEN:
- • The system initializes sequence counters and prepares for sequential car retrieval
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when bunch bill sequence has been initialized.
Trigger Criteria:
- Context: Bunch bill sequence has been initialized
- Applied to: Retrieve Next Car in Sequence
- Action: The system attempts to retrieve the next car in sequence
Logic Flow:
IF Bunch bill sequence has been initialized
AND The system attempts to retrieve the next car in sequence
THEN:
- • The system accesses equipment records to obtain the next car's data
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when attempt has been made to retrieve car data.
Trigger Criteria:
- Context: An attempt has been made to retrieve car data
- Applied to: Car Retrieved Successfully?
- Action: The system checks the retrieval status
Logic Flow:
IF An attempt has been made to retrieve car data
AND The system checks the retrieval status
THEN:
- • If successful, proceed with car validation; if unsuccessful, complete bunch bill processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when car has been successfully retrieved from equipment records.
Trigger Criteria:
- Context: A car has been successfully retrieved from equipment records
- Applied to: Validate Car Equipment ID
- Action: The system validates the car's equipment ID
Logic Flow:
IF A car has been successfully retrieved from equipment records
AND The system validates the car's equipment ID
THEN:
- • The equipment ID must meet format and business requirements for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when car's equipment id has been validated.
Trigger Criteria:
- Context: A car's equipment ID has been validated
- Applied to: Process Car Equipment Data
- Action: The system processes the car's equipment data
Logic Flow:
IF A car's equipment ID has been validated
AND The system processes the car's equipment data
THEN:
- • All relevant equipment attributes are extracted and prepared for manifest inclusion
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when car equipment data has been processed.
Trigger Criteria:
- Context: Car equipment data has been processed
- Applied to: Extract Car Load/Empty Status
- Action: The system extracts the load/empty status
Logic Flow:
IF Car equipment data has been processed
AND The system extracts the load/empty status
THEN:
- • Each car is classified as either loaded or empty based on waybill information
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when car's load/empty status has been determined.
Trigger Criteria:
- Context: A car's load/empty status has been determined
- Applied to: Update Equipment Totals
- Action: The system updates equipment totals
Logic Flow:
IF A car's load/empty status has been determined
AND The system updates equipment totals
THEN:
- • Running counts for total equipment, loaded cars, and empty cars are incremented appropriately
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment totals have been updated for a car.
Trigger Criteria:
- Context: Equipment totals have been updated for a car
- Applied to: Add Car to Train Manifest
- Action: The system adds the car to the train manifest
Logic Flow:
IF Equipment totals have been updated for a car
AND The system adds the car to the train manifest
THEN:
- • The car becomes part of the official train consist with all required documentation
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when car has been added to the train manifest.
Trigger Criteria:
- Context: A car has been added to the train manifest
- Applied to: More Cars in Sequence?
- Action: The system checks for more cars in the sequence
Logic Flow:
IF A car has been added to the train manifest
AND The system checks for more cars in the sequence
THEN:
- • If more cars exist, continue processing; if no more cars, complete bunch bill processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when all cars in the bunch bill sequence have been processed or retrieval has failed.
Trigger Criteria:
- Context: All cars in the bunch bill sequence have been processed or retrieval has failed
- Applied to: Complete Bunch Bill Processing
- Action: The system completes bunch bill processing
Logic Flow:
IF All cars in the bunch bill sequence have been processed or retrieval has failed
AND The system completes bunch bill processing
THEN:
- • All cars from the waybill are properly documented and totals are finalized
R-GCX146-cbl-00602 (+14) File: GCX146.cbl Business Rule: US Route Status Processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment requires us customs processing for cross-border movement.
Trigger Criteria:
- Context: Equipment requires US customs processing for cross-border movement
- Applied to: Access US Route Database
- Action: System accesses the US Route database using equipment and waybill information
Logic Flow:
IF Equipment requires US customs processing for cross-border movement
AND System accesses the US Route database using equipment and waybill information
THEN:
- • US Route record is retrieved if it exists in the GCSUSRT database
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when system has attempted to retrieve us route record for equipment.
Trigger Criteria:
- Context: System has attempted to retrieve US Route record for equipment
- Applied to: US Route Record Found?
- Action: Database lookup is completed
Logic Flow:
IF System has attempted to retrieve US Route record for equipment
AND Database lookup is completed
THEN:
- • Processing continues with bond validation if record exists, or skips US processing if no record found
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when us route record exists for the equipment.
Trigger Criteria:
- Context: US Route record exists for the equipment
- Applied to: Extract Bond Type Information
- Action: System processes the US Route record
Logic Flow:
IF US Route record exists for the equipment
AND System processes the US Route record
THEN:
- • Bond type, in-transit status, location, and vessel information are extracted for validation
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when bond type information has been extracted from us route record.
Trigger Criteria:
- Context: Bond type information has been extracted from US Route record
- Applied to: Validate Bond Type
- Action: System validates the bond type
Logic Flow:
IF Bond type information has been extracted from US Route record
AND System validates the bond type
THEN:
- • Bond type must be IT (In-Transit), TR (Transportation), TE (Temporary Export), or MT (Merchandise in Transit) to be considered valid
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when bond type has been validated against acceptable types.
Trigger Criteria:
- Context: Bond type has been validated against acceptable types
- Applied to: Bond Type Valid?
- Action: System evaluates bond type validity
Logic Flow:
IF Bond type has been validated against acceptable types
AND System evaluates bond type validity
THEN:
- • Processing continues with in-transit status check if valid, or generates bond type warning if invalid
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when bond type is valid for us customs processing.
Trigger Criteria:
- Context: Bond type is valid for US customs processing
- Applied to: Check In-Transit Status
- Action: System checks the in-transit status from the US Route record
Logic Flow:
IF Bond type is valid for US customs processing
AND System checks the in-transit status from the US Route record
THEN:
- • In-transit status information is validated for consistency with current equipment location and movement
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when in-transit status has been checked for the equipment.
Trigger Criteria:
- Context: In-transit status has been checked for the equipment
- Applied to: Validate Location Information
- Action: System validates location information against current equipment position
Logic Flow:
IF In-transit status has been checked for the equipment
AND System validates location information against current equipment position
THEN:
- • Location must be consistent with equipment routing and customs requirements
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when location information has been validated against equipment routing.
Trigger Criteria:
- Context: Location information has been validated against equipment routing
- Applied to: Location Valid?
- Action: System evaluates location validity
Logic Flow:
IF Location information has been validated against equipment routing
AND System evaluates location validity
THEN:
- • Processing continues with vessel validation if location is valid, or generates location warning if invalid
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when location information is valid for the equipment.
Trigger Criteria:
- Context: Location information is valid for the equipment
- Applied to: Validate Vessel Name
- Action: System validates the vessel name from the US Route record
Logic Flow:
IF Location information is valid for the equipment
AND System validates the vessel name from the US Route record
THEN:
- • Vessel name is checked against expected transportation mode for the current shipment
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when vessel name has been extracted from the us route record.
Trigger Criteria:
- Context: Vessel name has been extracted from the US Route record
- Applied to: Vessel is 'TRAIN'?
- Action: System checks if vessel name equals 'TRAIN'
Logic Flow:
IF Vessel name has been extracted from the US Route record
AND System checks if vessel name equals 'TRAIN'
THEN:
- • Processing continues normally if vessel is 'TRAIN', or generates vessel warning if vessel name indicates different transportation mode
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when bond type validation has failed for the equipment.
Trigger Criteria:
- Context: Bond type validation has failed for the equipment
- Applied to: Generate Bond Type Warning
- Action: System generates bond type warning
Logic Flow:
IF Bond type validation has failed for the equipment
AND System generates bond type warning
THEN:
- • Warning message is created indicating invalid bond type and potential customs compliance issue
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when location validation has failed for the equipment.
Trigger Criteria:
- Context: Location validation has failed for the equipment
- Applied to: Generate Location Warning
- Action: System generates location warning
Logic Flow:
IF Location validation has failed for the equipment
AND System generates location warning
THEN:
- • Warning message is created indicating location inconsistency and potential routing issue
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when vessel name does not indicate 'train' transportation mode.
Trigger Criteria:
- Context: Vessel name does not indicate 'TRAIN' transportation mode
- Applied to: Generate Vessel Warning
- Action: System generates vessel warning
Logic Flow:
IF Vessel name does not indicate 'TRAIN' transportation mode
AND System generates vessel warning
THEN:
- • Warning message is created indicating vessel name inconsistency with rail transportation mode
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when us route validation processing is complete with any applicable warnings.
Trigger Criteria:
- Context: US Route validation processing is complete with any applicable warnings
- Applied to: Set US Status Message
- Action: System sets the US status message
Logic Flow:
IF US Route validation processing is complete with any applicable warnings
AND System sets the US status message
THEN:
- • Status message includes validation results, warnings, and current customs status for the equipment
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when us status message has been configured for the equipment.
Trigger Criteria:
- Context: US status message has been configured for the equipment
- Applied to: Update Equipment Status
- Action: System updates equipment status
Logic Flow:
IF US status message has been configured for the equipment
AND System updates equipment status
THEN:
- • Equipment record is updated with US customs status, bond information, and any validation warnings
R-GCX146-cbl-00617 (+8) File: GCX146.cbl Business Rule: Canadian Goods Return Processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo shipment with origin and destination location information.
Trigger Criteria:
- Context: A cargo shipment with origin and destination location information
- Applied to: Identify Canadian Goods from US
- Action: The system processes the shipment location data
Logic Flow:
IF A cargo shipment with origin and destination location information
AND The system processes the shipment location data
THEN:
- • The system determines if the goods are Canadian goods returning from US by checking if origin is US and destination is Canadian province
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when canadian goods identified as returning from us with valid waybill data.
Trigger Criteria:
- Context: Canadian goods identified as returning from US with valid waybill data
- Applied to: Extract Equipment ID and Waybill Date
- Action: The system processes the equipment for return CCN creation
Logic Flow:
IF Canadian goods identified as returning from US with valid waybill data
AND The system processes the equipment for return CCN creation
THEN:
- • The system extracts equipment ID and waybill date from the waybill record for CCN key construction
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment id and waybill date extracted from return cargo.
Trigger Criteria:
- Context: Equipment ID and waybill date extracted from return cargo
- Applied to: Build Return CCN Number
- Action: The system creates a new CCN for return processing
Logic Flow:
IF Equipment ID and waybill date extracted from return cargo
AND The system creates a new CCN for return processing
THEN:
- • The system builds CCN key with format '6105E' + equipment ID + waybill date + sequence number
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when new ccn record being created for canadian return goods.
Trigger Criteria:
- Context: A new CCN record being created for Canadian return goods
- Applied to: Set CCN Status to RETURN
- Action: The system populates the CCN status field
Logic Flow:
IF A new CCN record being created for Canadian return goods
AND The system populates the CCN status field
THEN:
- • The system sets the CCN status to 'RETURN' to indicate return cargo processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn record for canadian return goods being processed.
Trigger Criteria:
- Context: A CCN record for Canadian return goods being processed
- Applied to: Set Transit Status to R
- Action: The system sets the transit status indicator
Logic Flow:
IF A CCN record for Canadian return goods being processed
AND The system sets the transit status indicator
THEN:
- • The system assigns transit status 'R' to indicate return movement
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when original waybill data with shipper information and a new return ccn record.
Trigger Criteria:
- Context: Original waybill data with shipper information and a new return CCN record
- Applied to: Populate Shipper Information
- Action: The system populates the return CCN with shipper details
Logic Flow:
IF Original waybill data with shipper information and a new return CCN record
AND The system populates the return CCN with shipper details
THEN:
- • The system copies shipper name and location information from the waybill to the CCN record
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when original waybill data with consignee information and a new return ccn record.
Trigger Criteria:
- Context: Original waybill data with consignee information and a new return CCN record
- Applied to: Populate Consignee Information
- Action: The system populates the return CCN with consignee details
Logic Flow:
IF Original waybill data with consignee information and a new return CCN record
AND The system populates the return CCN with consignee details
THEN:
- • The system copies consignee name and location information from the waybill to the CCN record
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when complete return ccn information including status, shipper, consignee, and equipment details.
Trigger Criteria:
- Context: Complete return CCN information including status, shipper, consignee, and equipment details
- Applied to: Insert Return CCN Record
- Action: The system attempts to create the CCN database record
Logic Flow:
IF Complete return CCN information including status, shipper, consignee, and equipment details
AND The system attempts to create the CCN database record
THEN:
- • The system inserts the new CCN record into the GCCCRT database with application type '33' for Canadian customs
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when attempt to create a return ccn record in the database.
Trigger Criteria:
- Context: An attempt to create a return CCN record in the database
- Applied to: CCN Creation Successful?
- Action: The system checks the result of the CCN creation operation
Logic Flow:
IF An attempt to create a return CCN record in the database
AND The system checks the result of the CCN creation operation
THEN:
- • The system determines success or failure based on the database operation return status
R-GCX146-cbl-00626 File: GCX146.cbl Business Rule: Conveying Car Validation
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when request to validate equipment as conveying cars for intermodal processing.
Trigger Criteria:
- Context: A request to validate equipment as conveying cars for intermodal processing
- Applied to: Conveying Car Validation - Validate equipment as conveying cars for intermodal processing
- Action: The system attempts to perform conveying car validation
Logic Flow:
IF A request to validate equipment as conveying cars for intermodal processing
AND The system attempts to perform conveying car validation
THEN:
- • The validation logic cannot be determined as the source code is not found in the provided COBOL summary
R-GCX146-cbl-00627 (+8) File: GCX146.cbl Business Rule: Idler Equipment Processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment record has been retrieved for processing.
Trigger Criteria:
- Context: An equipment record has been retrieved for processing
- Applied to: Check Equipment Type Classification
- Action: The system evaluates the equipment type classification
Logic Flow:
IF An equipment record has been retrieved for processing
AND The system evaluates the equipment type classification
THEN:
- • The equipment is identified as idler type if it meets idler classification criteria
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has been classified as idler type.
Trigger Criteria:
- Context: Equipment has been classified as idler type
- Applied to: Set Idler Equipment Flag
- Action: The system processes the idler equipment classification
Logic Flow:
IF Equipment has been classified as idler type
AND The system processes the idler equipment classification
THEN:
- • An idler equipment flag is set to indicate special processing requirements
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment is flagged as idler type.
Trigger Criteria:
- Context: Equipment is flagged as idler type
- Applied to: Bypass CCN Database Lookup
- Action: The system processes equipment for CCN requirements
Logic Flow:
IF Equipment is flagged as idler type
AND The system processes equipment for CCN requirements
THEN:
- • CCN database lookup is bypassed and not performed
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment is flagged as idler type.
Trigger Criteria:
- Context: Equipment is flagged as idler type
- Applied to: Bypass CCN Status Validation
- Action: The system processes equipment for CCN status validation
Logic Flow:
IF Equipment is flagged as idler type
AND The system processes equipment for CCN status validation
THEN:
- • CCN status validation is bypassed and not performed
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment is flagged as idler type.
Trigger Criteria:
- Context: Equipment is flagged as idler type
- Applied to: Bypass Train Assignment Validation
- Action: The system validates equipment train assignments
Logic Flow:
IF Equipment is flagged as idler type
AND The system validates equipment train assignments
THEN:
- • Train assignment validation is bypassed for the idler equipment
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has been processed as idler type.
Trigger Criteria:
- Context: Equipment has been processed as idler type
- Applied to: Set Equipment Status as IDLER
- Action: The system assigns equipment status
Logic Flow:
IF Equipment has been processed as idler type
AND The system assigns equipment status
THEN:
- • Equipment status is set to IDLER designation
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment status has been set as idler.
Trigger Criteria:
- Context: Equipment status has been set as IDLER
- Applied to: Add to Equipment Totals as Idler
- Action: The system calculates equipment totals for reporting
Logic Flow:
IF Equipment status has been set as IDLER
AND The system calculates equipment totals for reporting
THEN:
- • The equipment is added to totals under the idler category
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has been categorized and counted as idler.
Trigger Criteria:
- Context: Equipment has been categorized and counted as idler
- Applied to: Generate Equipment Type Message IDLER
- Action: The system generates equipment type messages
Logic Flow:
IF Equipment has been categorized and counted as idler
AND The system generates equipment type messages
THEN:
- • An equipment type message with IDLER designation is generated
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment type message has been generated for idler equipment.
Trigger Criteria:
- Context: Equipment type message has been generated for idler equipment
- Applied to: Include in Trip Sheet without CCN
- Action: The system creates trip sheet reports
Logic Flow:
IF Equipment type message has been generated for idler equipment
AND The system creates trip sheet reports
THEN:
- • Idler equipment is included in the trip sheet without CCN data requirements
R-GCX146-cbl-00636 (+5) File: GCX146.cbl Business Rule: Release Information Processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn record has a current status of release or csa-dlv.
Trigger Criteria:
- Context: A CCN record has a current status of RELEASE or CSA-DLV
- Applied to: Check Transit Status Code
- Action: The transit status code is 'E' (Export) or 'Z' (Export Zone)
Logic Flow:
IF A CCN record has a current status of RELEASE or CSA-DLV
AND The transit status code is 'E' (Export) or 'Z' (Export Zone)
THEN:
- • The cargo status should be classified as 'EXPORT' for reporting purposes
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn record has a current status of release or csa-dlv.
Trigger Criteria:
- Context: A CCN record has a current status of RELEASE or CSA-DLV
- Applied to: Set Status to 'RELEASE'
- Action: The transit status is not 'E' or 'Z' and the release-by field does not contain 'S.A.R.'
Logic Flow:
IF A CCN record has a current status of RELEASE or CSA-DLV
AND The transit status is not 'E' or 'Z' and the release-by field does not contain 'S.A.R.'
THEN:
- • The cargo status should be classified as 'RELEASE' for reporting purposes
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn record has a current status of release or csa-dlv and transit status is not 'e' or 'z'.
Trigger Criteria:
- Context: A CCN record has a current status of RELEASE or CSA-DLV and transit status is not 'E' or 'Z'
- Applied to: Has S.A.R. Release?
- Action: The release-by field contains 'S.A.R.' (Special Administrative Release)
Logic Flow:
IF A CCN record has a current status of RELEASE or CSA-DLV and transit status is not 'E' or 'Z'
AND The release-by field contains 'S.A.R.' (Special Administrative Release)
THEN:
- • The cargo status should be classified as 'S.A.R.' for reporting purposes
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has a ccn status of release or csa-dlv.
Trigger Criteria:
- Context: Equipment has a CCN status of RELEASE or CSA-DLV
- Applied to: Increment Release Equipment Totals
- Action: Processing equipment for VERIFY operation totals
Logic Flow:
IF Equipment has a CCN status of RELEASE or CSA-DLV
AND Processing equipment for VERIFY operation totals
THEN:
- • The TOTAL-RELEASE counter should be incremented by one
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn record exists with status information.
Trigger Criteria:
- Context: A CCN record exists with status information
- Applied to: Check Transit Status Code
- Action: Processing the transit status field from the CCN record
Logic Flow:
IF A CCN record exists with status information
AND Processing the transit status field from the CCN record
THEN:
- • The transit status code should be evaluated to determine appropriate cargo classification
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment has been processed and status determined.
Trigger Criteria:
- Context: Equipment has been processed and status determined
- Applied to: Track Release Status in Trip Sheet
- Action: Generating trip sheet details for ADD operations
Logic Flow:
IF Equipment has been processed and status determined
AND Generating trip sheet details for ADD operations
THEN:
- • The trip sheet should reflect the determined status (EXPORT, S.A.R., or RELEASE)
R-GCX146-cbl-00642 (+16) File: GCX146.cbl Business Rule: Train Transit Status Management
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn record exists with a current status value.
Trigger Criteria:
- Context: A CCN record exists with a current status value
- Applied to: Check Current Status Value
- Action: The system evaluates the current status code
Logic Flow:
IF A CCN record exists with a current status value
AND The system evaluates the current status code
THEN:
- • The system classifies the status as Transit, Return, Export, S.A.R. Release, or standard Release based on the status code value
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn record has current status equal to 't'.
Trigger Criteria:
- Context: A CCN record has current status equal to 'T'
- Applied to: Set Transit Status to 'TRANSIT'
- Action: The system processes the transit status classification
Logic Flow:
IF A CCN record has current status equal to 'T'
AND The system processes the transit status classification
THEN:
- • The transit status is set to 'TRANSIT' for business reporting
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn record has current status equal to 'r'.
Trigger Criteria:
- Context: A CCN record has current status equal to 'R'
- Applied to: Set Transit Status to 'RETURN'
- Action: The system processes the transit status classification
Logic Flow:
IF A CCN record has current status equal to 'R'
AND The system processes the transit status classification
THEN:
- • The transit status is set to 'RETURN' for business reporting
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn record has release status 'release' or 'csa-dlv' and in-transit status equal to 'e' or 'z'.
Trigger Criteria:
- Context: A CCN record has release status 'RELEASE' or 'CSA-DLV' and in-transit status equal to 'E' or 'Z'
- Applied to: Set Transit Status to 'EXPORT'
- Action: The system processes the transit status classification
Logic Flow:
IF A CCN record has release status 'RELEASE' or 'CSA-DLV' and in-transit status equal to 'E' or 'Z'
AND The system processes the transit status classification
THEN:
- • The transit status is set to 'EXPORT' for business reporting
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn record has release status 'release' or 'csa-dlv' and release-by field contains 's.a.r.'.
Trigger Criteria:
- Context: A CCN record has release status 'RELEASE' or 'CSA-DLV' and release-by field contains 'S.A.R.'
- Applied to: Set Transit Status to 'S.A.R.'
- Action: The system processes the transit status classification
Logic Flow:
IF A CCN record has release status 'RELEASE' or 'CSA-DLV' and release-by field contains 'S.A.R.'
AND The system processes the transit status classification
THEN:
- • The transit status is set to 'S.A.R.' for business reporting
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn record has release status 'release' or 'csa-dlv' and does not meet export or s.a.r. criteria.
Trigger Criteria:
- Context: A CCN record has release status 'RELEASE' or 'CSA-DLV' and does not meet export or S.A.R. criteria
- Applied to: Set Transit Status to 'RELEASE'
- Action: The system processes the transit status classification
Logic Flow:
IF A CCN record has release status 'RELEASE' or 'CSA-DLV' and does not meet export or S.A.R. criteria
AND The system processes the transit status classification
THEN:
- • The transit status is set to 'RELEASE' for business reporting
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn is being processed for train assignment.
Trigger Criteria:
- Context: A CCN is being processed for train assignment
- Applied to: Validate CCN Assignment Conflicts
- Action: The system checks existing train assignments for the CCN
Logic Flow:
IF A CCN is being processed for train assignment
AND The system checks existing train assignments for the CCN
THEN:
- • The system validates that the CCN is not already assigned to a different train
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn is found to be already assigned to a different train.
Trigger Criteria:
- Context: A CCN is found to be already assigned to a different train
- Applied to: Generate Assignment Conflict Error
- Action: The system detects the assignment conflict
Logic Flow:
IF A CCN is found to be already assigned to a different train
AND The system detects the assignment conflict
THEN:
- • The system generates error 13 indicating the car is already on another train
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has been processed and assigned a transit status.
Trigger Criteria:
- Context: Equipment has been processed and assigned a transit status
- Applied to: Update Equipment Status Totals
- Action: The system updates operational totals
Logic Flow:
IF Equipment has been processed and assigned a transit status
AND The system updates operational totals
THEN:
- • The appropriate status total counter (TOTAL-RELEASE, TOTAL-HAULAGE, TOTAL-PROCEED, TOTAL-HELD-CCRA, TOTAL-HELD-DOCS) is incremented based on the equipment's final status classification
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn record exists with transit status information.
Trigger Criteria:
- Context: A CCN record exists with transit status information
- Applied to: Check CCN Transit Status
- Action: The system checks the CCN transit status field
Logic Flow:
IF A CCN record exists with transit status information
AND The system checks the CCN transit status field
THEN:
- • If transit status equals 'T', the CCN is classified as in-transit cargo,
otherwise it proceeds to assignment conflict validation
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn exists and needs to be assigned to a train.
Trigger Criteria:
- Context: A CCN exists and needs to be assigned to a train
- Applied to: CCN Already Assigned to Another Train?
- Action: The system checks if the CCN is already assigned to another train
Logic Flow:
IF A CCN exists and needs to be assigned to a train
AND The system checks if the CCN is already assigned to another train
THEN:
- • If the CCN is already assigned to a different train, generate assignment conflict error,
otherwise proceed with status evaluation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn has status 'release' and contains transit code information.
Trigger Criteria:
- Context: A CCN has status 'RELEASE' and contains transit code information
- Applied to: Transit Code = 'E' or 'Z'?
- Action: The transit code is 'E' or 'Z'
Logic Flow:
IF A CCN has status 'RELEASE' and contains transit code information
AND The transit code is 'E' or 'Z'
THEN:
- • Set the display status to 'EXPORT' for reporting purposes
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn has status 'release' and transit code is not 'e' or 'z'.
Trigger Criteria:
- Context: A CCN has status 'RELEASE' and transit code is not 'E' or 'Z'
- Applied to: Transit Code = 'S.A.R.'?
- Action: The transit code equals 'S.A.R.'
Logic Flow:
IF A CCN has status 'RELEASE' and transit code is not 'E' or 'Z'
AND The transit code equals 'S.A.R.'
THEN:
- • Set the display status to 'S.A.R.' for reporting purposes
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn has status 'release' and transit code is neither 'e', 'z', nor 's.a.r.'.
Trigger Criteria:
- Context: A CCN has status 'RELEASE' and transit code is neither 'E', 'Z', nor 'S.A.R.'
- Applied to: Set Status to 'RELEASE'
- Action: No special transit code conditions are met
Logic Flow:
IF A CCN has status 'RELEASE' and transit code is neither 'E', 'Z', nor 'S.A.R.'
AND No special transit code conditions are met
THEN:
- • Set the display status to 'RELEASE' for reporting purposes
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn does not have 'release' status.
Trigger Criteria:
- Context: A CCN does not have 'RELEASE' status
- Applied to: Transit Status = 'R'?
- Action: The transit status equals 'R'
Logic Flow:
IF A CCN does not have 'RELEASE' status
AND The transit status equals 'R'
THEN:
- • Set the display status to 'RETURN' for reporting purposes
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn does not have 'release' status and transit status is not 'r'.
Trigger Criteria:
- Context: A CCN does not have 'RELEASE' status and transit status is not 'R'
- Applied to: Set Status to 'TRANSIT'
- Action: No other status classification rules apply
Logic Flow:
IF A CCN does not have 'RELEASE' status and transit status is not 'R'
AND No other status classification rules apply
THEN:
- • Set the display status to 'TRANSIT' for reporting purposes
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn exists with equipment id and waybill information.
Trigger Criteria:
- Context: A CCN exists with equipment ID and waybill information
- Applied to: CCN Usable for Train?
- Action: The system validates CCN usability by checking if equipment ID matches and either waybill number matches or new bond created flag is 'Y'
Logic Flow:
IF A CCN exists with equipment ID and waybill information
AND The system validates CCN usability by checking if equipment ID matches and either waybill number matches or new bond created flag is 'Y'
THEN:
- • If validation fails, mark CCN as unusable and report 'CCN FOUND NOT USABLE' for VERIFY operations,
otherwise allow CCN usage
R-GCX146-cbl-00651 (+8) File: GCX146.cbl Business Rule: Haulage Rights Validation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment record exists in the system.
Trigger Criteria:
- Context: An equipment record exists in the system
- Applied to: Retrieve Equipment SCAC Code
- Action: The system processes equipment for haulage rights validation
Logic Flow:
IF An equipment record exists in the system
AND The system processes equipment for haulage rights validation
THEN:
- • The equipment's SCAC code is retrieved from the equipment record for validation purposes
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment scac code has been retrieved.
Trigger Criteria:
- Context: An equipment SCAC code has been retrieved
- Applied to: SCAC Code Valid?
- Action: The system validates the SCAC code against authorized carriers
Logic Flow:
IF An equipment SCAC code has been retrieved
AND The system validates the SCAC code against authorized carriers
THEN:
- • The system determines if the SCAC code is valid for haulage rights processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid scac code exists for the equipment.
Trigger Criteria:
- Context: A valid SCAC code exists for the equipment
- Applied to: Haulage Rights Authorized?
- Action: The system checks haulage rights authorization for the SCAC
Logic Flow:
IF A valid SCAC code exists for the equipment
AND The system checks haulage rights authorization for the SCAC
THEN:
- • The system determines if haulage rights are authorized for this SCAC code
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has valid scac code and authorized haulage rights.
Trigger Criteria:
- Context: Equipment has valid SCAC code and authorized haulage rights
- Applied to: Set Haulage Rights Flag
- Action: The system processes the equipment for haulage validation
Logic Flow:
IF Equipment has valid SCAC code and authorized haulage rights
AND The system processes the equipment for haulage validation
THEN:
- • The haulage rights flag is set to indicate authorized haulage status
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has been validated with haulage rights authorization.
Trigger Criteria:
- Context: Equipment has been validated with haulage rights authorization
- Applied to: Increment Haulage Total Counter
- Action: The haulage rights flag is set for the equipment
Logic Flow:
IF Equipment has been validated with haulage rights authorization
AND The haulage rights flag is set for the equipment
THEN:
- • The total haulage counter is incremented by one
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment has validated haulage rights and the counter has been incremented.
Trigger Criteria:
- Context: Equipment has validated haulage rights and the counter has been incremented
- Applied to: Update Equipment Status as Haulage
- Action: The system updates equipment processing status
Logic Flow:
IF Equipment has validated haulage rights and the counter has been incremented
AND The system updates equipment processing status
THEN:
- • The equipment status is updated to indicate haulage rights authorization
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has an invalid scac code.
Trigger Criteria:
- Context: Equipment has an invalid SCAC code
- Applied to: Generate SCAC Access Error
- Action: The system validates SCAC code for haulage rights
Logic Flow:
IF Equipment has an invalid SCAC code
AND The system validates SCAC code for haulage rights
THEN:
- • A SCAC access error is generated indicating invalid authorization
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has valid scac code but lacks haulage rights authorization.
Trigger Criteria:
- Context: Equipment has valid SCAC code but lacks haulage rights authorization
- Applied to: Set Invalid Haulage Status
- Action: The system processes haulage rights validation
Logic Flow:
IF Equipment has valid SCAC code but lacks haulage rights authorization
AND The system processes haulage rights validation
THEN:
- • The equipment status is set to indicate invalid haulage rights
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment fails either scac validation or haulage rights authorization.
Trigger Criteria:
- Context: Equipment fails either SCAC validation or haulage rights authorization
- Applied to: Log Validation Failure
- Action: The system encounters validation failure
Logic Flow:
IF Equipment fails either SCAC validation or haulage rights authorization
AND The system encounters validation failure
THEN:
- • The validation failure is logged for audit and tracking purposes
R-GCX146-cbl-00660 (+8) File: GCX146.cbl Business Rule: Equipment Status Totals Management
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment record is being processed for status totals.
Trigger Criteria:
- Context: An equipment record is being processed for status totals
- Applied to: Increment TOTAL-RELEASE Counter
- Action: The equipment CCN status is 'RELEASE' or 'CSA-DLV'
Logic Flow:
IF An equipment record is being processed for status totals
AND The equipment CCN status is 'RELEASE' or 'CSA-DLV'
THEN:
- • The TOTAL-RELEASE counter should be incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment record is being processed for status totals.
Trigger Criteria:
- Context: An equipment record is being processed for status totals
- Applied to: Increment TOTAL-HAULAGE Counter
- Action: The equipment has haulage flag set to 'Y' or manual haulage flag set to 'Y'
Logic Flow:
IF An equipment record is being processed for status totals
AND The equipment has haulage flag set to 'Y' or manual haulage flag set to 'Y'
THEN:
- • The TOTAL-HAULAGE counter should be incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment record is being processed for status totals.
Trigger Criteria:
- Context: An equipment record is being processed for status totals
- Applied to: Increment TOTAL-HELD-CCRA Counter
- Action: The equipment CCN status is 'HOLD' or 'AGI-HOLD'
Logic Flow:
IF An equipment record is being processed for status totals
AND The equipment CCN status is 'HOLD' or 'AGI-HOLD'
THEN:
- • The TOTAL-HELD-CCRA counter should be incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment record is being processed for status totals.
Trigger Criteria:
- Context: An equipment record is being processed for status totals
- Applied to: Increment TOTAL-PROCEED Counter
- Action: The equipment CCN status is 'RETURN' or the manifest from station is different from the manifest to station and the status is not 'ERROR', 'REJECT', or 'DELETED'
Logic Flow:
IF An equipment record is being processed for status totals
AND The equipment CCN status is 'RETURN' or the manifest from station is different from the manifest to station and the status is not 'ERROR', 'REJECT', or 'DELETED'
THEN:
- • The TOTAL-PROCEED counter should be incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment record is being processed for status totals.
Trigger Criteria:
- Context: An equipment record is being processed for status totals
- Applied to: Increment TOTAL-HELD-DOCS Counter
- Action: The manifest from station equals the manifest to station and the broker entry field is empty
Logic Flow:
IF An equipment record is being processed for status totals
AND The manifest from station equals the manifest to station and the broker entry field is empty
THEN:
- • The TOTAL-HELD-DOCS counter should be incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment record is being processed.
Trigger Criteria:
- Context: An equipment record is being processed
- Applied to: Process Equipment Record
- Action: Any equipment record is encountered during processing
Logic Flow:
IF An equipment record is being processed
AND Any equipment record is encountered during processing
THEN:
- • The TOTAL-EQUIP counter should be incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment record has been categorized by status.
Trigger Criteria:
- Context: An equipment record has been categorized by status
- Applied to: Update Status Report Fields
- Action: The equipment has a valid CCN and is not a loaded or empty car without proper documentation
Logic Flow:
IF An equipment record has been categorized by status
AND The equipment has a valid CCN and is not a loaded or empty car without proper documentation
THEN:
- • The status report should be populated with equipment ID, manifest station names, and transit status where transit status shows 'TRANSIT' if in-transit status is 'T'
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment status processing is in progress.
Trigger Criteria:
- Context: Equipment status processing is in progress
- Applied to: More Equipment Records?
- Action: The current equipment record has been processed and categorized
Logic Flow:
IF Equipment status processing is in progress
AND The current equipment record has been processed and categorized
THEN:
- • If more equipment records exist in the train consist, continue processing the next record,
otherwise proceed to calculate final totals
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all equipment records have been processed and categorized.
Trigger Criteria:
- Context: All equipment records have been processed and categorized
- Applied to: Calculate Final Equipment Totals
- Action: No more equipment records remain to be processed
Logic Flow:
IF All equipment records have been processed and categorized
AND No more equipment records remain to be processed
THEN:
- • All status counters (TOTAL-RELEASE, TOTAL-HAULAGE, TOTAL-HELD-CCRA, TOTAL-PROCEED, TOTAL-HELD-DOCS, TOTAL-EQUIP) should be finalized for summary reporting
R-GCX146-cbl-00669 (+13) File: GCX146.cbl Business Rule: AEI Train Send Logging
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when aei train send operation is being processed.
Trigger Criteria:
- Context: An AEI train send operation is being processed
- Applied to: Get Email User Lists from Station Configuration
- Action: The system needs to determine email recipients for the AEI report
Logic Flow:
IF An AEI train send operation is being processed
AND The system needs to determine email recipients for the AEI report
THEN:
- • The system retrieves email user lists from the station configuration database (GCSTBRT) based on the train's station information
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when aei report has been generated with content lines.
Trigger Criteria:
- Context: An AEI report has been generated with content lines
- Applied to: Check Report Size
- Action: The system prepares to send the report via email
Logic Flow:
IF An AEI report has been generated with content lines
AND The system prepares to send the report via email
THEN:
- • The system counts the total number of lines in the report to determine if special handling is required
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when aei report has been sized and line count determined.
Trigger Criteria:
- Context: An AEI report has been sized and line count determined
- Applied to: Report > 699 Lines?
- Action: The report contains more than 699 lines
Logic Flow:
IF An AEI report has been sized and line count determined
AND The report contains more than 699 lines
THEN:
- • The system initiates large report processing with continuation logic,
otherwise uses standard single-message processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when aei report contains 699 lines or fewer.
Trigger Criteria:
- Context: An AEI report contains 699 lines or fewer
- Applied to: Process Standard AEI Report
- Action: The system processes the report for email transmission
Logic Flow:
IF An AEI report contains 699 lines or fewer
AND The system processes the report for email transmission
THEN:
- • The system prepares the entire report as a single email message without continuation headers
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when aei report contains more than 699 lines.
Trigger Criteria:
- Context: An AEI report contains more than 699 lines
- Applied to: Process Large Report with Continuation
- Action: The system processes the report for email transmission
Logic Flow:
IF An AEI report contains more than 699 lines
AND The system processes the report for email transmission
THEN:
- • The system splits the report into multiple email messages, each containing up to 699 lines with appropriate continuation headers
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when aei report message batch is prepared for transmission.
Trigger Criteria:
- Context: An AEI report message batch is prepared for transmission
- Applied to: Send Current Batch via EMCSEND3
- Action: The system initiates email sending
Logic Flow:
IF An AEI report message batch is prepared for transmission
AND The system initiates email sending
THEN:
- • The system calls EMCSEND3 service to transmit the email message to the configured recipients
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when batch of aei report lines has been sent via email.
Trigger Criteria:
- Context: A batch of AEI report lines has been sent via email
- Applied to: Reset Message Buffer
- Action: More lines remain to be processed in a large report
Logic Flow:
IF A batch of AEI report lines has been sent via email
AND More lines remain to be processed in a large report
THEN:
- • The system clears the current message buffer to prepare for the next continuation segment
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when large aei report requires multiple email messages.
Trigger Criteria:
- Context: A large AEI report requires multiple email messages
- Applied to: Add Continuation Header
- Action: The system prepares continuation messages after the first message
Logic Flow:
IF A large AEI report requires multiple email messages
AND The system prepares continuation messages after the first message
THEN:
- • The system adds 'CONTINUATION OF REPORT....' header to identify the message as part of a multi-part report
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when batch of lines from a large aei report has been processed.
Trigger Criteria:
- Context: A batch of lines from a large AEI report has been processed
- Applied to: More Lines to Process?
- Action: The system checks for remaining content
Logic Flow:
IF A batch of lines from a large AEI report has been processed
AND The system checks for remaining content
THEN:
- • If more lines exist beyond the current batch, the system continues processing with the next batch,
otherwise completes the report transmission
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when aei report email has been sent via emcsend3.
Trigger Criteria:
- Context: An AEI report email has been sent via EMCSEND3
- Applied to: Check Email Transmission Status
- Action: The system receives the transmission response
Logic Flow:
IF An AEI report email has been sent via EMCSEND3
AND The system receives the transmission response
THEN:
- • The system evaluates the response to determine if the email was successfully delivered or if fallback procedures are needed
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when aei report email transmission attempt has completed.
Trigger Criteria:
- Context: An AEI report email transmission attempt has completed
- Applied to: Email Successful?
- Action: The system evaluates the transmission status
Logic Flow:
IF An AEI report email transmission attempt has completed
AND The system evaluates the transmission status
THEN:
- • If transmission failed, the system initiates fallback email procedures,
otherwise proceeds with normal AEI logging activities
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when primary aei report email transmission has failed.
Trigger Criteria:
- Context: Primary AEI report email transmission has failed
- Applied to: Use Fallback Email OM01247/AEI9999
- Action: The system needs to ensure report delivery
Logic Flow:
IF Primary AEI report email transmission has failed
AND The system needs to ensure report delivery
THEN:
- • The system sends the AEI report to fallback email addresses OM01247 and AEI9999 to ensure delivery to support personnel
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when aei report transmission has been completed (successfully or via fallback).
Trigger Criteria:
- Context: An AEI report transmission has been completed (successfully or via fallback)
- Applied to: Log AEI Transmission Activity
- Action: The system finalizes the transmission process
Logic Flow:
IF An AEI report transmission has been completed (successfully or via fallback)
AND The system finalizes the transmission process
THEN:
- • The system creates audit log entries recording the AEI transmission activity, including transmission status and recipient information
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when aei transmission activities have been logged.
Trigger Criteria:
- Context: AEI transmission activities have been logged
- Applied to: Update AEI Send Status
- Action: The system completes the AEI send process
Logic Flow:
IF AEI transmission activities have been logged
AND The system completes the AEI send process
THEN:
- • The system updates the AEI send status in the relevant system records to reflect the completion of the transmission process
R-GCX146-cbl-00683 (+16) File: GCX146.cbl Business Rule: Trip Sheet Distribution
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when trip sheet needs to be distributed.
Trigger Criteria:
- Context: A trip sheet needs to be distributed
- Applied to: Check Distribution Configuration
- Action: The system checks the distribution configuration
Logic Flow:
IF A trip sheet needs to be distributed
AND The system checks the distribution configuration
THEN:
- • The system identifies whether auto-FAX is enabled based on station configuration
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when auto-fax distribution is enabled.
Trigger Criteria:
- Context: Auto-FAX distribution is enabled
- Applied to: Setup FAX Routing Parameters
- Action: The system sets up FAX routing
Logic Flow:
IF Auto-FAX distribution is enabled
AND The system sets up FAX routing
THEN:
- • FAX routing parameters are configured from station configuration data
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when trip sheet distribution is required.
Trigger Criteria:
- Context: Trip sheet distribution is required
- Applied to: Configure Merlin Transmission
- Action: The system configures Merlin transmission
Logic Flow:
IF Trip sheet distribution is required
AND The system configures Merlin transmission
THEN:
- • Merlin transmission parameters are set up for report delivery
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when canadian trip sheet is ready for distribution and merlin is configured.
Trigger Criteria:
- Context: A Canadian trip sheet is ready for distribution and Merlin is configured
- Applied to: Send Canadian Trip Sheet via Merlin
- Action: The system sends the trip sheet via Merlin
Logic Flow:
IF A Canadian trip sheet is ready for distribution and Merlin is configured
AND The system sends the trip sheet via Merlin
THEN:
- • The Canadian trip sheet is transmitted to customs and authorized recipients through Merlin system
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when trip sheet distribution is in progress.
Trigger Criteria:
- Context: A trip sheet distribution is in progress
- Applied to: US Trip Sheet Required?
- Action: The system evaluates if US trip sheet is required
Logic Flow:
IF A trip sheet distribution is in progress
AND The system evaluates if US trip sheet is required
THEN:
- • The system determines US trip sheet requirement based on cargo destination being US territory
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when us trip sheet is required.
Trigger Criteria:
- Context: US trip sheet is required
- Applied to: Prepare US Trip Sheet Data
- Action: The system prepares US trip sheet data
Logic Flow:
IF US trip sheet is required
AND The system prepares US trip sheet data
THEN:
- • US-specific trip sheet data is formatted with appropriate customs and regulatory information
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when us trip sheet data is prepared and merlin is configured.
Trigger Criteria:
- Context: US trip sheet data is prepared and Merlin is configured
- Applied to: Send US Trip Sheet via Merlin
- Action: The system sends the US trip sheet via Merlin
Logic Flow:
IF US trip sheet data is prepared and Merlin is configured
AND The system sends the US trip sheet via Merlin
THEN:
- • The US trip sheet is transmitted to US customs and authorized recipients through Merlin system
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when trip sheet distribution is in progress.
Trigger Criteria:
- Context: Trip sheet distribution is in progress
- Applied to: Check AEI Report Distribution
- Action: The system checks for AEI report distribution requirements
Logic Flow:
IF Trip sheet distribution is in progress
AND The system checks for AEI report distribution requirements
THEN:
- • The system identifies if AEI report distribution is needed based on train type and configuration
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when aei report distribution is being processed.
Trigger Criteria:
- Context: AEI report distribution is being processed
- Applied to: Email Distribution Required?
- Action: The system evaluates email distribution requirements
Logic Flow:
IF AEI report distribution is being processed
AND The system evaluates email distribution requirements
THEN:
- • The system determines if email distribution is required based on station configuration and recipient preferences
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when email distribution is required.
Trigger Criteria:
- Context: Email distribution is required
- Applied to: Get Email User Lists from Station Config
- Action: The system retrieves email user lists
Logic Flow:
IF Email distribution is required
AND The system retrieves email user lists
THEN:
- • Email distribution lists are obtained from station configuration data including authorized recipients
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when email user lists are retrieved and aei report is ready.
Trigger Criteria:
- Context: Email user lists are retrieved and AEI report is ready
- Applied to: Send AEI Report via Email
- Action: The system sends the AEI report via email
Logic Flow:
IF Email user lists are retrieved and AEI report is ready
AND The system sends the AEI report via email
THEN:
- • The AEI report is distributed via email to all configured recipients with proper formatting
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when aei report is being sent via email.
Trigger Criteria:
- Context: An AEI report is being sent via email
- Applied to: Large Report?
- Action: The system checks the report size
Logic Flow:
IF An AEI report is being sent via email
AND The system checks the report size
THEN:
- • The system determines if the report exceeds 699 lines requiring continuation message handling
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when report exceeds the maximum line limit of 699 lines.
Trigger Criteria:
- Context: A report exceeds the maximum line limit of 699 lines
- Applied to: Handle Report Continuation
- Action: The system handles report continuation
Logic Flow:
IF A report exceeds the maximum line limit of 699 lines
AND The system handles report continuation
THEN:
- • The system creates multiple email messages with continuation headers and distributes the complete report across multiple messages
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when fax routing parameters are configured.
Trigger Criteria:
- Context: FAX routing parameters are configured
- Applied to: Setup External FAX Addressing
- Action: The system sets up external FAX addressing
Logic Flow:
IF FAX routing parameters are configured
AND The system sets up external FAX addressing
THEN:
- • External FAX addresses are configured for customs and authorized recipients based on routing parameters
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when external fax addressing is set up. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: External FAX addressing is set up
- Applied to: Route to Copy IDs
- Action: The system routes to copy IDs
Logic Flow:
IF External FAX addressing is set up
AND The system routes to copy IDs
THEN:
- • Trip sheets are routed to all configured copy recipients based on distribution configuration
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when trip sheets are prepared and routing is configured.
Trigger Criteria:
- Context: Trip sheets are prepared and routing is configured
- Applied to: Transmit to Customs Systems
- Action: The system transmits to customs systems
Logic Flow:
IF Trip sheets are prepared and routing is configured
AND The system transmits to customs systems
THEN:
- • Trip sheets are transmitted to appropriate customs systems (Canadian and/or US) for regulatory processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when customs systems transmission is complete.
Trigger Criteria:
- Context: Customs systems transmission is complete
- Applied to: Transmit to Authorized Recipients
- Action: The system transmits to authorized recipients
Logic Flow:
IF Customs systems transmission is complete
AND The system transmits to authorized recipients
THEN:
- • Trip sheets are transmitted to all authorized recipients including brokers, agents, and other stakeholders
R-GCX146-cbl-00700 (+10) File: GCX146.cbl Business Rule: Status Report Distribution
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when status report needs to be distributed.
Trigger Criteria:
- Context: A status report needs to be distributed
- Applied to: Check Distribution Configuration
- Action: The system checks if this is an AEI train send operation
Logic Flow:
IF A status report needs to be distributed
AND The system checks if this is an AEI train send operation
THEN:
- • Email distribution is enabled for AEI train sends and disabled for regular operations
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when email distribution is required for a status report.
Trigger Criteria:
- Context: Email distribution is required for a status report
- Applied to: Prepare Email Recipients List
- Action: The system looks up email addresses using the station code from CUSEMAIL table
Logic Flow:
IF Email distribution is required for a status report
AND The system looks up email addresses using the station code from CUSEMAIL table
THEN:
- • If email addresses are found, use them for distribution,
otherwise use default support addresses OM01247 and AEI9999
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when status report is being sent via email.
Trigger Criteria:
- Context: A status report is being sent via email
- Applied to: Send Status Report via Email
- Action: The report exceeds 699 lines
Logic Flow:
IF A status report is being sent via email
AND The report exceeds 699 lines
THEN:
- • Split the report into multiple email messages with continuation headers 'CONTINUATION OF REPORT....' for subsequent messages
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when status report has been processed for email distribution.
Trigger Criteria:
- Context: A status report has been processed for email distribution
- Applied to: Merlin Distribution Required?
- Action: The system checks station configuration for Merlin distribution requirements
Logic Flow:
IF A status report has been processed for email distribution
AND The system checks station configuration for Merlin distribution requirements
THEN:
- • Enable Merlin distribution if required by customs processing rules or station settings
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when merlin distribution is required for a status report.
Trigger Criteria:
- Context: Merlin distribution is required for a status report
- Applied to: Prepare Merlin Message Format
- Action: The system prepares the message format using validated Merlin IDs from EMTZ table
Logic Flow:
IF Merlin distribution is required for a status report
AND The system prepares the message format using validated Merlin IDs from EMTZ table
THEN:
- • Format the report content according to Merlin communication standards with proper headers and routing information
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when status report is formatted for merlin transmission.
Trigger Criteria:
- Context: A status report is formatted for Merlin transmission
- Applied to: Send Status Report via Merlin
- Action: The system sends the report through Merlin communication channels
Logic Flow:
IF A status report is formatted for Merlin transmission
AND The system sends the report through Merlin communication channels
THEN:
- • Transmit the report to designated Merlin terminals with proper routing and confirmation handling
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when status report has been processed for merlin distribution.
Trigger Criteria:
- Context: A status report has been processed for Merlin distribution
- Applied to: FAX Distribution Required?
- Action: The system checks station configuration for auto-FAX settings
Logic Flow:
IF A status report has been processed for Merlin distribution
AND The system checks station configuration for auto-FAX settings
THEN:
- • Enable FAX distribution if auto-FAX is configured for the station
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when fax distribution is required for a status report.
Trigger Criteria:
- Context: FAX distribution is required for a status report
- Applied to: Setup FAX Routing Information
- Action: The system retrieves FAX configuration from station settings
Logic Flow:
IF FAX distribution is required for a status report
AND The system retrieves FAX configuration from station settings
THEN:
- • Setup routing information including FAX numbers, transmission parameters, and delivery options from station configuration
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when fax routing information is configured for a status report.
Trigger Criteria:
- Context: FAX routing information is configured for a status report
- Applied to: Send Status Report via FAX
- Action: The system initiates FAX transmission
Logic Flow:
IF FAX routing information is configured for a status report
AND The system initiates FAX transmission
THEN:
- • Send the status report via FAX to configured recipients with proper formatting and delivery confirmation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when primary distribution channels have been processed.
Trigger Criteria:
- Context: Primary distribution channels have been processed
- Applied to: Additional Recipients?
- Action: The system checks for additional recipients in the distribution configuration
Logic Flow:
IF Primary distribution channels have been processed
AND The system checks for additional recipients in the distribution configuration
THEN:
- • If additional recipients exist, continue processing them,
otherwise proceed to logging
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when status report distribution has been completed to all configured recipients.
Trigger Criteria:
- Context: Status report distribution has been completed to all configured recipients
- Applied to: Log Distribution Activity
- Action: The system finalizes the distribution process
Logic Flow:
IF Status report distribution has been completed to all configured recipients
AND The system finalizes the distribution process
THEN:
- • Log all distribution activities including transmission methods used, recipients contacted, success/failure status, and timestamps for audit trail
R-GCX146-cbl-00711 (+13) File: GCX146.cbl Business Rule: Error Message Distribution
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when processing error has been detected during train processing operations. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A processing error has been detected during train processing operations
- Applied to: Set Error Code in WS-ERROR-NB
- Action: The system identifies the specific type of error that occurred
Logic Flow:
IF A processing error has been detected during train processing operations
AND The system identifies the specific type of error that occurred
THEN:
- • The system assigns the corresponding error code to WS-ERROR-NB field for tracking and reporting purposes
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when error has been detected and error code has been assigned. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: An error has been detected and error code has been assigned
- Applied to: Set Rollback Flag WS-ROLB
- Action: The system determines that the error requires transaction rollback to maintain data consistency
Logic Flow:
IF An error has been detected and error code has been assigned
AND The system determines that the error requires transaction rollback to maintain data consistency
THEN:
- • The system sets the rollback flag WS-ROLB to indicate that all changes should be reversed
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when error code has been assigned and the error processing section is invoked.
Trigger Criteria:
- Context: An error code has been assigned and the error processing section is invoked
- Applied to: Generate Error Message Content
- Action: The system needs to create a human-readable error message
Logic Flow:
IF An error code has been assigned and the error processing section is invoked
AND The system needs to create a human-readable error message
THEN:
- • The system generates error message content that describes the error condition in business terms including relevant context information
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when error message has been generated with specific error content.
Trigger Criteria:
- Context: An error message has been generated with specific error content
- Applied to: Identify Distribution Recipients
- Action: The system needs to determine who should receive the error notification
Logic Flow:
IF An error message has been generated with specific error content
AND The system needs to determine who should receive the error notification
THEN:
- • The system identifies the appropriate recipients including supervisors and designated personnel based on the error type and current user context
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when error distribution recipients have been identified.
Trigger Criteria:
- Context: Error distribution recipients have been identified
- Applied to: Supervisor Notification Required?
- Action: The system evaluates the error severity and type against notification policies
Logic Flow:
IF Error distribution recipients have been identified
AND The system evaluates the error severity and type against notification policies
THEN:
- • The system determines if supervisor notification is required and routes accordingly to supervisor communication channels or proceeds to other notification methods
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when system has determined that supervisor notification is required.
Trigger Criteria:
- Context: The system has determined that supervisor notification is required
- Applied to: Route to Supervisor via ALT-PCB
- Action: Error message routing to supervisor is initiated
Logic Flow:
IF The system has determined that supervisor notification is required
AND Error message routing to supervisor is initiated
THEN:
- • The system routes the error message to supervisors using the ALT-PCB communication channel with supervisor contact information from GCSTBRT
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when supervisor notification processing has been completed or bypassed.
Trigger Criteria:
- Context: Supervisor notification processing has been completed or bypassed
- Applied to: Designated Personnel Notification?
- Action: The system evaluates whether additional designated personnel require notification
Logic Flow:
IF Supervisor notification processing has been completed or bypassed
AND The system evaluates whether additional designated personnel require notification
THEN:
- • The system determines if designated personnel notification is needed and either routes to Merlin communication system or proceeds to message queuing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when system has determined that designated personnel notification is required.
Trigger Criteria:
- Context: The system has determined that designated personnel notification is required
- Applied to: Route to Merlin Communication System
- Action: Error message routing to designated personnel is initiated
Logic Flow:
IF The system has determined that designated personnel notification is required
AND Error message routing to designated personnel is initiated
THEN:
- • The system routes the error message through the Merlin communication system using communication IDs from EMTZ-ROOT
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when error message routing decisions have been completed.
Trigger Criteria:
- Context: Error message routing decisions have been completed
- Applied to: Queue Error Message for Distribution
- Action: The system prepares to distribute the error message
Logic Flow:
IF Error message routing decisions have been completed
AND The system prepares to distribute the error message
THEN:
- • The system queues the error message for distribution through the messaging infrastructure
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when error messages have been queued for distribution.
Trigger Criteria:
- Context: Error messages have been queued for distribution
- Applied to: Send via IMS Message Queues
- Action: The system initiates message distribution
Logic Flow:
IF Error messages have been queued for distribution
AND The system initiates message distribution
THEN:
- • The system sends the error messages via IMS message queues to ensure reliable delivery to all identified recipients
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when user with supervisor privileges ('s' type) is submitting an eta date.
Trigger Criteria:
- Context: A user with supervisor privileges ('S' type) is submitting an ETA date
- Applied to: ETA Date Range - Special Users
- Action: The system validates the ETA date against the allowed range
Logic Flow:
IF A user with supervisor privileges ('S' type) is submitting an ETA date
AND The system validates the ETA date against the allowed range
THEN:
- • The system generates Error 25 if the ETA date is not between 30 days before and 5 days after the current date
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when standard user (non-supervisor) is submitting an eta date.
Trigger Criteria:
- Context: A standard user (non-supervisor) is submitting an ETA date
- Applied to: ETA Date Range - Standard Users
- Action: The system validates the ETA date against the allowed range
Logic Flow:
IF A standard user (non-supervisor) is submitting an ETA date
AND The system validates the ETA date against the allowed range
THEN:
- • The system generates Error 35 if the ETA date is not between 2 days before and 2 days after the current date
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when user is attempting to perform an operation that requires scac access validation.
Trigger Criteria:
- Context: A user is attempting to perform an operation that requires SCAC access validation
- Applied to: SCAC Access Violation
- Action: The system determines that SCAC access is invalid AND the operation is not an AEI train send
Logic Flow:
IF A user is attempting to perform an operation that requires SCAC access validation
AND The system determines that SCAC access is invalid AND the operation is not an AEI train send
THEN:
- • The system generates Error 36 for SCAC access violation and initiates error distribution process
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when processing failure occurs during transaction execution.
Trigger Criteria:
- Context: A processing failure occurs during transaction execution
- Applied to: Processing Failures
- Action: The system detects that a spawned transaction or critical process has failed
Logic Flow:
IF A processing failure occurs during transaction execution
AND The system detects that a spawned transaction or critical process has failed
THEN:
- • The system generates Error 38 for processing failures and initiates the error distribution workflow
R-GCX146-cbl-00733 (+7) File: GCX146.cbl Business Rule: Special Manifest Transaction Processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo item with a ccn (customs control number) exists in the system.
Trigger Criteria:
- Context: A cargo item with a CCN (Customs Control Number) exists in the system
- Applied to: Identify Cargo with Specific Routing Codes
- Action: The CCN key starts with '6105' prefix
Logic Flow:
IF A cargo item with a CCN (Customs Control Number) exists in the system
AND The CCN key starts with '6105' prefix
THEN:
- • The cargo is flagged as requiring special manifest processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has been identified as requiring special manifest processing.
Trigger Criteria:
- Context: Cargo has been identified as requiring special manifest processing
- Applied to: Set Security Processing Flag
- Action: The special manifest processing is initiated
Logic Flow:
IF Cargo has been identified as requiring special manifest processing
AND The special manifest processing is initiated
THEN:
- • The security processing flag is set to active status
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when special manifest transaction is being created.
Trigger Criteria:
- Context: A special manifest transaction is being created
- Applied to: Assign CA Record Type Code
- Action: The record type needs to be assigned
Logic Flow:
IF A special manifest transaction is being created
AND The record type needs to be assigned
THEN:
- • The record type is set to 'CA' indicating Canadian processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when special manifest transaction is being created.
Trigger Criteria:
- Context: A special manifest transaction is being created
- Applied to: Increment Spawn Counter
- Action: The transaction is queued for processing
Logic Flow:
IF A special manifest transaction is being created
AND The transaction is queued for processing
THEN:
- • The spawn counter is incremented by one to track the new transaction
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when train data contains border segment information in gcwb4tl.
Trigger Criteria:
- Context: Train data contains border segment information in GCWB4TL
- Applied to: Extract Border Information
- Action: Special manifest processing requires border details
Logic Flow:
IF Train data contains border segment information in GCWB4TL
AND Special manifest processing requires border details
THEN:
- • Border code and station name are extracted from the train border segments
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn exists for cargo requiring special manifest processing.
Trigger Criteria:
- Context: A CCN exists for cargo requiring special manifest processing
- Applied to: Store CCN Key Information
- Action: The special manifest transaction is being prepared
Logic Flow:
IF A CCN exists for cargo requiring special manifest processing
AND The special manifest transaction is being prepared
THEN:
- • The CCN key information is stored for transaction processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when border information, ccn key data, and record type are available.
Trigger Criteria:
- Context: Border information, CCN key data, and record type are available
- Applied to: Build Special Manifest Input
- Action: A special manifest transaction needs to be created
Logic Flow:
IF Border information, CCN key data, and record type are available
AND A special manifest transaction needs to be created
THEN:
- • The system builds the complete input structure with all required manifest data
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when complete special manifest input structure has been built.
Trigger Criteria:
- Context: A complete special manifest input structure has been built
- Applied to: Queue Special Manifest Transaction
- Action: The transaction is ready for processing
Logic Flow:
IF A complete special manifest input structure has been built
AND The transaction is ready for processing
THEN:
- • The transaction is queued in the special manifest processing queue for execution
R-GCX146-cbl-00741 File: GCX146.cbl Business Rule: Port Fix Message Generation
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when request to extract business rules for port fix message generation.
Trigger Criteria:
- Context: A request to extract business rules for port fix message generation
- Applied to: Port Fix Message Generation Not Found
- Action: The provided COBOL code summary is analyzed for port fix message generation logic
Logic Flow:
IF A request to extract business rules for port fix message generation
AND The provided COBOL code summary is analyzed for port fix message generation logic
THEN:
- • No specific port fix message generation business process can be identified in the available code
R-GCX146-cbl-00742 (+9) File: GCX146.cbl Business Rule: Equipment Totals Summary Generation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment totals summary generation process is starting.
Trigger Criteria:
- Context: Equipment totals summary generation process is starting
- Applied to: Initialize Equipment Status Counters
- Action: The system begins processing equipment records for summary totals
Logic Flow:
IF Equipment totals summary generation process is starting
AND The system begins processing equipment records for summary totals
THEN:
- • All equipment status counters (TOTAL-RELEASE, TOTAL-HAULAGE, TOTAL-HELD-CCRA, TOTAL-PROCEED, TOTAL-HELD-DOCS, TOTAL-EQUIP, TOTAL-DOCS-NR) are initialized to zero
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment record is being processed for totals calculation.
Trigger Criteria:
- Context: An equipment record is being processed for totals calculation
- Applied to: Increment TOTAL-RELEASE Counter
- Action: The equipment status is 'RELEASE' or 'CSA-DLV'
Logic Flow:
IF An equipment record is being processed for totals calculation
AND The equipment status is 'RELEASE' or 'CSA-DLV'
THEN:
- • The TOTAL-RELEASE counter is incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment record is being processed for totals calculation.
Trigger Criteria:
- Context: An equipment record is being processed for totals calculation
- Applied to: Increment TOTAL-HAULAGE Counter
- Action: The equipment has haulage flag set to 'Y' or manual haulage flag set to 'Y'
Logic Flow:
IF An equipment record is being processed for totals calculation
AND The equipment has haulage flag set to 'Y' or manual haulage flag set to 'Y'
THEN:
- • The TOTAL-HAULAGE counter is incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment record is being processed for totals calculation.
Trigger Criteria:
- Context: An equipment record is being processed for totals calculation
- Applied to: Increment TOTAL-HELD-CCRA Counter
- Action: The equipment status is 'HOLD' or 'AGI-HOLD'
Logic Flow:
IF An equipment record is being processed for totals calculation
AND The equipment status is 'HOLD' or 'AGI-HOLD'
THEN:
- • The TOTAL-HELD-CCRA counter is incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment record is being processed for totals calculation.
Trigger Criteria:
- Context: An equipment record is being processed for totals calculation
- Applied to: Increment TOTAL-PROCEED Counter
- Action: The equipment has 'RETURN' status or has different manifest from and to stations and the status is not error, reject, or deleted
Logic Flow:
IF An equipment record is being processed for totals calculation
AND The equipment has 'RETURN' status or has different manifest from and to stations and the status is not error, reject, or deleted
THEN:
- • The TOTAL-PROCEED counter is incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment record is being processed for totals calculation.
Trigger Criteria:
- Context: An equipment record is being processed for totals calculation
- Applied to: Increment TOTAL-HELD-DOCS Counter
- Action: The equipment manifest from station equals manifest to station and the broker entry is empty
Logic Flow:
IF An equipment record is being processed for totals calculation
AND The equipment manifest from station equals manifest to station and the broker entry is empty
THEN:
- • The TOTAL-HELD-DOCS counter is incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when all equipment records have been processed and individual counters updated.
Trigger Criteria:
- Context: All equipment records have been processed and individual counters updated
- Applied to: Calculate Summary Totals
- Action: The system completes processing all equipment in the train
Logic Flow:
IF All equipment records have been processed and individual counters updated
AND The system completes processing all equipment in the train
THEN:
- • Final summary totals are calculated including TOTAL-EQUIP as the sum of all equipment processed
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment summary totals have been calculated.
Trigger Criteria:
- Context: Equipment summary totals have been calculated
- Applied to: Format Totals for Trip Sheet Display
- Action: A trip sheet report is being generated
Logic Flow:
IF Equipment summary totals have been calculated
AND A trip sheet report is being generated
THEN:
- • Equipment totals are formatted with appropriate labels and numeric formatting for trip sheet display
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment summary totals have been calculated.
Trigger Criteria:
- Context: Equipment summary totals have been calculated
- Applied to: Format Totals for Status Report Display
- Action: A status report is being generated
Logic Flow:
IF Equipment summary totals have been calculated
AND A status report is being generated
THEN:
- • Equipment totals are formatted with appropriate labels and descriptions for status report display
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment totals have been formatted for display.
Trigger Criteria:
- Context: Equipment totals have been formatted for display
- Applied to: Generate Equipment Summary Lines
- Action: Report generation requires equipment summary information
Logic Flow:
IF Equipment totals have been formatted for display
AND Report generation requires equipment summary information
THEN:
- • Formatted summary lines are generated showing totals for released, held, proceeding, and other equipment categories
R-GCX146-cbl-00752 (+12) File: GCX146.cbl Business Rule: EDI Train Data Transmission
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when train manifest requires edi transmission to customs systems.
Trigger Criteria:
- Context: A train manifest requires EDI transmission to customs systems
- Applied to: Initialize EDI Header Setup
- Action: The EDI transmission process begins
Logic Flow:
IF A train manifest requires EDI transmission to customs systems
AND The EDI transmission process begins
THEN:
- • The system initializes EDI header with train ID, timestamp, and transmission control information
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment records exist in the train manifest.
Trigger Criteria:
- Context: Equipment records exist in the train manifest
- Applied to: Set Equipment Type Codes
- Action: Processing equipment for EDI transmission
Logic Flow:
IF Equipment records exist in the train manifest
AND Processing equipment for EDI transmission
THEN:
- • The system invokes GCCCARTP module to determine and assign appropriate equipment type codes for each piece of equipment
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment records with cargo information are available.
Trigger Criteria:
- Context: Equipment records with cargo information are available
- Applied to: Assign Load/Empty Status
- Action: Processing equipment status for EDI transmission
Logic Flow:
IF Equipment records with cargo information are available
AND Processing equipment status for EDI transmission
THEN:
- • The system assigns 'L' for loaded equipment with cargo and 'E' for empty equipment without cargo
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment records require customs tracking numbers.
Trigger Criteria:
- Context: Equipment records require customs tracking numbers
- Applied to: Set CCN Keys for Manifest
- Action: Processing equipment for customs manifest transmission
Logic Flow:
IF Equipment records require customs tracking numbers
AND Processing equipment for customs manifest transmission
THEN:
- • The system assigns valid CCN keys to each equipment record for customs identification and tracking
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment type is identified as container.
Trigger Criteria:
- Context: Equipment type is identified as container
- Applied to: Process Container Equipment
- Action: Processing container equipment for EDI transmission
Logic Flow:
IF Equipment type is identified as container
AND Processing container equipment for EDI transmission
THEN:
- • The system extracts container-specific data including container IDs, cross-references, and formats them according to EDI container standards
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment type is identified as trailer.
Trigger Criteria:
- Context: Equipment type is identified as trailer
- Applied to: Process Trailer Equipment
- Action: Processing trailer equipment for EDI transmission
Logic Flow:
IF Equipment type is identified as trailer
AND Processing trailer equipment for EDI transmission
THEN:
- • The system extracts trailer-specific data and formats it according to EDI trailer equipment standards
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment type is identified as rail car.
Trigger Criteria:
- Context: Equipment type is identified as rail car
- Applied to: Process Rail Car Equipment
- Action: Processing rail car equipment for EDI transmission
Logic Flow:
IF Equipment type is identified as rail car
AND Processing rail car equipment for EDI transmission
THEN:
- • The system extracts rail car specific data including car type, specifications, and formats them according to EDI rail car standards
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment data has been processed and classified.
Trigger Criteria:
- Context: Equipment data has been processed and classified
- Applied to: Build EDI Equipment Record
- Action: Building individual EDI equipment records
Logic Flow:
IF Equipment data has been processed and classified
AND Building individual EDI equipment records
THEN:
- • The system constructs complete EDI records with equipment ID, type, status, CCN, and all required customs fields in proper EDI format
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when edi equipment records are constructed and validated.
Trigger Criteria:
- Context: EDI equipment records are constructed and validated
- Applied to: Add to EDI Transmission Buffer
- Action: Adding records to transmission buffer
Logic Flow:
IF EDI equipment records are constructed and validated
AND Adding records to transmission buffer
THEN:
- • The system adds each completed equipment record to the EDI transmission buffer maintaining proper sequence and format
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment records are being processed for edi transmission.
Trigger Criteria:
- Context: Equipment records are being processed for EDI transmission
- Applied to: More Equipment?
- Action: Checking for remaining equipment to process
Logic Flow:
IF Equipment records are being processed for EDI transmission
AND Checking for remaining equipment to process
THEN:
- • The system continues processing if more equipment records exist,
otherwise proceeds to finalize the EDI message
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all equipment records have been processed and added to transmission buffer.
Trigger Criteria:
- Context: All equipment records have been processed and added to transmission buffer
- Applied to: Finalize EDI Message
- Action: Finalizing the EDI message for transmission
Logic Flow:
IF All equipment records have been processed and added to transmission buffer
AND Finalizing the EDI message for transmission
THEN:
- • The system adds EDI trailer records, calculates control totals, and prepares the complete message for customs transmission
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when edi message is finalized and ready for transmission.
Trigger Criteria:
- Context: EDI message is finalized and ready for transmission
- Applied to: Transmit to Customs Systems
- Action: Transmitting to customs systems
Logic Flow:
IF EDI message is finalized and ready for transmission
AND Transmitting to customs systems
THEN:
- • The system sends the complete EDI message to the designated customs systems using established communication protocols
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when edi transmission to customs systems has been completed.
Trigger Criteria:
- Context: EDI transmission to customs systems has been completed
- Applied to: Log EDI Transmission
- Action: Logging transmission activity
Logic Flow:
IF EDI transmission to customs systems has been completed
AND Logging transmission activity
THEN:
- • The system records transmission timestamp, message identifier, equipment count, and transmission status in audit logs
R-GCX146-cbl-00765 (+12) File: GCX146.cbl Business Rule: Train Processing Confirmation Generation
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when train has completed processing.
Trigger Criteria:
- Context: A train has completed processing
- Applied to: Check Processing Status
- Action: The system checks the processing status
Logic Flow:
IF A train has completed processing
AND The system checks the processing status
THEN:
- • The system determines if confirmation generation should proceed based on processing success
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when train processing has completed and equipment processing status needs verification.
Trigger Criteria:
- Context: Train processing has completed and equipment processing status needs verification
- Applied to: All Equipment Processed Successfully?
- Action: The system evaluates equipment processing results
Logic Flow:
IF Train processing has completed and equipment processing status needs verification
AND The system evaluates equipment processing results
THEN:
- • If all equipment processed successfully, proceed to confirmation generation,
otherwise skip confirmation due to processing errors
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when train processing completed successfully and confirmation generation is approved.
Trigger Criteria:
- Context: Train processing completed successfully and confirmation generation is approved
- Applied to: Gather Train Summary Data
- Action: The system gathers train summary data
Logic Flow:
IF Train processing completed successfully and confirmation generation is approved
AND The system gathers train summary data
THEN:
- • Train identification, station information, and processing details are collected for message formatting
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when train summary data has been gathered successfully.
Trigger Criteria:
- Context: Train summary data has been gathered successfully
- Applied to: Compile Equipment Totals
- Action: The system compiles equipment totals
Logic Flow:
IF Train summary data has been gathered successfully
AND The system compiles equipment totals
THEN:
- • Equipment counts are calculated by status (released, held, proceeding, haulage, documents not required) for confirmation reporting
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when train summary data and equipment totals have been compiled.
Trigger Criteria:
- Context: Train summary data and equipment totals have been compiled
- Applied to: Format Confirmation Message
- Action: The system formats the confirmation message
Logic Flow:
IF Train summary data and equipment totals have been compiled
AND The system formats the confirmation message
THEN:
- • Message is structured with proper headers, train details, equipment summaries, and processing timestamps in standard confirmation format
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when confirmation message formatting has begun.
Trigger Criteria:
- Context: Confirmation message formatting has begun
- Applied to: Include Train Identification
- Action: The system includes train identification
Logic Flow:
IF Confirmation message formatting has begun
AND The system includes train identification
THEN:
- • Train ID, origin station, destination station, and customs train ID are included in the confirmation message
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when train identification has been included in confirmation message.
Trigger Criteria:
- Context: Train identification has been included in confirmation message
- Applied to: Include Equipment Count Summary
- Action: The system includes equipment count summary
Logic Flow:
IF Train identification has been included in confirmation message
AND The system includes equipment count summary
THEN:
- • Equipment totals by status (total equipment, released, held by CCRA, held for documents, proceeding, haulage, documents not required) are included in confirmation message
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment count summary has been included in confirmation message.
Trigger Criteria:
- Context: Equipment count summary has been included in confirmation message
- Applied to: Include Processing Timestamp
- Action: The system includes processing timestamp
Logic Flow:
IF Equipment count summary has been included in confirmation message
AND The system includes processing timestamp
THEN:
- • Current processing date, time, and user identification are included in confirmation message for tracking and audit purposes
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when confirmation message content has been formatted with all required information.
Trigger Criteria:
- Context: Confirmation message content has been formatted with all required information
- Applied to: Set Message Priority
- Action: The system sets message priority
Logic Flow:
IF Confirmation message content has been formatted with all required information
AND The system sets message priority
THEN:
- • Message priority is assigned based on confirmation message type and distribution requirements
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when confirmation message has been formatted and priority assigned.
Trigger Criteria:
- Context: Confirmation message has been formatted and priority assigned
- Applied to: Queue Confirmation Message
- Action: The system queues the confirmation message
Logic Flow:
IF Confirmation message has been formatted and priority assigned
AND The system queues the confirmation message
THEN:
- • Message is placed in distribution queue for delivery to originating terminal and other designated recipients
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when confirmation message has been queued for distribution.
Trigger Criteria:
- Context: Confirmation message has been queued for distribution
- Applied to: Send to Message Distribution
- Action: The system sends to message distribution
Logic Flow:
IF Confirmation message has been queued for distribution
AND The system sends to message distribution
THEN:
- • Message is processed through distribution system and delivered to designated terminals and recipients
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when confirmation message has been sent to distribution system.
Trigger Criteria:
- Context: Confirmation message has been sent to distribution system
- Applied to: Log Confirmation Activity
- Action: The system logs confirmation activity
Logic Flow:
IF Confirmation message has been sent to distribution system
AND The system logs confirmation activity
THEN:
- • Confirmation generation, message content summary, distribution status, and timestamp are recorded in system audit log
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when train processing has completed but equipment processing errors were detected.
Trigger Criteria:
- Context: Train processing has completed but equipment processing errors were detected
- Applied to: Skip Confirmation - Errors Exist
- Action: The system evaluates confirmation generation eligibility
Logic Flow:
IF Train processing has completed but equipment processing errors were detected
AND The system evaluates confirmation generation eligibility
THEN:
- • Confirmation message generation is skipped and processing proceeds to completion without sending confirmation due to processing errors
R-GCX146-cbl-00778 (+7) File: GCX146.cbl Business Rule: Equipment Type Code Assignment
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment information is retrieved from equipment records.
Trigger Criteria:
- Context: Equipment information is retrieved from equipment records
- Applied to: Determine Equipment Category
- Action: The system analyzes the equipment identification and characteristics
Logic Flow:
IF Equipment information is retrieved from equipment records
AND The system analyzes the equipment identification and characteristics
THEN:
- • The equipment is categorized as Container, Trailer, or Car for subsequent type code processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment is categorized as a container.
Trigger Criteria:
- Context: Equipment is categorized as a container
- Applied to: Container Equipment Processing
- Action: Container equipment processing is initiated
Logic Flow:
IF Equipment is categorized as a container
AND Container equipment processing is initiated
THEN:
- • Container-specific type code determination logic is applied before calling GCCCARTP module
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment is categorized as a trailer.
Trigger Criteria:
- Context: Equipment is categorized as a trailer
- Applied to: Trailer Equipment Processing
- Action: Trailer equipment processing is initiated
Logic Flow:
IF Equipment is categorized as a trailer
AND Trailer equipment processing is initiated
THEN:
- • Trailer-specific type code determination logic is applied before calling GCCCARTP module
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment is categorized as a car.
Trigger Criteria:
- Context: Equipment is categorized as a car
- Applied to: Car Equipment Processing
- Action: Car equipment processing is initiated
Logic Flow:
IF Equipment is categorized as a car
AND Car equipment processing is initiated
THEN:
- • Car-specific type code determination logic is applied before calling GCCCARTP module
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has been processed according to its category (container, trailer, or car). ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Equipment has been processed according to its category (Container, Trailer, or Car)
- Applied to: Call GCCCARTP Module
- Action: Type code assignment is required
Logic Flow:
IF Equipment has been processed according to its category (Container, Trailer, or Car)
AND Type code assignment is required
THEN:
- • GCCCARTP module is called to determine and assign the appropriate equipment type code
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment type code has been assigned by the gcccartp module.
Trigger Criteria:
- Context: An equipment type code has been assigned by the GCCCARTP module
- Applied to: Validate Type Code Assignment
- Action: Type code validation is performed
Logic Flow:
IF An equipment type code has been assigned by the GCCCARTP module
AND Type code validation is performed
THEN:
- • The system verifies the type code is valid according to business rules and data constraints
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment type code has been validated successfully.
Trigger Criteria:
- Context: Equipment type code has been validated successfully
- Applied to: Set Equipment Type for EDI
- Action: EDI processing is required
Logic Flow:
IF Equipment type code has been validated successfully
AND EDI processing is required
THEN:
- • The validated equipment type code is set for EDI transmission
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment type code validation fails.
Trigger Criteria:
- Context: Equipment type code validation fails
- Applied to: Handle Type Code Error
- Action: An invalid type code is detected
Logic Flow:
IF Equipment type code validation fails
AND An invalid type code is detected
THEN:
- • Error handling procedures are initiated to address the type code assignment failure
R-GCX146-cbl-00786 (+8) File: GCX146.cbl Business Rule: Load/Empty Status Assignment
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment record is being processed and waybill data has been retrieved.
Trigger Criteria:
- Context: Equipment record is being processed and waybill data has been retrieved
- Applied to: Extract Load Status from Waybill
- Action: The waybill contains load/empty status indicator in the waybill record
Logic Flow:
IF Equipment record is being processed and waybill data has been retrieved
AND The waybill contains load/empty status indicator in the waybill record
THEN:
- • Extract the load/empty status from waybill and assign it to the equipment record
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment record is being processed and waybill does not contain load status.
Trigger Criteria:
- Context: Equipment record is being processed and waybill does not contain load status
- Applied to: Use Input Load/Empty Flag
- Action: Input specifications contain a load/empty flag indicator
Logic Flow:
IF Equipment record is being processed and waybill does not contain load status
AND Input specifications contain a load/empty flag indicator
THEN:
- • Use the input load/empty flag to assign status to the equipment
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment record has no explicit load/empty indicators from waybill or input.
Trigger Criteria:
- Context: Equipment record has no explicit load/empty indicators from waybill or input
- Applied to: Determine Load Status from Routing
- Action: Equipment has both origin and destination information available
Logic Flow:
IF Equipment record has no explicit load/empty indicators from waybill or input
AND Equipment has both origin and destination information available
THEN:
- • Analyze the routing information to determine if equipment is loaded or empty based on cargo movement patterns
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment has been classified as container type.
Trigger Criteria:
- Context: Equipment has been classified as container type
- Applied to: Container Load/Empty Assignment
- Action: Load/empty status needs to be assigned to the container
Logic Flow:
IF Equipment has been classified as container type
AND Load/empty status needs to be assigned to the container
THEN:
- • Apply container-specific rules to determine and assign load or empty status
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has been classified as trailer type.
Trigger Criteria:
- Context: Equipment has been classified as trailer type
- Applied to: Trailer Load/Empty Assignment
- Action: Load/empty status needs to be assigned to the trailer
Logic Flow:
IF Equipment has been classified as trailer type
AND Load/empty status needs to be assigned to the trailer
THEN:
- • Apply trailer-specific rules to determine and assign load or empty status
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has been classified as rail car type.
Trigger Criteria:
- Context: Equipment has been classified as rail car type
- Applied to: Rail Car Load/Empty Assignment
- Action: Load/empty status needs to be assigned to the rail car
Logic Flow:
IF Equipment has been classified as rail car type
AND Load/empty status needs to be assigned to the rail car
THEN:
- • Apply rail car-specific rules to determine and assign load or empty status
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when load/empty status has been determined for equipment.
Trigger Criteria:
- Context: Load/empty status has been determined for equipment
- Applied to: Validate Status Against Equipment Type
- Action: Status assignment is validated against equipment type constraints
Logic Flow:
IF Load/empty status has been determined for equipment
AND Status assignment is validated against equipment type constraints
THEN:
- • Verify that the assigned status is valid for the specific equipment type and reject invalid combinations
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when final load/empty status has been assigned to equipment.
Trigger Criteria:
- Context: Final load/empty status has been assigned to equipment
- Applied to: Set EDI Load/Empty Indicator
- Action: EDI transmission requires load/empty indicator
Logic Flow:
IF Final load/empty status has been assigned to equipment
AND EDI transmission requires load/empty indicator
THEN:
- • Convert the internal status to the appropriate EDI load/empty indicator format
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when load/empty status assignment process encounters an error condition.
Trigger Criteria:
- Context: Load/empty status assignment process encounters an error condition
- Applied to: Status Assignment Error
- Action: Status cannot be determined or is invalid for the equipment type
Logic Flow:
IF Load/empty status assignment process encounters an error condition
AND Status cannot be determined or is invalid for the equipment type
THEN:
- • Generate appropriate error message and handle the equipment record according to error processing rules
R-GCX146-cbl-00795 (+17) File: GCX146.cbl Business Rule: CCN Transit Status Processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn key is provided for lookup.
Trigger Criteria:
- Context: A CCN key is provided for lookup
- Applied to: Access CCN Database Record
- Action: The system attempts to access the CCN database record
Logic Flow:
IF A CCN key is provided for lookup
AND The system attempts to access the CCN database record
THEN:
- • The system retrieves the CCN record from the GCCCRT database if it exists
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn database lookup has been performed.
Trigger Criteria:
- Context: A CCN database lookup has been performed
- Applied to: CCN Record Found?
- Action: The system checks if the CCN record was found
Logic Flow:
IF A CCN database lookup has been performed
AND The system checks if the CCN record was found
THEN:
- • The system proceeds with transit status processing if record exists,
otherwise handles the not found condition
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when valid ccn record exists in the database. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A valid CCN record exists in the database
- Applied to: Read Current Transit Status
- Action: The system reads the current transit status field
Logic Flow:
IF A valid CCN record exists in the database
AND The system reads the current transit status field
THEN:
- • The system retrieves the transit status code for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when transit status code has been retrieved from the ccn record.
Trigger Criteria:
- Context: A transit status code has been retrieved from the CCN record
- Applied to: Check Transit Status Code
- Action: The system evaluates the transit status code
Logic Flow:
IF A transit status code has been retrieved from the CCN record
AND The system evaluates the transit status code
THEN:
- • The system determines the appropriate status classification based on the code value
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when transit status code is available for evaluation.
Trigger Criteria:
- Context: A transit status code is available for evaluation
- Applied to: Status = 'T' Transit?
- Action: The transit status code equals 'T'
Logic Flow:
IF A transit status code is available for evaluation
AND The transit status code equals 'T'
THEN:
- • The system classifies the cargo as in transit status
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when transit status code is available for evaluation and is not 't'.
Trigger Criteria:
- Context: A transit status code is available for evaluation and is not 'T'
- Applied to: Status = 'R' Return?
- Action: The transit status code equals 'R'
Logic Flow:
IF A transit status code is available for evaluation and is not 'T'
AND The transit status code equals 'R'
THEN:
- • The system classifies the cargo as return status
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when transit status code is available for evaluation and is not 't' or 'r'.
Trigger Criteria:
- Context: A transit status code is available for evaluation and is not 'T' or 'R'
- Applied to: Status = 'E' Export?
- Action: The transit status code equals 'E'
Logic Flow:
IF A transit status code is available for evaluation and is not 'T' or 'R'
AND The transit status code equals 'E'
THEN:
- • The system classifies the cargo as export status
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when transit status code is available for evaluation and is not 't', 'r', or 'e'.
Trigger Criteria:
- Context: A transit status code is available for evaluation and is not 'T', 'R', or 'E'
- Applied to: Status = 'Z' Export?
- Action: The transit status code equals 'Z'
Logic Flow:
IF A transit status code is available for evaluation and is not 'T', 'R', or 'E'
AND The transit status code equals 'Z'
THEN:
- • The system classifies the cargo as export status
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when transit status code has been evaluated as 't'.
Trigger Criteria:
- Context: The transit status code has been evaluated as 'T'
- Applied to: Set Status to 'TRANSIT'
- Action: The system processes the transit classification
Logic Flow:
IF The transit status code has been evaluated as 'T'
AND The system processes the transit classification
THEN:
- • The system sets the status to 'TRANSIT'
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when transit status code has been evaluated as 'r'.
Trigger Criteria:
- Context: The transit status code has been evaluated as 'R'
- Applied to: Set Status to 'RETURN'
- Action: The system processes the return classification
Logic Flow:
IF The transit status code has been evaluated as 'R'
AND The system processes the return classification
THEN:
- • The system sets the status to 'RETURN'
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when transit status code has been evaluated as 'e' or 'z'.
Trigger Criteria:
- Context: The transit status code has been evaluated as 'E' or 'Z'
- Applied to: Set Status to 'EXPORT'
- Action: The system processes the export classification
Logic Flow:
IF The transit status code has been evaluated as 'E' or 'Z'
AND The system processes the export classification
THEN:
- • The system sets the status to 'EXPORT'
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when transit status code is not 't', 'r', 'e', or 'z'.
Trigger Criteria:
- Context: The transit status code is not 'T', 'R', 'E', or 'Z'
- Applied to: Check S.A.R. Release Flag
- Action: The system evaluates the S.A.R. release flag
Logic Flow:
IF The transit status code is not 'T', 'R', 'E', or 'Z'
AND The system evaluates the S.A.R. release flag
THEN:
- • The system determines if cargo has special administrative release authorization
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when s.a.r. release flag has been evaluated.
Trigger Criteria:
- Context: The S.A.R. release flag has been evaluated
- Applied to: S.A.R. Release?
- Action: The cargo has S.A.R. release authorization
Logic Flow:
IF The S.A.R. release flag has been evaluated
AND The cargo has S.A.R. release authorization
THEN:
- • The system classifies the cargo for S.A.R. release processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo has been determined to have s.a.r. release authorization.
Trigger Criteria:
- Context: The cargo has been determined to have S.A.R. release authorization
- Applied to: Set Status to 'S.A.R.'
- Action: The system processes the S.A.R. classification
Logic Flow:
IF The cargo has been determined to have S.A.R. release authorization
AND The system processes the S.A.R. classification
THEN:
- • The system sets the status to 'S.A.R.'
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo has been determined to not have s.a.r. release authorization.
Trigger Criteria:
- Context: The cargo has been determined to not have S.A.R. release authorization
- Applied to: Set Status to 'RELEASE'
- Action: The system processes the release classification
Logic Flow:
IF The cargo has been determined to not have S.A.R. release authorization
AND The system processes the release classification
THEN:
- • The system sets the status to 'RELEASE'
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when transit status has been determined and assigned.
Trigger Criteria:
- Context: A transit status has been determined and assigned
- Applied to: Update CCN Transit Status
- Action: The system updates the CCN transit status
Logic Flow:
IF A transit status has been determined and assigned
AND The system updates the CCN transit status
THEN:
- • The CCN record is updated with the new transit status in the database
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn transit status has been updated.
Trigger Criteria:
- Context: The CCN transit status has been updated
- Applied to: Track Cargo Movement
- Action: The system processes cargo movement tracking
Logic Flow:
IF The CCN transit status has been updated
AND The system processes cargo movement tracking
THEN:
- • The system records the cargo movement information for tracking purposes
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn lookup has been performed.
Trigger Criteria:
- Context: A CCN lookup has been performed
- Applied to: Handle CCN Not Found
- Action: No CCN record is found in the database
Logic Flow:
IF A CCN lookup has been performed
AND No CCN record is found in the database
THEN:
- • The system handles the not found condition and completes processing
R-GCX146-cbl-00813 (+7) File: GCX146.cbl Business Rule: Equipment Car ID Formatting
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment car id is provided for processing.
Trigger Criteria:
- Context: An equipment car ID is provided for processing
- Applied to: Apply Standard Formatting Rules
- Action: The car ID has a valid format
Logic Flow:
IF An equipment car ID is provided for processing
AND The car ID has a valid format
THEN:
- • Standard formatting rules are applied to normalize the car ID
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment car id contains spaces or special characters.
Trigger Criteria:
- Context: An equipment car ID contains spaces or special characters
- Applied to: Remove Spaces and Special Characters
- Action: The car ID is being formatted for train manifest
Logic Flow:
IF An equipment car ID contains spaces or special characters
AND The car ID is being formatted for train manifest
THEN:
- • All spaces and special characters are removed from the car ID
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment car id is shorter than the required length.
Trigger Criteria:
- Context: An equipment car ID is shorter than the required length
- Applied to: Pad with Zeros if Needed
- Action: The car ID is being formatted for train manifest display
Logic Flow:
IF An equipment car ID is shorter than the required length
AND The car ID is being formatted for train manifest display
THEN:
- • The car ID is padded with leading zeros to meet the standard length requirement
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment car id contains lowercase characters.
Trigger Criteria:
- Context: An equipment car ID contains lowercase characters
- Applied to: Convert to Uppercase
- Action: The car ID is being processed for train manifest
Logic Flow:
IF An equipment car ID contains lowercase characters
AND The car ID is being processed for train manifest
THEN:
- • All characters in the car ID are converted to uppercase
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment car id has been formatted.
Trigger Criteria:
- Context: An equipment car ID has been formatted
- Applied to: Validate Length Requirements
- Action: The length validation is performed
Logic Flow:
IF An equipment car ID has been formatted
AND The length validation is performed
THEN:
- • The car ID length must meet the standard requirements for valid processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment car id has passed length validation.
Trigger Criteria:
- Context: An equipment car ID has passed length validation
- Applied to: Format for Train Manifest Display
- Action: The car ID is prepared for train manifest display
Logic Flow:
IF An equipment car ID has passed length validation
AND The car ID is prepared for train manifest display
THEN:
- • The car ID is formatted according to train manifest display standards
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment car id has been formatted for train manifest display.
Trigger Criteria:
- Context: An equipment car ID has been formatted for train manifest display
- Applied to: Set Equipment Type Code
- Action: Equipment type classification is required
Logic Flow:
IF An equipment car ID has been formatted for train manifest display
AND Equipment type classification is required
THEN:
- • The appropriate equipment type code is assigned based on car ID characteristics
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment car id fails format validation or length requirements.
Trigger Criteria:
- Context: An equipment car ID fails format validation or length requirements
- Applied to: Format Error - Use Default
- Action: Standard formatting cannot be applied successfully
Logic Flow:
IF An equipment car ID fails format validation or length requirements
AND Standard formatting cannot be applied successfully
THEN:
- • A default format is used to ensure the car ID can still be processed
R-GCX146-cbl-00821 (+17) File: GCX146.cbl Business Rule: AEI Report Email Distribution
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when aei report needs to be distributed via email.
Trigger Criteria:
- Context: An AEI report needs to be distributed via email
- Applied to: Start AEI Report Email Distribution
- Action: The email distribution process is initiated
Logic Flow:
IF An AEI report needs to be distributed via email
AND The email distribution process is initiated
THEN:
- • The system should prepare for email processing and set up the distribution workflow
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when station code is available for email distribution.
Trigger Criteria:
- Context: A station code is available for email distribution
- Applied to: Get Email User Lists from Station Configuration
- Action: The system needs to determine email recipients
Logic Flow:
IF A station code is available for email distribution
AND The system needs to determine email recipients
THEN:
- • The system should lookup email addresses from CUSEMAIL table using the station code and retrieve the configured user email lists
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when email recipients have been identified.
Trigger Criteria:
- Context: Email recipients have been identified
- Applied to: Initialize Report Message Buffer
- Action: The system prepares to format the report for email
Logic Flow:
IF Email recipients have been identified
AND The system prepares to format the report for email
THEN:
- • The system should initialize the message buffer and prepare report content for processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when report is ready for email distribution.
Trigger Criteria:
- Context: A report is ready for email distribution
- Applied to: Check Report Size
- Action: The system checks the report size
Logic Flow:
IF A report is ready for email distribution
AND The system checks the report size
THEN:
- • The system should count the total number of lines in the report to determine processing approach
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when report has been sized and is ready for email transmission.
Trigger Criteria:
- Context: A report has been sized and is ready for email transmission
- Applied to: Report Exceeds 699 Lines?
- Action: The system evaluates if the report exceeds 699 lines
Logic Flow:
IF A report has been sized and is ready for email transmission
AND The system evaluates if the report exceeds 699 lines
THEN:
- • If the report has more than 699 lines, the system should initiate batch processing,
otherwise proceed with single email transmission
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when report batch is prepared and ready for transmission.
Trigger Criteria:
- Context: A report batch is prepared and ready for transmission
- Applied to: Send Current Report Batch via Email
- Action: The system sends the current report batch via email
Logic Flow:
IF A report batch is prepared and ready for transmission
AND The system sends the current report batch via email
THEN:
- • The system should transmit the current batch using EMCSEND3 email service to the configured recipients
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when report batch has been successfully sent via email.
Trigger Criteria:
- Context: A report batch has been successfully sent via email
- Applied to: Reset Message Buffer
- Action: The system needs to prepare for the next batch
Logic Flow:
IF A report batch has been successfully sent via email
AND The system needs to prepare for the next batch
THEN:
- • The system should reset the message buffer and clear previous content to prepare for continuation processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when report has been split into multiple email batches.
Trigger Criteria:
- Context: A report has been split into multiple email batches
- Applied to: Add Continuation Header Message
- Action: The system prepares a continuation email message
Logic Flow:
IF A report has been split into multiple email batches
AND The system prepares a continuation email message
THEN:
- • The system should add the header 'CONTINUATION OF REPORT....' to indicate this is a continuation of the previous message
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when initial report batch has been sent and continuation header added.
Trigger Criteria:
- Context: The initial report batch has been sent and continuation header added
- Applied to: Continue Processing Remaining Lines
- Action: The system continues processing the remaining report lines
Logic Flow:
IF The initial report batch has been sent and continuation header added
AND The system continues processing the remaining report lines
THEN:
- • The system should continue processing the remaining lines from where the previous batch ended
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when there are remaining report lines to process.
Trigger Criteria:
- Context: There are remaining report lines to process
- Applied to: Process Next Line Batch
- Action: The system processes the next line batch
Logic Flow:
IF There are remaining report lines to process
AND The system processes the next line batch
THEN:
- • The system should process up to 699 lines for the next email batch while maintaining report formatting
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when batch of report lines has been processed.
Trigger Criteria:
- Context: A batch of report lines has been processed
- Applied to: More Lines to Process?
- Action: The system checks for additional lines to process
Logic Flow:
IF A batch of report lines has been processed
AND The system checks for additional lines to process
THEN:
- • If there are more lines remaining, continue batch processing,
otherwise proceed to send the final email batch
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when all report lines have been processed and the final batch is ready.
Trigger Criteria:
- Context: All report lines have been processed and the final batch is ready
- Applied to: Send Final Email Batch
- Action: The system sends the final email batch
Logic Flow:
IF All report lines have been processed and the final batch is ready
AND The system sends the final email batch
THEN:
- • The system should transmit the final batch using EMCSEND3 email service to complete the report distribution
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when email has been sent via the primary email service.
Trigger Criteria:
- Context: An email has been sent via the primary email service
- Applied to: Email Send Successful?
- Action: The system checks the email transmission status
Logic Flow:
IF An email has been sent via the primary email service
AND The system checks the email transmission status
THEN:
- • If the email was successful, proceed to log the transmission,
otherwise initiate fallback email procedures
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when primary email transmission has failed.
Trigger Criteria:
- Context: The primary email transmission has failed
- Applied to: Use Fallback Email Recipients
- Action: The system activates fallback email recipients
Logic Flow:
IF The primary email transmission has failed
AND The system activates fallback email recipients
THEN:
- • The system should prepare to use the fallback email addresses OM01247 and AEI9999 for report delivery
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when primary email delivery has failed and fallback recipients are activated.
Trigger Criteria:
- Context: Primary email delivery has failed and fallback recipients are activated
- Applied to: Send via OM01247/AEI9999
- Action: The system sends via fallback email addresses
Logic Flow:
IF Primary email delivery has failed and fallback recipients are activated
AND The system sends via fallback email addresses
THEN:
- • The system should transmit the report to OM01247 and AEI9999 using the fallback email service
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when email has been successfully transmitted (either primary or fallback).
Trigger Criteria:
- Context: An email has been successfully transmitted (either primary or fallback)
- Applied to: Log Email Transmission
- Action: The system logs the email transmission
Logic Flow:
IF An email has been successfully transmitted (either primary or fallback)
AND The system logs the email transmission
THEN:
- • The system should record the transmission details including recipients, timestamp, and delivery status for audit purposes
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when all email transmissions have been completed and logged.
Trigger Criteria:
- Context: All email transmissions have been completed and logged
- Applied to: AEI Report Distribution Complete
- Action: The AEI report distribution process concludes
Logic Flow:
IF All email transmissions have been completed and logged
AND The AEI report distribution process concludes
THEN:
- • The system should mark the distribution as complete and finalize the process
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when both primary and fallback email transmissions have failed.
Trigger Criteria:
- Context: Both primary and fallback email transmissions have failed
- Applied to: Email Distribution Failed
- Action: The email distribution fails completely
Logic Flow:
IF Both primary and fallback email transmissions have failed
AND The email distribution fails completely
THEN:
- • The system should mark the distribution as failed and handle the error condition appropriately
R-GCX146-cbl-00839 (+13) File: GCX146.cbl Business Rule: Merlin Message Transmission
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when merlin message transmission is initiated for a specific station.
Trigger Criteria:
- Context: A Merlin message transmission is initiated for a specific station
- Applied to: Check Auto-FAX Configuration
- Action: The system checks the station configuration in GCSTBRT
Logic Flow:
IF A Merlin message transmission is initiated for a specific station
AND The system checks the station configuration in GCSTBRT
THEN:
- • The auto-FAX capability flag is retrieved and evaluated to determine if FAX routing should be enabled
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when auto-fax is enabled for the current station.
Trigger Criteria:
- Context: Auto-FAX is enabled for the current station
- Applied to: Setup FAX Routing Parameters
- Action: The system prepares for message transmission
Logic Flow:
IF Auto-FAX is enabled for the current station
AND The system prepares for message transmission
THEN:
- • FAX routing parameters are configured including destination settings and transmission options
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when fax routing parameters are configured. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: FAX routing parameters are configured
- Applied to: Set Copy IDs for FAX Distribution
- Action: The system prepares copy distribution settings
Logic Flow:
IF FAX routing parameters are configured
AND The system prepares copy distribution settings
THEN:
- • Copy IDs are assigned based on station configuration to enable multi-recipient FAX delivery
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when copy ids are configured for fax distribution. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Copy IDs are configured for FAX distribution
- Applied to: Configure External FAX Addressing
- Action: The system sets up external addressing
Logic Flow:
IF Copy IDs are configured for FAX distribution
AND The system sets up external addressing
THEN:
- • External FAX addresses and routing information are configured for customs authority delivery
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when merlin message is prepared for transmission.
Trigger Criteria:
- Context: A Merlin message is prepared for transmission
- Applied to: Check Message Size
- Action: The system counts the total number of message lines
Logic Flow:
IF A Merlin message is prepared for transmission
AND The system counts the total number of message lines
THEN:
- • If message exceeds 699 lines, it is flagged for continuation processing,
otherwise it proceeds as standard transmission
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when merlin message is prepared and is 699 lines or fewer.
Trigger Criteria:
- Context: A Merlin message is prepared and is 699 lines or fewer
- Applied to: Send Standard Merlin Message
- Action: The system initiates transmission
Logic Flow:
IF A Merlin message is prepared and is 699 lines or fewer
AND The system initiates transmission
THEN:
- • The complete message is sent as a single transmission unit
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when merlin message exceeds 699 lines.
Trigger Criteria:
- Context: A Merlin message exceeds 699 lines
- Applied to: Split Message for Continuation
- Action: The system processes the oversized message
Logic Flow:
IF A Merlin message exceeds 699 lines
AND The system processes the oversized message
THEN:
- • The message is divided into multiple batches with the first batch containing up to 699 lines
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when message has been split into multiple batches.
Trigger Criteria:
- Context: A message has been split into multiple batches
- Applied to: Send First Message Batch
- Action: The system transmits the first batch
Logic Flow:
IF A message has been split into multiple batches
AND The system transmits the first batch
THEN:
- • The first 699 lines are sent as the initial message segment
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when message has remaining batches after the first transmission.
Trigger Criteria:
- Context: A message has remaining batches after the first transmission
- Applied to: Add Continuation Header
- Action: The system prepares subsequent message batches
Logic Flow:
IF A message has remaining batches after the first transmission
AND The system prepares subsequent message batches
THEN:
- • Each remaining batch is prefixed with 'CONTINUATION OF REPORT....' header
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when message batches with continuation headers are prepared.
Trigger Criteria:
- Context: Message batches with continuation headers are prepared
- Applied to: Send Remaining Message Batches
- Action: The system processes remaining batches
Logic Flow:
IF Message batches with continuation headers are prepared
AND The system processes remaining batches
THEN:
- • Each batch is transmitted sequentially until all message content is delivered
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when message or message batch is ready for transmission. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A message or message batch is ready for transmission
- Applied to: Call EMCSEND3 for Transmission
- Action: The system calls EMCSEND3 service
Logic Flow:
IF A message or message batch is ready for transmission
AND The system calls EMCSEND3 service
THEN:
- • The message is transmitted through the Merlin communication channel
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when emcsend3 service has been called for message transmission.
Trigger Criteria:
- Context: EMCSEND3 service has been called for message transmission
- Applied to: Transmission Successful?
- Action: The system receives transmission response
Logic Flow:
IF EMCSEND3 service has been called for message transmission
AND The system receives transmission response
THEN:
- • If transmission is successful, proceed to logging,
otherwise handle transmission error
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when message transmission is confirmed successful.
Trigger Criteria:
- Context: Message transmission is confirmed successful
- Applied to: Log Successful Transmission
- Action: The system processes the success response
Logic Flow:
IF Message transmission is confirmed successful
AND The system processes the success response
THEN:
- • Transmission details are logged including timestamp and delivery confirmation
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when message transmission fails.
Trigger Criteria:
- Context: Message transmission fails
- Applied to: Handle Transmission Error
- Action: The system receives error response from EMCSEND3
Logic Flow:
IF Message transmission fails
AND The system receives error response from EMCSEND3
THEN:
- • Error details are logged and appropriate error handling procedures are initiated
R-GCX146-cbl-00853 (+13) File: GCX146.cbl Business Rule: Equipment Waybill Lookup
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment id is provided for waybill lookup.
Trigger Criteria:
- Context: An equipment ID is provided for waybill lookup
- Applied to: Format Equipment ID for Search
- Action: The system prepares to search for waybill information
Logic Flow:
IF An equipment ID is provided for waybill lookup
AND The system prepares to search for waybill information
THEN:
- • The equipment ID is formatted by removing spaces and standardized to proper search format
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when formatted equipment id is available for search.
Trigger Criteria:
- Context: A formatted equipment ID is available for search
- Applied to: Search Primary Waybill Database FWIIROOT
- Action: The system searches the primary waybill database FWIIROOT
Logic Flow:
IF A formatted equipment ID is available for search
AND The system searches the primary waybill database FWIIROOT
THEN:
- • The system retrieves waybill record if equipment ID exists in the database
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when search has been performed in the primary waybill database.
Trigger Criteria:
- Context: A search has been performed in the primary waybill database
- Applied to: Waybill Record Found?
- Action: The system evaluates the search results
Logic Flow:
IF A search has been performed in the primary waybill database
AND The system evaluates the search results
THEN:
- • The system determines if a waybill record was found and proceeds to extract information or searches alternative sources
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when no waybill record was found in the primary database fwiiroot.
Trigger Criteria:
- Context: No waybill record was found in the primary database FWIIROOT
- Applied to: Search Enhanced Waybill SHIPROOT
- Action: The system performs a fallback search
Logic Flow:
IF No waybill record was found in the primary database FWIIROOT
AND The system performs a fallback search
THEN:
- • The system searches the enhanced waybill database SHIPROOT using multi-criteria search parameters
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when search has been performed in the enhanced waybill database shiproot.
Trigger Criteria:
- Context: A search has been performed in the enhanced waybill database SHIPROOT
- Applied to: Enhanced Record Found?
- Action: The system evaluates the enhanced database search results
Logic Flow:
IF A search has been performed in the enhanced waybill database SHIPROOT
AND The system evaluates the enhanced database search results
THEN:
- • The system determines if an enhanced waybill record was found and proceeds accordingly
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when no waybill records were found in both primary fwiiroot and enhanced shiproot databases.
Trigger Criteria:
- Context: No waybill records were found in both primary FWIIROOT and enhanced SHIPROOT databases
- Applied to: Search Inquiry Database FW-IQ
- Action: The system performs the final fallback search
Logic Flow:
IF No waybill records were found in both primary FWIIROOT and enhanced SHIPROOT databases
AND The system performs the final fallback search
THEN:
- • The system searches the inquiry database FW-IQ as the last resort for waybill information
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when search has been performed in the inquiry database fw-iq.
Trigger Criteria:
- Context: A search has been performed in the inquiry database FW-IQ
- Applied to: Inquiry Record Found?
- Action: The system evaluates the inquiry database search results
Logic Flow:
IF A search has been performed in the inquiry database FW-IQ
AND The system evaluates the inquiry database search results
THEN:
- • The system determines if any inquiry records were found or if waybill lookup has failed completely
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when all database searches (primary, enhanced, and inquiry) have been exhausted without finding waybill records.
Trigger Criteria:
- Context: All database searches (primary, enhanced, and inquiry) have been exhausted without finding waybill records
- Applied to: Set Waybill Not Found Flag
- Action: The system completes the comprehensive waybill search process
Logic Flow:
IF All database searches (primary, enhanced, and inquiry) have been exhausted without finding waybill records
AND The system completes the comprehensive waybill search process
THEN:
- • The system sets a waybill not found flag to indicate unsuccessful lookup
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when waybill record has been found in any of the searched databases.
Trigger Criteria:
- Context: A waybill record has been found in any of the searched databases
- Applied to: Extract Waybill Information
- Action: The system processes the located waybill record
Logic Flow:
IF A waybill record has been found in any of the searched databases
AND The system processes the located waybill record
THEN:
- • The system extracts all relevant waybill information including shipment details and equipment data
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when waybill information has been extracted from a database record.
Trigger Criteria:
- Context: Waybill information has been extracted from a database record
- Applied to: Validate Waybill Data Quality
- Action: The system validates the extracted data
Logic Flow:
IF Waybill information has been extracted from a database record
AND The system validates the extracted data
THEN:
- • The system verifies data completeness, format correctness, and business rule compliance
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when waybill data has been validated for quality.
Trigger Criteria:
- Context: Waybill data has been validated for quality
- Applied to: Extract Equipment Details
- Action: The system processes equipment-specific information
Logic Flow:
IF Waybill data has been validated for quality
AND The system processes equipment-specific information
THEN:
- • The system extracts equipment details including car type, status, and identification information
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment details have been successfully extracted.
Trigger Criteria:
- Context: Equipment details have been successfully extracted
- Applied to: Extract Shipment Information
- Action: The system processes shipment-specific data
Logic Flow:
IF Equipment details have been successfully extracted
AND The system processes shipment-specific data
THEN:
- • The system extracts shipment information including shipper, consignee, origin station, destination station, and cargo details
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when all waybill and shipment information has been successfully extracted.
Trigger Criteria:
- Context: All waybill and shipment information has been successfully extracted
- Applied to: Set Waybill Found Flag
- Action: The system completes the waybill lookup process
Logic Flow:
IF All waybill and shipment information has been successfully extracted
AND The system completes the waybill lookup process
THEN:
- • The system sets a waybill found flag to indicate successful completion of the lookup process
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when waybill lookup process has been completed with either success or failure.
Trigger Criteria:
- Context: The waybill lookup process has been completed with either success or failure
- Applied to: Return Waybill Results
- Action: The system finalizes the lookup operation
Logic Flow:
IF The waybill lookup process has been completed with either success or failure
AND The system finalizes the lookup operation
THEN:
- • The system returns the waybill lookup results including extracted data if found or failure indication if not found
R-GCX146-cbl-00867 (+12) File: GCX146.cbl Business Rule: Container Equipment Processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when container equipment processing request is initiated.
Trigger Criteria:
- Context: A container equipment processing request is initiated
- Applied to: Access Container Records via FWSWRWR
- Action: The system attempts to access container records via FWSWRWR database
Logic Flow:
IF A container equipment processing request is initiated
AND The system attempts to access container records via FWSWRWR database
THEN:
- • Container equipment records are retrieved for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when container records have been accessed from fwswrwr database.
Trigger Criteria:
- Context: Container records have been accessed from FWSWRWR database
- Applied to: Container Record Found?
- Action: The system checks for the existence of container records
Logic Flow:
IF Container records have been accessed from FWSWRWR database
AND The system checks for the existence of container records
THEN:
- • If container records are found, proceed to extract container information,
otherwise access container inquiry database
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when container records exist in the fwswrwr database.
Trigger Criteria:
- Context: Container records exist in the FWSWRWR database
- Applied to: Extract Container Information
- Action: The system processes the container records
Logic Flow:
IF Container records exist in the FWSWRWR database
AND The system processes the container records
THEN:
- • Container information is extracted and made available for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when container information has been successfully extracted.
Trigger Criteria:
- Context: Container information has been successfully extracted
- Applied to: Set Flat Car Processing Flag
- Action: The system processes container equipment on flat cars
Logic Flow:
IF Container information has been successfully extracted
AND The system processes container equipment on flat cars
THEN:
- • The flat car processing flag is set to indicate active container processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container records are not found in fwswrwr database.
Trigger Criteria:
- Context: Container records are not found in FWSWRWR database
- Applied to: Access Container Inquiry Database
- Action: The system needs to locate container information
Logic Flow:
IF Container records are not found in FWSWRWR database
AND The system needs to locate container information
THEN:
- • The system accesses the FW-IQ container inquiry database as an alternative source
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when container inquiry database has been accessed.
Trigger Criteria:
- Context: Container inquiry database has been accessed
- Applied to: Retrieve T/C XREF Records
- Action: The system processes container cross-reference requirements
Logic Flow:
IF Container inquiry database has been accessed
AND The system processes container cross-reference requirements
THEN:
- • T/C XREF records are retrieved to establish container ID relationships
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when t/c xref records have been retrieved.
Trigger Criteria:
- Context: T/C XREF records have been retrieved
- Applied to: Container ID Available?
- Action: The system checks for container ID availability
Logic Flow:
IF T/C XREF records have been retrieved
AND The system checks for container ID availability
THEN:
- • If container ID is available, extract it from XREF records,
otherwise report container processing error
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container id is available in t/c xref records.
Trigger Criteria:
- Context: Container ID is available in T/C XREF records
- Applied to: Extract Container ID from XREF
- Action: The system processes container identification requirements
Logic Flow:
IF Container ID is available in T/C XREF records
AND The system processes container identification requirements
THEN:
- • Container ID is extracted from XREF records for subsequent waybill information retrieval
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when container id has been extracted or container information is available.
Trigger Criteria:
- Context: Container ID has been extracted or container information is available
- Applied to: Retrieve Associated Waybill Information
- Action: The system needs waybill data for container processing
Logic Flow:
IF Container ID has been extracted or container information is available
AND The system needs waybill data for container processing
THEN:
- • Associated waybill information is retrieved for the container
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill information retrieval has been attempted for the container.
Trigger Criteria:
- Context: Waybill information retrieval has been attempted for the container
- Applied to: Waybill Data Found?
- Action: The system checks for waybill data availability
Logic Flow:
IF Waybill information retrieval has been attempted for the container
AND The system checks for waybill data availability
THEN:
- • If waybill data is found, process container waybill data,
otherwise report container processing error
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when waybill data has been found for the container.
Trigger Criteria:
- Context: Waybill data has been found for the container
- Applied to: Process Container Waybill Data
- Action: The system processes container waybill information
Logic Flow:
IF Waybill data has been found for the container
AND The system processes container waybill information
THEN:
- • Container waybill data is processed according to business requirements
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when container waybill data has been successfully processed.
Trigger Criteria:
- Context: Container waybill data has been successfully processed
- Applied to: Set Container Processing Complete
- Action: The system completes container processing operations
Logic Flow:
IF Container waybill data has been successfully processed
AND The system completes container processing operations
THEN:
- • Container processing status is set to complete
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when container id is not available from xref records or waybill data is not found for the container.
Trigger Criteria:
- Context: Container ID is not available from XREF records OR waybill data is not found for the container
- Applied to: Container Processing Error
- Action: The system encounters container processing failures
Logic Flow:
IF Container ID is not available from XREF records OR waybill data is not found for the container
AND The system encounters container processing failures
THEN:
- • Container processing error is reported and processing terminates
R-GCX146-cbl-00880 (+8) File: GCX146.cbl Business Rule: Equipment Segment Processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment segment processing is starting.
Trigger Criteria:
- Context: Equipment segment processing is starting
- Applied to: Initialize Equipment Sequence Counter
- Action: The system begins processing equipment records
Logic Flow:
IF Equipment segment processing is starting
AND The system begins processing equipment records
THEN:
- • The equipment sequence counter is set to 1 to track the first equipment position
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment sequence counter is set. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: An equipment sequence counter is set
- Applied to: Retrieve Current Equipment Record
- Action: The system needs to access equipment data
Logic Flow:
IF An equipment sequence counter is set
AND The system needs to access equipment data
THEN:
- • The system retrieves the equipment record from FWIIROOT database using FWCMSGET call with the current sequence number
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when database call has been made to retrieve equipment data. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A database call has been made to retrieve equipment data
- Applied to: Equipment Record Found?
- Action: The system checks the return status from the database call
Logic Flow:
IF A database call has been made to retrieve equipment data
AND The system checks the return status from the database call
THEN:
- • If the return code is zero, the equipment record exists and processing continues,
otherwise an equipment segment error occurs
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when valid equipment record has been retrieved from the database.
Trigger Criteria:
- Context: A valid equipment record has been retrieved from the database
- Applied to: Process Current Equipment Data
- Action: The system processes the equipment data
Logic Flow:
IF A valid equipment record has been retrieved from the database
AND The system processes the equipment data
THEN:
- • Equipment details are extracted and stored for further processing including equipment ID, car type, and status information
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when current equipment data has been processed and stored.
Trigger Criteria:
- Context: Current equipment data has been processed and stored
- Applied to: Increment Sequence Counter
- Action: The system completes processing of the current equipment record
Logic Flow:
IF Current equipment data has been processed and stored
AND The system completes processing of the current equipment record
THEN:
- • The equipment sequence counter is incremented by 1 to point to the next equipment position
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment sequence counter has been incremented. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: The equipment sequence counter has been incremented
- Applied to: Call FWCMSGET for Next Record
- Action: The system needs to access the next equipment record
Logic Flow:
IF The equipment sequence counter has been incremented
AND The system needs to access the next equipment record
THEN:
- • FWCMSGET is called with the new sequence number to retrieve the next equipment record from FWIIROOT
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when call has been made to retrieve the next equipment record. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A call has been made to retrieve the next equipment record
- Applied to: More Equipment in Sequence?
- Action: The system evaluates the return status from the database call
Logic Flow:
IF A call has been made to retrieve the next equipment record
AND The system evaluates the return status from the database call
THEN:
- • If return code is zero, more equipment exists and processing continues with the next record,
otherwise check for additional cars in bunch bill
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when no more equipment records exist in the current sequence.
Trigger Criteria:
- Context: No more equipment records exist in the current sequence
- Applied to: Additional Cars in Bunch Bill?
- Action: The system checks for bunch bill processing requirements
Logic Flow:
IF No more equipment records exist in the current sequence
AND The system checks for bunch bill processing requirements
THEN:
- • If additional cars exist in the bunch bill, processing continues with the additional car sequence,
otherwise equipment segment processing is complete
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when additional cars exist in a bunch bill arrangement.
Trigger Criteria:
- Context: Additional cars exist in a bunch bill arrangement
- Applied to: Process Additional Car Sequence
- Action: The system processes the additional car sequence
Logic Flow:
IF Additional cars exist in a bunch bill arrangement
AND The system processes the additional car sequence
THEN:
- • The sequence counter is reset and processing continues with the next group of cars in the bunch bill
R-GCX146-cbl-00889 (+17) File: GCX146.cbl Business Rule: Train Equipment List Building
Rule Belongs to : GCX146.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 Equipment Records
- Action: Equipment list building begins
Logic Flow:
IF A train processing request is received
AND Equipment list building begins
THEN:
- • Equipment counters are reset to zero and processing flags are initialized
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment segments exist in the train consist.
Trigger Criteria:
- Context: Equipment segments exist in the train consist
- Applied to: Process Equipment Segment
- Action: Processing equipment for manifest building
Logic Flow:
IF Equipment segments exist in the train consist
AND Processing equipment for manifest building
THEN:
- • Each equipment segment is processed sequentially with proper error handling
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment processing is in progress.
Trigger Criteria:
- Context: Equipment processing is in progress
- Applied to: Retrieve Next Equipment Record
- Action: Retrieving equipment records from the database
Logic Flow:
IF Equipment processing is in progress
AND Retrieving equipment records from the database
THEN:
- • The next equipment record is retrieved and continuation status is determined
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment records are being processed sequentially.
Trigger Criteria:
- Context: Equipment records are being processed sequentially
- Applied to: More Equipment?
- Action: Checking for additional equipment records
Logic Flow:
IF Equipment records are being processed sequentially
AND Checking for additional equipment records
THEN:
- • Processing continues if more equipment exists,
otherwise moves to list completion
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when raw equipment car id data is available.
Trigger Criteria:
- Context: Raw equipment car ID data is available
- Applied to: Format Equipment Car ID
- Action: Formatting car identifiers for manifest display
Logic Flow:
IF Raw equipment car ID data is available
AND Formatting car identifiers for manifest display
THEN:
- • Spaces are removed and standard 12-character format is applied to car IDs
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment record with type indicators is available.
Trigger Criteria:
- Context: Equipment record with type indicators is available
- Applied to: Assign Equipment Type Code
- Action: Assigning equipment type codes for manifest
Logic Flow:
IF Equipment record with type indicators is available
AND Assigning equipment type codes for manifest
THEN:
- • Appropriate type code is assigned based on equipment classification (container/trailer/car) with corresponding type messages
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment record and associated waybill information.
Trigger Criteria:
- Context: Equipment record and associated waybill information
- Applied to: Set Load/Empty Status
- Action: Determining equipment load status
Logic Flow:
IF Equipment record and associated waybill information
AND Determining equipment load status
THEN:
- • Load/empty flags are set correctly and validated against waybill data
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when formatted equipment id, type code, and status information.
Trigger Criteria:
- Context: Formatted equipment ID, type code, and status information
- Applied to: Build Equipment Line Entry
- Action: Building equipment line for manifest display
Logic Flow:
IF Formatted equipment ID, type code, and status information
AND Building equipment line for manifest display
THEN:
- • Complete equipment line entry is constructed with ID, type, and status information in proper format
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when formatted equipment line entry is ready.
Trigger Criteria:
- Context: Formatted equipment line entry is ready
- Applied to: Add to Equipment List
- Action: Adding equipment to the train manifest list
Logic Flow:
IF Formatted equipment line entry is ready
AND Adding equipment to the train manifest list
THEN:
- • Equipment entry is added to the list maintaining proper sequence and format
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment record with container indicators.
Trigger Criteria:
- Context: Equipment record with container indicators
- Applied to: Container on Flat Car?
- Action: Checking for container on flat car configuration
Logic Flow:
IF Equipment record with container indicators
AND Checking for container on flat car configuration
THEN:
- • Container processing is initiated if equipment is identified as container on flat car,
otherwise standard processing continues
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when flat car equipment with associated container cross-reference records.
Trigger Criteria:
- Context: Flat car equipment with associated container cross-reference records
- Applied to: Extract Container IDs
- Action: Processing container information
Logic Flow:
IF Flat car equipment with associated container cross-reference records
AND Processing container information
THEN:
- • Container IDs are extracted from T/C XREF records with proper sequence identification for multiple containers
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when extracted container ids and position information.
Trigger Criteria:
- Context: Extracted container IDs and position information
- Applied to: Format Container Information
- Action: Formatting container information for display
Logic Flow:
IF Extracted container IDs and position information
AND Formatting container information for display
THEN:
- • Container information is formatted with container ID, position on flat car, and flat car association details
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when waybill information with bunch bill indicators.
Trigger Criteria:
- Context: Waybill information with bunch bill indicators
- Applied to: Bunch Bill Present?
- Action: Checking for bunch bill configuration
Logic Flow:
IF Waybill information with bunch bill indicators
AND Checking for bunch bill configuration
THEN:
- • Additional car retrieval is initiated if bunch bill is present,
otherwise processing continues with single car
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when bunch bill waybill with multiple associated cars.
Trigger Criteria:
- Context: Bunch bill waybill with multiple associated cars
- Applied to: Retrieve Additional Cars
- Action: Retrieving additional cars from bunch bill
Logic Flow:
IF Bunch bill waybill with multiple associated cars
AND Retrieving additional cars from bunch bill
THEN:
- • Additional cars are retrieved using FWCMSGET with sequential retrieval maintaining waybill association
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when multiple cars from bunch bill waybill.
Trigger Criteria:
- Context: Multiple cars from bunch bill waybill
- Applied to: Format Sequential Car IDs
- Action: Formatting sequential car identifiers
Logic Flow:
IF Multiple cars from bunch bill waybill
AND Formatting sequential car identifiers
THEN:
- • Car sequence is formatted maintaining waybill association with proper sequential numbering
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all individual equipment entries have been processed.
Trigger Criteria:
- Context: All individual equipment entries have been processed
- Applied to: Build Comprehensive List
- Action: Building the comprehensive equipment list
Logic Flow:
IF All individual equipment entries have been processed
AND Building the comprehensive equipment list
THEN:
- • All equipment entries are compiled into a complete list maintaining proper order and associations
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when complete equipment list with all entries.
Trigger Criteria:
- Context: Complete equipment list with all entries
- Applied to: Apply Proper Formatting
- Action: Applying final formatting standards
Logic Flow:
IF Complete equipment list with all entries
AND Applying final formatting standards
THEN:
- • Proper formatting is applied to ensure consistent presentation across all equipment entries
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when formatted equipment list ready for validation.
Trigger Criteria:
- Context: Formatted equipment list ready for validation
- Applied to: Validate List Completeness
- Action: Validating list completeness
Logic Flow:
IF Formatted equipment list ready for validation
AND Validating list completeness
THEN:
- • Equipment list completeness is verified ensuring all required equipment is included and properly formatted
R-GCX146-cbl-00907 (+23) File: GCX146.cbl Business Rule: Cargo Control Number Database Operations
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment id is provided for ccn lookup.
Trigger Criteria:
- Context: An equipment ID is provided for CCN lookup
- Applied to: Search CCN by Equipment ID
- Action: The system searches the CCN database using the equipment ID
Logic Flow:
IF An equipment ID is provided for CCN lookup
AND The system searches the CCN database using the equipment ID
THEN:
- • The system retrieves any existing CCN records associated with that equipment
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn database search has been performed for an equipment id.
Trigger Criteria:
- Context: A CCN database search has been performed for an equipment ID
- Applied to: CCN Record Found?
- Action: The system evaluates the search results
Logic Flow:
IF A CCN database search has been performed for an equipment ID
AND The system evaluates the search results
THEN:
- • The system determines if a CCN record was found and routes processing accordingly
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn record exists in the database for the equipment.
Trigger Criteria:
- Context: A CCN record exists in the database for the equipment
- Applied to: Retrieve CCN Details
- Action: The system processes the found CCN record
Logic Flow:
IF A CCN record exists in the database for the equipment
AND The system processes the found CCN record
THEN:
- • The system extracts all relevant CCN details including status, waybill information, and customs control data
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn record has been retrieved with its details.
Trigger Criteria:
- Context: A CCN record has been retrieved with its details
- Applied to: Check CCN Usability
- Action: The system validates CCN usability against current transaction requirements
Logic Flow:
IF A CCN record has been retrieved with its details
AND The system validates CCN usability against current transaction requirements
THEN:
- • The system determines if the CCN is usable based on equipment ID matching and waybill consistency
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn usability assessment has been completed.
Trigger Criteria:
- Context: CCN usability assessment has been completed
- Applied to: CCN Usable?
- Action: The system evaluates the usability results
Logic Flow:
IF CCN usability assessment has been completed
AND The system evaluates the usability results
THEN:
- • The system determines if the CCN is usable and routes to appropriate processing path
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when usable ccn record has been identified.
Trigger Criteria:
- Context: A usable CCN record has been identified
- Applied to: Validate CCN Status
- Action: The system validates the current CCN status
Logic Flow:
IF A usable CCN record has been identified
AND The system validates the current CCN status
THEN:
- • The system confirms the CCN status is valid for customs operations (SENT, RETURN, MANUAL, RELEASE, ACK, or CSA-DLV)
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn status validation has been completed.
Trigger Criteria:
- Context: CCN status validation has been completed
- Applied to: Check Bond Creation Flag
- Action: The system examines the bond creation indicator
Logic Flow:
IF CCN status validation has been completed
AND The system examines the bond creation indicator
THEN:
- • The system determines if a new bond has been created (Y flag) for the CCN
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when bond creation flag has been checked.
Trigger Criteria:
- Context: The bond creation flag has been checked
- Applied to: Bond Created = Y?
- Action: The system evaluates if the bond created flag equals 'Y'
Logic Flow:
IF The bond creation flag has been checked
AND The system evaluates if the bond created flag equals 'Y'
THEN:
- • The system routes processing based on whether a new bond has been created
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn has failed usability validation or bond creation requirements.
Trigger Criteria:
- Context: A CCN has failed usability validation or bond creation requirements
- Applied to: Mark CCN as Unusable
- Action: The system processes the unusable CCN
Logic Flow:
IF A CCN has failed usability validation or bond creation requirements
AND The system processes the unusable CCN
THEN:
- • The system marks the CCN as unusable and reports 'CCN FOUND NOT USABLE' for verify operations
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when usable ccn with valid bond creation status has been identified.
Trigger Criteria:
- Context: A usable CCN with valid bond creation status has been identified
- Applied to: Set CCN Status Values
- Action: The system processes CCN status assignment
Logic Flow:
IF A usable CCN with valid bond creation status has been identified
AND The system processes CCN status assignment
THEN:
- • The system sets appropriate CCN status values for customs processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn status values have been set.
Trigger Criteria:
- Context: CCN status values have been set
- Applied to: Assign Status Based on Transit
- Action: The system evaluates transit status and release conditions
Logic Flow:
IF CCN status values have been set
AND The system evaluates transit status and release conditions
THEN:
- • The system assigns the final status based on transit state (E/Z for export, S.A.R. for special release, T for transit, R for return)
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn is ready for status assignment based on transit conditions.
Trigger Criteria:
- Context: CCN is ready for status assignment based on transit conditions
- Applied to: Transit Status?
- Action: The system evaluates the current transit status code
Logic Flow:
IF CCN is ready for status assignment based on transit conditions
AND The system evaluates the current transit status code
THEN:
- • The system determines the appropriate status path based on transit conditions (E/Z, S.A.R., T, R, or other)
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn has release status and transit status is e (export) or z (export zone).
Trigger Criteria:
- Context: CCN has RELEASE status and transit status is E (export) or Z (export zone)
- Applied to: EXPORT
- Action: The system processes status assignment
Logic Flow:
IF CCN has RELEASE status and transit status is E (export) or Z (export zone)
AND The system processes status assignment
THEN:
- • The system sets the CCN status to 'EXPORT'
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn has release status and is released by 's.a.r.' authority.
Trigger Criteria:
- Context: CCN has RELEASE status and is released by 'S.A.R.' authority
- Applied to: S.A.R.
- Action: The system processes status assignment
Logic Flow:
IF CCN has RELEASE status and is released by 'S.A.R.' authority
AND The system processes status assignment
THEN:
- • The system sets the CCN status to 'S.A.R.'
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn has release status but does not meet export or s.a.r. conditions.
Trigger Criteria:
- Context: CCN has RELEASE status but does not meet export or S.A.R. conditions
- Applied to: RELEASE
- Action: The system processes status assignment
Logic Flow:
IF CCN has RELEASE status but does not meet export or S.A.R. conditions
AND The system processes status assignment
THEN:
- • The system sets the CCN status to 'RELEASE'
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn has in-transit status code 't'.
Trigger Criteria:
- Context: CCN has in-transit status code 'T'
- Applied to: TRANSIT
- Action: The system processes status assignment
Logic Flow:
IF CCN has in-transit status code 'T'
AND The system processes status assignment
THEN:
- • The system sets the CCN status to 'TRANSIT'
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn has in-transit status code 'r'.
Trigger Criteria:
- Context: CCN has in-transit status code 'R'
- Applied to: RETURN
- Action: The system processes status assignment
Logic Flow:
IF CCN has in-transit status code 'R'
AND The system processes status assignment
THEN:
- • The system sets the CCN status to 'RETURN'
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when status has been assigned to the ccn requiring return processing.
Trigger Criteria:
- Context: A status has been assigned to the CCN requiring return processing
- Applied to: Create Return CCN
- Action: The system processes return CCN creation
Logic Flow:
IF A status has been assigned to the CCN requiring return processing
AND The system processes return CCN creation
THEN:
- • The system creates a new CCN record with return status and populates shipper, consignee, and station data
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when return ccn needs to be created.
Trigger Criteria:
- Context: A return CCN needs to be created
- Applied to: Build CCN with 6105E Prefix
- Action: The system builds the CCN key
Logic Flow:
IF A return CCN needs to be created
AND The system builds the CCN key
THEN:
- • The system constructs CCN key with format: type(6) + carrier(105) + E + equipment_id + waybill_date + sequence
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn key has been built with 6105e prefix.
Trigger Criteria:
- Context: A CCN key has been built with 6105E prefix
- Applied to: Set Return Status
- Action: The system sets the CCN status
Logic Flow:
IF A CCN key has been built with 6105E prefix
AND The system sets the CCN status
THEN:
- • The system sets the CCN status to 'RETURN' and application type to '33' for Canadian customs
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when new ccn record has been created with return status.
Trigger Criteria:
- Context: A new CCN record has been created with return status
- Applied to: Insert New CCN Record
- Action: The system processes the database insertion
Logic Flow:
IF A new CCN record has been created with return status
AND The system processes the database insertion
THEN:
- • The system inserts the new CCN record into the GCCCRT database
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn processing has been completed with status assignments.
Trigger Criteria:
- Context: CCN processing has been completed with status assignments
- Applied to: Update CCN Database
- Action: The system performs database updates
Logic Flow:
IF CCN processing has been completed with status assignments
AND The system performs database updates
THEN:
- • The system updates the CCN database with current status, train information, and transaction details
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when all ccn database operations have been performed.
Trigger Criteria:
- Context: All CCN database operations have been performed
- Applied to: CCN Operations Complete
- Action: The system finalizes CCN processing
Logic Flow:
IF All CCN database operations have been performed
AND The system finalizes CCN processing
THEN:
- • The system confirms successful completion of all CCN operations
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn record is not found or ccn is marked as unusable.
Trigger Criteria:
- Context: CCN record is not found or CCN is marked as unusable
- Applied to: CCN Not Found/Error
- Action: The system processes the error condition
Logic Flow:
IF CCN record is not found or CCN is marked as unusable
AND The system processes the error condition
THEN:
- • The system handles the CCN not found condition and routes to appropriate error processing
R-GCX146-cbl-00931 (+11) File: GCX146.cbl Business Rule: Customer Report Database Operations
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when customer report generation request is received.
Trigger Criteria:
- Context: A customer report generation request is received
- Applied to: Initialize Customer Report Message
- Action: The system begins customer report database operations
Logic Flow:
IF A customer report generation request is received
AND The system begins customer report database operations
THEN:
- • The customer report message structure is initialized with default values
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when customer report message is initialized.
Trigger Criteria:
- Context: Customer report message is initialized
- Applied to: Set Message Format to GCT1401E
- Action: The system configures message format
Logic Flow:
IF Customer report message is initialized
AND The system configures message format
THEN:
- • The message format is set to GCT1401E transaction type
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when message format is set to gct1401e.
Trigger Criteria:
- Context: Message format is set to GCT1401E
- Applied to: Configure ALT-PCB2 for Message Queuing
- Action: The system configures message queuing
Logic Flow:
IF Message format is set to GCT1401E
AND The system configures message queuing
THEN:
- • ALT-PCB2 is configured for customer report message control and queuing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when alt-pcb2 is configured for message queuing and report content exists in gcx140-input.
Trigger Criteria:
- Context: ALT-PCB2 is configured for message queuing AND report content exists in GCX140-INPUT
- Applied to: Move Report Content to Message Buffer
- Action: The system transfers report content
Logic Flow:
IF ALT-PCB2 is configured for message queuing AND report content exists in GCX140-INPUT
AND The system transfers report content
THEN:
- • Report content is moved from GCX140-INPUT to the message buffer
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when report content is in message buffer.
Trigger Criteria:
- Context: Report content is in message buffer
- Applied to: Execute CIMS CHNG Operation
- Action: The system executes CIMS CHNG operation
Logic Flow:
IF Report content is in message buffer
AND The system executes CIMS CHNG operation
THEN:
- • Database change operation is performed for customer report update
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when cims chng operation is executed.
Trigger Criteria:
- Context: CIMS CHNG operation is executed
- Applied to: CHNG Operation Successful?
- Action: The system checks operation status
Logic Flow:
IF CIMS CHNG operation is executed
AND The system checks operation status
THEN:
- • If CHNG operation is successful, proceed to message write operation,
otherwise handle database operation error
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when chng operation completed successfully.
Trigger Criteria:
- Context: CHNG operation completed successfully
- Applied to: Execute CIMS WRITMSGL Operation
- Action: The system executes CIMS WRITMSGL operation
Logic Flow:
IF CHNG operation completed successfully
AND The system executes CIMS WRITMSGL operation
THEN:
- • Customer report message is written to the message queue
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when cims writmsgl operation is executed.
Trigger Criteria:
- Context: CIMS WRITMSGL operation is executed
- Applied to: WRITMSGL Operation Successful?
- Action: The system checks operation status
Logic Flow:
IF CIMS WRITMSGL operation is executed
AND The system checks operation status
THEN:
- • If WRITMSGL operation is successful, proceed to purge operation,
otherwise handle database operation error
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when writmsgl operation completed successfully.
Trigger Criteria:
- Context: WRITMSGL operation completed successfully
- Applied to: Execute CIMS PURG Operation
- Action: The system executes CIMS PURG operation
Logic Flow:
IF WRITMSGL operation completed successfully
AND The system executes CIMS PURG operation
THEN:
- • Temporary message data is purged from the system
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when cims purg operation is executed.
Trigger Criteria:
- Context: CIMS PURG operation is executed
- Applied to: PURG Operation Successful?
- Action: The system checks operation status
Logic Flow:
IF CIMS PURG operation is executed
AND The system checks operation status
THEN:
- • If PURG operation is successful, customer report is successfully created,
otherwise handle database operation error
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when all database operations (chng, writmsgl, purg) completed successfully.
Trigger Criteria:
- Context: All database operations (CHNG, WRITMSGL, PURG) completed successfully
- Applied to: Customer Report Successfully Created
- Action: The system confirms report creation
Logic Flow:
IF All database operations (CHNG, WRITMSGL, PURG) completed successfully
AND The system confirms report creation
THEN:
- • Customer report is marked as successfully created and process completes normally
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when any database operation (chng, writmsgl, or purg) fails.
Trigger Criteria:
- Context: Any database operation (CHNG, WRITMSGL, or PURG) fails
- Applied to: Handle Database Operation Error
- Action: The system detects operation failure
Logic Flow:
IF Any database operation (CHNG, WRITMSGL, or PURG) fails
AND The system detects operation failure
THEN:
- • Database operation error is handled and process terminates with error status
R-GCX146-cbl-00943 (+7) File: GCX146.cbl Business Rule: Equipment Car Formatting
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment car identifier contains spaces.
Trigger Criteria:
- Context: An equipment car identifier contains spaces
- Applied to: Remove Spaces from Car ID
- Action: The system processes the car identifier for formatting
Logic Flow:
IF An equipment car identifier contains spaces
AND The system processes the car identifier for formatting
THEN:
- • All spaces are removed from the car identifier
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when train number contains spaces.
Trigger Criteria:
- Context: A train number contains spaces
- Applied to: Remove Spaces from Car ID
- Action: The system builds the customs train identifier
Logic Flow:
IF A train number contains spaces
AND The system builds the customs train identifier
THEN:
- • All spaces in the train number are replaced with zeros
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when day component contains spaces.
Trigger Criteria:
- Context: A day component contains spaces
- Applied to: Remove Spaces from Car ID
- Action: The system builds the customs train identifier
Logic Flow:
IF A day component contains spaces
AND The system builds the customs train identifier
THEN:
- • All spaces in the day component are replaced with zeros
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when from station code contains spaces.
Trigger Criteria:
- Context: A from station code contains spaces
- Applied to: Remove Spaces from Car ID
- Action: The system builds the customs train identifier
Logic Flow:
IF A from station code contains spaces
AND The system builds the customs train identifier
THEN:
- • All spaces in the from station code are replaced with zeros
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when to station code contains spaces.
Trigger Criteria:
- Context: A to station code contains spaces
- Applied to: Remove Spaces from Car ID
- Action: The system builds the customs train identifier
Logic Flow:
IF A to station code contains spaces
AND The system builds the customs train identifier
THEN:
- • All spaces in the to station code are replaced with zeros
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when consist number contains spaces.
Trigger Criteria:
- Context: A consist number contains spaces
- Applied to: Remove Spaces from Car ID
- Action: The system builds the customs train identifier
Logic Flow:
IF A consist number contains spaces
AND The system builds the customs train identifier
THEN:
- • All spaces in the consist number are replaced with zeros
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment is identified as a container.
Trigger Criteria:
- Context: Equipment is identified as a container
- Applied to: Apply Standard Formatting Rules
- Action: The system processes the container for formatting
Logic Flow:
IF Equipment is identified as a container
AND The system processes the container for formatting
THEN:
- • The container identifier is formatted to 12-character standard format using GCCCARFM utility
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment identifier is provided for processing.
Trigger Criteria:
- Context: An equipment identifier is provided for processing
- Applied to: Validate Car ID Format
- Action: The system validates the identifier format
Logic Flow:
IF An equipment identifier is provided for processing
AND The system validates the identifier format
THEN:
- • The identifier must meet the required format standards to proceed with processing
R-GCX146-cbl-00951 (+9) File: GCX146.cbl Business Rule: Bunch Bill Processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when waybill record exists in the system.
Trigger Criteria:
- Context: A waybill record exists in the system
- Applied to: Identify Single Waybill with Multiple Cars
- Action: The waybill contains multiple car equipment records associated with it
Logic Flow:
IF A waybill record exists in the system
AND The waybill contains multiple car equipment records associated with it
THEN:
- • The system identifies this as a bunch bill and prepares for sequential car processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when bunch bill has been identified with multiple cars.
Trigger Criteria:
- Context: A bunch bill has been identified with multiple cars
- Applied to: Initialize Sequential Car Processing
- Action: Sequential processing needs to be established
Logic Flow:
IF A bunch bill has been identified with multiple cars
AND Sequential processing needs to be established
THEN:
- • The system initializes the car processing sequence to handle each car record systematically
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when bunch bill requires processing. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A bunch bill requires processing
- Applied to: Call Z980-PROCESS-BUNCHBILL
- Action: Sequential car processing has been initialized
Logic Flow:
IF A bunch bill requires processing
AND Sequential car processing has been initialized
THEN:
- • The system calls the Z980-PROCESS-BUNCHBILL module to execute bunch bill processing logic
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when bunch bill processing module has been invoked.
Trigger Criteria:
- Context: The bunch bill processing module has been invoked
- Applied to: Execute D2554A-BUNCH-BILL-RTN
- Action: Core bunch bill processing needs to be executed
Logic Flow:
IF The bunch bill processing module has been invoked
AND Core bunch bill processing needs to be executed
THEN:
- • The system executes the D2554A-BUNCH-BILL-RTN routine to process the bunch bill
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when bunch bill processing routine is active.
Trigger Criteria:
- Context: A bunch bill processing routine is active
- Applied to: Use FWCMSGET to Retrieve Next Car Record
- Action: The next car record needs to be retrieved for processing
Logic Flow:
IF A bunch bill processing routine is active
AND The next car record needs to be retrieved for processing
THEN:
- • The system uses FWCMSGET to retrieve the next sequential car equipment record
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when car record has been processed within a bunch bill.
Trigger Criteria:
- Context: A car record has been processed within a bunch bill
- Applied to: More Cars Under This Waybill?
- Action: The system needs to determine if more cars exist under the same waybill
Logic Flow:
IF A car record has been processed within a bunch bill
AND The system needs to determine if more cars exist under the same waybill
THEN:
- • The system checks if additional car records remain for processing under this waybill
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when car equipment record has been retrieved from the bunch bill.
Trigger Criteria:
- Context: A car equipment record has been retrieved from the bunch bill
- Applied to: Process Current Car Equipment Record
- Action: The car record requires processing
Logic Flow:
IF A car equipment record has been retrieved from the bunch bill
AND The car record requires processing
THEN:
- • The system processes the current car equipment record applying all standard equipment processing rules
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when car has been processed within a bunch bill.
Trigger Criteria:
- Context: A car has been processed within a bunch bill
- Applied to: Move to Next Car in Sequence
- Action: More cars remain to be processed under the same waybill
Logic Flow:
IF A car has been processed within a bunch bill
AND More cars remain to be processed under the same waybill
THEN:
- • The system moves to the next car in the processing sequence
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all cars under a bunch bill waybill have been processed.
Trigger Criteria:
- Context: All cars under a bunch bill waybill have been processed
- Applied to: Complete Bunch Bill Processing
- Action: No more cars remain for processing under the current waybill
Logic Flow:
IF All cars under a bunch bill waybill have been processed
AND No more cars remain for processing under the current waybill
THEN:
- • The system completes the bunch bill processing and prepares to return to main processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when bunch bill processing has been completed.
Trigger Criteria:
- Context: Bunch bill processing has been completed
- Applied to: Return to Main Equipment Processing
- Action: All cars under the bunch bill have been processed
Logic Flow:
IF Bunch bill processing has been completed
AND All cars under the bunch bill have been processed
THEN:
- • The system returns control to the main equipment processing flow to continue with overall train processing
R-GCX146-cbl-00961 (+12) File: GCX146.cbl Business Rule: Additional Car Sequence Processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when waybill contains multiple cars in a bunch bill arrangement.
Trigger Criteria:
- Context: A waybill contains multiple cars in a bunch bill arrangement
- Applied to: Initialize Bunch Bill Processing
- Action: The system begins processing additional car sequences
Logic Flow:
IF A waybill contains multiple cars in a bunch bill arrangement
AND The system begins processing additional car sequences
THEN:
- • The bunch bill processing parameters are initialized and ready for car sequence processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when bunch bill processing has been initialized. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Bunch bill processing has been initialized
- Applied to: Call D2554A-BUNCH-BILL-RTN
- Action: The system needs to process cars in a bunch bill sequence
Logic Flow:
IF Bunch bill processing has been initialized
AND The system needs to process cars in a bunch bill sequence
THEN:
- • The D2554A-BUNCH-BILL-RTN routine is called to handle the bunch bill processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when bunch bill contains multiple equipment records.
Trigger Criteria:
- Context: A bunch bill contains multiple equipment records
- Applied to: Use FWCMSGET to Get Next Equipment Record
- Action: The system processes each car in the sequence
Logic Flow:
IF A bunch bill contains multiple equipment records
AND The system processes each car in the sequence
THEN:
- • The FWCMSGET function retrieves the next equipment record from the SHIPROOT waybill data
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when system attempts to retrieve an equipment record from waybill data.
Trigger Criteria:
- Context: The system attempts to retrieve an equipment record from waybill data
- Applied to: Equipment Record Found?
- Action: The FWCMSGET function is executed
Logic Flow:
IF The system attempts to retrieve an equipment record from waybill data
AND The FWCMSGET function is executed
THEN:
- • The system validates whether an equipment record was found and continues processing if found, or completes processing if no more records exist
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment record has been successfully retrieved from waybill data.
Trigger Criteria:
- Context: An equipment record has been successfully retrieved from waybill data
- Applied to: Extract Car Identification Data
- Action: The system processes the equipment record
Logic Flow:
IF An equipment record has been successfully retrieved from waybill data
AND The system processes the equipment record
THEN:
- • Car identification data is extracted from the equipment record for validation and processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when car identification data has been extracted from an equipment record.
Trigger Criteria:
- Context: Car identification data has been extracted from an equipment record
- Applied to: Validate Car ID Format
- Action: The system validates the car ID format
Logic Flow:
IF Car identification data has been extracted from an equipment record
AND The system validates the car ID format
THEN:
- • The car ID format is checked against required standards and marked as valid or invalid
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when car id has been validated against format requirements.
Trigger Criteria:
- Context: A car ID has been validated against format requirements
- Applied to: Car ID Valid?
- Action: The system evaluates car ID validity
Logic Flow:
IF A car ID has been validated against format requirements
AND The system evaluates car ID validity
THEN:
- • The system determines if the car ID is valid for processing or requires error handling
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when car id has been validated as meeting format requirements.
Trigger Criteria:
- Context: A car ID has been validated as meeting format requirements
- Applied to: Process Car in Sequence
- Action: The car ID is determined to be valid
Logic Flow:
IF A car ID has been validated as meeting format requirements
AND The car ID is determined to be valid
THEN:
- • The car is processed as part of the bunch bill sequence
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when car has been successfully processed in the bunch bill sequence.
Trigger Criteria:
- Context: A car has been successfully processed in the bunch bill sequence
- Applied to: Increment Car Sequence Counter
- Action: The car processing is completed
Logic Flow:
IF A car has been successfully processed in the bunch bill sequence
AND The car processing is completed
THEN:
- • The car sequence counter is incremented to track the number of processed cars
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when car has been processed and the sequence counter has been incremented.
Trigger Criteria:
- Context: A car has been processed and the sequence counter has been incremented
- Applied to: More Cars in Bunch Bill?
- Action: The system checks for remaining cars in the bunch bill
Logic Flow:
IF A car has been processed and the sequence counter has been incremented
AND The system checks for remaining cars in the bunch bill
THEN:
- • The system determines whether more cars exist for processing or if the bunch bill is complete
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when car id has been extracted from an equipment record.
Trigger Criteria:
- Context: A car ID has been extracted from an equipment record
- Applied to: Log Invalid Car ID Error
- Action: The car ID fails format validation
Logic Flow:
IF A car ID has been extracted from an equipment record
AND The car ID fails format validation
THEN:
- • An invalid car ID error is logged for tracking and audit purposes
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when car id has been determined to be invalid and an error has been logged.
Trigger Criteria:
- Context: A car ID has been determined to be invalid and an error has been logged
- Applied to: Skip Invalid Car Record
- Action: The system continues bunch bill processing
Logic Flow:
IF A car ID has been determined to be invalid and an error has been logged
AND The system continues bunch bill processing
THEN:
- • The invalid car record is skipped and processing continues with the next car in the sequence
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when all cars in the bunch bill have been processed or no more equipment records are available.
Trigger Criteria:
- Context: All cars in the bunch bill have been processed or no more equipment records are available
- Applied to: Complete Additional Car Processing
- Action: The bunch bill processing reaches completion
Logic Flow:
IF All cars in the bunch bill have been processed or no more equipment records are available
AND The bunch bill processing reaches completion
THEN:
- • The additional car processing is completed and the system is ready for the next processing step
R-GCX146-cbl-00974 (+16) File: GCX146.cbl Business Rule: US Trip Sheet Data Preparation
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when us trip sheet generation process is starting.
Trigger Criteria:
- Context: A US trip sheet generation process is starting
- Applied to: Initialize US Trip Sheet Equipment Records
- Action: The system begins processing equipment records
Logic Flow:
IF A US trip sheet generation process is starting
AND The system begins processing equipment records
THEN:
- • Equipment counters are reset to zero and processing flags are initialized
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when train consist record exists with equipment information.
Trigger Criteria:
- Context: A train consist record exists with equipment information
- Applied to: Extract Equipment Information
- Action: The system processes each equipment entry
Logic Flow:
IF A train consist record exists with equipment information
AND The system processes each equipment entry
THEN:
- • Equipment ID, type, status, and associated data are extracted for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment information has been extracted from train records.
Trigger Criteria:
- Context: Equipment information has been extracted from train records
- Applied to: Determine Equipment Type
- Action: The system analyzes equipment characteristics
Logic Flow:
IF Equipment information has been extracted from train records
AND The system analyzes equipment characteristics
THEN:
- • Equipment is classified as IDLER, UNIT, VAN, ETU, or Other type based on its properties
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment is classified as idler type.
Trigger Criteria:
- Context: Equipment is classified as IDLER type
- Applied to: Process IDLER Equipment
- Action: The system processes the IDLER equipment
Logic Flow:
IF Equipment is classified as IDLER type
AND The system processes the IDLER equipment
THEN:
- • IDLER equipment data is formatted according to US customs requirements with appropriate status indicators
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment is classified as unit type (locomotives, power units).
Trigger Criteria:
- Context: Equipment is classified as UNIT type (locomotives, power units)
- Applied to: Process UNIT Equipment
- Action: The system processes the UNIT equipment
Logic Flow:
IF Equipment is classified as UNIT type (locomotives, power units)
AND The system processes the UNIT equipment
THEN:
- • UNIT equipment data is formatted with proper identification and status information for US customs reporting
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment is classified as van type.
Trigger Criteria:
- Context: Equipment is classified as VAN type
- Applied to: Process VAN Equipment
- Action: The system processes the VAN equipment
Logic Flow:
IF Equipment is classified as VAN type
AND The system processes the VAN equipment
THEN:
- • VAN equipment data is formatted with cargo information and customs status for trip sheet reporting
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment is classified as etu type.
Trigger Criteria:
- Context: Equipment is classified as ETU type
- Applied to: Process ETU Equipment
- Action: The system processes the ETU equipment
Logic Flow:
IF Equipment is classified as ETU type
AND The system processes the ETU equipment
THEN:
- • ETU equipment data is formatted with appropriate technical specifications and status for customs reporting
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment is classified as other type (not idler, unit, van, or etu).
Trigger Criteria:
- Context: Equipment is classified as Other type (not IDLER, UNIT, VAN, or ETU)
- Applied to: Process Other Equipment Types
- Action: The system processes the other equipment type
Logic Flow:
IF Equipment is classified as Other type (not IDLER, UNIT, VAN, or ETU)
AND The system processes the other equipment type
THEN:
- • Equipment data is formatted using standard default rules for US customs trip sheet reporting
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment has been processed according to its type classification.
Trigger Criteria:
- Context: Equipment has been processed according to its type classification
- Applied to: Format Equipment Data for US Customs
- Action: The system formats the equipment data for US customs
Logic Flow:
IF Equipment has been processed according to its type classification
AND The system formats the equipment data for US customs
THEN:
- • Equipment information is structured in compliance with US customs trip sheet format requirements including proper field positioning and data validation
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment data has been formatted for us customs requirements.
Trigger Criteria:
- Context: Equipment data has been formatted for US customs requirements
- Applied to: Build Merlin Transmission Lines
- Action: The system builds Merlin transmission lines
Logic Flow:
IF Equipment data has been formatted for US customs requirements
AND The system builds Merlin transmission lines
THEN:
- • Message lines are constructed with proper formatting, sequencing, and transmission headers for Merlin system delivery
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when merlin transmission lines have been built for equipment.
Trigger Criteria:
- Context: Merlin transmission lines have been built for equipment
- Applied to: Prepare Equipment Type Messages
- Action: The system prepares equipment type messages
Logic Flow:
IF Merlin transmission lines have been built for equipment
AND The system prepares equipment type messages
THEN:
- • Messages are customized with equipment-specific information, status codes, and regulatory data appropriate for each equipment type
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment type messages have been prepared.
Trigger Criteria:
- Context: Equipment type messages have been prepared
- Applied to: Format Equipment Car IDs
- Action: The system formats equipment car IDs
Logic Flow:
IF Equipment type messages have been prepared
AND The system formats equipment car IDs
THEN:
- • Car identification numbers are standardized with proper length, character formatting, and validation according to railroad and customs standards
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment car ids have been formatted.
Trigger Criteria:
- Context: Equipment car IDs have been formatted
- Applied to: Compile Equipment Status Information
- Action: The system compiles equipment status information
Logic Flow:
IF Equipment car IDs have been formatted
AND The system compiles equipment status information
THEN:
- • Complete status records are created including customs status, transit information, cargo details, and regulatory compliance data
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment status information has been compiled into trip sheet format.
Trigger Criteria:
- Context: Equipment status information has been compiled into trip sheet format
- Applied to: Segment Message for Transmission
- Action: The message exceeds transmission system limits
Logic Flow:
IF Equipment status information has been compiled into trip sheet format
AND The message exceeds transmission system limits
THEN:
- • The message is segmented into multiple parts with proper continuation headers and sequence numbering to ensure complete delivery
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when current equipment record has been processed and segmented for transmission.
Trigger Criteria:
- Context: Current equipment record has been processed and segmented for transmission
- Applied to: More Equipment?
- Action: The system checks for additional equipment in the train consist
Logic Flow:
IF Current equipment record has been processed and segmented for transmission
AND The system checks for additional equipment in the train consist
THEN:
- • If more equipment exists, processing continues with the next equipment record;
otherwise, processing moves to finalization
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all equipment records have been processed and no more equipment remains.
Trigger Criteria:
- Context: All equipment records have been processed and no more equipment remains
- Applied to: Finalize US Trip Sheet Data
- Action: The system finalizes the US trip sheet data
Logic Flow:
IF All equipment records have been processed and no more equipment remains
AND The system finalizes the US trip sheet data
THEN:
- • Trip sheet is completed with summary totals, final formatting, and all required regulatory information for US customs submission
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when us trip sheet data has been finalized with all equipment and summary information.
Trigger Criteria:
- Context: US trip sheet data has been finalized with all equipment and summary information
- Applied to: Ready for Merlin Transmission
- Action: The system prepares for Merlin transmission
Logic Flow:
IF US trip sheet data has been finalized with all equipment and summary information
AND The system prepares for Merlin transmission
THEN:
- • Trip sheet is formatted for Merlin system delivery with proper transmission headers, routing information, and delivery confirmation requirements
R-GCX146-cbl-00991 (+17) File: GCX146.cbl Business Rule: Merlin Report Line Processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when merlin report needs to be processed for transmission.
Trigger Criteria:
- Context: A Merlin report needs to be processed for transmission
- Applied to: Initialize Line Counter
- Action: The system starts processing report lines
Logic Flow:
IF A Merlin report needs to be processed for transmission
AND The system starts processing report lines
THEN:
- • The line counter is set to zero and message buffer is initialized
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when report lines are available for processing.
Trigger Criteria:
- Context: Report lines are available for processing
- Applied to: Get Next Report Line
- Action: The system requests the next report line
Logic Flow:
IF Report lines are available for processing
AND The system requests the next report line
THEN:
- • The next sequential report line is retrieved from the report data
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when system is processing report lines.
Trigger Criteria:
- Context: The system is processing report lines
- Applied to: Line Available?
- Action: The system checks for line availability
Logic Flow:
IF The system is processing report lines
AND The system checks for line availability
THEN:
- • If lines are available, continue processing; if no lines available, finalize current message
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when report line is available for processing.
Trigger Criteria:
- Context: A report line is available for processing
- Applied to: Format Line for Merlin Transmission
- Action: The system formats the line for Merlin transmission
Logic Flow:
IF A report line is available for processing
AND The system formats the line for Merlin transmission
THEN:
- • The line is formatted according to Merlin protocol specifications
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when formatted report line is ready to be added to the message buffer.
Trigger Criteria:
- Context: A formatted report line is ready to be added to the message buffer
- Applied to: Check Line Length Limits
- Action: The system checks the current line count in the message
Logic Flow:
IF A formatted report line is ready to be added to the message buffer
AND The system checks the current line count in the message
THEN:
- • If the message has 699 or more lines, create a continuation message;
otherwise add line to current message
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when formatted report line is ready and message buffer has not exceeded line limits.
Trigger Criteria:
- Context: A formatted report line is ready and message buffer has not exceeded line limits
- Applied to: Add Line to Current Message Buffer
- Action: The system adds the line to the message buffer
Logic Flow:
IF A formatted report line is ready and message buffer has not exceeded line limits
AND The system adds the line to the message buffer
THEN:
- • The line is appended to the current message buffer
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when report line has been added to the message buffer.
Trigger Criteria:
- Context: A report line has been added to the message buffer
- Applied to: Increment Line Counter
- Action: The system updates the line counter
Logic Flow:
IF A report line has been added to the message buffer
AND The system updates the line counter
THEN:
- • The line counter is incremented by one
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when current message has reached or exceeded 699 lines.
Trigger Criteria:
- Context: The current message has reached or exceeded 699 lines
- Applied to: Create Continuation Message
- Action: The system needs to add more lines
Logic Flow:
IF The current message has reached or exceeded 699 lines
AND The system needs to add more lines
THEN:
- • A new continuation message is created to handle additional lines
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when continuation message needs to be created.
Trigger Criteria:
- Context: A continuation message needs to be created
- Applied to: Reset Message Buffer
- Action: The system resets the message buffer
Logic Flow:
IF A continuation message needs to be created
AND The system resets the message buffer
THEN:
- • The message buffer is cleared and line counter is reset to zero
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when continuation message has been created.
Trigger Criteria:
- Context: A continuation message has been created
- Applied to: Add Continuation Header
- Action: The system adds the continuation header
Logic Flow:
IF A continuation message has been created
AND The system adds the continuation header
THEN:
- • The header 'CONTINUATION OF REPORT....' is added to the beginning of the new message
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment data is available for processing.
Trigger Criteria:
- Context: Equipment data is available for processing
- Applied to: Process Equipment Type Messages
- Action: The system processes equipment type messages
Logic Flow:
IF Equipment data is available for processing
AND The system processes equipment type messages
THEN:
- • Each equipment type (IDLER, UNIT, VAN, ETU) is processed according to its specific requirements
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when idler equipment data is available.
Trigger Criteria:
- Context: IDLER equipment data is available
- Applied to: Process IDLER Equipment
- Action: The system processes IDLER equipment
Logic Flow:
IF IDLER equipment data is available
AND The system processes IDLER equipment
THEN:
- • IDLER equipment information is formatted and included in the report
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when unit equipment data is available.
Trigger Criteria:
- Context: UNIT equipment data is available
- Applied to: Process UNIT Equipment
- Action: The system processes UNIT equipment
Logic Flow:
IF UNIT equipment data is available
AND The system processes UNIT equipment
THEN:
- • UNIT equipment information is formatted and included in the report
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when van equipment data is available.
Trigger Criteria:
- Context: VAN equipment data is available
- Applied to: Process VAN Equipment
- Action: The system processes VAN equipment
Logic Flow:
IF VAN equipment data is available
AND The system processes VAN equipment
THEN:
- • VAN equipment information is formatted and included in the report
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when etu equipment data is available.
Trigger Criteria:
- Context: ETU equipment data is available
- Applied to: Process ETU Equipment
- Action: The system processes ETU equipment
Logic Flow:
IF ETU equipment data is available
AND The system processes ETU equipment
THEN:
- • ETU equipment information is formatted and included in the report
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment type processing has been completed for current line.
Trigger Criteria:
- Context: Equipment type processing has been completed for current line
- Applied to: More Lines to Process?
- Action: The system checks for more lines to process
Logic Flow:
IF Equipment type processing has been completed for current line
AND The system checks for more lines to process
THEN:
- • If more lines exist, continue processing; if no more lines, finalize the current message
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all available lines have been processed or message is complete.
Trigger Criteria:
- Context: All available lines have been processed or message is complete
- Applied to: Finalize Current Message
- Action: The system finalizes the current message
Logic Flow:
IF All available lines have been processed or message is complete
AND The system finalizes the current message
THEN:
- • The message buffer is prepared for transmission with proper formatting and headers
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when message has been finalized and is ready for transmission.
Trigger Criteria:
- Context: A message has been finalized and is ready for transmission
- Applied to: Send Message via Merlin
- Action: The system sends the message via Merlin
Logic Flow:
IF A message has been finalized and is ready for transmission
AND The system sends the message via Merlin
THEN:
- • The message is transmitted through the Merlin system to the intended recipients
R-GCX146-cbl-01009 (+19) File: GCX146.cbl Business Rule: Equipment Information Message Assignment
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment record with a specific car type code.
Trigger Criteria:
- Context: An equipment record with a specific car type code
- Applied to: Equipment Type?
- Action: The system evaluates the equipment type for message assignment
Logic Flow:
IF An equipment record with a specific car type code
AND The system evaluates the equipment type for message assignment
THEN:
- • The system classifies the equipment as IDLER, UNIT, VAN, ETU, Container, Trailer, or standard Car based on the car type code patterns
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has been classified as idler type.
Trigger Criteria:
- Context: Equipment has been classified as IDLER type
- Applied to: Assign IDLER Message
- Action: The system processes the equipment for message assignment
Logic Flow:
IF Equipment has been classified as IDLER type
AND The system processes the equipment for message assignment
THEN:
- • The system assigns the appropriate IDLER equipment message format
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment has been classified as unit type with car type codes l, p, d, or u.
Trigger Criteria:
- Context: Equipment has been classified as UNIT type with car type codes L, P, D, or U
- Applied to: Assign UNIT Message
- Action: The system processes the equipment for message assignment
Logic Flow:
IF Equipment has been classified as UNIT type with car type codes L, P, D, or U
AND The system processes the equipment for message assignment
THEN:
- • The system assigns the appropriate UNIT equipment message format
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has been classified as van type with car type code v.
Trigger Criteria:
- Context: Equipment has been classified as VAN type with car type code V
- Applied to: Assign VAN Message
- Action: The system processes the equipment for message assignment
Logic Flow:
IF Equipment has been classified as VAN type with car type code V
AND The system processes the equipment for message assignment
THEN:
- • The system assigns the appropriate VAN equipment message format
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has been classified as etu type with car type code e.
Trigger Criteria:
- Context: Equipment has been classified as ETU type with car type code E
- Applied to: Assign ETU Message
- Action: The system processes the equipment for message assignment
Logic Flow:
IF Equipment has been classified as ETU type with car type code E
AND The system processes the equipment for message assignment
THEN:
- • The system assigns the appropriate ETU equipment message format
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has been identified as a container type.
Trigger Criteria:
- Context: Equipment has been identified as a container type
- Applied to: Assign Container Message
- Action: The system processes the equipment for message assignment
Logic Flow:
IF Equipment has been identified as a container type
AND The system processes the equipment for message assignment
THEN:
- • The system assigns the appropriate container equipment message format
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has been identified as a trailer type.
Trigger Criteria:
- Context: Equipment has been identified as a trailer type
- Applied to: Assign Trailer Message
- Action: The system processes the equipment for message assignment
Logic Flow:
IF Equipment has been identified as a trailer type
AND The system processes the equipment for message assignment
THEN:
- • The system assigns the appropriate trailer equipment message format
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment does not match idler, unit, van, etu, container, or trailer classifications.
Trigger Criteria:
- Context: Equipment does not match IDLER, UNIT, VAN, ETU, Container, or Trailer classifications
- Applied to: Assign Car Message
- Action: The system processes the equipment for message assignment
Logic Flow:
IF Equipment does not match IDLER, UNIT, VAN, ETU, Container, or Trailer classifications
AND The system processes the equipment for message assignment
THEN:
- • The system assigns the standard car equipment message format
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has been assigned a type classification.
Trigger Criteria:
- Context: Equipment has been assigned a type classification
- Applied to: Equipment Status?
- Action: The system evaluates the equipment status for message assignment
Logic Flow:
IF Equipment has been assigned a type classification
AND The system evaluates the equipment status for message assignment
THEN:
- • The system determines if the equipment is Load, Empty, Transit, Release, or Held status
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment status indicates loaded condition.
Trigger Criteria:
- Context: Equipment status indicates loaded condition
- Applied to: Assign Load Status Message
- Action: The system processes the equipment status for message assignment
Logic Flow:
IF Equipment status indicates loaded condition
AND The system processes the equipment status for message assignment
THEN:
- • The system assigns the appropriate load status message
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment status indicates empty condition.
Trigger Criteria:
- Context: Equipment status indicates empty condition
- Applied to: Assign Empty Status Message
- Action: The system processes the equipment status for message assignment
Logic Flow:
IF Equipment status indicates empty condition
AND The system processes the equipment status for message assignment
THEN:
- • The system assigns the appropriate empty status message
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment status indicates transit condition.
Trigger Criteria:
- Context: Equipment status indicates transit condition
- Applied to: Assign Transit Status Message
- Action: The system processes the equipment status for message assignment
Logic Flow:
IF Equipment status indicates transit condition
AND The system processes the equipment status for message assignment
THEN:
- • The system assigns the appropriate transit status message
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment status indicates released condition.
Trigger Criteria:
- Context: Equipment status indicates released condition
- Applied to: Assign Release Status Message
- Action: The system processes the equipment status for message assignment
Logic Flow:
IF Equipment status indicates released condition
AND The system processes the equipment status for message assignment
THEN:
- • The system assigns the appropriate release status message
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment status indicates held condition.
Trigger Criteria:
- Context: Equipment status indicates held condition
- Applied to: Assign Held Status Message
- Action: The system processes the equipment status for message assignment
Logic Flow:
IF Equipment status indicates held condition
AND The system processes the equipment status for message assignment
THEN:
- • The system assigns the appropriate held status message
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has been assigned type and status messages.
Trigger Criteria:
- Context: Equipment has been assigned type and status messages
- Applied to: Special Processing Required?
- Action: The system evaluates special processing requirements
Logic Flow:
IF Equipment has been assigned type and status messages
AND The system evaluates special processing requirements
THEN:
- • The system determines if equipment needs Bunch Bill, Flat Car Container, Return CCN, or standard processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment requires bunch bill special processing.
Trigger Criteria:
- Context: Equipment requires bunch bill special processing
- Applied to: Assign Bunch Bill Message
- Action: The system processes the equipment for bunch bill message assignment
Logic Flow:
IF Equipment requires bunch bill special processing
AND The system processes the equipment for bunch bill message assignment
THEN:
- • The system assigns the appropriate bunch bill message format
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment requires flat car container special processing.
Trigger Criteria:
- Context: Equipment requires flat car container special processing
- Applied to: Assign Flat Car Container Message
- Action: The system processes the equipment for flat car container message assignment
Logic Flow:
IF Equipment requires flat car container special processing
AND The system processes the equipment for flat car container message assignment
THEN:
- • The system assigns the appropriate flat car container message format
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment requires return ccn special processing.
Trigger Criteria:
- Context: Equipment requires return CCN special processing
- Applied to: Assign Return CCN Message
- Action: The system processes the equipment for return CCN message assignment
Logic Flow:
IF Equipment requires return CCN special processing
AND The system processes the equipment for return CCN message assignment
THEN:
- • The system assigns the appropriate return CCN message format
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment has been assigned appropriate type, status, and special processing messages.
Trigger Criteria:
- Context: Equipment has been assigned appropriate type, status, and special processing messages
- Applied to: Format Equipment Information
- Action: The system formats the equipment information
Logic Flow:
IF Equipment has been assigned appropriate type, status, and special processing messages
AND The system formats the equipment information
THEN:
- • The system creates properly formatted equipment information message ready for storage
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment information has been properly formatted.
Trigger Criteria:
- Context: Equipment information has been properly formatted
- Applied to: Store Message Assignment
- Action: The system stores the message assignment
Logic Flow:
IF Equipment information has been properly formatted
AND The system stores the message assignment
THEN:
- • The system saves the equipment message assignment data for subsequent processing steps
R-GCX146-cbl-01029 (+14) File: GCX146.cbl Business Rule: Bunch Bill Waybill Processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill record exists in the system.
Trigger Criteria:
- Context: A waybill record exists in the system
- Applied to: Initialize Bunch Bill Sequence
- Action: The system begins bunch bill processing
Logic Flow:
IF A waybill record exists in the system
AND The system begins bunch bill processing
THEN:
- • The bunch bill sequence counter is set to 1 and processing flags are initialized
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when waybill number is provided for processing.
Trigger Criteria:
- Context: A waybill number is provided for processing
- Applied to: Retrieve Primary Waybill Record
- Action: The system attempts to retrieve the waybill record
Logic Flow:
IF A waybill number is provided for processing
AND The system attempts to retrieve the waybill record
THEN:
- • The primary waybill record is retrieved from FWIIROOT database
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when waybill record has been retrieved.
Trigger Criteria:
- Context: A waybill record has been retrieved
- Applied to: Waybill Has Multiple Cars?
- Action: The system examines the waybill structure
Logic Flow:
IF A waybill record has been retrieved
AND The system examines the waybill structure
THEN:
- • If the waybill contains multiple cars, sequential processing is initiated,
otherwise processing ends
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when bunch bill with multiple cars has been identified.
Trigger Criteria:
- Context: A bunch bill with multiple cars has been identified
- Applied to: Set Sequential Car Counter
- Action: Sequential processing begins
Logic Flow:
IF A bunch bill with multiple cars has been identified
AND Sequential processing begins
THEN:
- • The car counter is initialized to track each car in the sequence
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when car position in the bunch bill sequence is identified.
Trigger Criteria:
- Context: A car position in the bunch bill sequence is identified
- Applied to: Process Current Car Equipment
- Action: The system processes the current car
Logic Flow:
IF A car position in the bunch bill sequence is identified
AND The system processes the current car
THEN:
- • Equipment details for the current car are extracted and prepared for validation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment id has been extracted from the waybill.
Trigger Criteria:
- Context: An equipment ID has been extracted from the waybill
- Applied to: Validate Equipment ID
- Action: The system validates the equipment ID
Logic Flow:
IF An equipment ID has been extracted from the waybill
AND The system validates the equipment ID
THEN:
- • The equipment ID is verified against SHIPROOT equipment records for existence and format compliance
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment id has been validated successfully.
Trigger Criteria:
- Context: An equipment ID has been validated successfully
- Applied to: Extract Car Details
- Action: The system extracts car details
Logic Flow:
IF An equipment ID has been validated successfully
AND The system extracts car details
THEN:
- • Complete car information including type, status, and specifications are extracted from the equipment records
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when car details have been successfully extracted.
Trigger Criteria:
- Context: Car details have been successfully extracted
- Applied to: Store Car Information
- Action: The system stores the car information
Logic Flow:
IF Car details have been successfully extracted
AND The system stores the car information
THEN:
- • Car information is stored in the processing queue for subsequent operations
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when car has been successfully processed.
Trigger Criteria:
- Context: A car has been successfully processed
- Applied to: Increment Car Counter
- Action: The system completes processing of the current car
Logic Flow:
IF A car has been successfully processed
AND The system completes processing of the current car
THEN:
- • The car counter is incremented to move to the next car in the sequence
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when car counter has been incremented.
Trigger Criteria:
- Context: The car counter has been incremented
- Applied to: Retrieve Next Car in Sequence
- Action: The system retrieves the next car in sequence
Logic Flow:
IF The car counter has been incremented
AND The system retrieves the next car in sequence
THEN:
- • The next car record is retrieved from FWIIROOT database using the sequential position
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when car has been processed and counter incremented.
Trigger Criteria:
- Context: A car has been processed and counter incremented
- Applied to: More Cars in Bunch Bill?
- Action: The system checks for more cars
Logic Flow:
IF A car has been processed and counter incremented
AND The system checks for more cars
THEN:
- • If additional cars exist in the bunch bill, processing continues with the next car,
otherwise processing finalizes
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when all cars in the bunch bill have been processed.
Trigger Criteria:
- Context: All cars in the bunch bill have been processed
- Applied to: Finalize Bunch Bill Processing
- Action: The system finalizes bunch bill processing
Logic Flow:
IF All cars in the bunch bill have been processed
AND The system finalizes bunch bill processing
THEN:
- • Processing results are consolidated and prepared for final output
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when bunch bill processing has been finalized.
Trigger Criteria:
- Context: Bunch bill processing has been finalized
- Applied to: Update Equipment Totals
- Action: The system updates equipment totals
Logic Flow:
IF Bunch bill processing has been finalized
AND The system updates equipment totals
THEN:
- • Total equipment counts, status summaries, and processing statistics are updated with bunch bill results
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment id fails validation.
Trigger Criteria:
- Context: An equipment ID fails validation
- Applied to: Handle Equipment Error
- Action: The system handles the equipment error
Logic Flow:
IF An equipment ID fails validation
AND The system handles the equipment error
THEN:
- • Error handling procedures are initiated and the invalid equipment is flagged for review
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when invalid equipment has been identified.
Trigger Criteria:
- Context: Invalid equipment has been identified
- Applied to: Log Invalid Equipment
- Action: The system logs the invalid equipment
Logic Flow:
IF Invalid equipment has been identified
AND The system logs the invalid equipment
THEN:
- • Equipment details and error information are logged for subsequent review and correction
R-GCX146-cbl-01044 (+19) File: GCX146.cbl Business Rule: US Trip Sheet Merlin Transmission
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when us trip sheet transmission is being prepared.
Trigger Criteria:
- Context: A US trip sheet transmission is being prepared
- Applied to: Initialize US Trip Sheet Equipment Records
- Action: The system begins processing equipment records
Logic Flow:
IF A US trip sheet transmission is being prepared
AND The system begins processing equipment records
THEN:
- • Equipment counters are reset to zero and processing flags are initialized
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment records exist for the train.
Trigger Criteria:
- Context: Equipment records exist for the train
- Applied to: Build Equipment List for US Customs
- Action: The system processes each equipment record for US customs reporting
Logic Flow:
IF Equipment records exist for the train
AND The system processes each equipment record for US customs reporting
THEN:
- • Valid equipment records are added to the trip sheet processing list
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment record needs to be formatted for transmission.
Trigger Criteria:
- Context: An equipment record needs to be formatted for transmission
- Applied to: Format Equipment Type Messages
- Action: The system processes the equipment record
Logic Flow:
IF An equipment record needs to be formatted for transmission
AND The system processes the equipment record
THEN:
- • Equipment details are formatted according to US customs requirements including car type, waybill information, and cargo details
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment record with car type information.
Trigger Criteria:
- Context: An equipment record with car type information
- Applied to: Equipment Type?
- Action: The system evaluates the equipment type
Logic Flow:
IF An equipment record with car type information
AND The system evaluates the equipment type
THEN:
- • Equipment is classified as IDLER, UNIT, VAN, ETU, or Other based on car type codes
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment record classified as idler type.
Trigger Criteria:
- Context: An equipment record classified as IDLER type
- Applied to: Format IDLER Equipment Message
- Action: The system formats the equipment message
Logic Flow:
IF An equipment record classified as IDLER type
AND The system formats the equipment message
THEN:
- • IDLER equipment is formatted with car identification and basic details without cargo information
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment record classified as unit type (l, p, d, u car types).
Trigger Criteria:
- Context: An equipment record classified as UNIT type (L, P, D, U car types)
- Applied to: Format UNIT Equipment Message
- Action: The system formats the equipment message
Logic Flow:
IF An equipment record classified as UNIT type (L, P, D, U car types)
AND The system formats the equipment message
THEN:
- • UNIT equipment is formatted with complete details including car ID, waybill number, shipper, consignee, origin, destination, and cargo description
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment record classified as van type.
Trigger Criteria:
- Context: An equipment record classified as VAN type
- Applied to: Format VAN Equipment Message
- Action: The system formats the equipment message
Logic Flow:
IF An equipment record classified as VAN type
AND The system formats the equipment message
THEN:
- • VAN equipment is formatted with van identification and cargo details appropriate for van shipments
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment record classified as etu type.
Trigger Criteria:
- Context: An equipment record classified as ETU type
- Applied to: Format ETU Equipment Message
- Action: The system formats the equipment message
Logic Flow:
IF An equipment record classified as ETU type
AND The system formats the equipment message
THEN:
- • ETU equipment is formatted with tank unit identification and empty status indication
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment record that does not match idler, unit, van, or etu classifications.
Trigger Criteria:
- Context: An equipment record that does not match IDLER, UNIT, VAN, or ETU classifications
- Applied to: Format Other Equipment Message
- Action: The system formats the equipment message
Logic Flow:
IF An equipment record that does not match IDLER, UNIT, VAN, or ETU classifications
AND The system formats the equipment message
THEN:
- • Equipment is formatted using standard formatting rules with available car and cargo information
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when formatted equipment message.
Trigger Criteria:
- Context: A formatted equipment message
- Applied to: Add Equipment to Merlin Message Buffer
- Action: The system adds the equipment to the message buffer
Logic Flow:
IF A formatted equipment message
AND The system adds the equipment to the message buffer
THEN:
- • Equipment information is appended to the current message buffer and line counters are updated
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment processing is in progress.
Trigger Criteria:
- Context: Equipment processing is in progress
- Applied to: More Equipment?
- Action: The system checks for remaining equipment records
Logic Flow:
IF Equipment processing is in progress
AND The system checks for remaining equipment records
THEN:
- • Processing continues if more equipment exists,
otherwise proceeds to message finalization
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has been added to the message buffer.
Trigger Criteria:
- Context: Equipment has been added to the message buffer
- Applied to: Check Message Size Limits
- Action: The system checks the current message size
Logic Flow:
IF Equipment has been added to the message buffer
AND The system checks the current message size
THEN:
- • Message line count and size are validated against maximum transmission limits
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when message buffer with accumulated equipment data.
Trigger Criteria:
- Context: A message buffer with accumulated equipment data
- Applied to: Message Size Exceeded?
- Action: The system evaluates the message size against limits
Logic Flow:
IF A message buffer with accumulated equipment data
AND The system evaluates the message size against limits
THEN:
- • Message segmentation is triggered if size exceeds limits,
otherwise processing continues normally
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when message buffer that has exceeded size limits.
Trigger Criteria:
- Context: A message buffer that has exceeded size limits
- Applied to: Segment Message for Transmission
- Action: The system segments the message
Logic Flow:
IF A message buffer that has exceeded size limits
AND The system segments the message
THEN:
- • Current message content is prepared for transmission as a complete segment
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when prepared message segment ready for transmission.
Trigger Criteria:
- Context: A prepared message segment ready for transmission
- Applied to: Send Current Message Segment
- Action: The system sends the message segment
Logic Flow:
IF A prepared message segment ready for transmission
AND The system sends the message segment
THEN:
- • Message segment is transmitted to US customs through Merlin communication system
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when message segment has been transmitted.
Trigger Criteria:
- Context: A message segment has been transmitted
- Applied to: Initialize New Message Segment
- Action: The system initializes a new message segment
Logic Flow:
IF A message segment has been transmitted
AND The system initializes a new message segment
THEN:
- • Message buffer is reset and prepared for additional equipment data with appropriate headers
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when new message segment has been initialized.
Trigger Criteria:
- Context: A new message segment has been initialized
- Applied to: Continue with Remaining Equipment
- Action: The system continues equipment processing
Logic Flow:
IF A new message segment has been initialized
AND The system continues equipment processing
THEN:
- • Remaining equipment records are processed and added to the new message segment
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when all equipment has been processed and message size is within limits.
Trigger Criteria:
- Context: All equipment has been processed and message size is within limits
- Applied to: Finalize Complete Message
- Action: The system finalizes the message
Logic Flow:
IF All equipment has been processed and message size is within limits
AND The system finalizes the message
THEN:
- • Message is prepared for final transmission with appropriate headers and footers
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when finalized message ready for transmission.
Trigger Criteria:
- Context: A finalized message ready for transmission
- Applied to: Transmit Final Message to US Customs
- Action: The system transmits the final message
Logic Flow:
IF A finalized message ready for transmission
AND The system transmits the final message
THEN:
- • Complete trip sheet data is sent to US customs via Merlin communication system
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when message has been transmitted to us customs.
Trigger Criteria:
- Context: A message has been transmitted to US customs
- Applied to: Log Transmission Activity
- Action: The system logs the transmission
Logic Flow:
IF A message has been transmitted to US customs
AND The system logs the transmission
THEN:
- • Transmission details including timestamp, message count, and status are recorded for audit trail
R-GCX146-cbl-01064 (+6) File: GCX146.cbl Business Rule: Cargo Arrival Detection Processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn record exists with transit status information.
Trigger Criteria:
- Context: A CCN record exists with transit status information
- Applied to: Check Transit Status = 'D' for Delivered?
- Action: The system checks the transit status field
Logic Flow:
IF A CCN record exists with transit status information
AND The system checks the transit status field
THEN:
- • If transit status equals 'D' (Delivered), the cargo is identified as arrived,
otherwise continue processing next equipment
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has transit status 'd' and manifest contains destination station information.
Trigger Criteria:
- Context: Cargo has transit status 'D' and manifest contains destination station information
- Applied to: Current Station = Final Destination?
- Action: The system compares current station location with final destination station from manifest
Logic Flow:
IF Cargo has transit status 'D' and manifest contains destination station information
AND The system compares current station location with final destination station from manifest
THEN:
- • If current station matches final destination station, cargo is confirmed as arrived at correct location,
otherwise skip arrival processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when cargo has been identified as arrived at final destination.
Trigger Criteria:
- Context: Cargo has been identified as arrived at final destination
- Applied to: Update Cargo Status to Arrived
- Action: The system processes the arrival confirmation
Logic Flow:
IF Cargo has been identified as arrived at final destination
AND The system processes the arrival confirmation
THEN:
- • The cargo status is updated to 'Arrived' in the CCN database
Rule Belongs to : GCX146.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: Trigger Arrival Notification Process
- Action: The system completes the arrival status update
Logic Flow:
IF Cargo status has been updated to arrived
AND The system completes the arrival status update
THEN:
- • Arrival notification process is triggered to send notifications to brokers, customs, and other stakeholders
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo arrival has been detected and processed.
Trigger Criteria:
- Context: Cargo arrival has been detected and processed
- Applied to: Log Arrival Detection
- Action: The system completes arrival notification triggering
Logic Flow:
IF Cargo arrival has been detected and processed
AND The system completes arrival notification triggering
THEN:
- • An audit log entry is created recording the arrival detection event with timestamp and relevant cargo details
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn record exists in the database.
Trigger Criteria:
- Context: A CCN record exists in the database
- Applied to: Retrieve CCN Transit Status
- Action: The system begins cargo arrival detection processing
Logic Flow:
IF A CCN record exists in the database
AND The system begins cargo arrival detection processing
THEN:
- • Transit status information is retrieved from the GCCCRT CCN database for evaluation
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn transit status has been retrieved.
Trigger Criteria:
- Context: CCN transit status has been retrieved
- Applied to: Check Manifest Codes
- Action: The system processes arrival detection
Logic Flow:
IF CCN transit status has been retrieved
AND The system processes arrival detection
THEN:
- • Manifest station codes are checked from GCSB4RT train records to identify destination information
R-GCX146-cbl-01071 (+5) File: GCX146.cbl Business Rule: Return CCN Creation Processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when cargo shipment with origin and destination information.
Trigger Criteria:
- Context: A cargo shipment with origin and destination information
- Applied to: Identify Canadian Goods Returning from US
- Action: The system analyzes the cargo movement pattern
Logic Flow:
IF A cargo shipment with origin and destination information
AND The system analyzes the cargo movement pattern
THEN:
- • The system determines if the cargo represents Canadian goods returning from US territory
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment id and waybill date information are available.
Trigger Criteria:
- Context: Equipment ID and waybill date information are available
- Applied to: Build Return CCN Number
- Action: A return CCN needs to be created for Canadian goods
Logic Flow:
IF Equipment ID and waybill date information are available
AND A return CCN needs to be created for Canadian goods
THEN:
- • The system builds CCN with format: '6105E' + equipment_id + waybill_date + sequence_number
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when new return ccn record is being created.
Trigger Criteria:
- Context: A new return CCN record is being created
- Applied to: Set CCN Status to 'RETURN'
- Action: The CCN status needs to be established
Logic Flow:
IF A new return CCN record is being created
AND The CCN status needs to be established
THEN:
- • The system sets CCN status to 'RETURN' and transit status to 'R'
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when waybill data contains shipper and consignee information.
Trigger Criteria:
- Context: Waybill data contains shipper and consignee information
- Applied to: Populate Complete Shipment Data
- Action: Creating a return CCN record
Logic Flow:
IF Waybill data contains shipper and consignee information
AND Creating a return CCN record
THEN:
- • The system populates shipper name, consignee name, origin station, destination station, and application type '33' for Canadian customs
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all return ccn data has been prepared and validated.
Trigger Criteria:
- Context: All return CCN data has been prepared and validated
- Applied to: Insert Return CCN Record into Database
- Action: The system needs to persist the return CCN information
Logic Flow:
IF All return CCN data has been prepared and validated
AND The system needs to persist the return CCN information
THEN:
- • The system inserts the CCN record into GCCCRT database and spawns GCX105 transaction for audit trail creation
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when return ccn creation attempt has been made.
Trigger Criteria:
- Context: A return CCN creation attempt has been made
- Applied to: CCN Creation Successful?
- Action: The system checks the creation result
Logic Flow:
IF A return CCN creation attempt has been made
AND The system checks the creation result
THEN:
- • If successful, the system continues processing; if failed, the system handles the error condition
R-GCX146-cbl-01077 (+11) File: GCX146.cbl Business Rule: Broker Notification Multi
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn requires broker notification and primary broker exists and broker communication preference is x12 edi.
Trigger Criteria:
- Context: A CCN requires broker notification AND primary broker exists AND broker communication preference is X12 EDI
- Applied to: Send X12 EDI Notification via GCCS309C
- Action: The system processes broker notification distribution
Logic Flow:
IF A CCN requires broker notification AND primary broker exists AND broker communication preference is X12 EDI
AND The system processes broker notification distribution
THEN:
- • The system invokes GCCS309C program to send X12 EDI notification to the primary broker
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn requires broker notification and primary broker exists and broker communication preference is merlin.
Trigger Criteria:
- Context: A CCN requires broker notification AND primary broker exists AND broker communication preference is Merlin
- Applied to: Send Merlin Notification via GCX019
- Action: The system processes broker notification distribution
Logic Flow:
IF A CCN requires broker notification AND primary broker exists AND broker communication preference is Merlin
AND The system processes broker notification distribution
THEN:
- • The system invokes GCX019 program to send Merlin notification to the primary broker
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn requires broker notification and primary broker exists and broker communication preference is internet.
Trigger Criteria:
- Context: A CCN requires broker notification AND primary broker exists AND broker communication preference is Internet
- Applied to: Send Internet Notification via GCX019
- Action: The system processes broker notification distribution
Logic Flow:
IF A CCN requires broker notification AND primary broker exists AND broker communication preference is Internet
AND The system processes broker notification distribution
THEN:
- • The system invokes GCX019 program to send Internet notification to the primary broker
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn requires broker notification and primary broker exists and broker communication preference is fax.
Trigger Criteria:
- Context: A CCN requires broker notification AND primary broker exists AND broker communication preference is FAX
- Applied to: Send FAX Notification via GCX019
- Action: The system processes broker notification distribution
Logic Flow:
IF A CCN requires broker notification AND primary broker exists AND broker communication preference is FAX
AND The system processes broker notification distribution
THEN:
- • The system invokes GCX019 program to send FAX notification to the primary broker
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn requires broker notification and primary broker exists and broker communication preference is paper. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A CCN requires broker notification AND primary broker exists AND broker communication preference is Paper
- Applied to: Send Paper Notification via Batch Print Call Letters
- Action: The system processes broker notification distribution
Logic Flow:
IF A CCN requires broker notification AND primary broker exists AND broker communication preference is Paper
AND The system processes broker notification distribution
THEN:
- • The system generates paper notification through batch print call letters process
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when primary broker notification has been processed.
Trigger Criteria:
- Context: Primary broker notification has been processed
- Applied to: Secondary Broker Configured?
- Action: The system checks for secondary broker configuration
Logic Flow:
IF Primary broker notification has been processed
AND The system checks for secondary broker configuration
THEN:
- • IF secondary broker exists THEN proceed with secondary broker notifications ELSE complete broker notification process
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when secondary broker is configured and secondary broker communication preference is x12 edi.
Trigger Criteria:
- Context: Secondary broker is configured AND secondary broker communication preference is X12 EDI
- Applied to: Send X12 EDI to Secondary Broker via GCCS309C
- Action: The system processes secondary broker notification distribution
Logic Flow:
IF Secondary broker is configured AND secondary broker communication preference is X12 EDI
AND The system processes secondary broker notification distribution
THEN:
- • The system invokes GCCS309C program to send X12 EDI notification to the secondary broker
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when secondary broker is configured and secondary broker communication preference is merlin.
Trigger Criteria:
- Context: Secondary broker is configured AND secondary broker communication preference is Merlin
- Applied to: Send Merlin to Secondary Broker via GCX019
- Action: The system processes secondary broker notification distribution
Logic Flow:
IF Secondary broker is configured AND secondary broker communication preference is Merlin
AND The system processes secondary broker notification distribution
THEN:
- • The system invokes GCX019 program to send Merlin notification to the secondary broker
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when secondary broker is configured and secondary broker communication preference is internet.
Trigger Criteria:
- Context: Secondary broker is configured AND secondary broker communication preference is Internet
- Applied to: Send Internet to Secondary Broker via GCX019
- Action: The system processes secondary broker notification distribution
Logic Flow:
IF Secondary broker is configured AND secondary broker communication preference is Internet
AND The system processes secondary broker notification distribution
THEN:
- • The system invokes GCX019 program to send Internet notification to the secondary broker
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when secondary broker is configured and secondary broker communication preference is fax.
Trigger Criteria:
- Context: Secondary broker is configured AND secondary broker communication preference is FAX
- Applied to: Send FAX to Secondary Broker via GCX019
- Action: The system processes secondary broker notification distribution
Logic Flow:
IF Secondary broker is configured AND secondary broker communication preference is FAX
AND The system processes secondary broker notification distribution
THEN:
- • The system invokes GCX019 program to send FAX notification to the secondary broker
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when secondary broker is configured and secondary broker communication preference is paper.
Trigger Criteria:
- Context: Secondary broker is configured AND secondary broker communication preference is Paper
- Applied to: Send Paper to Secondary Broker via Batch Print
- Action: The system processes secondary broker notification distribution
Logic Flow:
IF Secondary broker is configured AND secondary broker communication preference is Paper
AND The system processes secondary broker notification distribution
THEN:
- • The system generates paper notification through batch print process for the secondary broker
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when broker notification needs to be sent.
Trigger Criteria:
- Context: A broker notification needs to be sent
- Applied to: Broker Communication Preference Available?
- Action: The system evaluates broker communication preferences
Logic Flow:
IF A broker notification needs to be sent
AND The system evaluates broker communication preferences
THEN:
- • The system selects the appropriate channel (X12 EDI, Merlin, Internet, FAX, or Paper) based on broker configuration
R-GCX146-cbl-01089 (+11) File: GCX146.cbl Business Rule: CCN Compression Processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn number containing space characters.
Trigger Criteria:
- Context: A CCN number containing space characters
- Applied to: Remove Spaces from CCN
- Action: The system processes the CCN for compression
Logic Flow:
IF A CCN number containing space characters
AND The system processes the CCN for compression
THEN:
- • All space characters are removed from the CCN number while preserving all non-space characters in their original sequence
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn number with mixed characters and spaces.
Trigger Criteria:
- Context: A CCN number with mixed characters and spaces
- Applied to: Scan CCN Character by Character
- Action: The system scans the CCN character by character
Logic Flow:
IF A CCN number with mixed characters and spaces
AND The system scans the CCN character by character
THEN:
- • Each character position is evaluated to determine if it contains a space or non-space character
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when character being examined during ccn compression.
Trigger Criteria:
- Context: A character being examined during CCN compression
- Applied to: Is Character a Space?
- Action: The character is identified as a space
Logic Flow:
IF A character being examined during CCN compression
AND The character is identified as a space
THEN:
- • The space character is skipped and not included in the compressed CCN output
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when character being examined during ccn compression.
Trigger Criteria:
- Context: A character being examined during CCN compression
- Applied to: Keep Non-Space Character
- Action: The character is identified as a non-space character
Logic Flow:
IF A character being examined during CCN compression
AND The character is identified as a non-space character
THEN:
- • The character is retained and included in the compressed CCN output in its sequential position
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment identifier containing numeric sequences.
Trigger Criteria:
- Context: An equipment identifier containing numeric sequences
- Applied to: Organize Numeric Sequences
- Action: The system processes the equipment number for compression
Logic Flow:
IF An equipment identifier containing numeric sequences
AND The system processes the equipment number for compression
THEN:
- • Numeric sequences are identified, formatted, and reorganized according to standard equipment numbering conventions
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment identifier with mixed alphanumeric characters.
Trigger Criteria:
- Context: An equipment identifier with mixed alphanumeric characters
- Applied to: Identify Numeric Sequences
- Action: The system analyzes the identifier structure
Logic Flow:
IF An equipment identifier with mixed alphanumeric characters
AND The system analyzes the identifier structure
THEN:
- • All consecutive numeric character sequences are identified and marked for formatting
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when identified numeric sequences within an equipment identifier.
Trigger Criteria:
- Context: Identified numeric sequences within an equipment identifier
- Applied to: Format Numeric Components
- Action: The system formats the numeric components
Logic Flow:
IF Identified numeric sequences within an equipment identifier
AND The system formats the numeric components
THEN:
- • Numeric sequences are formatted according to equipment numbering standards with proper padding and alignment
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn with formatted numeric components and preserved characters.
Trigger Criteria:
- Context: A CCN with formatted numeric components and preserved characters
- Applied to: Reorganize CCN Structure
- Action: The system reorganizes the CCN structure
Logic Flow:
IF A CCN with formatted numeric components and preserved characters
AND The system reorganizes the CCN structure
THEN:
- • CCN components are arranged in the standard format with proper sequencing and positioning
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when reorganized ccn components with formatted numeric sequences.
Trigger Criteria:
- Context: Reorganized CCN components with formatted numeric sequences
- Applied to: Build Compressed CCN Format
- Action: The system builds the compressed CCN format
Logic Flow:
IF Reorganized CCN components with formatted numeric sequences
AND The system builds the compressed CCN format
THEN:
- • All components are combined into a single compressed CCN string without spaces and with standardized formatting
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when compressed ccn format constructed from processed components.
Trigger Criteria:
- Context: A compressed CCN format constructed from processed components
- Applied to: Validate Compressed CCN
- Action: The system validates the compressed CCN
Logic Flow:
IF A compressed CCN format constructed from processed components
AND The system validates the compressed CCN
THEN:
- • The CCN format is verified against business rules for length, character composition, and structural requirements
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when compressed ccn that has undergone format validation.
Trigger Criteria:
- Context: A compressed CCN that has undergone format validation
- Applied to: CCN Format Valid?
- Action: The CCN format validation is successful
Logic Flow:
IF A compressed CCN that has undergone format validation
AND The CCN format validation is successful
THEN:
- • The system returns the compressed CCN for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when compressed ccn that fails format validation.
Trigger Criteria:
- Context: A compressed CCN that fails format validation
- Applied to: Handle Format Error
- Action: The CCN format validation is unsuccessful
Logic Flow:
IF A compressed CCN that fails format validation
AND The CCN format validation is unsuccessful
THEN:
- • The system initiates error handling procedures and does not return the invalid CCN format
R-GCX146-cbl-01101 (+16) File: GCX146.cbl Business Rule: US Customs Status Validation Processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when cargo shipment requires us customs validation.
Trigger Criteria:
- Context: A cargo shipment requires US customs validation
- Applied to: Access US Customs Route Information
- Action: The system attempts to access US route data using the cargo's customs control number
Logic Flow:
IF A cargo shipment requires US customs validation
AND The system attempts to access US route data using the cargo's customs control number
THEN:
- • The system retrieves US customs route segment data if it exists
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when system has attempted to access us route data for a cargo shipment.
Trigger Criteria:
- Context: The system has attempted to access US route data for a cargo shipment
- Applied to: US Route Data Found?
- Action: The system checks if US route segment data was successfully retrieved
Logic Flow:
IF The system has attempted to access US route data for a cargo shipment
AND The system checks if US route segment data was successfully retrieved
THEN:
- • If US route data exists, proceed with bond type validation,
otherwise skip US customs validation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when us route data exists for a cargo shipment.
Trigger Criteria:
- Context: US route data exists for a cargo shipment
- Applied to: Validate Bond Type
- Action: The system examines the bond type field in the US route data
Logic Flow:
IF US route data exists for a cargo shipment
AND The system examines the bond type field in the US route data
THEN:
- • The bond type must be one of: IT (In-Transit), TR (Transportation), TE (Temporary Export), or MT (Merchandise in Transit)
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo shipment has us route data with bond type 'it'.
Trigger Criteria:
- Context: A cargo shipment has US route data with bond type 'IT'
- Applied to: IT Bond Type
- Action: The system processes the IT bond type cargo
Logic Flow:
IF A cargo shipment has US route data with bond type 'IT'
AND The system processes the IT bond type cargo
THEN:
- • Generate appropriate warning messages for in-transit bond requirements and restrictions
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo shipment has us route data with bond type 'tr'.
Trigger Criteria:
- Context: A cargo shipment has US route data with bond type 'TR'
- Applied to: TR Bond Type
- Action: The system processes the TR bond type cargo
Logic Flow:
IF A cargo shipment has US route data with bond type 'TR'
AND The system processes the TR bond type cargo
THEN:
- • Apply transportation bond specific validation rules and generate appropriate status messages
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo shipment has us route data with bond type 'te'.
Trigger Criteria:
- Context: A cargo shipment has US route data with bond type 'TE'
- Applied to: TE Bond Type
- Action: The system processes the TE bond type cargo
Logic Flow:
IF A cargo shipment has US route data with bond type 'TE'
AND The system processes the TE bond type cargo
THEN:
- • Apply temporary export bond validation rules and generate export-related status messages
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo shipment has us route data with bond type 'mt'.
Trigger Criteria:
- Context: A cargo shipment has US route data with bond type 'MT'
- Applied to: MT Bond Type
- Action: The system processes the MT bond type cargo
Logic Flow:
IF A cargo shipment has US route data with bond type 'MT'
AND The system processes the MT bond type cargo
THEN:
- • Apply merchandise in transit bond validation rules and generate transit-related status messages
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo shipment has valid us route data with a recognized bond type.
Trigger Criteria:
- Context: A cargo shipment has valid US route data with a recognized bond type
- Applied to: Cargo In-Transit?
- Action: The system checks the in-transit status indicator in the US route data
Logic Flow:
IF A cargo shipment has valid US route data with a recognized bond type
AND The system checks the in-transit status indicator in the US route data
THEN:
- • If cargo is marked as in-transit, proceed with location validation,
otherwise proceed with vessel validation
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when cargo shipment is marked as in-transit in us route data.
Trigger Criteria:
- Context: A cargo shipment is marked as in-transit in US route data
- Applied to: Location Valid?
- Action: The system validates the current location information against expected transit locations
Logic Flow:
IF A cargo shipment is marked as in-transit in US route data
AND The system validates the current location information against expected transit locations
THEN:
- • If location is valid, proceed with vessel validation,
otherwise generate location warning message
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo shipment has completed location validation (if applicable).
Trigger Criteria:
- Context: A cargo shipment has completed location validation (if applicable)
- Applied to: Vessel = 'TRAIN'?
- Action: The system examines the vessel name field in the US route data
Logic Flow:
IF A cargo shipment has completed location validation (if applicable)
AND The system examines the vessel name field in the US route data
THEN:
- • If vessel name equals 'TRAIN', generate train-specific warning,
otherwise generate other vessel warning
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo shipment has vessel name designated as 'train'.
Trigger Criteria:
- Context: A cargo shipment has vessel name designated as 'TRAIN'
- Applied to: Generate Train Vessel Warning
- Action: The system processes train vessel cargo
Logic Flow:
IF A cargo shipment has vessel name designated as 'TRAIN'
AND The system processes train vessel cargo
THEN:
- • Generate train-specific warning messages related to rail transportation requirements and restrictions
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when cargo shipment has vessel name that is not 'train'.
Trigger Criteria:
- Context: A cargo shipment has vessel name that is not 'TRAIN'
- Applied to: Generate Other Vessel Warning
- Action: The system processes non-train vessel cargo
Logic Flow:
IF A cargo shipment has vessel name that is not 'TRAIN'
AND The system processes non-train vessel cargo
THEN:
- • Generate vessel-specific warning messages appropriate for the transportation method
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo shipment has us route data with an invalid or unrecognized bond type.
Trigger Criteria:
- Context: A cargo shipment has US route data with an invalid or unrecognized bond type
- Applied to: Generate Bond Type Warning Message
- Action: The system encounters a bond type that is not IT, TR, TE, or MT
Logic Flow:
IF A cargo shipment has US route data with an invalid or unrecognized bond type
AND The system encounters a bond type that is not IT, TR, TE, or MT
THEN:
- • Generate a warning message indicating invalid bond type and potential compliance issues
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when cargo shipment is marked as in-transit but has invalid location information.
Trigger Criteria:
- Context: A cargo shipment is marked as in-transit but has invalid location information
- Applied to: Generate Location Warning Message
- Action: The system detects location validation failure
Logic Flow:
IF A cargo shipment is marked as in-transit but has invalid location information
AND The system detects location validation failure
THEN:
- • Generate a warning message indicating location mismatch or invalid transit location
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo shipment has in-transit status issues or validation failures.
Trigger Criteria:
- Context: A cargo shipment has in-transit status issues or validation failures
- Applied to: Generate In-Transit Warning Message
- Action: The system processes in-transit cargo with identified problems
Logic Flow:
IF A cargo shipment has in-transit status issues or validation failures
AND The system processes in-transit cargo with identified problems
THEN:
- • Generate comprehensive warning messages covering all in-transit related issues and compliance requirements
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when system has processed us customs validation and generated various warning messages.
Trigger Criteria:
- Context: The system has processed US customs validation and generated various warning messages
- Applied to: Compile All Warning Messages
- Action: All individual warning messages have been created
Logic Flow:
IF The system has processed US customs validation and generated various warning messages
AND All individual warning messages have been created
THEN:
- • Compile all warning messages into a single comprehensive report for the cargo shipment
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when cargo shipment has no us route data available.
Trigger Criteria:
- Context: A cargo shipment has no US route data available
- Applied to: No US Route Data - Skip Validation
- Action: The system attempts to perform US customs validation
Logic Flow:
IF A cargo shipment has no US route data available
AND The system attempts to perform US customs validation
THEN:
- • Skip all US customs validation processes and proceed with normal cargo processing
R-GCX146-cbl-01118 (+5) File: GCX146.cbl Business Rule: Equipment Car ID Formatting and Validation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when train identification component contains space characters.
Trigger Criteria:
- Context: A train identification component contains space characters
- Applied to: Replace Spaces with Zeros
- Action: The system processes the train component for customs ID building
Logic Flow:
IF A train identification component contains space characters
AND The system processes the train component for customs ID building
THEN:
- • All space characters in the component are replaced with zero characters
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when train number, day, from station, to station, consist number, and system date are available. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Train number, day, from station, to station, consist number, and system date are available
- Applied to: Build Customs Train ID Components
- Action: The system needs to create a customs train identifier
Logic Flow:
IF Train number, day, from station, to station, consist number, and system date are available
AND The system needs to create a customs train identifier
THEN:
- • The system concatenates all components with spaces replaced by zeros to form WS-CUSTOMS-TRAIN-ID
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment car identifier needs to be formatted.
Trigger Criteria:
- Context: An equipment car identifier needs to be formatted
- Applied to: Format Equipment Car Identifier
- Action: The system processes the car identifier for display or storage
Logic Flow:
IF An equipment car identifier needs to be formatted
AND The system processes the car identifier for display or storage
THEN:
- • The system applies standard 12-character formatting using GCCCARFM utility
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when formatted equipment car identifier.
Trigger Criteria:
- Context: A formatted equipment car identifier
- Applied to: Validate Car ID Format
- Action: The system validates the car ID format
Logic Flow:
IF A formatted equipment car identifier
AND The system validates the car ID format
THEN:
- • The system confirms the car ID meets required format standards or flags format errors
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when validated and formatted car identifier.
Trigger Criteria:
- Context: A validated and formatted car identifier
- Applied to: Store in Equipment Record
- Action: The system completes car ID formatting process
Logic Flow:
IF A validated and formatted car identifier
AND The system completes car ID formatting process
THEN:
- • The formatted car ID is stored in the equipment record and made available for processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when validated car identifier.
Trigger Criteria:
- Context: A validated car identifier
- Applied to: Set Formatted Car ID for Display
- Action: The system prepares the car ID for display purposes
Logic Flow:
IF A validated car identifier
AND The system prepares the car ID for display purposes
THEN:
- • The car ID is formatted according to display standards and stored in appropriate display fields
R-GCX146-cbl-01142 (+6) File: GCX146.cbl Business Rule: AEI Report Email Distribution with Continuation
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when aei report is being prepared for email distribution.
Trigger Criteria:
- Context: An AEI report is being prepared for email distribution
- Applied to: Line Count > 699?
- Action: The system counts the number of lines in the current email message
Logic Flow:
IF An AEI report is being prepared for email distribution
AND The system counts the number of lines in the current email message
THEN:
- • If the line count exceeds 699 lines, the system must send the current batch and prepare for continuation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when email message has reached the 699 line limit and needs to be continued.
Trigger Criteria:
- Context: An email message has reached the 699 line limit and needs to be continued
- Applied to: Add Continuation Header Message
- Action: The system prepares the next email message segment
Logic Flow:
IF An email message has reached the 699 line limit and needs to be continued
AND The system prepares the next email message segment
THEN:
- • The system must add a continuation header message 'CONTINUATION OF REPORT....' to identify it as a follow-up message
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when primary email distribution has failed for an aei report.
Trigger Criteria:
- Context: Primary email distribution has failed for an AEI report
- Applied to: Use Fallback Email Recipients
- Action: The system detects email send failure
Logic Flow:
IF Primary email distribution has failed for an AEI report
AND The system detects email send failure
THEN:
- • The system must use fallback email recipients OM01247 and AEI9999 to ensure report delivery
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when aei report needs to be distributed via email.
Trigger Criteria:
- Context: An AEI report needs to be distributed via email
- Applied to: Get Email User List from Station Configuration
- Action: The system determines email recipients
Logic Flow:
IF An AEI report needs to be distributed via email
AND The system determines email recipients
THEN:
- • The system must retrieve email user lists from GCSTBRT station email configuration and AECWRKTB email user lists based on the station code
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when email message has been sent due to line limit being reached.
Trigger Criteria:
- Context: An email message has been sent due to line limit being reached
- Applied to: Reset Message Buffer
- Action: The system needs to prepare for the next message segment
Logic Flow:
IF An email message has been sent due to line limit being reached
AND The system needs to prepare for the next message segment
THEN:
- • The system must reset the message buffer to prepare for additional report content
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when system is processing report lines for email distribution.
Trigger Criteria:
- Context: The system is processing report lines for email distribution
- Applied to: More Lines to Process?
- Action: The system checks for remaining content after sending a message batch
Logic Flow:
IF The system is processing report lines for email distribution
AND The system checks for remaining content after sending a message batch
THEN:
- • If more lines exist to be processed, the system must continue adding lines to the email buffer,
otherwise proceed to send the final email batch
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when email message has been sent via the primary email system.
Trigger Criteria:
- Context: An email message has been sent via the primary email system
- Applied to: Email Send Successful?
- Action: The system receives the email send response
Logic Flow:
IF An email message has been sent via the primary email system
AND The system receives the email send response
THEN:
- • If the email send is successful, complete the distribution process,
otherwise activate fallback email recipients
R-GCX146-cbl-01149 (+3) File: GCX146.cbl Business Rule: Equipment Car Type Description Retrieval
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when piece of equipment with a car type code needs to be displayed on a trip sheet.
Trigger Criteria:
- Context: A piece of equipment with a car type code needs to be displayed on a trip sheet
- Applied to: Equipment Car Type Description Retrieval
- Action: The system processes the equipment for trip sheet generation
Logic Flow:
IF A piece of equipment with a car type code needs to be displayed on a trip sheet
AND The system processes the equipment for trip sheet generation
THEN:
- • The system should lookup the car type description from the equipment type reference table and populate it in the trip sheet detail, or use a default description if lookup fails
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when car type code exists for equipment being processed.
Trigger Criteria:
- Context: A car type code exists for equipment being processed
- Applied to: Access GCSTBRT VI Segment
- Action: The system needs to retrieve the corresponding car type description
Logic Flow:
IF A car type code exists for equipment being processed
AND The system needs to retrieve the corresponding car type description
THEN:
- • The system should access the VI segment of the GCSTBRT table using the car type as the lookup key
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when car type description has been successfully retrieved from the reference table.
Trigger Criteria:
- Context: A car type description has been successfully retrieved from the reference table
- Applied to: Move Description to Trip Sheet Detail
- Action: The description data is available for assignment
Logic Flow:
IF A car type description has been successfully retrieved from the reference table
AND The description data is available for assignment
THEN:
- • The system should move the retrieved description to the appropriate field in the trip sheet detail record
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when car type code does not have a corresponding description in the reference table.
Trigger Criteria:
- Context: A car type code does not have a corresponding description in the reference table
- Applied to: Set Default Description
- Action: The car type description lookup fails to find a match
Logic Flow:
IF A car type code does not have a corresponding description in the reference table
AND The car type description lookup fails to find a match
THEN:
- • The system should assign a default description value to ensure the trip sheet field is populated
R-GCX146-cbl-01153 (+5) File: GCX146.cbl Business Rule: CCN Status Assignment Processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn record has current status of 'release'.
Trigger Criteria:
- Context: A CCN record has current status of 'RELEASE'
- Applied to: Check Transit Status
- Action: The transit status is 'E' (Export) or 'Z' (Export Zone)
Logic Flow:
IF A CCN record has current status of 'RELEASE'
AND The transit status is 'E' (Export) or 'Z' (Export Zone)
THEN:
- • Assign the trip sheet status as 'EXPORT'
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn record has current status of 'release' and transit status is not 'e' or 'z'.
Trigger Criteria:
- Context: A CCN record has current status of 'RELEASE' and transit status is not 'E' or 'Z'
- Applied to: Has S.A.R. Release?
- Action: The release-by field contains 'S.A.R.'
Logic Flow:
IF A CCN record has current status of 'RELEASE' and transit status is not 'E' or 'Z'
AND The release-by field contains 'S.A.R.'
THEN:
- • Assign the trip sheet status as 'S.A.R.'
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn record has current status of 'release' and transit status is not 'e' or 'z'.
Trigger Criteria:
- Context: A CCN record has current status of 'RELEASE' and transit status is not 'E' or 'Z'
- Applied to: Assign Status = 'RELEASE'
- Action: The release-by field does not contain 'S.A.R.'
Logic Flow:
IF A CCN record has current status of 'RELEASE' and transit status is not 'E' or 'Z'
AND The release-by field does not contain 'S.A.R.'
THEN:
- • Assign the trip sheet status as 'RELEASE'
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn record has current status other than 'release'.
Trigger Criteria:
- Context: A CCN record has current status other than 'RELEASE'
- Applied to: Transit Status = 'T'?
- Action: The transit status is 'T' (Transit)
Logic Flow:
IF A CCN record has current status other than 'RELEASE'
AND The transit status is 'T' (Transit)
THEN:
- • Assign the trip sheet status as 'TRANSIT'
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn record has current status other than 'release'.
Trigger Criteria:
- Context: A CCN record has current status other than 'RELEASE'
- Applied to: Keep Current Status
- Action: The transit status is neither 'T' nor 'R'
Logic Flow:
IF A CCN record has current status other than 'RELEASE'
AND The transit status is neither 'T' nor 'R'
THEN:
- • Assign the trip sheet status as the current CCN status without modification
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn record has current status other than 'release' and transit status is not 't'.
Trigger Criteria:
- Context: A CCN record has current status other than 'RELEASE' and transit status is not 'T'
- Applied to: Transit Status = 'R'?
- Action: The transit status is 'R' (Return)
Logic Flow:
IF A CCN record has current status other than 'RELEASE' and transit status is not 'T'
AND The transit status is 'R' (Return)
THEN:
- • Assign the trip sheet status as 'RETURN'
R-GCX146-cbl-01159 (+7) File: GCX146.cbl Business Rule: Train Record Database Operations
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when train id is provided for processing.
Trigger Criteria:
- Context: A train ID is provided for processing
- Applied to: Retrieve Existing Train Record
- Action: The system attempts to retrieve the existing train record from the GCSB4RT database
Logic Flow:
IF A train ID is provided for processing
AND The system attempts to retrieve the existing train record from the GCSB4RT database
THEN:
- • The system should successfully locate and retrieve the train record if it exists, or return a not found status if no record exists
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when database retrieval operation has been performed for a train record.
Trigger Criteria:
- Context: A database retrieval operation has been performed for a train record
- Applied to: Train Record Exists?
- Action: The system evaluates the retrieval result status
Logic Flow:
IF A database retrieval operation has been performed for a train record
AND The system evaluates the retrieval result status
THEN:
- • If the train record exists, proceed to delete the existing record; if no train record exists, proceed directly to insert new record
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when existing train record has been found in the gcsb4rt database.
Trigger Criteria:
- Context: An existing train record has been found in the GCSB4RT database
- Applied to: Delete Existing Train Record
- Action: The system performs a delete operation on the existing train record
Logic Flow:
IF An existing train record has been found in the GCSB4RT database
AND The system performs a delete operation on the existing train record
THEN:
- • The existing train record should be successfully removed from the database to prepare for the new record insertion
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when delete operation has been performed on an existing train record.
Trigger Criteria:
- Context: A delete operation has been performed on an existing train record
- Applied to: Deletion Successful?
- Action: The system evaluates the deletion operation result
Logic Flow:
IF A delete operation has been performed on an existing train record
AND The system evaluates the deletion operation result
THEN:
- • If deletion was successful, proceed to insert new train record; if deletion failed, report database operation error
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when either no existing train record was found or existing record was successfully deleted.
Trigger Criteria:
- Context: Either no existing train record was found or existing record was successfully deleted
- Applied to: Insert New Train Record with Equipment Details
- Action: The system performs an insert operation for the new train record with equipment details
Logic Flow:
IF Either no existing train record was found or existing record was successfully deleted
AND The system performs an insert operation for the new train record with equipment details
THEN:
- • A new train record should be created in the GCSB4RT database with status set to SENT and all equipment details included
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when insert operation has been performed for a new train record.
Trigger Criteria:
- Context: An insert operation has been performed for a new train record
- Applied to: Insert Successful?
- Action: The system evaluates the insertion operation result
Logic Flow:
IF An insert operation has been performed for a new train record
AND The system evaluates the insertion operation result
THEN:
- • If insertion was successful, complete train record operations; if insertion failed, report database operation error
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when all required database operations for train record processing have been performed.
Trigger Criteria:
- Context: All required database operations for train record processing have been performed
- Applied to: Train Record Operations Complete
- Action: The new train record has been successfully inserted into the database
Logic Flow:
IF All required database operations for train record processing have been performed
AND The new train record has been successfully inserted into the database
THEN:
- • The train record operations should be marked as complete and processing can continue to next step
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when database operation (delete or insert) has been attempted on train records.
Trigger Criteria:
- Context: A database operation (delete or insert) has been attempted on train records
- Applied to: Database Operation Error
- Action: The database operation fails to complete successfully
Logic Flow:
IF A database operation (delete or insert) has been attempted on train records
AND The database operation fails to complete successfully
THEN:
- • The system should report a database operation error and halt further processing of the train record
R-GCX146-cbl-01167 (+7) File: GCX146.cbl Business Rule: Customer Report Message Generation
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when customer report needs to be generated.
Trigger Criteria:
- Context: A customer report needs to be generated
- Applied to: Initialize Report Message Format
- Action: The system begins report message creation process
Logic Flow:
IF A customer report needs to be generated
AND The system begins report message creation process
THEN:
- • The report message format is initialized and ready to receive content
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when customer report message is being prepared.
Trigger Criteria:
- Context: A customer report message is being prepared
- Applied to: Set Message Type to GCT1401E
- Action: The system sets up the message structure
Logic Flow:
IF A customer report message is being prepared
AND The system sets up the message structure
THEN:
- • The message type is configured as GCT1401E for proper routing and processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when customer report message type has been set.
Trigger Criteria:
- Context: A customer report message type has been set
- Applied to: Configure Message Queue Routing
- Action: The system configures message routing
Logic Flow:
IF A customer report message type has been set
AND The system configures message routing
THEN:
- • The message queue is configured to use ALT-PCB2 for proper distribution routing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when customer report content exists in gcx140-input and message routing is configured.
Trigger Criteria:
- Context: Customer report content exists in GCX140-INPUT and message routing is configured
- Applied to: Move Report Content to Message Buffer
- Action: The system prepares to queue the message
Logic Flow:
IF Customer report content exists in GCX140-INPUT and message routing is configured
AND The system prepares to queue the message
THEN:
- • The report content is moved to the message buffer for distribution
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when customer report content has been moved to message buffer.
Trigger Criteria:
- Context: Customer report content has been moved to message buffer
- Applied to: Queue Message for Distribution
- Action: The system processes the message for distribution
Logic Flow:
IF Customer report content has been moved to message buffer
AND The system processes the message for distribution
THEN:
- • The message is queued in the distribution system for delivery to recipients
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when customer report message has been queued for distribution.
Trigger Criteria:
- Context: Customer report message has been queued for distribution
- Applied to: Process Message Queue Commands
- Action: The system executes queue processing commands
Logic Flow:
IF Customer report message has been queued for distribution
AND The system executes queue processing commands
THEN:
- • The queued message commands are processed to complete the distribution
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when customer report message queue commands have been processed.
Trigger Criteria:
- Context: Customer report message queue commands have been processed
- Applied to: Purge Temporary Message Data
- Action: The system completes message distribution
Logic Flow:
IF Customer report message queue commands have been processed
AND The system completes message distribution
THEN:
- • Temporary message data is purged to clean up system resources
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when customer report message has been processed and temporary data purged.
Trigger Criteria:
- Context: Customer report message has been processed and temporary data purged
- Applied to: Customer Report Message Ready for Distribution
- Action: The system completes all message preparation steps
Logic Flow:
IF Customer report message has been processed and temporary data purged
AND The system completes all message preparation steps
THEN:
- • The customer report message is confirmed ready for distribution to designated recipients
R-GCX146-cbl-01175 (+12) File: GCX146.cbl Business Rule: Primary Waybill Lookup
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment id is provided for waybill lookup.
Trigger Criteria:
- Context: An equipment ID is provided for waybill lookup
- Applied to: Primary Waybill Lookup - Search FWIIROOT using Equipment ID & Primary Waybill Lookup - FWIIROOT
- Action: The system searches the FWIIROOT waybill database using the equipment ID as the search key
Logic Flow:
IF An equipment ID is provided for waybill lookup
AND The system searches the FWIIROOT waybill database using the equipment ID as the search key
THEN:
- • The system retrieves the waybill record if it exists and sets the waybill found flag, or sets the waybill not found flag if no record exists
- • The system retrieves the waybill record and sets the waybill found flag if successful, or sets the waybill not found flag if unsuccessful
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when raw equipment id data is available.
Trigger Criteria:
- Context: Raw equipment ID data is available
- Applied to: Prepare Equipment ID for Search
- Action: The system needs to perform a waybill database search
Logic Flow:
IF Raw equipment ID data is available
AND The system needs to perform a waybill database search
THEN:
- • The equipment ID is formatted and prepared as the search key for database access
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when database search has been performed using equipment id.
Trigger Criteria:
- Context: A database search has been performed using equipment ID
- Applied to: Waybill Record Found?
- Action: The system evaluates the search results
Logic Flow:
IF A database search has been performed using equipment ID
AND The system evaluates the search results
THEN:
- • The system determines if a waybill record was found and sets the appropriate status flag
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill record exists for the equipment id. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A waybill record exists for the equipment ID
- Applied to: Set WS-WAYBILL-FOUND Flag
- Action: The database search successfully locates the record
Logic Flow:
IF A waybill record exists for the equipment ID
AND The database search successfully locates the record
THEN:
- • The system sets the WS-WAYBILL-FOUND flag to indicate successful lookup
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when waybill record has been found in the database.
Trigger Criteria:
- Context: A waybill record has been found in the database
- Applied to: Extract Waybill Information
- Action: The system processes the retrieved record
Logic Flow:
IF A waybill record has been found in the database
AND The system processes the retrieved record
THEN:
- • All relevant waybill information is extracted from the database record
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when waybill information has been extracted from the database record.
Trigger Criteria:
- Context: Waybill information has been extracted from the database record
- Applied to: Move Waybill Data to Work Areas
- Action: The system needs to make the data available for processing
Logic Flow:
IF Waybill information has been extracted from the database record
AND The system needs to make the data available for processing
THEN:
- • The waybill data is moved to appropriate work areas for subsequent business operations
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when no waybill record exists for the equipment id. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: No waybill record exists for the equipment ID
- Applied to: Set WS-WAYBILL-NOT-FOUND Flag
- Action: The database search fails to locate any matching record
Logic Flow:
IF No waybill record exists for the equipment ID
AND The database search fails to locate any matching record
THEN:
- • The system sets the WS-WAYBILL-NOT-FOUND flag to indicate unsuccessful lookup
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when waybill lookup request is initiated.
Trigger Criteria:
- Context: A waybill lookup request is initiated
- Applied to: Set Equipment ID as Search Key
- Action: The system prepares database search parameters
Logic Flow:
IF A waybill lookup request is initiated
AND The system prepares database search parameters
THEN:
- • The equipment ID is set as the search key for the FWIIROOT database query
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when database call to fwiiroot has been executed. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A database call to FWIIROOT has been executed
- Applied to: Database Call Successful?
- Action: The system evaluates the database call result
Logic Flow:
IF A database call to FWIIROOT has been executed
AND The system evaluates the database call result
THEN:
- • If the call is successful, the system proceeds to retrieve waybill data; if unsuccessful, the system sets failure indicators
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when waybill record has been successfully retrieved from fwiiroot database. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A waybill record has been successfully retrieved from FWIIROOT database
- Applied to: Set WS-WAYBILL-FOUND Flag
- Action: The system processes the successful database response
Logic Flow:
IF A waybill record has been successfully retrieved from FWIIROOT database
AND The system processes the successful database response
THEN:
- • The WS-WAYBILL-FOUND flag is set to indicate successful waybill retrieval
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when database call to fwiiroot has failed to retrieve a waybill record. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A database call to FWIIROOT has failed to retrieve a waybill record
- Applied to: Set WS-WAYBILL-NOT-FOUND Flag
- Action: The system processes the unsuccessful database response
Logic Flow:
IF A database call to FWIIROOT has failed to retrieve a waybill record
AND The system processes the unsuccessful database response
THEN:
- • The WS-WAYBILL-NOT-FOUND flag is set to indicate failed waybill retrieval
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when waybill record has been successfully retrieved and the waybill found flag is set.
Trigger Criteria:
- Context: A waybill record has been successfully retrieved and the waybill found flag is set
- Applied to: Extract Waybill Information
- Action: The system processes the waybill record data
Logic Flow:
IF A waybill record has been successfully retrieved and the waybill found flag is set
AND The system processes the waybill record data
THEN:
- • Relevant waybill information is extracted and made available for subsequent business operations
R-GCX146-cbl-01182 (+21) File: GCX146.cbl Business Rule: Enhanced Waybill Search
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when waybill search request is initiated for equipment.
Trigger Criteria:
- Context: A waybill search request is initiated for equipment
- Applied to: Prepare FWCARGET Search Parameters
- Action: The system prepares FWCARGET search parameters
Logic Flow:
IF A waybill search request is initiated for equipment
AND The system prepares FWCARGET search parameters
THEN:
- • Search parameters are initialized and prepared for database query execution
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment information is available for waybill search.
Trigger Criteria:
- Context: Equipment information is available for waybill search
- Applied to: Set Equipment ID as Primary Search Key
- Action: The system sets the primary search key
Logic Flow:
IF Equipment information is available for waybill search
AND The system sets the primary search key
THEN:
- • Equipment ID is assigned as the primary search criterion for FWCARGET lookup
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when primary search key is established with equipment id.
Trigger Criteria:
- Context: Primary search key is established with equipment ID
- Applied to: Add Additional Search Criteria
- Action: The system adds additional search criteria
Logic Flow:
IF Primary search key is established with equipment ID
AND The system adds additional search criteria
THEN:
- • Supplementary search parameters are configured to improve search effectiveness
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when search parameters are prepared with equipment id and additional criteria. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Search parameters are prepared with equipment ID and additional criteria
- Applied to: Execute FWCARGET Database Call
- Action: The system executes FWCARGET database call
Logic Flow:
IF Search parameters are prepared with equipment ID and additional criteria
AND The system executes FWCARGET database call
THEN:
- • Database query is performed against SHIPROOT shipment database to locate waybill records
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when fwcarget database call has been executed. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: FWCARGET database call has been executed
- Applied to: Waybill Record Found?
- Action: The system checks for waybill record existence
Logic Flow:
IF FWCARGET database call has been executed
AND The system checks for waybill record existence
THEN:
- • System determines if a matching waybill record was found and proceeds accordingly
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when waybill record has been found in the database.
Trigger Criteria:
- Context: A waybill record has been found in the database
- Applied to: Extract Waybill Information
- Action: The system extracts waybill information
Logic Flow:
IF A waybill record has been found in the database
AND The system extracts waybill information
THEN:
- • Relevant waybill data is retrieved from the database record for processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill information has been extracted from the database record.
Trigger Criteria:
- Context: Waybill information has been extracted from the database record
- Applied to: Validate Waybill Data Quality
- Action: The system validates waybill data quality
Logic Flow:
IF Waybill information has been extracted from the database record
AND The system validates waybill data quality
THEN:
- • System verifies that extracted waybill data is complete and meets quality standards
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when waybill data quality validation has been performed.
Trigger Criteria:
- Context: Waybill data quality validation has been performed
- Applied to: Data Complete?
- Action: The system assesses data completeness
Logic Flow:
IF Waybill data quality validation has been performed
AND The system assesses data completeness
THEN:
- • System determines if waybill data is complete and suitable for processing or if it should be treated as not found
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when waybill data is determined to be complete and valid.
Trigger Criteria:
- Context: Waybill data is determined to be complete and valid
- Applied to: Set Waybill Found Flag
- Action: The system sets the waybill found flag
Logic Flow:
IF Waybill data is determined to be complete and valid
AND The system sets the waybill found flag
THEN:
- • Waybill found indicator is set to true to indicate successful waybill location
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when waybill found flag has been set indicating successful waybill location.
Trigger Criteria:
- Context: Waybill found flag has been set indicating successful waybill location
- Applied to: Populate Equipment Waybill Fields
- Action: The system populates equipment waybill fields
Logic Flow:
IF Waybill found flag has been set indicating successful waybill location
AND The system populates equipment waybill fields
THEN:
- • Equipment record is updated with waybill information for subsequent processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when either no waybill record was found or waybill data is determined to be incomplete.
Trigger Criteria:
- Context: Either no waybill record was found OR waybill data is determined to be incomplete
- Applied to: Set Waybill Not Found Flag
- Action: The system sets the waybill not found flag
Logic Flow:
IF Either no waybill record was found OR waybill data is determined to be incomplete
AND The system sets the waybill not found flag
THEN:
- • Waybill not found indicator is set to indicate unsuccessful waybill location for appropriate error handling
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when request to find waybill information for specific equipment.
Trigger Criteria:
- Context: A request to find waybill information for specific equipment
- Applied to: Set Equipment ID Search Criteria
- Action: The system prepares to search the shipment database
Logic Flow:
IF A request to find waybill information for specific equipment
AND The system prepares to search the shipment database
THEN:
- • Equipment ID is configured as the primary search criterion for FWCARGET lookup
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment id search criteria is established. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Equipment ID search criteria is established
- Applied to: Call FWCARGET with Equipment ID
- Action: The system calls FWCARGET function with the equipment identifier
Logic Flow:
IF Equipment ID search criteria is established
AND The system calls FWCARGET function with the equipment identifier
THEN:
- • Database query is executed against SHIPROOT shipment database using multi-criteria search capabilities
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when fwcarget database query has been executed for equipment id.
Trigger Criteria:
- Context: FWCARGET database query has been executed for equipment ID
- Applied to: Waybill Record Found?
- Action: The system evaluates the query results
Logic Flow:
IF FWCARGET database query has been executed for equipment ID
AND The system evaluates the query results
THEN:
- • System determines if waybill record exists and routes processing accordingly - to record retrieval if found or to not-found handling if absent
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when valid waybill record has been found in the shipment database.
Trigger Criteria:
- Context: A valid waybill record has been found in the shipment database
- Applied to: Retrieve Waybill Details
- Action: The system processes the located record
Logic Flow:
IF A valid waybill record has been found in the shipment database
AND The system processes the located record
THEN:
- • Complete waybill details are extracted from the shipment record for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill details have been successfully retrieved from the shipment record. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Waybill details have been successfully retrieved from the shipment record
- Applied to: Set WS-WAYBILL-FOUND Flag
- Action: The system completes waybill information extraction
Logic Flow:
IF Waybill details have been successfully retrieved from the shipment record
AND The system completes waybill information extraction
THEN:
- • WS-WAYBILL-FOUND flag is set to indicate successful waybill location and retrieval
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill record has been retrieved and waybill-found flag is set.
Trigger Criteria:
- Context: Waybill record has been retrieved and waybill-found flag is set
- Applied to: Extract Shipment Information
- Action: The system processes the waybill data
Logic Flow:
IF Waybill record has been retrieved and waybill-found flag is set
AND The system processes the waybill data
THEN:
- • Relevant shipment information is extracted and organized for business use
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when shipment information has been extracted from the waybill record.
Trigger Criteria:
- Context: Shipment information has been extracted from the waybill record
- Applied to: Validate Waybill Data Quality
- Action: The system validates the extracted data
Logic Flow:
IF Shipment information has been extracted from the waybill record
AND The system validates the extracted data
THEN:
- • Data quality is assessed to determine if the waybill information is complete and usable
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill data quality has been assessed.
Trigger Criteria:
- Context: Waybill data quality has been assessed
- Applied to: Data Complete?
- Action: The system evaluates data completeness
Logic Flow:
IF Waybill data quality has been assessed
AND The system evaluates data completeness
THEN:
- • System determines if data is complete for immediate use or requires fallback to inquiry database
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when waybill data has been validated as complete and usable.
Trigger Criteria:
- Context: Waybill data has been validated as complete and usable
- Applied to: Return Waybill Information
- Action: The system finalizes waybill processing
Logic Flow:
IF Waybill data has been validated as complete and usable
AND The system finalizes waybill processing
THEN:
- • Complete waybill information is returned for business operations
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when fwcarget query did not locate a waybill record for the equipment id. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: FWCARGET query did not locate a waybill record for the equipment ID
- Applied to: Set WS-WAYBILL-NOT-FOUND Flag
- Action: The system processes the unsuccessful search result
Logic Flow:
IF FWCARGET query did not locate a waybill record for the equipment ID
AND The system processes the unsuccessful search result
THEN:
- • WS-WAYBILL-NOT-FOUND flag is set to indicate waybill was not located in shipment database
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when either no waybill record was found or retrieved data is incomplete.
Trigger Criteria:
- Context: Either no waybill record was found OR retrieved data is incomplete
- Applied to: Prepare for Inquiry Database Fallback
- Action: The system determines primary search was unsuccessful
Logic Flow:
IF Either no waybill record was found OR retrieved data is incomplete
AND The system determines primary search was unsuccessful
THEN:
- • System prepares to use inquiry database as fallback search method
R-GCX146-cbl-01193 (+14) File: GCX146.cbl Business Rule: Inquiry Database Processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when primary waybill search has failed to locate equipment information.
Trigger Criteria:
- Context: Primary waybill search has failed to locate equipment information
- Applied to: Initialize FW-IQ Inquiry Search
- Action: The system initiates FW-IQ inquiry search process
Logic Flow:
IF Primary waybill search has failed to locate equipment information
AND The system initiates FW-IQ inquiry search process
THEN:
- • FW-IQ inquiry parameters are initialized and search is prepared for equipment lookup
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when fw-iq inquiry search is initialized with valid equipment id.
Trigger Criteria:
- Context: FW-IQ inquiry search is initialized with valid equipment ID
- Applied to: Search FW-IQ Database by Equipment ID
- Action: The system performs database lookup in FW-IQ using equipment identifier
Logic Flow:
IF FW-IQ inquiry search is initialized with valid equipment ID
AND The system performs database lookup in FW-IQ using equipment identifier
THEN:
- • Database search is executed and inquiry record status is determined
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when fw-iq database search has been completed for equipment id.
Trigger Criteria:
- Context: FW-IQ database search has been completed for equipment ID
- Applied to: Inquiry Record Found?
- Action: The system evaluates the search results
Logic Flow:
IF FW-IQ database search has been completed for equipment ID
AND The system evaluates the search results
THEN:
- • If inquiry record exists, proceed with data extraction;
otherwise set waybill not found flag
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when valid inquiry record has been found in fw-iq database.
Trigger Criteria:
- Context: Valid inquiry record has been found in FW-IQ database
- Applied to: Extract Waybill Information from Inquiry
- Action: The system extracts waybill information from inquiry record
Logic Flow:
IF Valid inquiry record has been found in FW-IQ database
AND The system extracts waybill information from inquiry record
THEN:
- • Waybill data including numbers, dates, and related details are retrieved for processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill information has been extracted from fw-iq inquiry record.
Trigger Criteria:
- Context: Waybill information has been extracted from FW-IQ inquiry record
- Applied to: Data Complete?
- Action: The system validates the completeness and quality of extracted data
Logic Flow:
IF Waybill information has been extracted from FW-IQ inquiry record
AND The system validates the completeness and quality of extracted data
THEN:
- • If data is complete and valid, set waybill found flag;
otherwise treat as waybill not found
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when inquiry data has been validated and found to be complete.
Trigger Criteria:
- Context: Inquiry data has been validated and found to be complete
- Applied to: Set Waybill Found Flag
- Action: The system confirms successful waybill information retrieval
Logic Flow:
IF Inquiry data has been validated and found to be complete
AND The system confirms successful waybill information retrieval
THEN:
- • Waybill found flag is set to indicate valid waybill data is available for equipment processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill found flag has been set and inquiry record is valid.
Trigger Criteria:
- Context: Waybill found flag has been set and inquiry record is valid
- Applied to: Extract Equipment Details
- Action: The system extracts equipment-specific details from inquiry data
Logic Flow:
IF Waybill found flag has been set and inquiry record is valid
AND The system extracts equipment-specific details from inquiry data
THEN:
- • Equipment type, status, dimensions, and other relevant details are retrieved for processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment details have been extracted from inquiry record.
Trigger Criteria:
- Context: Equipment details have been extracted from inquiry record
- Applied to: Get Container Information if Flat Car
- Action: The system evaluates if equipment is a flat car type that may carry containers
Logic Flow:
IF Equipment details have been extracted from inquiry record
AND The system evaluates if equipment is a flat car type that may carry containers
THEN:
- • If equipment is flat car, initiate container information lookup;
otherwise continue with standard equipment processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has been identified as flat car requiring container processing.
Trigger Criteria:
- Context: Equipment has been identified as flat car requiring container processing
- Applied to: Container Records Available?
- Action: The system searches for associated container records
Logic Flow:
IF Equipment has been identified as flat car requiring container processing
AND The system searches for associated container records
THEN:
- • If container records are available, proceed with container processing;
otherwise continue with equipment processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container records are available for flat car equipment.
Trigger Criteria:
- Context: Container records are available for flat car equipment
- Applied to: Process Container Sequence
- Action: The system processes container sequence information
Logic Flow:
IF Container records are available for flat car equipment
AND The system processes container sequence information
THEN:
- • Each container in sequence is identified and prepared for detailed processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when container sequence processing is active for flat car.
Trigger Criteria:
- Context: Container sequence processing is active for flat car
- Applied to: Extract Container IDs from T/C XREF
- Action: The system accesses trailer/container cross-reference (T/C XREF) data
Logic Flow:
IF Container sequence processing is active for flat car
AND The system accesses trailer/container cross-reference (T/C XREF) data
THEN:
- • Container IDs are extracted and validated for each container associated with the flat car
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when container ids have been successfully extracted from cross-reference data.
Trigger Criteria:
- Context: Container IDs have been successfully extracted from cross-reference data
- Applied to: Set Container Processing Flags
- Action: The system sets container processing indicators
Logic Flow:
IF Container IDs have been successfully extracted from cross-reference data
AND The system sets container processing indicators
THEN:
- • Container processing flags are activated to enable proper handling of containerized cargo
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when either no inquiry record was found or extracted data failed validation.
Trigger Criteria:
- Context: Either no inquiry record was found OR extracted data failed validation
- Applied to: Set Waybill Not Found Flag
- Action: The system determines waybill information is not available
Logic Flow:
IF Either no inquiry record was found OR extracted data failed validation
AND The system determines waybill information is not available
THEN:
- • Waybill not found flag is set to indicate equipment lacks valid waybill data
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when waybill not found flag has been set due to inquiry search failure.
Trigger Criteria:
- Context: Waybill not found flag has been set due to inquiry search failure
- Applied to: Log Inquiry Search Failure
- Action: The system logs the unsuccessful search attempt
Logic Flow:
IF Waybill not found flag has been set due to inquiry search failure
AND The system logs the unsuccessful search attempt
THEN:
- • Inquiry search failure is recorded with equipment ID and search details for audit trail
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when inquiry search failure has been logged and waybill not found flag is set.
Trigger Criteria:
- Context: Inquiry search failure has been logged and waybill not found flag is set
- Applied to: Proceed with Empty Equipment Processing
- Action: The system continues with equipment processing
Logic Flow:
IF Inquiry search failure has been logged and waybill not found flag is set
AND The system continues with equipment processing
THEN:
- • Equipment is processed using empty equipment business rules and validation criteria
R-GCX146-cbl-01208 (+13) File: GCX146.cbl Business Rule: Container Record Processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when flat car equipment id is provided for container lookup.
Trigger Criteria:
- Context: A flat car equipment ID is provided for container lookup
- Applied to: Access Flat Car Container Records Z510-GU-FWSWRWR
- Action: The system accesses the flat car container records database
Logic Flow:
IF A flat car equipment ID is provided for container lookup
AND The system accesses the flat car container records database
THEN:
- • Container records associated with the flat car are retrieved for processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when flat car container database lookup has been performed.
Trigger Criteria:
- Context: A flat car container database lookup has been performed
- Applied to: Container Records Found?
- Action: The system checks for the presence of container records
Logic Flow:
IF A flat car container database lookup has been performed
AND The system checks for the presence of container records
THEN:
- • Processing continues if records are found,
otherwise container processing is skipped
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container records exist for a flat car.
Trigger Criteria:
- Context: Container records exist for a flat car
- Applied to: Extract Container IDs from Flat Car Records
- Action: The system processes the flat car container records
Logic Flow:
IF Container records exist for a flat car
AND The system processes the flat car container records
THEN:
- • Individual container IDs are extracted from the records for validation and processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when container records have been found for equipment. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Container records have been found for equipment
- Applied to: Set Flat Car Processing Flag WS-FLAT-CAR = TRUE
- Action: The system identifies the equipment as carrying containers
Logic Flow:
IF Container records have been found for equipment
AND The system identifies the equipment as carrying containers
THEN:
- • The flat car processing flag is set to indicate special container handling is required
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when container ids have been extracted from flat car records.
Trigger Criteria:
- Context: Container IDs have been extracted from flat car records
- Applied to: Access Container Inquiry Database Z530-GU-FW-IQ
- Action: The system needs detailed container information
Logic Flow:
IF Container IDs have been extracted from flat car records
AND The system needs detailed container information
THEN:
- • Container inquiry database is accessed to retrieve comprehensive container data
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container inquiry database has been accessed.
Trigger Criteria:
- Context: Container inquiry database has been accessed
- Applied to: Container Inquiry Records Available?
- Action: The system checks for available container inquiry records
Logic Flow:
IF Container inquiry database has been accessed
AND The system checks for available container inquiry records
THEN:
- • Processing continues with record retrieval if available,
otherwise container processing completes
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when container inquiry records are available in the database.
Trigger Criteria:
- Context: Container inquiry records are available in the database
- Applied to: Retrieve Next Container Record Z540-GNP-FWIQ
- Action: The system processes containers sequentially
Logic Flow:
IF Container inquiry records are available in the database
AND The system processes containers sequentially
THEN:
- • Each container record is retrieved in sequence for individual processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when container inquiry records contain t/c xref data.
Trigger Criteria:
- Context: Container inquiry records contain T/C XREF data
- Applied to: Extract Container ID from T/C XREF Records
- Action: The system processes cross-reference information
Logic Flow:
IF Container inquiry records contain T/C XREF data
AND The system processes cross-reference information
THEN:
- • Container IDs are extracted from the cross-reference records for validation
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when container id has been extracted from cross-reference records.
Trigger Criteria:
- Context: A container ID has been extracted from cross-reference records
- Applied to: Validate Container ID Format
- Action: The system validates the container ID format
Logic Flow:
IF A container ID has been extracted from cross-reference records
AND The system validates the container ID format
THEN:
- • Container ID is accepted if format is valid,
otherwise marked as invalid
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container id format validation has been performed.
Trigger Criteria:
- Context: Container ID format validation has been performed
- Applied to: Container ID Valid?
- Action: The system evaluates validation results
Logic Flow:
IF Container ID format validation has been performed
AND The system evaluates validation results
THEN:
- • Valid container IDs are stored for processing, invalid IDs are marked and processing continues
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container id has passed format validation.
Trigger Criteria:
- Context: A container ID has passed format validation
- Applied to: Store Valid Container ID for Processing
- Action: The system processes valid container information
Logic Flow:
IF A container ID has passed format validation
AND The system processes valid container information
THEN:
- • The valid container ID is stored in the processing queue for further business operations
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container id has failed format validation.
Trigger Criteria:
- Context: A container ID has failed format validation
- Applied to: Mark Container as Invalid
- Action: The system encounters an invalid container ID
Logic Flow:
IF A container ID has failed format validation
AND The system encounters an invalid container ID
THEN:
- • The container is marked as invalid and excluded from further processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when container has been processed from a flat car.
Trigger Criteria:
- Context: A container has been processed from a flat car
- Applied to: More Containers on Flat Car?
- Action: The system checks for additional containers on the same flat car
Logic Flow:
IF A container has been processed from a flat car
AND The system checks for additional containers on the same flat car
THEN:
- • Processing continues with next container if more exist,
otherwise container processing completes
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when all containers on a flat car have been processed or no containers were found.
Trigger Criteria:
- Context: All containers on a flat car have been processed or no containers were found
- Applied to: Container Processing Complete
- Action: The system reaches the end of container processing
Logic Flow:
IF All containers on a flat car have been processed or no containers were found
AND The system reaches the end of container processing
THEN:
- • Container processing is marked as complete and control returns to main equipment processing
R-GCX146-cbl-01222 (+22) File: GCX146.cbl Business Rule: Container Sequence Processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when flat car equipment requires container processing.
Trigger Criteria:
- Context: A flat car equipment requires container processing
- Applied to: Access Flat Car Container Records
- Action: The system initiates container sequence processing
Logic Flow:
IF A flat car equipment requires container processing
AND The system initiates container sequence processing
THEN:
- • The system accesses the flat car's container records from the container database
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when system has accessed container records for a flat car.
Trigger Criteria:
- Context: The system has accessed container records for a flat car
- Applied to: Container Record Found?
- Action: The system checks for container record availability
Logic Flow:
IF The system has accessed container records for a flat car
AND The system checks for container record availability
THEN:
- • The system determines if valid container records exist or if container processing should terminate with error
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when valid container record has been found for the flat car.
Trigger Criteria:
- Context: A valid container record has been found for the flat car
- Applied to: Extract Container ID from Record
- Action: The system processes the container record
Logic Flow:
IF A valid container record has been found for the flat car
AND The system processes the container record
THEN:
- • The system extracts the container ID from the record for further validation and processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when container id has been extracted from the container record.
Trigger Criteria:
- Context: A container ID has been extracted from the container record
- Applied to: Validate Container Information
- Action: The system validates the container information
Logic Flow:
IF A container ID has been extracted from the container record
AND The system validates the container information
THEN:
- • The system verifies the container data meets all validation criteria and business requirements
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when container information has been validated successfully.
Trigger Criteria:
- Context: Container information has been validated successfully
- Applied to: Process Container Waybill Data
- Action: The system processes the container's waybill data
Logic Flow:
IF Container information has been validated successfully
AND The system processes the container's waybill data
THEN:
- • The system retrieves and processes all relevant waybill information for the container
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when one container has been processed for a flat car.
Trigger Criteria:
- Context: One container has been processed for a flat car
- Applied to: More Containers on Flat Car?
- Action: The system checks for additional containers on the same flat car
Logic Flow:
IF One container has been processed for a flat car
AND The system checks for additional containers on the same flat car
THEN:
- • The system determines whether more containers exist that need to be processed or if container sequence processing is complete
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when multiple containers exist on a flat car and one has been processed.
Trigger Criteria:
- Context: Multiple containers exist on a flat car and one has been processed
- Applied to: Get Next Container Record
- Action: The system needs to process the next container
Logic Flow:
IF Multiple containers exist on a flat car and one has been processed
AND The system needs to process the next container
THEN:
- • The system retrieves the next sequential container record for processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when all containers on a flat car have been processed successfully.
Trigger Criteria:
- Context: All containers on a flat car have been processed successfully
- Applied to: Set Flat Car Processing Flag
- Action: The system completes container sequence processing
Logic Flow:
IF All containers on a flat car have been processed successfully
AND The system completes container sequence processing
THEN:
- • The system sets the flat car processing flag to indicate completion
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when flat car processing flag has been set.
Trigger Criteria:
- Context: The flat car processing flag has been set
- Applied to: Complete Container Sequence
- Action: The system finalizes container processing
Logic Flow:
IF The flat car processing flag has been set
AND The system finalizes container processing
THEN:
- • The system completes the container sequence processing and prepares for next equipment processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container records are not found for a flat car.
Trigger Criteria:
- Context: Container records are not found for a flat car
- Applied to: Container Processing Error
- Action: The system encounters container processing errors
Logic Flow:
IF Container records are not found for a flat car
AND The system encounters container processing errors
THEN:
- • The system terminates container processing and handles the error condition appropriately
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when flat car equipment record is being processed.
Trigger Criteria:
- Context: A flat car equipment record is being processed
- Applied to: Access Flat Car Container Records
- Action: The system needs to process containers on the flat car
Logic Flow:
IF A flat car equipment record is being processed
AND The system needs to process containers on the flat car
THEN:
- • The system accesses FWSWRWR container records using the flat car identification
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container records have been accessed for a flat car.
Trigger Criteria:
- Context: Container records have been accessed for a flat car
- Applied to: Container Records Found?
- Action: The system checks for container record availability
Logic Flow:
IF Container records have been accessed for a flat car
AND The system checks for container record availability
THEN:
- • The system determines if container records exist and routes processing accordingly
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when container records exist for a flat car.
Trigger Criteria:
- Context: Container records exist for a flat car
- Applied to: Extract Container ID from T/C XREF
- Action: The system processes container identification
Logic Flow:
IF Container records exist for a flat car
AND The system processes container identification
THEN:
- • The system extracts container ID from T/C XREF records for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when container id has been extracted from t/c xref.
Trigger Criteria:
- Context: Container ID has been extracted from T/C XREF
- Applied to: Set Flat Car Processing Flag
- Action: The system begins flat car container processing
Logic Flow:
IF Container ID has been extracted from T/C XREF
AND The system begins flat car container processing
THEN:
- • The system sets the flat car processing flag to indicate active container processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container id has been extracted and flat car processing flag is set.
Trigger Criteria:
- Context: Container ID has been extracted and flat car processing flag is set
- Applied to: Validate Container Identification
- Action: The system validates container identification
Logic Flow:
IF Container ID has been extracted and flat car processing flag is set
AND The system validates container identification
THEN:
- • The system verifies container ID format and validity for business processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when container identification has been validated.
Trigger Criteria:
- Context: Container identification has been validated
- Applied to: Individual Container Validation
- Action: The system processes individual container validation
Logic Flow:
IF Container identification has been validated
AND The system processes individual container validation
THEN:
- • The system applies business rules specific to container processing requirements
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when individual container validation has been completed.
Trigger Criteria:
- Context: Individual container validation has been completed
- Applied to: Update Container Processing Status
- Action: The system updates container processing status
Logic Flow:
IF Individual container validation has been completed
AND The system updates container processing status
THEN:
- • The system records the current processing status for the container
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when container processing status has been updated.
Trigger Criteria:
- Context: Container processing status has been updated
- Applied to: Process Next Container in Sequence
- Action: The system continues sequential processing
Logic Flow:
IF Container processing status has been updated
AND The system continues sequential processing
THEN:
- • The system moves to process the next container in the sequence
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container has been processed in sequence.
Trigger Criteria:
- Context: A container has been processed in sequence
- Applied to: More Containers on Flat Car?
- Action: The system checks for additional containers
Logic Flow:
IF A container has been processed in sequence
AND The system checks for additional containers
THEN:
- • The system determines if more containers exist on the flat car for processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when no more containers exist on the flat car.
Trigger Criteria:
- Context: No more containers exist on the flat car
- Applied to: Complete Container Sequence
- Action: The system completes container sequence processing
Logic Flow:
IF No more containers exist on the flat car
AND The system completes container sequence processing
THEN:
- • The system finalizes all container processing for the flat car
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when no container records were found in primary lookup.
Trigger Criteria:
- Context: No container records were found in primary lookup
- Applied to: Container Inquiry Database Lookup
- Action: The system performs inquiry database lookup
Logic Flow:
IF No container records were found in primary lookup
AND The system performs inquiry database lookup
THEN:
- • The system accesses FW-IQ inquiry database for container information
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when inquiry database lookup has been performed.
Trigger Criteria:
- Context: Inquiry database lookup has been performed
- Applied to: Inquiry Data Available?
- Action: The system checks inquiry data availability
Logic Flow:
IF Inquiry database lookup has been performed
AND The system checks inquiry data availability
THEN:
- • The system determines if container data exists in the inquiry database
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container data is available in inquiry database.
Trigger Criteria:
- Context: Container data is available in inquiry database
- Applied to: Use Inquiry Container Data
- Action: The system processes inquiry container data
Logic Flow:
IF Container data is available in inquiry database
AND The system processes inquiry container data
THEN:
- • The system uses inquiry database container data for validation processing
R-GCX146-cbl-01232 (+12) File: GCX146.cbl Business Rule: Equipment Status Classification
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment is being processed for status classification.
Trigger Criteria:
- Context: Equipment is being processed for status classification
- Applied to: Check CCN Current Status
- Action: The system checks for CCN existence for the equipment
Logic Flow:
IF Equipment is being processed for status classification
AND The system checks for CCN existence for the equipment
THEN:
- • If CCN is found, retrieve and use the current CCN status for further classification,
otherwise proceed to alternative classification logic
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment has a ccn with current status available.
Trigger Criteria:
- Context: Equipment has a CCN with current status available
- Applied to: Status = RELEASE?
- Action: The CCN current status equals 'RELEASE' or 'CSA-DLV'
Logic Flow:
IF Equipment has a CCN with current status available
AND The CCN current status equals 'RELEASE' or 'CSA-DLV'
THEN:
- • Proceed to evaluate transit status for further sub-classification of RELEASE status equipment
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment has ccn status of 'release' or 'csa-dlv'.
Trigger Criteria:
- Context: Equipment has CCN status of 'RELEASE' or 'CSA-DLV'
- Applied to: Classify as EXPORT Status
- Action: The transit status is 'E' (Export) or 'Z'
Logic Flow:
IF Equipment has CCN status of 'RELEASE' or 'CSA-DLV'
AND The transit status is 'E' (Export) or 'Z'
THEN:
- • Classify the equipment status as 'EXPORT' for reporting purposes
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment has ccn status of 'release' or 'csa-dlv'.
Trigger Criteria:
- Context: Equipment has CCN status of 'RELEASE' or 'CSA-DLV'
- Applied to: Classify as RELEASE Status
- Action: Transit status is not 'E' or 'Z' and release-by field does not contain 'S.A.R.'
Logic Flow:
IF Equipment has CCN status of 'RELEASE' or 'CSA-DLV'
AND Transit status is not 'E' or 'Z' and release-by field does not contain 'S.A.R.'
THEN:
- • Classify the equipment status as 'RELEASE' for reporting purposes
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has ccn status of 'release' or 'csa-dlv' and transit status is not 'e' or 'z'.
Trigger Criteria:
- Context: Equipment has CCN status of 'RELEASE' or 'CSA-DLV' and transit status is not 'E' or 'Z'
- Applied to: Classify as S.A.R. Status
- Action: The release-by field contains 'S.A.R.'
Logic Flow:
IF Equipment has CCN status of 'RELEASE' or 'CSA-DLV' and transit status is not 'E' or 'Z'
AND The release-by field contains 'S.A.R.'
THEN:
- • Classify the equipment status as 'S.A.R.' for reporting purposes
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has ccn with status other than 'release' or 'csa-dlv'.
Trigger Criteria:
- Context: Equipment has CCN with status other than 'RELEASE' or 'CSA-DLV'
- Applied to: Classify as TRANSIT Status
- Action: The in-transit status equals 'T'
Logic Flow:
IF Equipment has CCN with status other than 'RELEASE' or 'CSA-DLV'
AND The in-transit status equals 'T'
THEN:
- • Classify the equipment status as 'TRANSIT' for reporting purposes
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has ccn with status other than 'release' or 'csa-dlv'.
Trigger Criteria:
- Context: Equipment has CCN with status other than 'RELEASE' or 'CSA-DLV'
- Applied to: Use Current CCN Status
- Action: In-transit status is neither 'T' nor 'R'
Logic Flow:
IF Equipment has CCN with status other than 'RELEASE' or 'CSA-DLV'
AND In-transit status is neither 'T' nor 'R'
THEN:
- • Use the current CCN status as-is for equipment classification
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has ccn with status other than 'release' or 'csa-dlv' and in-transit status is not 't'.
Trigger Criteria:
- Context: Equipment has CCN with status other than 'RELEASE' or 'CSA-DLV' and in-transit status is not 'T'
- Applied to: Classify as RETURN Status
- Action: The in-transit status equals 'R'
Logic Flow:
IF Equipment has CCN with status other than 'RELEASE' or 'CSA-DLV' and in-transit status is not 'T'
AND The in-transit status equals 'R'
THEN:
- • Classify the equipment status as 'RETURN' for reporting purposes
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment does not have a ccn record.
Trigger Criteria:
- Context: Equipment does not have a CCN record
- Applied to: Classify as PROCEED Status
- Action: Equipment is marked as empty (LE = 'E') or is exempted from CCN requirements
Logic Flow:
IF Equipment does not have a CCN record
AND Equipment is marked as empty (LE = 'E') or is exempted from CCN requirements
THEN:
- • Classify the equipment status as 'PROCEED' and increment TOTAL-PROCEED counter
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment does not have ccn and is not empty or exempted.
Trigger Criteria:
- Context: Equipment does not have CCN and is not empty or exempted
- Applied to: Classify as HELD-CCRA Status
- Action: Equipment has status 'HOLD' or 'AGI-HOLD'
Logic Flow:
IF Equipment does not have CCN and is not empty or exempted
AND Equipment has status 'HOLD' or 'AGI-HOLD'
THEN:
- • Classify the equipment status as 'HELD-CCRA' and increment TOTAL-HELD-CCRA counter
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment does not have ccn, is not empty/exempted, and is not held by ccra.
Trigger Criteria:
- Context: Equipment does not have CCN, is not empty/exempted, and is not held by CCRA
- Applied to: Classify as HELD-DOCS Status
- Action: Manifest from station equals manifest to station and broker entry is empty
Logic Flow:
IF Equipment does not have CCN, is not empty/exempted, and is not held by CCRA
AND Manifest from station equals manifest to station and broker entry is empty
THEN:
- • Classify the equipment status as 'HELD-DOCS' and increment TOTAL-HELD-DOCS counter
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment does not meet other classification criteria.
Trigger Criteria:
- Context: Equipment does not meet other classification criteria
- Applied to: Classify as HAULAGE Status
- Action: Manual haulage flag is set to 'Y' or haulage flag is set
Logic Flow:
IF Equipment does not meet other classification criteria
AND Manual haulage flag is set to 'Y' or haulage flag is set
THEN:
- • Classify the equipment status as 'HAULAGE' and increment TOTAL-HAULAGE counter
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has been classified into a specific status category.
Trigger Criteria:
- Context: Equipment has been classified into a specific status category
- Applied to: Update Equipment Status Totals
- Action: Status classification is complete
Logic Flow:
IF Equipment has been classified into a specific status category
AND Status classification is complete
THEN:
- • Increment the appropriate total counter (TOTAL-RELEASE, TOTAL-HAULAGE, TOTAL-PROCEED, TOTAL-HELD-CCRA, TOTAL-HELD-DOCS, or TOTAL-EQUIP) based on the classified status
R-GCX146-cbl-01245 (+8) File: GCX146.cbl Business Rule: Status Counter Management
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment item is being processed for status totals.
Trigger Criteria:
- Context: An equipment item is being processed for status totals
- Applied to: Increment TOTAL-RELEASE Counter
- Action: The CCN status is 'RELEASE' or 'CSA-DLV'
Logic Flow:
IF An equipment item is being processed for status totals
AND The CCN status is 'RELEASE' or 'CSA-DLV'
THEN:
- • The TOTAL-RELEASE counter should be incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment item is being processed for status totals.
Trigger Criteria:
- Context: An equipment item is being processed for status totals
- Applied to: Increment TOTAL-HAULAGE Counter
- Action: The equipment has haulage rights flag set or manual haulage flag is set
Logic Flow:
IF An equipment item is being processed for status totals
AND The equipment has haulage rights flag set or manual haulage flag is set
THEN:
- • The TOTAL-HAULAGE counter should be incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment item is being processed for status totals.
Trigger Criteria:
- Context: An equipment item is being processed for status totals
- Applied to: Increment TOTAL-HELD-CCRA Counter
- Action: The CCN status is 'HOLD' or 'AGI-HOLD'
Logic Flow:
IF An equipment item is being processed for status totals
AND The CCN status is 'HOLD' or 'AGI-HOLD'
THEN:
- • The TOTAL-HELD-CCRA counter should be incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment item is being processed for status totals.
Trigger Criteria:
- Context: An equipment item is being processed for status totals
- Applied to: Increment TOTAL-PROCEED Counter
- Action: The CCN status is 'RETURN' or the manifest from station is different from the manifest to station and the status is not error, reject, or deleted
Logic Flow:
IF An equipment item is being processed for status totals
AND The CCN status is 'RETURN' or the manifest from station is different from the manifest to station and the status is not error, reject, or deleted
THEN:
- • The TOTAL-PROCEED counter should be incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment item is being processed for status totals.
Trigger Criteria:
- Context: An equipment item is being processed for status totals
- Applied to: Increment TOTAL-HELD-DOCS Counter
- Action: The manifest from station equals the manifest to station and the broker entry is empty
Logic Flow:
IF An equipment item is being processed for status totals
AND The manifest from station equals the manifest to station and the broker entry is empty
THEN:
- • The TOTAL-HELD-DOCS counter should be incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment item is being processed for status totals.
Trigger Criteria:
- Context: An equipment item is being processed for status totals
- Applied to: Increment TOTAL-TRANSIT Counter
- Action: The in-transit status is 'T'
Logic Flow:
IF An equipment item is being processed for status totals
AND The in-transit status is 'T'
THEN:
- • The TOTAL-TRANSIT counter should be incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment item is being processed for status totals.
Trigger Criteria:
- Context: An equipment item is being processed for status totals
- Applied to: Increment TOTAL-EXPORT Counter
- Action: The in-transit status is 'E' or 'Z'
Logic Flow:
IF An equipment item is being processed for status totals
AND The in-transit status is 'E' or 'Z'
THEN:
- • The TOTAL-EXPORT counter should be incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment item is being processed for status totals.
Trigger Criteria:
- Context: An equipment item is being processed for status totals
- Applied to: Increment TOTAL-RETURN Counter
- Action: The in-transit status is 'R'
Logic Flow:
IF An equipment item is being processed for status totals
AND The in-transit status is 'R'
THEN:
- • The TOTAL-RETURN counter should be incremented by 1
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when all status-specific counters have been evaluated for an equipment item.
Trigger Criteria:
- Context: All status-specific counters have been evaluated for an equipment item
- Applied to: Update Equipment Status Totals
- Action: The equipment processing is complete
Logic Flow:
IF All status-specific counters have been evaluated for an equipment item
AND The equipment processing is complete
THEN:
- • All applicable status counters should be updated and the total equipment count should be incremented by 1
R-GCX146-cbl-01254 (+10) File: GCX146.cbl Business Rule: Trip Sheet Header Generation
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when trip sheet report needs to be generated.
Trigger Criteria:
- Context: A trip sheet report needs to be generated
- Applied to: Initialize Trip Sheet Header Fields
- Action: The system begins trip sheet header generation
Logic Flow:
IF A trip sheet report needs to be generated
AND The system begins trip sheet header generation
THEN:
- • All header fields are cleared and initialized to spaces or zeros
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when input message contains train identification data.
Trigger Criteria:
- Context: An input message contains train identification data
- Applied to: Extract Train Components from Input
- Action: The system processes the train information
Logic Flow:
IF An input message contains train identification data
AND The system processes the train information
THEN:
- • Train number, day, from station, to station, and consist number are extracted from the input message
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when train identification components may contain spaces.
Trigger Criteria:
- Context: Train identification components may contain spaces
- Applied to: Replace Spaces with Zeros
- Action: The system formats train components
Logic Flow:
IF Train identification components may contain spaces
AND The system formats train components
THEN:
- • All spaces in train number, day, from station, to station, and consist number are replaced with zeros
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when individual train components have been formatted.
Trigger Criteria:
- Context: Individual train components have been formatted
- Applied to: Build Customs Train ID
- Action: The system builds the customs train ID
Logic Flow:
IF Individual train components have been formatted
AND The system builds the customs train ID
THEN:
- • The customs train ID is constructed by concatenating train number, day, from station, to station, and consist number
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when train has from and to station codes.
Trigger Criteria:
- Context: Train has from and to station codes
- Applied to: Retrieve From Station Code
- Action: The system formats station information
Logic Flow:
IF Train has from and to station codes
AND The system formats station information
THEN:
- • Station codes are retrieved and corresponding station names are formatted for display
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when trip sheet report is being generated.
Trigger Criteria:
- Context: A trip sheet report is being generated
- Applied to: Capture Current System Date
- Action: The system needs to timestamp the report
Logic Flow:
IF A trip sheet report is being generated
AND The system needs to timestamp the report
THEN:
- • Current system date and time are captured and formatted for report display
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when trip sheet report is being generated.
Trigger Criteria:
- Context: A trip sheet report is being generated
- Applied to: Set Report Type Indicator
- Action: The system sets report identification
Logic Flow:
IF A trip sheet report is being generated
AND The system sets report identification
THEN:
- • Report type indicator is set to identify this as a trip sheet report
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when trip sheet report is being generated.
Trigger Criteria:
- Context: A trip sheet report is being generated
- Applied to: Set Page Number and Line Counter
- Action: The system sets up report pagination
Logic Flow:
IF A trip sheet report is being generated
AND The system sets up report pagination
THEN:
- • Page number is set to 1 and line counter is initialized to track report lines
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when train has an estimated time of arrival.
Trigger Criteria:
- Context: Train has an estimated time of arrival
- Applied to: Validate ETA Date Format
- Action: The system formats ETA information
Logic Flow:
IF Train has an estimated time of arrival
AND The system formats ETA information
THEN:
- • ETA date format is validated and formatted appropriately for trip sheet display
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when trip sheet report is for canadian customs.
Trigger Criteria:
- Context: A trip sheet report is for Canadian customs
- Applied to: Set Canadian Customs Header Text
- Action: The system sets report headers
Logic Flow:
IF A trip sheet report is for Canadian customs
AND The system sets report headers
THEN:
- • Canadian customs header text and report title are set with appropriate description
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when trip sheet report includes equipment totals.
Trigger Criteria:
- Context: A trip sheet report includes equipment totals
- Applied to: Initialize Equipment Count Fields
- Action: The system initializes the totals section
Logic Flow:
IF A trip sheet report includes equipment totals
AND The system initializes the totals section
THEN:
- • All equipment count fields are set to zero and status category headers are established
R-GCX146-cbl-01265 (+15) File: GCX146.cbl Business Rule: Equipment List Processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment record is being processed for formatting.
Trigger Criteria:
- Context: An equipment record is being processed for formatting
- Applied to: Determine Equipment Type
- Action: The equipment is identified as a container type
Logic Flow:
IF An equipment record is being processed for formatting
AND The equipment is identified as a container type
THEN:
- • The system sets the equipment type code to 'C' for container and applies container-specific formatting rules
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment record is being processed for formatting.
Trigger Criteria:
- Context: An equipment record is being processed for formatting
- Applied to: Determine Equipment Type
- Action: The equipment is identified as a trailer type
Logic Flow:
IF An equipment record is being processed for formatting
AND The equipment is identified as a trailer type
THEN:
- • The system sets the equipment type code to 'T' for trailer and applies trailer-specific formatting rules
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment record is being processed for formatting.
Trigger Criteria:
- Context: An equipment record is being processed for formatting
- Applied to: Determine Equipment Type
- Action: The equipment is identified as a rail car type
Logic Flow:
IF An equipment record is being processed for formatting
AND The equipment is identified as a rail car type
THEN:
- • The system sets the equipment type code to 'R' for rail car and applies rail car-specific formatting rules
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment record has been classified as container type.
Trigger Criteria:
- Context: An equipment record has been classified as container type
- Applied to: Format Container Entry
- Action: The container ID needs to be formatted for display
Logic Flow:
IF An equipment record has been classified as container type
AND The container ID needs to be formatted for display
THEN:
- • The system applies container-specific ID formatting using GCCCARFM utility to create 12-character standardized format
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment record has been classified as trailer type.
Trigger Criteria:
- Context: An equipment record has been classified as trailer type
- Applied to: Format Trailer Entry
- Action: The trailer ID needs to be formatted for display
Logic Flow:
IF An equipment record has been classified as trailer type
AND The trailer ID needs to be formatted for display
THEN:
- • The system applies trailer-specific ID formatting rules to create standardized trailer identification format
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment record has been classified as rail car type.
Trigger Criteria:
- Context: An equipment record has been classified as rail car type
- Applied to: Format Rail Car Entry
- Action: The rail car ID needs to be formatted for display
Logic Flow:
IF An equipment record has been classified as rail car type
AND The rail car ID needs to be formatted for display
THEN:
- • The system applies rail car-specific ID formatting rules to create standardized car number format
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment record is being processed with load/empty indicator available.
Trigger Criteria:
- Context: An equipment record is being processed with load/empty indicator available
- Applied to: Determine Load/Empty Status
- Action: The system evaluates the load status indicator field
Logic Flow:
IF An equipment record is being processed with load/empty indicator available
AND The system evaluates the load status indicator field
THEN:
- • The system determines if equipment is loaded or empty and sets corresponding status flags for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has been evaluated for load status.
Trigger Criteria:
- Context: Equipment has been evaluated for load status
- Applied to: Set LOADED Status
- Action: The equipment is determined to be carrying cargo (loaded)
Logic Flow:
IF Equipment has been evaluated for load status
AND The equipment is determined to be carrying cargo (loaded)
THEN:
- • The system sets the equipment status to 'LOADED' and applies loaded equipment processing rules
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has been evaluated for load status.
Trigger Criteria:
- Context: Equipment has been evaluated for load status
- Applied to: Set EMPTY Status
- Action: The equipment is determined to be not carrying cargo (empty)
Logic Flow:
IF Equipment has been evaluated for load status
AND The equipment is determined to be not carrying cargo (empty)
THEN:
- • The system sets the equipment status to 'EMPTY' and applies empty equipment processing rules
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has been classified by type and load status.
Trigger Criteria:
- Context: Equipment has been classified by type and load status
- Applied to: Format Equipment ID
- Action: The equipment ID needs to be formatted for processing
Logic Flow:
IF Equipment has been classified by type and load status
AND The equipment ID needs to be formatted for processing
THEN:
- • The system removes spaces from the equipment ID and applies standardized formatting rules based on equipment type
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment id has been initially formatted.
Trigger Criteria:
- Context: Equipment ID has been initially formatted
- Applied to: Apply Car ID Formatting
- Action: Car-specific formatting is required
Logic Flow:
IF Equipment ID has been initially formatted
AND Car-specific formatting is required
THEN:
- • The system applies car ID formatting rules to create standardized car number representation with proper spacing and character positioning
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has been formatted and classified.
Trigger Criteria:
- Context: Equipment has been formatted and classified
- Applied to: Set IDLER Message
- Action: The equipment is identified as idler equipment (non-revenue generating)
Logic Flow:
IF Equipment has been formatted and classified
AND The equipment is identified as idler equipment (non-revenue generating)
THEN:
- • The system sets the equipment message to 'IDLER' to indicate special handling requirements
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has been formatted and classified.
Trigger Criteria:
- Context: Equipment has been formatted and classified
- Applied to: Set UNIT Message
- Action: The equipment is identified as unit equipment (part of unit train)
Logic Flow:
IF Equipment has been formatted and classified
AND The equipment is identified as unit equipment (part of unit train)
THEN:
- • The system sets the equipment message to 'UNIT' to indicate unit train handling requirements
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has been formatted and classified.
Trigger Criteria:
- Context: Equipment has been formatted and classified
- Applied to: Set Standard Message
- Action: The equipment is not identified as idler or unit equipment
Logic Flow:
IF Equipment has been formatted and classified
AND The equipment is not identified as idler or unit equipment
THEN:
- • The system sets a standard equipment message for normal processing and handling
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has been classified, formatted, and assigned appropriate status messages.
Trigger Criteria:
- Context: Equipment has been classified, formatted, and assigned appropriate status messages
- Applied to: Build Equipment Entry Line
- Action: A complete equipment entry line needs to be constructed
Logic Flow:
IF Equipment has been classified, formatted, and assigned appropriate status messages
AND A complete equipment entry line needs to be constructed
THEN:
- • The system combines equipment ID, type code, load status, and status messages into a single formatted equipment entry line
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when complete equipment entry line has been constructed.
Trigger Criteria:
- Context: A complete equipment entry line has been constructed
- Applied to: Add to Equipment List
- Action: The equipment entry needs to be added to the train's equipment list
Logic Flow:
IF A complete equipment entry line has been constructed
AND The equipment entry needs to be added to the train's equipment list
THEN:
- • The system adds the formatted equipment entry to the master equipment list maintaining proper sequence and organization
R-GCX146-cbl-01281 (+11) File: GCX146.cbl Business Rule: Summary Totals Generation
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when summary totals generation process is starting.
Trigger Criteria:
- Context: A summary totals generation process is starting
- Applied to: Initialize Total Counters
- Action: The system begins calculating equipment totals
Logic Flow:
IF A summary totals generation process is starting
AND The system begins calculating equipment totals
THEN:
- • All total counters (TOTAL-EQUIP, TOTAL-RELEASE, TOTAL-HAULAGE, TOTAL-HELD-CCRA, TOTAL-PROCEED, TOTAL-HELD-DOCS, TOTAL-DOCS-NR) are set to zero
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment records with various status values exist.
Trigger Criteria:
- Context: Equipment records with various status values exist
- Applied to: Calculate Released Cargo Total
- Action: The system processes equipment with status equal to 'RELEASE' or 'CSA-DLV'
Logic Flow:
IF Equipment records with various status values exist
AND The system processes equipment with status equal to 'RELEASE' or 'CSA-DLV'
THEN:
- • The TOTAL-RELEASE counter is incremented by one for each qualifying equipment piece
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment records with haulage and manual haulage indicators exist.
Trigger Criteria:
- Context: Equipment records with haulage and manual haulage indicators exist
- Applied to: Calculate Haulage Rights Total
- Action: The system processes equipment where haulage flag is 'Y' or manual haulage flag is 'Y'
Logic Flow:
IF Equipment records with haulage and manual haulage indicators exist
AND The system processes equipment where haulage flag is 'Y' or manual haulage flag is 'Y'
THEN:
- • The TOTAL-HAULAGE counter is incremented by one for each qualifying equipment piece
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment records with various hold status values exist.
Trigger Criteria:
- Context: Equipment records with various hold status values exist
- Applied to: Calculate CCRA Held Total
- Action: The system processes equipment with status equal to 'HOLD' or 'AGI-HOLD'
Logic Flow:
IF Equipment records with various hold status values exist
AND The system processes equipment with status equal to 'HOLD' or 'AGI-HOLD'
THEN:
- • The TOTAL-HELD-CCRA counter is incremented by one for each qualifying equipment piece
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment records with manifest from/to stations and status information exist.
Trigger Criteria:
- Context: Equipment records with manifest from/to stations and status information exist
- Applied to: Calculate Proceeding Cargo Total
- Action: The system processes equipment with status 'RETURN' or where manifest from station differs from manifest to station and status is not error, reject, or deleted
Logic Flow:
IF Equipment records with manifest from/to stations and status information exist
AND The system processes equipment with status 'RETURN' or where manifest from station differs from manifest to station and status is not error, reject, or deleted
THEN:
- • The TOTAL-PROCEED counter is incremented by one for each qualifying equipment piece
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment records with manifest station information and broker entry data exist.
Trigger Criteria:
- Context: Equipment records with manifest station information and broker entry data exist
- Applied to: Calculate Documentation Held Total
- Action: The system processes equipment where manifest from station equals manifest to station and broker entry is empty or spaces
Logic Flow:
IF Equipment records with manifest station information and broker entry data exist
AND The system processes equipment where manifest from station equals manifest to station and broker entry is empty or spaces
THEN:
- • The TOTAL-HELD-DOCS counter is incremented by one for each qualifying equipment piece
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when calculated total counter values exist as numeric fields.
Trigger Criteria:
- Context: Calculated total counter values exist as numeric fields
- Applied to: Format Total Values for Display
- Action: The system prepares totals for report display
Logic Flow:
IF Calculated total counter values exist as numeric fields
AND The system prepares totals for report display
THEN:
- • Each total value is formatted with leading zeros suppressed and right-justified in display fields
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when formatted total values for all equipment categories exist.
Trigger Criteria:
- Context: Formatted total values for all equipment categories exist
- Applied to: Generate Equipment Summary Lines
- Action: The system generates summary report lines
Logic Flow:
IF Formatted total values for all equipment categories exist
AND The system generates summary report lines
THEN:
- • Summary lines are created showing 'TOTAL EQUIPMENT', 'TOTAL RELEASE', 'TOTAL HAULAGE', 'TOTAL HELD CCRA', 'TOTAL PROCEED', 'TOTAL HELD DOCS', and 'TOTAL DOCS N/R' with their respective counts
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when trip sheet report is being generated for an add operation and equipment summary lines exist.
Trigger Criteria:
- Context: A trip sheet report is being generated for an ADD operation and equipment summary lines exist
- Applied to: Add Totals to Trip Sheet
- Action: The system adds totals to the trip sheet
Logic Flow:
IF A trip sheet report is being generated for an ADD operation and equipment summary lines exist
AND The system adds totals to the trip sheet
THEN:
- • Equipment summary lines are appended to the trip sheet report with proper formatting and line spacing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when status report is being generated for a verify operation and equipment summary lines exist.
Trigger Criteria:
- Context: A status report is being generated for a VERIFY operation and equipment summary lines exist
- Applied to: Add Totals to Status Report
- Action: The system adds totals to the status report
Logic Flow:
IF A status report is being generated for a VERIFY operation and equipment summary lines exist
AND The system adds totals to the status report
THEN:
- • Equipment summary lines are appended to the status report with proper formatting and line spacing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all equipment totals have been calculated.
Trigger Criteria:
- Context: All equipment totals have been calculated
- Applied to: Validate Total Calculations
- Action: The system validates the total calculations
Logic Flow:
IF All equipment totals have been calculated
AND The system validates the total calculations
THEN:
- • The sum of all category totals (RELEASE + HAULAGE + HELD-CCRA + PROCEED + HELD-DOCS + DOCS-NR) equals or is less than TOTAL-EQUIP
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when total calculations have been validated and found to be inconsistent.
Trigger Criteria:
- Context: Total calculations have been validated and found to be inconsistent
- Applied to: Report Total Calculation Error
- Action: The validation fails
Logic Flow:
IF Total calculations have been validated and found to be inconsistent
AND The validation fails
THEN:
- • An error message is generated indicating total calculation inconsistency and the summary generation continues with available totals
R-GCX146-cbl-01293 (+8) File: GCX146.cbl Business Rule: Return CCN Number Construction
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when return cargo ccn needs to be created for canadian customs.
Trigger Criteria:
- Context: A return cargo CCN needs to be created for Canadian customs
- Applied to: Set CCN Prefix to '6105E'
- Action: The system constructs the CCN number
Logic Flow:
IF A return cargo CCN needs to be created for Canadian customs
AND The system constructs the CCN number
THEN:
- • The CCN must start with the prefix '6105E' followed by the equipment identifier
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when current equipment record is being processed for return ccn creation.
Trigger Criteria:
- Context: A current equipment record is being processed for return CCN creation
- Applied to: Extract Equipment ID from Current Record
- Action: The system needs to build the CCN identifier
Logic Flow:
IF A current equipment record is being processed for return CCN creation
AND The system needs to build the CCN identifier
THEN:
- • The equipment ID must be extracted from the current record and used in CCN construction
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when waybill record exists for the equipment being processed.
Trigger Criteria:
- Context: A waybill record exists for the equipment being processed
- Applied to: Extract Waybill Date from Waybill Record
- Action: The system constructs a return CCN
Logic Flow:
IF A waybill record exists for the equipment being processed
AND The system constructs a return CCN
THEN:
- • The waybill date must be extracted from the waybill record and appended to the CCN identifier
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn has been constructed with prefix, equipment id, and waybill date.
Trigger Criteria:
- Context: A CCN has been constructed with prefix, equipment ID, and waybill date
- Applied to: Validate CCN Format
- Action: The system validates the CCN format
Logic Flow:
IF A CCN has been constructed with prefix, equipment ID, and waybill date
AND The system validates the CCN format
THEN:
- • The CCN format must be valid according to customs requirements or the construction process must be rejected
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when valid ccn has been constructed for return cargo.
Trigger Criteria:
- Context: A valid CCN has been constructed for return cargo
- Applied to: Set CCN Status to 'RETURN'
- Action: The system sets the CCN processing status
Logic Flow:
IF A valid CCN has been constructed for return cargo
AND The system sets the CCN processing status
THEN:
- • The CCN status must be set to 'RETURN' to indicate return cargo processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn is being created for return cargo processing.
Trigger Criteria:
- Context: A CCN is being created for return cargo processing
- Applied to: Set Transit Status to 'R'
- Action: The system assigns transit status
Logic Flow:
IF A CCN is being created for return cargo processing
AND The system assigns transit status
THEN:
- • The transit status must be set to 'R' to indicate return movement
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when waybill record contains shipper information for the equipment.
Trigger Criteria:
- Context: A waybill record contains shipper information for the equipment
- Applied to: Populate Shipper Data from Waybill
- Action: The system creates a return CCN record
Logic Flow:
IF A waybill record contains shipper information for the equipment
AND The system creates a return CCN record
THEN:
- • All relevant shipper data must be extracted from the waybill and populated into the CCN record
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when waybill record contains consignee information for the equipment.
Trigger Criteria:
- Context: A waybill record contains consignee information for the equipment
- Applied to: Populate Consignee Data from Waybill
- Action: The system creates a return CCN record
Logic Flow:
IF A waybill record contains consignee information for the equipment
AND The system creates a return CCN record
THEN:
- • All relevant consignee data must be extracted from the waybill and populated into the CCN record
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn identifier, status, transit status, shipper data, and consignee data have been populated.
Trigger Criteria:
- Context: CCN identifier, status, transit status, shipper data, and consignee data have been populated
- Applied to: Complete Return CCN Record
- Action: The system finalizes the return CCN record
Logic Flow:
IF CCN identifier, status, transit status, shipper data, and consignee data have been populated
AND The system finalizes the return CCN record
THEN:
- • The CCN record must be marked as complete with all required fields populated for customs processing
R-GCX146-cbl-01302 (+9) File: GCX146.cbl Business Rule: Return CCN Data Population
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when return ccn requires data population from waybill records.
Trigger Criteria:
- Context: A return CCN requires data population from waybill records
- Applied to: Waybill Data Available?
- Action: The system accesses the waybill database for the specified equipment
Logic Flow:
IF A return CCN requires data population from waybill records
AND The system accesses the waybill database for the specified equipment
THEN:
- • The system must verify waybill data exists before proceeding with shipper and consignee information extraction
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when valid waybill data exists for the equipment.
Trigger Criteria:
- Context: Valid waybill data exists for the equipment
- Applied to: Extract Shipper Information
- Action: The system processes shipper information from the waybill record
Logic Flow:
IF Valid waybill data exists for the equipment
AND The system processes shipper information from the waybill record
THEN:
- • The system must extract shipper name, address, and identification details from the waybill
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when valid waybill data exists for the equipment.
Trigger Criteria:
- Context: Valid waybill data exists for the equipment
- Applied to: Extract Consignee Information
- Action: The system processes consignee information from the waybill record
Logic Flow:
IF Valid waybill data exists for the equipment
AND The system processes consignee information from the waybill record
THEN:
- • The system must extract consignee name, address, and identification details from the waybill
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when valid waybill data exists for the equipment.
Trigger Criteria:
- Context: Valid waybill data exists for the equipment
- Applied to: Extract Shipment Details
- Action: The system processes shipment details from the waybill record
Logic Flow:
IF Valid waybill data exists for the equipment
AND The system processes shipment details from the waybill record
THEN:
- • The system must extract commodity information, weight, origin station, destination station, and other shipment-specific data
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when shipper information has been extracted from the waybill.
Trigger Criteria:
- Context: Shipper information has been extracted from the waybill
- Applied to: Populate CCN Shipper Fields
- Action: The system updates the return CCN record with shipper data
Logic Flow:
IF Shipper information has been extracted from the waybill
AND The system updates the return CCN record with shipper data
THEN:
- • The CCN record must be populated with shipper name, address, and identification in the appropriate CCN shipper fields
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when consignee information has been extracted from the waybill.
Trigger Criteria:
- Context: Consignee information has been extracted from the waybill
- Applied to: Populate CCN Consignee Fields
- Action: The system updates the return CCN record with consignee data
Logic Flow:
IF Consignee information has been extracted from the waybill
AND The system updates the return CCN record with consignee data
THEN:
- • The CCN record must be populated with consignee name, address, and identification in the appropriate CCN consignee fields
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when shipment details have been extracted from the waybill.
Trigger Criteria:
- Context: Shipment details have been extracted from the waybill
- Applied to: Populate Additional Shipment Data
- Action: The system updates the return CCN record with shipment data
Logic Flow:
IF Shipment details have been extracted from the waybill
AND The system updates the return CCN record with shipment data
THEN:
- • The CCN record must be populated with commodity information, weight, origin/destination stations, and other relevant shipment data
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn record has been populated with waybill data.
Trigger Criteria:
- Context: CCN record has been populated with waybill data
- Applied to: All Required Data Present?
- Action: The system validates data completeness for the return CCN
Logic Flow:
IF CCN record has been populated with waybill data
AND The system validates data completeness for the return CCN
THEN:
- • The system must verify that all required shipper, consignee, and shipment fields contain valid data before marking the population process as complete
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when all required data fields have been validated as complete in the return ccn.
Trigger Criteria:
- Context: All required data fields have been validated as complete in the return CCN
- Applied to: Set Data Population Complete Flag
- Action: The system completes the data population process
Logic Flow:
IF All required data fields have been validated as complete in the return CCN
AND The system completes the data population process
THEN:
- • The system must set the data population complete flag to indicate successful completion of the return CCN data population
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill data is unavailable or required ccn data fields are incomplete.
Trigger Criteria:
- Context: Waybill data is unavailable or required CCN data fields are incomplete
- Applied to: Log Missing Data Warning
- Action: The system encounters missing or incomplete data during population
Logic Flow:
IF Waybill data is unavailable or required CCN data fields are incomplete
AND The system encounters missing or incomplete data during population
THEN:
- • The system must log a warning message indicating which data elements are missing and continue processing
R-GCX146-cbl-01312 (+9) File: GCX146.cbl Business Rule: Primary Broker Notification
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn record requires broker notification.
Trigger Criteria:
- Context: A CCN record requires broker notification
- Applied to: Check Broker Configuration
- Action: The system checks for primary broker configuration
Logic Flow:
IF A CCN record requires broker notification
AND The system checks for primary broker configuration
THEN:
- • The system should verify if a primary broker exists and is configured for notifications
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn record requires broker notification.
Trigger Criteria:
- Context: A CCN record requires broker notification
- Applied to: Skip Notification
- Action: No primary broker is configured in the system
Logic Flow:
IF A CCN record requires broker notification
AND No primary broker is configured in the system
THEN:
- • The system should skip the primary broker notification process and continue with other processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when primary broker exists and is configured for notifications.
Trigger Criteria:
- Context: A primary broker exists and is configured for notifications
- Applied to: Determine Notification Channels
- Action: The system evaluates available notification channels
Logic Flow:
IF A primary broker exists and is configured for notifications
AND The system evaluates available notification channels
THEN:
- • The system should identify all configured channels including X12 EDI, Merlin, Internet, FAX, and Paper based on broker preferences
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when primary broker has x12 edi channel configured. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Primary broker has X12 EDI channel configured
- Applied to: Call GCCS309C for X12
- Action: The system processes X12 notifications
Logic Flow:
IF Primary broker has X12 EDI channel configured
AND The system processes X12 notifications
THEN:
- • The system should call GCCS309C program to send X12 EDI notifications to the primary broker
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when primary broker has merlin channel configured. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Primary broker has Merlin channel configured
- Applied to: Call GCX019 for Merlin
- Action: The system processes Merlin notifications
Logic Flow:
IF Primary broker has Merlin channel configured
AND The system processes Merlin notifications
THEN:
- • The system should call GCX019 program to send Merlin notifications to the primary broker
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when primary broker has internet channel configured. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Primary broker has Internet channel configured
- Applied to: Call GCX019 for Internet
- Action: The system processes Internet notifications
Logic Flow:
IF Primary broker has Internet channel configured
AND The system processes Internet notifications
THEN:
- • The system should call GCX019 program to send Internet notifications to the primary broker
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when primary broker has fax channel configured. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Primary broker has FAX channel configured
- Applied to: Call GCX019 for FAX
- Action: The system processes FAX notifications
Logic Flow:
IF Primary broker has FAX channel configured
AND The system processes FAX notifications
THEN:
- • The system should call GCX019 program to send FAX notifications to the primary broker
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when primary broker has paper channel configured. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Primary broker has paper channel configured
- Applied to: Generate Print Call Letters
- Action: The system processes paper notifications
Logic Flow:
IF Primary broker has paper channel configured
AND The system processes paper notifications
THEN:
- • The system should generate print call letters for physical delivery to the primary broker
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when multiple notification channels are configured for the primary broker.
Trigger Criteria:
- Context: Multiple notification channels are configured for the primary broker
- Applied to: All Channels Processed?
- Action: The system processes each notification channel
Logic Flow:
IF Multiple notification channels are configured for the primary broker
AND The system processes each notification channel
THEN:
- • The system should verify that all configured channels have been processed before completing the notification workflow
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all configured notification channels have been processed for the primary broker.
Trigger Criteria:
- Context: All configured notification channels have been processed for the primary broker
- Applied to: Log Notification Success
- Action: The notification process completes successfully
Logic Flow:
IF All configured notification channels have been processed for the primary broker
AND The notification process completes successfully
THEN:
- • The system should log the successful completion of primary broker notifications for audit and tracking purposes
R-GCX146-cbl-01322 (+12) File: GCX146.cbl Business Rule: Secondary Broker Notification
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo notification process is initiated.
Trigger Criteria:
- Context: A cargo notification process is initiated
- Applied to: Secondary Broker ID Available?
- Action: The system checks for secondary broker configuration
Logic Flow:
IF A cargo notification process is initiated
AND The system checks for secondary broker configuration
THEN:
- • The process continues to notification channel determination if secondary broker ID exists,
otherwise completes without secondary broker notification
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when secondary broker notification is required.
Trigger Criteria:
- Context: A secondary broker notification is required
- Applied to: X12 EDI Channel?
- Action: The notification channel is evaluated
Logic Flow:
IF A secondary broker notification is required
AND The notification channel is evaluated
THEN:
- • X12 EDI notification is sent via GCCS309C if X12 EDI channel is selected,
otherwise check next available channel
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when x12 edi channel is selected for secondary broker notification.
Trigger Criteria:
- Context: X12 EDI channel is selected for secondary broker notification
- Applied to: Send X12 EDI Notification via GCCS309C
- Action: The notification transmission is initiated
Logic Flow:
IF X12 EDI channel is selected for secondary broker notification
AND The notification transmission is initiated
THEN:
- • The system invokes GCCS309C program to send X12 EDI notification and returns success or failure status
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when x12 edi channel is not selected for secondary broker notification.
Trigger Criteria:
- Context: X12 EDI channel is not selected for secondary broker notification
- Applied to: Merlin Channel?
- Action: The notification channel is evaluated for Merlin
Logic Flow:
IF X12 EDI channel is not selected for secondary broker notification
AND The notification channel is evaluated for Merlin
THEN:
- • Merlin notification is sent via GCX019 if Merlin channel is selected,
otherwise check next available channel
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when merlin channel is selected for secondary broker notification.
Trigger Criteria:
- Context: Merlin channel is selected for secondary broker notification
- Applied to: Send Merlin Notification via GCX019
- Action: The notification transmission is initiated
Logic Flow:
IF Merlin channel is selected for secondary broker notification
AND The notification transmission is initiated
THEN:
- • The system invokes GCX019 program to send Merlin notification and returns success or failure status
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when neither x12 edi nor merlin channels are selected for secondary broker notification.
Trigger Criteria:
- Context: Neither X12 EDI nor Merlin channels are selected for secondary broker notification
- Applied to: Internet Channel?
- Action: The notification channel is evaluated for Internet
Logic Flow:
IF Neither X12 EDI nor Merlin channels are selected for secondary broker notification
AND The notification channel is evaluated for Internet
THEN:
- • Internet notification is sent via GCX019 if Internet channel is selected,
otherwise check next available channel
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when internet channel is selected for secondary broker notification.
Trigger Criteria:
- Context: Internet channel is selected for secondary broker notification
- Applied to: Send Internet Notification via GCX019
- Action: The notification transmission is initiated
Logic Flow:
IF Internet channel is selected for secondary broker notification
AND The notification transmission is initiated
THEN:
- • The system invokes GCX019 program to send Internet notification and returns success or failure status
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when x12 edi, merlin, and internet channels are not selected for secondary broker notification.
Trigger Criteria:
- Context: X12 EDI, Merlin, and Internet channels are not selected for secondary broker notification
- Applied to: FAX Channel?
- Action: The notification channel is evaluated for FAX
Logic Flow:
IF X12 EDI, Merlin, and Internet channels are not selected for secondary broker notification
AND The notification channel is evaluated for FAX
THEN:
- • FAX notification is sent via GCX019 if FAX channel is selected,
otherwise check next available channel
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when fax channel is selected for secondary broker notification.
Trigger Criteria:
- Context: FAX channel is selected for secondary broker notification
- Applied to: Send FAX Notification via GCX019
- Action: The notification transmission is initiated
Logic Flow:
IF FAX channel is selected for secondary broker notification
AND The notification transmission is initiated
THEN:
- • The system invokes GCX019 program to send FAX notification and returns success or failure status
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when electronic notification channels (x12 edi, merlin, internet, fax) are not selected for secondary broker notification.
Trigger Criteria:
- Context: Electronic notification channels (X12 EDI, Merlin, Internet, FAX) are not selected for secondary broker notification
- Applied to: Paper Channel?
- Action: The notification channel is evaluated for Paper
Logic Flow:
IF Electronic notification channels (X12 EDI, Merlin, Internet, FAX) are not selected for secondary broker notification
AND The notification channel is evaluated for Paper
THEN:
- • Paper notification is generated via batch print if Paper channel is selected,
otherwise complete notification process
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when paper channel is selected for secondary broker notification.
Trigger Criteria:
- Context: Paper channel is selected for secondary broker notification
- Applied to: Generate Paper Notification via Batch Print
- Action: The notification generation is initiated
Logic Flow:
IF Paper channel is selected for secondary broker notification
AND The notification generation is initiated
THEN:
- • The system generates paper notification via batch print process and returns success or failure status
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when secondary broker notification transmission is completed successfully.
Trigger Criteria:
- Context: A secondary broker notification transmission is completed successfully
- Applied to: Log Notification Success
- Action: The notification result is processed
Logic Flow:
IF A secondary broker notification transmission is completed successfully
AND The notification result is processed
THEN:
- • The system logs the successful notification transmission for audit and tracking purposes
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when secondary broker notification transmission fails.
Trigger Criteria:
- Context: A secondary broker notification transmission fails
- Applied to: Log Notification Failure
- Action: The notification result is processed
Logic Flow:
IF A secondary broker notification transmission fails
AND The notification result is processed
THEN:
- • The system logs the failed notification transmission for audit and error tracking purposes
R-GCX146-cbl-01335 (+15) File: GCX146.cbl Business Rule: Email Report Processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when station code is provided for email report processing.
Trigger Criteria:
- Context: A station code is provided for email report processing
- Applied to: Get Email User List from Station Configuration
- Action: The system looks up email configuration for the station
Logic Flow:
IF A station code is provided for email report processing
AND The system looks up email configuration for the station
THEN:
- • The system retrieves the list of email users configured for that station from the station configuration table
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when email user lookup has been performed for a station.
Trigger Criteria:
- Context: Email user lookup has been performed for a station
- Applied to: Email Users Found?
- Action: The system checks if any email users were found in the configuration
Logic Flow:
IF Email user lookup has been performed for a station
AND The system checks if any email users were found in the configuration
THEN:
- • If email users are found, proceed with email processing,
otherwise skip email processing and mark as no users configured
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when email users are configured for the station.
Trigger Criteria:
- Context: Email users are configured for the station
- Applied to: Initialize Email Message Buffer
- Action: The system begins email report processing
Logic Flow:
IF Email users are configured for the station
AND The system begins email report processing
THEN:
- • Initialize email message buffer, clear previous content, and prepare for new report data
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when email message buffer is initialized.
Trigger Criteria:
- Context: Email message buffer is initialized
- Applied to: Add Report Header Lines
- Action: The system begins building the email report content
Logic Flow:
IF Email message buffer is initialized
AND The system begins building the email report content
THEN:
- • Add report header lines including report identification, date, time, and relevant train or processing information
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when report header has been added to email message.
Trigger Criteria:
- Context: Report header has been added to email message
- Applied to: Process Equipment Report Lines
- Action: The system processes equipment data for the report
Logic Flow:
IF Report header has been added to email message
AND The system processes equipment data for the report
THEN:
- • Generate detailed report lines for each equipment item including status, location, and relevant business information
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment report lines are being processed for email.
Trigger Criteria:
- Context: Equipment report lines are being processed for email
- Applied to: Within Line Limit ≤ 699 lines?
- Action: The system checks the current line count in the email message
Logic Flow:
IF Equipment report lines are being processed for email
AND The system checks the current line count in the email message
THEN:
- • If line count is 699 or less, continue adding equipment details,
otherwise finalize current message and prepare for continuation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when email message is within the 699 line limit.
Trigger Criteria:
- Context: Email message is within the 699 line limit
- Applied to: Add Equipment Details to Email
- Action: The system processes equipment details for inclusion
Logic Flow:
IF Email message is within the 699 line limit
AND The system processes equipment details for inclusion
THEN:
- • Add equipment details including car ID, status, location, and other relevant business information to the email message
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when current equipment item has been processed.
Trigger Criteria:
- Context: Current equipment item has been processed
- Applied to: More Equipment?
- Action: The system checks for additional equipment in the report queue
Logic Flow:
IF Current equipment item has been processed
AND The system checks for additional equipment in the report queue
THEN:
- • If more equipment exists, continue processing next item,
otherwise proceed to finalize the email message
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all equipment processing is complete or line limit reached.
Trigger Criteria:
- Context: All equipment processing is complete or line limit reached
- Applied to: Finalize Email Message
- Action: The system finalizes the email message
Logic Flow:
IF All equipment processing is complete or line limit reached
AND The system finalizes the email message
THEN:
- • Add any closing information, format the message properly, and prepare for email transmission
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when email message is finalized and ready for transmission.
Trigger Criteria:
- Context: Email message is finalized and ready for transmission
- Applied to: Send Email via EMCSEND3
- Action: The system calls EMCSEND3 to send the email
Logic Flow:
IF Email message is finalized and ready for transmission
AND The system calls EMCSEND3 to send the email
THEN:
- • Attempt to transmit the email to configured recipients using the email service
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when email transmission attempt has been made via emcsend3.
Trigger Criteria:
- Context: Email transmission attempt has been made via EMCSEND3
- Applied to: Email Send Successful?
- Action: The system checks the transmission result
Logic Flow:
IF Email transmission attempt has been made via EMCSEND3
AND The system checks the transmission result
THEN:
- • If email send was successful, log successful transmission,
otherwise attempt fallback email delivery
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when email has been successfully transmitted.
Trigger Criteria:
- Context: Email has been successfully transmitted
- Applied to: Log Successful Email Transmission
- Action: The system processes the successful transmission
Logic Flow:
IF Email has been successfully transmitted
AND The system processes the successful transmission
THEN:
- • Log the successful email transmission with timestamp, recipient information, and report details for audit trail
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when primary email transmission has failed.
Trigger Criteria:
- Context: Primary email transmission has failed
- Applied to: Try Fallback Email Address OM01247/AEI9999
- Action: The system attempts fallback email delivery
Logic Flow:
IF Primary email transmission has failed
AND The system attempts fallback email delivery
THEN:
- • Send the email report to fallback support addresses OM01247 and AEI9999 to ensure report delivery
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when fallback email transmission attempt has been made.
Trigger Criteria:
- Context: Fallback email transmission attempt has been made
- Applied to: Fallback Send Successful?
- Action: The system checks the fallback transmission result
Logic Flow:
IF Fallback email transmission attempt has been made
AND The system checks the fallback transmission result
THEN:
- • If fallback send was successful, log successful transmission,
otherwise log email failure
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when both primary and fallback email transmissions have failed.
Trigger Criteria:
- Context: Both primary and fallback email transmissions have failed
- Applied to: Log Email Failure
- Action: The system processes the failed transmission attempts
Logic Flow:
IF Both primary and fallback email transmissions have failed
AND The system processes the failed transmission attempts
THEN:
- • Log the email failure with error details, attempted recipients, and report information for troubleshooting
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when email user lookup found no configured users for the station.
Trigger Criteria:
- Context: Email user lookup found no configured users for the station
- Applied to: No Email Users Configured
- Action: The system processes the no-users scenario
Logic Flow:
IF Email user lookup found no configured users for the station
AND The system processes the no-users scenario
THEN:
- • Skip email processing, log that no email users are configured, and proceed to complete email processing
R-GCX146-cbl-01351 (+9) File: GCX146.cbl Business Rule: Continuation Report Processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when email report is being generated with multiple lines of content.
Trigger Criteria:
- Context: An email report is being generated with multiple lines of content
- Applied to: Line Counter > 699?
- Action: The line counter exceeds 699 lines in the current email message
Logic Flow:
IF An email report is being generated with multiple lines of content
AND The line counter exceeds 699 lines in the current email message
THEN:
- • The system should trigger continuation processing to send the current batch and prepare for the next message segment
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when email message has reached its maximum line capacity of 699 lines.
Trigger Criteria:
- Context: An email message has reached its maximum line capacity of 699 lines
- Applied to: Send Current Email Batch
- Action: The continuation processing is triggered
Logic Flow:
IF An email message has reached its maximum line capacity of 699 lines
AND The continuation processing is triggered
THEN:
- • The system should send the current email batch using the email delivery service
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when email batch has been successfully sent.
Trigger Criteria:
- Context: An email batch has been successfully sent
- Applied to: Reset Message Buffer
- Action: Preparing for continuation message processing
Logic Flow:
IF An email batch has been successfully sent
AND Preparing for continuation message processing
THEN:
- • The system should reset the message buffer to empty state
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when new continuation email message is being prepared.
Trigger Criteria:
- Context: A new continuation email message is being prepared
- Applied to: Add Continuation Header Message
- Action: The message buffer has been reset for continuation processing
Logic Flow:
IF A new continuation email message is being prepared
AND The message buffer has been reset for continuation processing
THEN:
- • The system should add the header message 'CONTINUATION OF REPORT ....' to identify this as a continuation message
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when continuation message is being prepared with header added.
Trigger Criteria:
- Context: A continuation message is being prepared with header added
- Applied to: Reset Line Counter
- Action: Starting to process remaining report lines for the new message
Logic Flow:
IF A continuation message is being prepared with header added
AND Starting to process remaining report lines for the new message
THEN:
- • The system should reset the line counter to zero to begin counting lines for the new message segment
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when continuation processing has been completed with buffer reset and counter reset.
Trigger Criteria:
- Context: Continuation processing has been completed with buffer reset and counter reset
- Applied to: Continue Processing Remaining Lines
- Action: There are remaining report lines to be processed
Logic Flow:
IF Continuation processing has been completed with buffer reset and counter reset
AND There are remaining report lines to be processed
THEN:
- • The system should continue processing the remaining lines in the new message segment
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when report line is being processed for email transmission.
Trigger Criteria:
- Context: A report line is being processed for email transmission
- Applied to: Add Line to Email Buffer
- Action: The line is ready to be included in the email message
Logic Flow:
IF A report line is being processed for email transmission
AND The line is ready to be included in the email message
THEN:
- • The system should add the line to the current email message buffer
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when line has been successfully added to the email message buffer.
Trigger Criteria:
- Context: A line has been successfully added to the email message buffer
- Applied to: Increment Line Counter
- Action: The line addition is complete
Logic Flow:
IF A line has been successfully added to the email message buffer
AND The line addition is complete
THEN:
- • The system should increment the line counter by one to maintain accurate count of lines in current message
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when report line has been processed and added to the email buffer.
Trigger Criteria:
- Context: A report line has been processed and added to the email buffer
- Applied to: More Lines to Process?
- Action: Checking for continuation of report processing
Logic Flow:
IF A report line has been processed and added to the email buffer
AND Checking for continuation of report processing
THEN:
- • The system should evaluate whether there are more lines remaining in the report to be processed
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all report lines have been processed and no more lines remain.
Trigger Criteria:
- Context: All report lines have been processed and no more lines remain
- Applied to: Send Final Email Batch
- Action: The final email message batch is ready for transmission
Logic Flow:
IF All report lines have been processed and no more lines remain
AND The final email message batch is ready for transmission
THEN:
- • The system should send the final email batch containing the remaining report content
R-GCX146-cbl-01361 (+3) File: GCX146.cbl Business Rule: FAX Configuration Setup
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when station configuration record exists with auto-fax settings.
Trigger Criteria:
- Context: A station configuration record exists with auto-FAX settings
- Applied to: Check Auto-FAX Configuration Flag
- Action: The system checks the auto-FAX configuration flag in the station record
Logic Flow:
IF A station configuration record exists with auto-FAX settings
AND The system checks the auto-FAX configuration flag in the station record
THEN:
- • The system should proceed to station FAX flag validation if auto-FAX is enabled,
otherwise skip FAX configuration entirely
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when auto-fax configuration is enabled and a station configuration record exists.
Trigger Criteria:
- Context: Auto-FAX configuration is enabled and a station configuration record exists
- Applied to: Check Station FAX Flag
- Action: The system checks the station FAX flag in the station configuration record
Logic Flow:
IF Auto-FAX configuration is enabled and a station configuration record exists
AND The system checks the station FAX flag in the station configuration record
THEN:
- • The system should proceed with FAX routing setup if the station FAX flag is active,
otherwise skip FAX configuration
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when both auto-fax configuration flag and station fax flag are enabled. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Both auto-FAX configuration flag and station FAX flag are enabled
- Applied to: Set Up FAX Routing Parameters
- Action: The system sets up FAX routing parameters
Logic Flow:
IF Both auto-FAX configuration flag and station FAX flag are enabled
AND The system sets up FAX routing parameters
THEN:
- • The system should configure copy IDs for distribution, set external FAX addressing, prepare Merlin transmission parameters, and call EMCSEND for FAX routing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when fax routing parameters are properly configured with copy ids and external addressing. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: FAX routing parameters are properly configured with copy IDs and external addressing
- Applied to: Call EMCSEND for FAX Routing
- Action: The system calls the EMCSEND service for FAX routing
Logic Flow:
IF FAX routing parameters are properly configured with copy IDs and external addressing
AND The system calls the EMCSEND service for FAX routing
THEN:
- • The external FAX routing service should be invoked to handle the transmission
R-GCX146-cbl-01365 (+20) File: GCX146.cbl Business Rule: Merlin Message Preparation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when merlin message needs to be prepared for transmission.
Trigger Criteria:
- Context: A Merlin message needs to be prepared for transmission
- Applied to: Initialize Message Buffer
- Action: The message preparation process begins
Logic Flow:
IF A Merlin message needs to be prepared for transmission
AND The message preparation process begins
THEN:
- • The message buffer is cleared and initialized with default values
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when message buffer has been initialized for merlin transmission.
Trigger Criteria:
- Context: A message buffer has been initialized for Merlin transmission
- Applied to: Set Message Type and Headers
- Action: The system determines the message type and required headers
Logic Flow:
IF A message buffer has been initialized for Merlin transmission
AND The system determines the message type and required headers
THEN:
- • The appropriate message type identifier and standard headers are set in the message buffer
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when message headers have been established.
Trigger Criteria:
- Context: Message headers have been established
- Applied to: Format Train Information
- Action: Train information needs to be formatted for the message
Logic Flow:
IF Message headers have been established
AND Train information needs to be formatted for the message
THEN:
- • Train ID, date/time, and operational details are formatted and added to the message content
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when train information has been formatted in the message.
Trigger Criteria:
- Context: Train information has been formatted in the message
- Applied to: Add Station Names to Message
- Action: Station information needs to be included
Logic Flow:
IF Train information has been formatted in the message
AND Station information needs to be included
THEN:
- • From and to station codes and names are added to the message content
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when station information has been added to the message.
Trigger Criteria:
- Context: Station information has been added to the message
- Applied to: Format Equipment Details
- Action: Equipment details need to be formatted
Logic Flow:
IF Station information has been added to the message
AND Equipment details need to be formatted
THEN:
- • Equipment IDs, car types, and related information are formatted for inclusion in the message
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment details are being formatted.
Trigger Criteria:
- Context: Equipment details are being formatted
- Applied to: Container Equipment?
- Action: The system evaluates the equipment type
Logic Flow:
IF Equipment details are being formatted
AND The system evaluates the equipment type
THEN:
- • If the equipment is container equipment, container-specific formatting is applied,
otherwise standard equipment formatting is used
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has been identified as container equipment.
Trigger Criteria:
- Context: Equipment has been identified as container equipment
- Applied to: Format Container Information
- Action: Container information needs to be formatted
Logic Flow:
IF Equipment has been identified as container equipment
AND Container information needs to be formatted
THEN:
- • Container-specific details including container IDs and attributes are formatted for the message
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has been identified as standard (non-container) equipment.
Trigger Criteria:
- Context: Equipment has been identified as standard (non-container) equipment
- Applied to: Format Standard Equipment
- Action: Standard equipment information needs to be formatted
Logic Flow:
IF Equipment has been identified as standard (non-container) equipment
AND Standard equipment information needs to be formatted
THEN:
- • Standard equipment details are formatted using regular equipment formatting rules
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment information has been formatted (either container or standard).
Trigger Criteria:
- Context: Equipment information has been formatted (either container or standard)
- Applied to: Add Load/Empty Status
- Action: Load status needs to be added to equipment details
Logic Flow:
IF Equipment information has been formatted (either container or standard)
AND Load status needs to be added to equipment details
THEN:
- • The appropriate load/empty indicator is added to each equipment entry
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when load/empty status has been added to equipment.
Trigger Criteria:
- Context: Load/empty status has been added to equipment
- Applied to: Add CCN Information
- Action: CCN information exists for the equipment
Logic Flow:
IF Load/empty status has been added to equipment
AND CCN information exists for the equipment
THEN:
- • CCN numbers and associated customs status information are added to the equipment details
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn information has been processed for equipment.
Trigger Criteria:
- Context: CCN information has been processed for equipment
- Applied to: Format Equipment Type Messages
- Action: Equipment type messages need to be formatted
Logic Flow:
IF CCN information has been processed for equipment
AND Equipment type messages need to be formatted
THEN:
- • Car type descriptions and related equipment type messages are formatted and added to the message
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment type messages have been formatted.
Trigger Criteria:
- Context: Equipment type messages have been formatted
- Applied to: Message Line Limit Reached?
- Action: The system checks the current message line count
Logic Flow:
IF Equipment type messages have been formatted
AND The system checks the current message line count
THEN:
- • If the line limit has been reached, the message is prepared for segmentation,
otherwise formatting continues
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when message line limit has been reached.
Trigger Criteria:
- Context: The message line limit has been reached
- Applied to: Segment Message for Transmission
- Action: Message segmentation is required
Logic Flow:
IF The message line limit has been reached
AND Message segmentation is required
THEN:
- • The message is divided into appropriate segments for separate transmission
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when message has been segmented for transmission.
Trigger Criteria:
- Context: A message has been segmented for transmission
- Applied to: Add Continuation Headers
- Action: Continuation headers need to be added
Logic Flow:
IF A message has been segmented for transmission
AND Continuation headers need to be added
THEN:
- • Appropriate continuation headers are added to indicate the message sequence and relationship
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when message content has been prepared (with continuation headers if segmented).
Trigger Criteria:
- Context: Message content has been prepared (with continuation headers if segmented)
- Applied to: Format Message Lines for Merlin
- Action: Final message line formatting is applied
Logic Flow:
IF Message content has been prepared (with continuation headers if segmented)
AND Final message line formatting is applied
THEN:
- • Message lines are formatted according to Merlin system specifications
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when message lines have been formatted for merlin.
Trigger Criteria:
- Context: Message lines have been formatted for Merlin
- Applied to: Set FAX Routing Information
- Action: FAX routing information needs to be configured
Logic Flow:
IF Message lines have been formatted for Merlin
AND FAX routing information needs to be configured
THEN:
- • Station-specific FAX routing parameters are set based on system configuration
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when fax routing information has been configured. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: FAX routing information has been configured
- Applied to: Auto-FAX Enabled?
- Action: The system evaluates auto-FAX settings
Logic Flow:
IF FAX routing information has been configured
AND The system evaluates auto-FAX settings
THEN:
- • If auto-FAX is enabled, FAX copy IDs are added,
otherwise external FAX addressing is configured
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when auto-fax has been determined to be enabled. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Auto-FAX has been determined to be enabled
- Applied to: Add FAX Copy IDs
- Action: FAX copy IDs need to be added
Logic Flow:
IF Auto-FAX has been determined to be enabled
AND FAX copy IDs need to be added
THEN:
- • Appropriate FAX copy identifiers are added to enable automatic FAX distribution
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when fax configuration is being finalized (either after adding copy ids or when auto-fax is disabled). ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: FAX configuration is being finalized (either after adding copy IDs or when auto-FAX is disabled)
- Applied to: Set External FAX Addressing
- Action: External FAX addressing needs to be configured
Logic Flow:
IF FAX configuration is being finalized (either after adding copy IDs or when auto-FAX is disabled)
AND External FAX addressing needs to be configured
THEN:
- • External FAX numbers and addressing parameters are set based on station configuration
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when external fax addressing has been configured.
Trigger Criteria:
- Context: External FAX addressing has been configured
- Applied to: Prepare Final Message Buffer
- Action: The final message buffer needs to be prepared
Logic Flow:
IF External FAX addressing has been configured
AND The final message buffer needs to be prepared
THEN:
- • All message components are assembled into the final transmission-ready buffer
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when final message buffer has been prepared.
Trigger Criteria:
- Context: The final message buffer has been prepared
- Applied to: Message Ready for Transmission
- Action: Message preparation is complete
Logic Flow:
IF The final message buffer has been prepared
AND Message preparation is complete
THEN:
- • The message is marked as ready for transmission with all required components properly formatted
R-GCX146-cbl-01386 (+7) File: GCX146.cbl Business Rule: Return CCN Identification
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo shipment with origin province/state information.
Trigger Criteria:
- Context: A cargo shipment with origin province/state information
- Applied to: Is Cargo Canadian Origin?
- Action: The system evaluates the origin location
Logic Flow:
IF A cargo shipment with origin province/state information
AND The system evaluates the origin location
THEN:
- • The cargo is classified as Canadian origin if the origin province code matches any Canadian province (NF, PE, NS, NB, PQ, ON, MB, SK, AB, BC, YT, NT),
otherwise it is classified as non-Canadian origin
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when canadian origin cargo shipment with destination information.
Trigger Criteria:
- Context: A Canadian origin cargo shipment with destination information
- Applied to: Has US Destination History?
- Action: The system checks the destination province/state codes
Logic Flow:
IF A Canadian origin cargo shipment with destination information
AND The system checks the destination province/state codes
THEN:
- • The cargo is identified as having US destination history if the destination province/state code is not in the Canadian province list (NF, PE, NS, NB, PQ, ON, MB, SK, AB, BC, YT, NT)
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo shipment identified as canadian origin with us destination history.
Trigger Criteria:
- Context: A cargo shipment identified as Canadian origin with US destination history
- Applied to: Valid Return Pattern?
- Action: The system validates the return movement pattern
Logic Flow:
IF A cargo shipment identified as Canadian origin with US destination history
AND The system validates the return movement pattern
THEN:
- • The movement is valid for return CCN creation if it represents Canadian goods that went to US and are now returning to Canada
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when valid return cargo with equipment id, waybill date, and carrier information.
Trigger Criteria:
- Context: Valid return cargo with equipment ID, waybill date, and carrier information
- Applied to: Build Return CCN Format
- Action: The system creates a return CCN record
Logic Flow:
IF Valid return cargo with equipment ID, waybill date, and carrier information
AND The system creates a return CCN record
THEN:
- • The CCN key is built using format: type '6' + carrier '105' + 'E' + equipment ID + waybill date + sequence number
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when return ccn record being created.
Trigger Criteria:
- Context: A return CCN record being created
- Applied to: Set Return Status Indicators
- Action: The system sets status indicators
Logic Flow:
IF A return CCN record being created
AND The system sets status indicators
THEN:
- • The CCN status is set to 'RETURN' and application type is set to '33' for Canadian customs processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when valid return cargo with complete shipment details including shipper, consignee, origin and destination station data.
Trigger Criteria:
- Context: Valid return cargo with complete shipment details including shipper, consignee, origin and destination station data
- Applied to: Create Return CCN Record
- Action: The system creates the return CCN record
Logic Flow:
IF Valid return cargo with complete shipment details including shipper, consignee, origin and destination station data
AND The system creates the return CCN record
THEN:
- • A new CCN record is inserted with status 'RETURN', populated shipper/consignee information, origin/destination stations, and application type '33'
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when return ccn record successfully created.
Trigger Criteria:
- Context: A return CCN record successfully created
- Applied to: Update Transit Status to 'R'
- Action: The system updates transit status
Logic Flow:
IF A return CCN record successfully created
AND The system updates transit status
THEN:
- • The equipment transit status is set to 'R' to indicate return movement
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when return ccn record successfully created.
Trigger Criteria:
- Context: A return CCN record successfully created
- Applied to: Log Return CCN Creation
- Action: The system logs the creation activity
Logic Flow:
IF A return CCN record successfully created
AND The system logs the creation activity
THEN:
- • An audit trail entry is created by spawning GCX105 transaction with the return CCN details
R-GCX146-cbl-01394 (+13) File: GCX146.cbl Business Rule: Return CCN Construction
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when return ccn needs to be created for cargo processing.
Trigger Criteria:
- Context: A return CCN needs to be created for cargo processing
- Applied to: Build CCN Prefix '6105E'
- Action: The system builds the CCN identifier
Logic Flow:
IF A return CCN needs to be created for cargo processing
AND The system builds the CCN identifier
THEN:
- • The CCN prefix must be set to '6105E' to identify it as return cargo
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when waybill record exists with equipment information.
Trigger Criteria:
- Context: A waybill record exists with equipment information
- Applied to: Extract Equipment ID from Waybill
- Action: The system processes return CCN creation
Logic Flow:
IF A waybill record exists with equipment information
AND The system processes return CCN creation
THEN:
- • The equipment ID must be extracted from the waybill record and used in CCN construction
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when waybill record contains date information.
Trigger Criteria:
- Context: A waybill record contains date information
- Applied to: Extract Waybill Date
- Action: The system creates a return CCN
Logic Flow:
IF A waybill record contains date information
AND The system creates a return CCN
THEN:
- • The waybill date must be extracted and included in the CCN identifier for uniqueness
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn prefix '6105e', equipment id, and waybill date are available.
Trigger Criteria:
- Context: CCN prefix '6105E', equipment ID, and waybill date are available
- Applied to: '6105E' + Equipment ID + Waybill Date
- Action: The system constructs the return CCN
Logic Flow:
IF CCN prefix '6105E', equipment ID, and waybill date are available
AND The system constructs the return CCN
THEN:
- • The CCN must be formed by concatenating '6105E' + equipment ID + waybill date in that exact sequence
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn string may contain spaces from concatenation.
Trigger Criteria:
- Context: A CCN string may contain spaces from concatenation
- Applied to: Compress CCN - Remove Spaces
- Action: The system finalizes the CCN format
Logic Flow:
IF A CCN string may contain spaces from concatenation
AND The system finalizes the CCN format
THEN:
- • All spaces must be removed from the CCN string to create a continuous identifier
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn contains numeric sequences from equipment id and date.
Trigger Criteria:
- Context: A CCN contains numeric sequences from equipment ID and date
- Applied to: Organize Numeric Sequences
- Action: The system processes CCN formatting
Logic Flow:
IF A CCN contains numeric sequences from equipment ID and date
AND The system processes CCN formatting
THEN:
- • Numeric sequences must be properly organized to maintain CCN integrity and uniqueness
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when new ccn is being created for return cargo.
Trigger Criteria:
- Context: A new CCN is being created for return cargo
- Applied to: Set CCN Status to 'RETURN'
- Action: The system sets the CCN status
Logic Flow:
IF A new CCN is being created for return cargo
AND The system sets the CCN status
THEN:
- • The CCN status must be set to 'RETURN' to indicate return cargo processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when return ccn is being processed.
Trigger Criteria:
- Context: A return CCN is being processed
- Applied to: Set Transit Status to 'R'
- Action: The system sets transit status
Logic Flow:
IF A return CCN is being processed
AND The system sets transit status
THEN:
- • The transit status must be set to 'R' to indicate return movement status
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill contains shipper information.
Trigger Criteria:
- Context: A waybill contains shipper information
- Applied to: Populate Shipper Data from Waybill
- Action: The system creates a return CCN record
Logic Flow:
IF A waybill contains shipper information
AND The system creates a return CCN record
THEN:
- • Shipper data must be extracted from the waybill and populated in the return CCN record
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when waybill contains consignee information.
Trigger Criteria:
- Context: A waybill contains consignee information
- Applied to: Populate Consignee Data from Waybill
- Action: The system creates a return CCN record
Logic Flow:
IF A waybill contains consignee information
AND The system creates a return CCN record
THEN:
- • Consignee data must be extracted from the waybill and populated in the return CCN record
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn has been constructed with all required components.
Trigger Criteria:
- Context: A CCN has been constructed with all required components
- Applied to: Validate CCN Format
- Action: The system validates the CCN format
Logic Flow:
IF A CCN has been constructed with all required components
AND The system validates the CCN format
THEN:
- • The CCN must meet all format requirements including proper length, character composition, and structure
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn has undergone format validation.
Trigger Criteria:
- Context: A CCN has undergone format validation
- Applied to: CCN Format Valid?
- Action: The system evaluates validation results
Logic Flow:
IF A CCN has undergone format validation
AND The system evaluates validation results
THEN:
- • If CCN format is valid, proceed to store the record; if invalid, handle format error
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when return ccn has passed all format validations.
Trigger Criteria:
- Context: A return CCN has passed all format validations
- Applied to: Store Return CCN Record
- Action: The system processes the validated CCN
Logic Flow:
IF A return CCN has passed all format validations
AND The system processes the validated CCN
THEN:
- • The return CCN record must be stored in the database with all populated data
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn has failed format validation.
Trigger Criteria:
- Context: A CCN has failed format validation
- Applied to: CCN Format Error
- Action: The system processes the validation failure
Logic Flow:
IF A CCN has failed format validation
AND The system processes the validation failure
THEN:
- • A format error must be generated and the CCN construction process must be terminated
R-GCX146-cbl-01408 (+13) File: GCX146.cbl Business Rule: Return CCN Data Assembly
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when waybill record exists with equipment information.
Trigger Criteria:
- Context: A waybill record exists with equipment information
- Applied to: Extract Equipment ID from Waybill
- Action: The system processes return CCN data assembly
Logic Flow:
IF A waybill record exists with equipment information
AND The system processes return CCN data assembly
THEN:
- • The equipment ID is extracted from the waybill record and stored for CCN creation
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill record contains date information.
Trigger Criteria:
- Context: A waybill record contains date information
- Applied to: Extract Waybill Date Information
- Action: The system processes return CCN data assembly
Logic Flow:
IF A waybill record contains date information
AND The system processes return CCN data assembly
THEN:
- • The waybill date is extracted and formatted for use in CCN key generation
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment id and waybill date have been extracted.
Trigger Criteria:
- Context: Equipment ID and waybill date have been extracted
- Applied to: Build Return CCN Number
- Action: The system builds the return CCN number
Logic Flow:
IF Equipment ID and waybill date have been extracted
AND The system builds the return CCN number
THEN:
- • The CCN number is constructed with format '6105E' + equipment ID + waybill date + sequence number
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when return ccn record is being created.
Trigger Criteria:
- Context: A return CCN record is being created
- Applied to: Set CCN Status to 'RETURN'
- Action: The system sets the CCN status
Logic Flow:
IF A return CCN record is being created
AND The system sets the CCN status
THEN:
- • The CCN status is set to 'RETURN' to indicate return cargo processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when return ccn record is being processed.
Trigger Criteria:
- Context: A return CCN record is being processed
- Applied to: Set Transit Status to 'R'
- Action: The system sets the transit status
Logic Flow:
IF A return CCN record is being processed
AND The system sets the transit status
THEN:
- • The transit status is set to 'R' to indicate return transit movement
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when waybill record contains shipper information in the ship segment.
Trigger Criteria:
- Context: A waybill record contains shipper information in the SHIP segment
- Applied to: Extract Shipper Information from Waybill
- Action: The system processes return CCN data assembly
Logic Flow:
IF A waybill record contains shipper information in the SHIP segment
AND The system processes return CCN data assembly
THEN:
- • The shipper name and address information is extracted and populated in the CCN record
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill record contains consignee information in the cons segment.
Trigger Criteria:
- Context: A waybill record contains consignee information in the CONS segment
- Applied to: Extract Consignee Information from Waybill
- Action: The system processes return CCN data assembly
Logic Flow:
IF A waybill record contains consignee information in the CONS segment
AND The system processes return CCN data assembly
THEN:
- • The consignee name and address information is extracted and populated in the CCN record
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when station codes are available from waybill or train information.
Trigger Criteria:
- Context: Station codes are available from waybill or train information
- Applied to: Populate Origin Station Data
- Action: The system populates origin station data
Logic Flow:
IF Station codes are available from waybill or train information
AND The system populates origin station data
THEN:
- • The origin station information is populated in the CCN record using the appropriate station codes
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when station codes are available from waybill or train information.
Trigger Criteria:
- Context: Station codes are available from waybill or train information
- Applied to: Populate Destination Station Data
- Action: The system populates destination station data
Logic Flow:
IF Station codes are available from waybill or train information
AND The system populates destination station data
THEN:
- • The destination station information is populated in the CCN record using the appropriate station codes
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill record contains commodity information.
Trigger Criteria:
- Context: A waybill record contains commodity information
- Applied to: Set Commodity Code Information
- Action: The system sets commodity code information
Logic Flow:
IF A waybill record contains commodity information
AND The system sets commodity code information
THEN:
- • The commodity description and code are extracted from the waybill and populated in the CCN record
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill record contains weight and quantity information.
Trigger Criteria:
- Context: A waybill record contains weight and quantity information
- Applied to: Assign Weight and Quantity Data
- Action: The system assigns weight and quantity data
Logic Flow:
IF A waybill record contains weight and quantity information
AND The system assigns weight and quantity data
THEN:
- • The shipment weight and quantity are extracted from the waybill and populated in the CCN record
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when return ccn record is being assembled.
Trigger Criteria:
- Context: A return CCN record is being assembled
- Applied to: Set Return Processing Flags
- Action: The system sets return processing flags
Logic Flow:
IF A return CCN record is being assembled
AND The system sets return processing flags
THEN:
- • The appropriate flags are set to indicate return cargo processing requirements and handling instructions
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all individual data elements have been extracted and populated.
Trigger Criteria:
- Context: All individual data elements have been extracted and populated
- Applied to: Complete CCN Record Assembly
- Action: The system completes CCN record assembly
Logic Flow:
IF All individual data elements have been extracted and populated
AND The system completes CCN record assembly
THEN:
- • The CCN record is finalized with all required data elements populated and ready for database insertion
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn record assembly is complete with all required data.
Trigger Criteria:
- Context: The CCN record assembly is complete with all required data
- Applied to: Return CCN Data Ready for Insert
- Action: The system prepares the data for insert
Logic Flow:
IF The CCN record assembly is complete with all required data
AND The system prepares the data for insert
THEN:
- • The return CCN data is ready for database insertion with all business rules satisfied and data integrity validated
R-GCX146-cbl-01422 (+8) File: GCX146.cbl Business Rule: Equipment ID Preparation and Validation
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment id is received from the input message.
Trigger Criteria:
- Context: An equipment ID is received from the input message
- Applied to: Check Equipment ID Format
- Action: The system checks the equipment ID format for valid characters
Logic Flow:
IF An equipment ID is received from the input message
AND The system checks the equipment ID format for valid characters
THEN:
- • The equipment ID should contain only alphanumeric characters and be properly formatted
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment id has been formatted and cleaned.
Trigger Criteria:
- Context: An equipment ID has been formatted and cleaned
- Applied to: Validate Equipment ID Length
- Action: The system validates the equipment ID length
Logic Flow:
IF An equipment ID has been formatted and cleaned
AND The system validates the equipment ID length
THEN:
- • The equipment ID length should be within acceptable limits for database operations
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment id has passed initial format validation.
Trigger Criteria:
- Context: An equipment ID has passed initial format validation
- Applied to: Apply Padding Rules
- Action: The system applies padding rules to the equipment ID
Logic Flow:
IF An equipment ID has passed initial format validation
AND The system applies padding rules to the equipment ID
THEN:
- • The equipment ID should be padded with appropriate characters to meet standard length requirements
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment id contains spaces or special characters.
Trigger Criteria:
- Context: An equipment ID contains spaces or special characters
- Applied to: Remove Spaces and Special Characters
- Action: The system processes the equipment ID for cleanup
Logic Flow:
IF An equipment ID contains spaces or special characters
AND The system processes the equipment ID for cleanup
THEN:
- • All spaces and invalid special characters should be removed from the equipment ID
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment id has been validated and cleaned.
Trigger Criteria:
- Context: An equipment ID has been validated and cleaned
- Applied to: Format for Database Search
- Action: The system formats the equipment ID for database operations
Logic Flow:
IF An equipment ID has been validated and cleaned
AND The system formats the equipment ID for database operations
THEN:
- • The equipment ID should be formatted according to database search requirements
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment id has been formatted for database use.
Trigger Criteria:
- Context: An equipment ID has been formatted for database use
- Applied to: Compress Equipment ID
- Action: The system compresses the equipment ID
Logic Flow:
IF An equipment ID has been formatted for database use
AND The system compresses the equipment ID
THEN:
- • The equipment ID should be compressed while maintaining its integrity and searchability
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment id contains numeric sequences.
Trigger Criteria:
- Context: An equipment ID contains numeric sequences
- Applied to: Organize Numeric Sequences
- Action: The system organizes the numeric portions
Logic Flow:
IF An equipment ID contains numeric sequences
AND The system organizes the numeric portions
THEN:
- • Numeric sequences should be properly aligned and formatted for consistent processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment id fails format validation.
Trigger Criteria:
- Context: An equipment ID fails format validation
- Applied to: Generate Format Error
- Action: The system detects invalid format
Logic Flow:
IF An equipment ID fails format validation
AND The system detects invalid format
THEN:
- • A format error should be generated indicating the equipment ID does not meet format requirements
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment id fails length validation.
Trigger Criteria:
- Context: An equipment ID fails length validation
- Applied to: Generate Length Error
- Action: The system detects invalid length
Logic Flow:
IF An equipment ID fails length validation
AND The system detects invalid length
THEN:
- • A length error should be generated indicating the equipment ID does not meet length requirements
R-GCX146-cbl-01431 (+9) File: GCX146.cbl Business Rule: Multiple Search Criteria Configuration
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when search operation is being initiated for equipment lookup.
Trigger Criteria:
- Context: A search operation is being initiated for equipment lookup
- Applied to: Initialize Search Parameters
- Action: The system begins parameter configuration
Logic Flow:
IF A search operation is being initiated for equipment lookup
AND The system begins parameter configuration
THEN:
- • All search parameter fields are cleared and set to initial default values
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment search parameters are being configured.
Trigger Criteria:
- Context: Equipment search parameters are being configured
- Applied to: Set Equipment Type Criteria
- Action: Equipment type criteria needs to be established
Logic Flow:
IF Equipment search parameters are being configured
AND Equipment type criteria needs to be established
THEN:
- • Car type code and equipment category are set based on the search requirements
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment search is being configured with temporal constraints.
Trigger Criteria:
- Context: Equipment search is being configured with temporal constraints
- Applied to: Configure Date Range Parameters
- Action: Date range parameters are being set
Logic Flow:
IF Equipment search is being configured with temporal constraints
AND Date range parameters are being set
THEN:
- • Waybill date range and system date parameters are established to define the search time window
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment search requires geographic filtering.
Trigger Criteria:
- Context: Equipment search requires geographic filtering
- Applied to: Set Station Code Filters
- Action: Station code filters are being configured
Logic Flow:
IF Equipment search requires geographic filtering
AND Station code filters are being configured
THEN:
- • Origin station code and destination station code are set to limit search to specific locations
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment search needs to reference specific waybill documents.
Trigger Criteria:
- Context: Equipment search needs to reference specific waybill documents
- Applied to: Set Waybill Key Parameters
- Action: Waybill key parameters are being set
Logic Flow:
IF Equipment search needs to reference specific waybill documents
AND Waybill key parameters are being set
THEN:
- • Primary waybill key and secondary key index are configured for document reference
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment search requires ordered sequence processing.
Trigger Criteria:
- Context: Equipment search requires ordered sequence processing
- Applied to: Configure Car Type Sequence
- Action: Car type sequence is being configured
Logic Flow:
IF Equipment search requires ordered sequence processing
AND Car type sequence is being configured
THEN:
- • Car sequence number and type sequence ID are set to define retrieval order
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when search targets specific equipment pieces.
Trigger Criteria:
- Context: Search targets specific equipment pieces
- Applied to: Set Equipment ID Criteria
- Action: Equipment ID criteria are being set
Logic Flow:
IF Search targets specific equipment pieces
AND Equipment ID criteria are being set
THEN:
- • Equipment ID format and car number parameters are configured for precise equipment identification
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when all search parameters have been configured.
Trigger Criteria:
- Context: All search parameters have been configured
- Applied to: Validate Search Parameter Combination
- Action: Parameter combination validation is performed
Logic Flow:
IF All search parameters have been configured
AND Parameter combination validation is performed
THEN:
- • System verifies that the parameter combination is valid and compatible for search execution
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when search parameters are validated and confirmed as compatible.
Trigger Criteria:
- Context: Search parameters are validated and confirmed as compatible
- Applied to: Execute Enhanced Search with FWCARGET
- Action: Enhanced search execution is initiated
Logic Flow:
IF Search parameters are validated and confirmed as compatible
AND Enhanced search execution is initiated
THEN:
- • FWCARGET service is called with all configured search parameters to retrieve equipment records
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when search parameters have been configured.
Trigger Criteria:
- Context: Search parameters have been configured
- Applied to: Search Configuration Error
- Action: Parameter validation fails due to incompatible combination
Logic Flow:
IF Search parameters have been configured
AND Parameter validation fails due to incompatible combination
THEN:
- • System sets search configuration error status and prevents search execution
R-GCX146-cbl-01441 (+10) File: GCX146.cbl Business Rule: Container XREF Processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when flat car equipment record exists in the system.
Trigger Criteria:
- Context: A flat car equipment record exists in the system
- Applied to: Search for T/C XREF Records
- Action: The system processes the flat car for container identification
Logic Flow:
IF A flat car equipment record exists in the system
AND The system processes the flat car for container identification
THEN:
- • The system searches the FW-IQ inquiry database for T/C XREF records matching the flat car
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when system has searched for t/c xref records for a flat car.
Trigger Criteria:
- Context: The system has searched for T/C XREF records for a flat car
- Applied to: XREF Record Found?
- Action: The search is completed
Logic Flow:
IF The system has searched for T/C XREF records for a flat car
AND The search is completed
THEN:
- • The system determines if any cross-reference records were found and proceeds with container processing if found, or handles the no-record scenario if not found
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when valid t/c xref records exist for a flat car.
Trigger Criteria:
- Context: Valid T/C XREF records exist for a flat car
- Applied to: Extract Container ID from XREF
- Action: The system processes each cross-reference record
Logic Flow:
IF Valid T/C XREF records exist for a flat car
AND The system processes each cross-reference record
THEN:
- • The system extracts the container ID from each XREF record for further validation and processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when container id has been extracted from a cross-reference record.
Trigger Criteria:
- Context: A container ID has been extracted from a cross-reference record
- Applied to: Validate Container ID Format
- Action: The system validates the container ID format
Logic Flow:
IF A container ID has been extracted from a cross-reference record
AND The system validates the container ID format
THEN:
- • The system verifies the container ID meets format requirements and is valid for processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container id has undergone format validation.
Trigger Criteria:
- Context: A container ID has undergone format validation
- Applied to: Container ID Valid?
- Action: The validation process is complete
Logic Flow:
IF A container ID has undergone format validation
AND The validation process is complete
THEN:
- • The system determines if the container ID is valid and proceeds with sequence assignment if valid, or handles the invalid ID error if not valid
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when container id has been validated as having correct format.
Trigger Criteria:
- Context: A container ID has been validated as having correct format
- Applied to: Set Container Sequence Number
- Action: The system processes the valid container
Logic Flow:
IF A container ID has been validated as having correct format
AND The system processes the valid container
THEN:
- • The system assigns a sequence number to the container for proper ordering and identification within the flat car's container list
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container has been validated and assigned a sequence number.
Trigger Criteria:
- Context: A container has been validated and assigned a sequence number
- Applied to: Store Container Information
- Action: The system completes container validation
Logic Flow:
IF A container has been validated and assigned a sequence number
AND The system completes container validation
THEN:
- • The system stores the container information including ID and sequence number for subsequent processing steps
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when system has processed one container from a flat car's cross-reference records.
Trigger Criteria:
- Context: The system has processed one container from a flat car's cross-reference records
- Applied to: More Containers?
- Action: The system checks for additional containers
Logic Flow:
IF The system has processed one container from a flat car's cross-reference records
AND The system checks for additional containers
THEN:
- • The system determines if more containers exist for the same flat car and continues processing if more exist, or completes container processing if no more exist
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when multiple containers exist on a flat car and one has been processed.
Trigger Criteria:
- Context: Multiple containers exist on a flat car and one has been processed
- Applied to: Process Next Container in Sequence
- Action: The system identifies additional containers to process
Logic Flow:
IF Multiple containers exist on a flat car and one has been processed
AND The system identifies additional containers to process
THEN:
- • The system processes the next container in sequence, extracting and validating its ID following the same validation rules
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when flat car is being processed for container identification.
Trigger Criteria:
- Context: A flat car is being processed for container identification
- Applied to: Handle XREF Not Found Error
- Action: No T/C XREF records are found in the inquiry database
Logic Flow:
IF A flat car is being processed for container identification
AND No T/C XREF records are found in the inquiry database
THEN:
- • The system handles the no cross-reference scenario and completes processing without container data
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when container id has been extracted from cross-reference records.
Trigger Criteria:
- Context: A container ID has been extracted from cross-reference records
- Applied to: Handle Invalid Container ID Error
- Action: The container ID fails format validation requirements
Logic Flow:
IF A container ID has been extracted from cross-reference records
AND The container ID fails format validation requirements
THEN:
- • The system handles the invalid container ID error and continues processing remaining containers or completes processing
R-GCX146-cbl-01452 (+11) File: GCX146.cbl Business Rule: Flat Car Container Sequence Management
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment record is being processed.
Trigger Criteria:
- Context: An equipment record is being processed
- Applied to: Set Flat Car Flag
- Action: The equipment type indicates it is a flat car capable of carrying containers
Logic Flow:
IF An equipment record is being processed
AND The equipment type indicates it is a flat car capable of carrying containers
THEN:
- • The system sets the flat car processing flag to enable container sequence management
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when flat car is being processed for container handling.
Trigger Criteria:
- Context: A flat car is being processed for container handling
- Applied to: Initialize Container Sequence Counter
- Action: Container sequence processing begins
Logic Flow:
IF A flat car is being processed for container handling
AND Container sequence processing begins
THEN:
- • The container sequence counter is initialized to zero to track container positions on the flat car
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when flat car requires container processing.
Trigger Criteria:
- Context: A flat car requires container processing
- Applied to: Access Container Records via Z510-GU-FWSWRWR
- Action: The system needs to identify containers on the flat car
Logic Flow:
IF A flat car requires container processing
AND The system needs to identify containers on the flat car
THEN:
- • The system accesses the FWSWRWR container records database using the Z510-GU-FWSWRWR procedure
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when system has attempted to retrieve container records for a flat car.
Trigger Criteria:
- Context: The system has attempted to retrieve container records for a flat car
- Applied to: Container Record Found?
- Action: The database lookup is completed
Logic Flow:
IF The system has attempted to retrieve container records for a flat car
AND The database lookup is completed
THEN:
- • The system determines if valid container records were found and branches processing accordingly
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when valid container record has been retrieved from the database.
Trigger Criteria:
- Context: A valid container record has been retrieved from the database
- Applied to: Extract Container ID from Record
- Action: Container identification is required for processing
Logic Flow:
IF A valid container record has been retrieved from the database
AND Container identification is required for processing
THEN:
- • The system extracts the container ID from the container record for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container id has been extracted from a container record.
Trigger Criteria:
- Context: A container ID has been extracted from a container record
- Applied to: Set Container Position Tracking
- Action: Container position management is required
Logic Flow:
IF A container ID has been extracted from a container record
AND Container position management is required
THEN:
- • The system establishes position tracking for the container including its sequential placement on the flat car
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container has been identified and positioned on the flat car.
Trigger Criteria:
- Context: A container has been identified and positioned on the flat car
- Applied to: Process Current Container
- Action: Container processing is required
Logic Flow:
IF A container has been identified and positioned on the flat car
AND Container processing is required
THEN:
- • The system processes the current container including status updates and detail recording
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container has been successfully processed.
Trigger Criteria:
- Context: A container has been successfully processed
- Applied to: Increment Sequence Counter
- Action: Moving to the next container in sequence
Logic Flow:
IF A container has been successfully processed
AND Moving to the next container in sequence
THEN:
- • The system increments the container sequence counter to maintain proper position tracking
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when current container has been processed and the sequence counter incremented.
Trigger Criteria:
- Context: The current container has been processed and the sequence counter incremented
- Applied to: Get Next Container in Sequence
- Action: Additional containers may exist on the flat car
Logic Flow:
IF The current container has been processed and the sequence counter incremented
AND Additional containers may exist on the flat car
THEN:
- • The system retrieves the next container record in the sequential order
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when container has been processed and the next container record has been attempted.
Trigger Criteria:
- Context: A container has been processed and the next container record has been attempted
- Applied to: More Containers on Flat Car?
- Action: Determining if container processing should continue
Logic Flow:
IF A container has been processed and the next container record has been attempted
AND Determining if container processing should continue
THEN:
- • The system evaluates whether more containers exist on the flat car and branches processing accordingly
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all containers on the flat car have been processed or no containers were found.
Trigger Criteria:
- Context: All containers on the flat car have been processed OR no containers were found
- Applied to: Complete Container Sequence Processing
- Action: Container sequence processing reaches completion
Logic Flow:
IF All containers on the flat car have been processed OR no containers were found
AND Container sequence processing reaches completion
THEN:
- • The system completes the container sequence processing and finalizes all container-related activities for the flat car
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when flat car has been identified for container processing.
Trigger Criteria:
- Context: A flat car has been identified for container processing
- Applied to: Handle Container Not Found
- Action: No container records are found in the FWSWRWR database
Logic Flow:
IF A flat car has been identified for container processing
AND No container records are found in the FWSWRWR database
THEN:
- • The system handles the container not found condition and proceeds to complete processing
R-GCX146-cbl-01464 (+5) File: GCX146.cbl Business Rule: CCN Status and Transit Status Cross
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment has ccn status of 'release' and transit status is either 'e' (export) or 'z' (export zone).
Trigger Criteria:
- Context: Equipment has CCN status of 'RELEASE' and transit status is either 'E' (Export) or 'Z' (Export Zone)
- Applied to: Set Status to 'EXPORT'
- Action: The system processes equipment status for trip sheet generation
Logic Flow:
IF Equipment has CCN status of 'RELEASE' and transit status is either 'E' (Export) or 'Z' (Export Zone)
AND The system processes equipment status for trip sheet generation
THEN:
- • The equipment status should be classified as 'EXPORT' on the trip sheet
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has ccn status of 'release' and transit status is not 'e' or 'z' and the release is designated as s.a.r. release.
Trigger Criteria:
- Context: Equipment has CCN status of 'RELEASE' and transit status is not 'E' or 'Z' and the release is designated as S.A.R. release
- Applied to: Set Status to 'S.A.R.'
- Action: The system processes equipment status for trip sheet generation
Logic Flow:
IF Equipment has CCN status of 'RELEASE' and transit status is not 'E' or 'Z' and the release is designated as S.A.R. release
AND The system processes equipment status for trip sheet generation
THEN:
- • The equipment status should be classified as 'S.A.R.' on the trip sheet
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has ccn status of 'release' and transit status is not 'e' or 'z' and does not have s.a.r. release designation.
Trigger Criteria:
- Context: Equipment has CCN status of 'RELEASE' and transit status is not 'E' or 'Z' and does not have S.A.R. release designation
- Applied to: Set Status to 'RELEASE'
- Action: The system processes equipment status for trip sheet generation
Logic Flow:
IF Equipment has CCN status of 'RELEASE' and transit status is not 'E' or 'Z' and does not have S.A.R. release designation
AND The system processes equipment status for trip sheet generation
THEN:
- • The equipment status should be classified as 'RELEASE' on the trip sheet
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has transit status of 't' (transit) and ccn status is not 'release'.
Trigger Criteria:
- Context: Equipment has transit status of 'T' (Transit) and CCN status is not 'RELEASE'
- Applied to: Set Status to 'TRANSIT'
- Action: The system processes equipment status for trip sheet generation
Logic Flow:
IF Equipment has transit status of 'T' (Transit) and CCN status is not 'RELEASE'
AND The system processes equipment status for trip sheet generation
THEN:
- • The equipment status should be classified as 'TRANSIT' on the trip sheet
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment has transit status of 'r' (return) and ccn status is not 'release' and transit status is not 't'.
Trigger Criteria:
- Context: Equipment has transit status of 'R' (Return) and CCN status is not 'RELEASE' and transit status is not 'T'
- Applied to: Set Status to 'RETURN'
- Action: The system processes equipment status for trip sheet generation
Logic Flow:
IF Equipment has transit status of 'R' (Return) and CCN status is not 'RELEASE' and transit status is not 'T'
AND The system processes equipment status for trip sheet generation
THEN:
- • The equipment status should be classified as 'RETURN' on the trip sheet
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment ccn status is not 'release' and transit status is not 't' or 'r'.
Trigger Criteria:
- Context: Equipment CCN status is not 'RELEASE' and transit status is not 'T' or 'R'
- Applied to: Maintain Current Status
- Action: The system processes equipment status for trip sheet generation
Logic Flow:
IF Equipment CCN status is not 'RELEASE' and transit status is not 'T' or 'R'
AND The system processes equipment status for trip sheet generation
THEN:
- • The equipment status should remain as the current CCN status on the trip sheet
R-GCX146-cbl-01470 (+6) File: GCX146.cbl Business Rule: Train ID Component Extraction and Formatting
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when train number component has been extracted from the input message.
Trigger Criteria:
- Context: A train number component has been extracted from the input message
- Applied to: Replace Spaces with Zeros in Train Number
- Action: The train number component contains one or more space characters
Logic Flow:
IF A train number component has been extracted from the input message
AND The train number component contains one or more space characters
THEN:
- • All space characters in the train number component are replaced with zero characters
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when train day component has been extracted from the input message.
Trigger Criteria:
- Context: A train day component has been extracted from the input message
- Applied to: Replace Spaces with Zeros in Train Day
- Action: The train day component contains one or more space characters
Logic Flow:
IF A train day component has been extracted from the input message
AND The train day component contains one or more space characters
THEN:
- • All space characters in the train day component are replaced with zero characters
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when from station component has been extracted from the input message.
Trigger Criteria:
- Context: A from station component has been extracted from the input message
- Applied to: Replace Spaces with Zeros in From Station
- Action: The from station component contains one or more space characters
Logic Flow:
IF A from station component has been extracted from the input message
AND The from station component contains one or more space characters
THEN:
- • All space characters in the from station component are replaced with zero characters
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when to station component has been extracted from the input message.
Trigger Criteria:
- Context: A to station component has been extracted from the input message
- Applied to: Replace Spaces with Zeros in To Station
- Action: The to station component contains one or more space characters
Logic Flow:
IF A to station component has been extracted from the input message
AND The to station component contains one or more space characters
THEN:
- • All space characters in the to station component are replaced with zero characters
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when consist number component has been extracted from the input message.
Trigger Criteria:
- Context: A consist number component has been extracted from the input message
- Applied to: Replace Spaces with Zeros in Consist Number
- Action: The consist number component contains one or more space characters
Logic Flow:
IF A consist number component has been extracted from the input message
AND The consist number component contains one or more space characters
THEN:
- • All space characters in the consist number component are replaced with zero characters
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when all train components have been extracted and formatted with spaces replaced by zeros. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: All train components have been extracted and formatted with spaces replaced by zeros
- Applied to: Build WS-CUSTOMS-TRAIN-ID
- Action: Building the customs train ID
Logic Flow:
IF All train components have been extracted and formatted with spaces replaced by zeros
AND Building the customs train ID
THEN:
- • The customs train ID is constructed by concatenating train number, train day, from station, to station, consist number, and system date components in sequence
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when all train components have been extracted and formatted with spaces replaced by zeros.
Trigger Criteria:
- Context: All train components have been extracted and formatted with spaces replaced by zeros
- Applied to: Build GCWB4TL-CP-TRAIN-ID
- Action: Building the CP train ID
Logic Flow:
IF All train components have been extracted and formatted with spaces replaced by zeros
AND Building the CP train ID
THEN:
- • The CP train ID is constructed using the same concatenated components as the customs train ID
R-GCX146-cbl-01477 (+12) File: GCX146.cbl Business Rule: Equipment Type Code Assignment Logic
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment record with car type and container indicators are available.
Trigger Criteria:
- Context: Equipment record with car type and container indicators are available
- Applied to: Is Container Equipment?
- Action: Equipment is identified as container equipment
Logic Flow:
IF Equipment record with car type and container indicators are available
AND Equipment is identified as container equipment
THEN:
- • System checks container load status and assigns container-specific type code
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment is confirmed as container equipment.
Trigger Criteria:
- Context: Equipment is confirmed as container equipment
- Applied to: Container Loaded?
- Action: Container load status indicates loaded condition
Logic Flow:
IF Equipment is confirmed as container equipment
AND Container load status indicates loaded condition
THEN:
- • System assigns loaded container type code
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment is confirmed as container equipment.
Trigger Criteria:
- Context: Equipment is confirmed as container equipment
- Applied to: Assign Empty Container Code
- Action: Container load status indicates empty condition
Logic Flow:
IF Equipment is confirmed as container equipment
AND Container load status indicates empty condition
THEN:
- • System assigns empty container type code
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment is not container equipment.
Trigger Criteria:
- Context: Equipment is not container equipment
- Applied to: Is Trailer Equipment?
- Action: Equipment type indicators are evaluated for trailer classification
Logic Flow:
IF Equipment is not container equipment
AND Equipment type indicators are evaluated for trailer classification
THEN:
- • System identifies equipment as trailer or proceeds to rail car classification
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment is confirmed as trailer equipment.
Trigger Criteria:
- Context: Equipment is confirmed as trailer equipment
- Applied to: Trailer Loaded?
- Action: Trailer load status indicates loaded condition
Logic Flow:
IF Equipment is confirmed as trailer equipment
AND Trailer load status indicates loaded condition
THEN:
- • System assigns loaded trailer type code
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment is confirmed as trailer equipment.
Trigger Criteria:
- Context: Equipment is confirmed as trailer equipment
- Applied to: Assign Empty Trailer Code
- Action: Trailer load status indicates empty condition
Logic Flow:
IF Equipment is confirmed as trailer equipment
AND Trailer load status indicates empty condition
THEN:
- • System assigns empty trailer type code
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment is rail car type (not container or trailer).
Trigger Criteria:
- Context: Equipment is rail car type (not container or trailer)
- Applied to: Is Flat Car?
- Action: Car type indicates flat car classification
Logic Flow:
IF Equipment is rail car type (not container or trailer)
AND Car type indicates flat car classification
THEN:
- • System assigns flat car type code
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment is rail car type and not a flat car.
Trigger Criteria:
- Context: Equipment is rail car type and not a flat car
- Applied to: Is Tank Car?
- Action: Car type indicates tank car classification
Logic Flow:
IF Equipment is rail car type and not a flat car
AND Car type indicates tank car classification
THEN:
- • System assigns tank car type code
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment is rail car type and not flat car or tank car.
Trigger Criteria:
- Context: Equipment is rail car type and not flat car or tank car
- Applied to: Is Box Car?
- Action: Car type indicates box car classification
Logic Flow:
IF Equipment is rail car type and not flat car or tank car
AND Car type indicates box car classification
THEN:
- • System assigns box car type code
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment is rail car type.
Trigger Criteria:
- Context: Equipment is rail car type
- Applied to: Assign General Car Code
- Action: Car type does not match flat car, tank car, or box car classifications
Logic Flow:
IF Equipment is rail car type
AND Car type does not match flat car, tank car, or box car classifications
THEN:
- • System assigns general car type code
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment type code has been assigned.
Trigger Criteria:
- Context: Equipment type code has been assigned
- Applied to: Equipment Loaded?
- Action: Equipment load status is evaluated
Logic Flow:
IF Equipment type code has been assigned
AND Equipment load status is evaluated
THEN:
- • System sets appropriate load status flag (loaded or empty)
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment load status has been determined.
Trigger Criteria:
- Context: Equipment load status has been determined
- Applied to: Set Load Status Flag
- Action: Equipment is confirmed as loaded
Logic Flow:
IF Equipment load status has been determined
AND Equipment is confirmed as loaded
THEN:
- • System sets load status flag to indicate loaded condition
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment load status has been determined.
Trigger Criteria:
- Context: Equipment load status has been determined
- Applied to: Set Empty Status Flag
- Action: Equipment is confirmed as empty
Logic Flow:
IF Equipment load status has been determined
AND Equipment is confirmed as empty
THEN:
- • System sets empty status flag to indicate empty condition
R-GCX146-cbl-01490 (+9) File: GCX146.cbl Business Rule: CCN Format Validation and Construction Rules
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when return cargo ccn needs to be created.
Trigger Criteria:
- Context: A return cargo CCN needs to be created
- Applied to: Construct CCN Prefix '6105E'
- Action: The system constructs the CCN identifier
Logic Flow:
IF A return cargo CCN needs to be created
AND The system constructs the CCN identifier
THEN:
- • The CCN must start with the standard prefix '6105E'
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment id from waybill data.
Trigger Criteria:
- Context: An equipment ID from waybill data
- Applied to: Build Equipment ID Component
- Action: The equipment ID is being formatted for CCN construction
Logic Flow:
IF An equipment ID from waybill data
AND The equipment ID is being formatted for CCN construction
THEN:
- • The equipment ID must be exactly 10 characters in length and padded with spaces if necessary
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment id extracted from waybill.
Trigger Criteria:
- Context: An equipment ID extracted from waybill
- Applied to: Equipment ID Length Valid?
- Action: The system validates the equipment ID length
Logic Flow:
IF An equipment ID extracted from waybill
AND The system validates the equipment ID length
THEN:
- • If the equipment ID is less than 10 characters, it must be padded with spaces to reach exactly 10 characters
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill date components (year, month, day).
Trigger Criteria:
- Context: Waybill date components (year, month, day)
- Applied to: Format Date Component YYMMDD
- Action: The date is being formatted for CCN construction
Logic Flow:
IF Waybill date components (year, month, day)
AND The date is being formatted for CCN construction
THEN:
- • The date must be formatted as YYMMDD with 2-digit year, 2-digit month, and 2-digit day
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn prefix '6105e', formatted equipment id, and formatted date.
Trigger Criteria:
- Context: CCN prefix '6105E', formatted equipment ID, and formatted date
- Applied to: Concatenate CCN Components
- Action: The system constructs the complete CCN
Logic Flow:
IF CCN prefix '6105E', formatted equipment ID, and formatted date
AND The system constructs the complete CCN
THEN:
- • The CCN must be formed by concatenating prefix + equipment ID + date in that exact order
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when constructed ccn string.
Trigger Criteria:
- Context: A constructed CCN string
- Applied to: Validate CCN Format Structure
- Action: The system validates the CCN format
Logic Flow:
IF A constructed CCN string
AND The system validates the CCN format
THEN:
- • The CCN must have exactly 22 characters total length, start with '6105E', contain valid equipment ID, and end with valid YYMMDD date
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when constructed ccn with all components.
Trigger Criteria:
- Context: A constructed CCN with all components
- Applied to: CCN Format Valid?
- Action: The system checks format compliance
Logic Flow:
IF A constructed CCN with all components
AND The system checks format compliance
THEN:
- • If the CCN format is invalid, processing must stop with format error; if valid, processing continues to status assignment
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when valid ccn format has been constructed.
Trigger Criteria:
- Context: A valid CCN format has been constructed
- Applied to: Set CCN Status to 'RETURN'
- Action: The system assigns status to the CCN
Logic Flow:
IF A valid CCN format has been constructed
AND The system assigns status to the CCN
THEN:
- • The CCN status must be set to 'RETURN' to indicate return cargo processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn with return status assigned.
Trigger Criteria:
- Context: A CCN with return status assigned
- Applied to: Set Transit Status to 'R'
- Action: The system sets transit status
Logic Flow:
IF A CCN with return status assigned
AND The system sets transit status
THEN:
- • The transit status must be set to 'R' to indicate return movement
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn with valid format, return status, and transit status.
Trigger Criteria:
- Context: A CCN with valid format, return status, and transit status
- Applied to: Assign CCN Key Fields
- Action: The system assigns key fields
Logic Flow:
IF A CCN with valid format, return status, and transit status
AND The system assigns key fields
THEN:
- • All CCN key fields including equipment ID, waybill date, and sequence must be properly assigned for database storage
R-GCX146-cbl-01500 (+16) File: GCX146.cbl Business Rule: Broker Channel Priority and Fallback Logic
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when broker notification needs to be sent and primary broker configuration is checked.
Trigger Criteria:
- Context: A broker notification needs to be sent and primary broker configuration is checked
- Applied to: X12 EDI Channel Available?
- Action: The system evaluates available notification channels
Logic Flow:
IF A broker notification needs to be sent and primary broker configuration is checked
AND The system evaluates available notification channels
THEN:
- • X12 EDI channel is selected as the first priority if available
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when x12 edi channel is available and selected for broker notification.
Trigger Criteria:
- Context: X12 EDI channel is available and selected for broker notification
- Applied to: Send via X12 EDI - GCCS309C
- Action: The system initiates X12 EDI transmission
Logic Flow:
IF X12 EDI channel is available and selected for broker notification
AND The system initiates X12 EDI transmission
THEN:
- • GCCS309C program is invoked to process the X12 EDI notification
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when x12 edi transmission has been attempted via gccs309c.
Trigger Criteria:
- Context: X12 EDI transmission has been attempted via GCCS309C
- Applied to: X12 Transmission Successful?
- Action: The system checks the transmission result
Logic Flow:
IF X12 EDI transmission has been attempted via GCCS309C
AND The system checks the transmission result
THEN:
- • If successful, primary notification is marked complete,
otherwise fallback to next channel
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when x12 edi channel is either unavailable or transmission failed.
Trigger Criteria:
- Context: X12 EDI channel is either unavailable or transmission failed
- Applied to: Merlin Channel Available?
- Action: The system evaluates the next available notification channel
Logic Flow:
IF X12 EDI channel is either unavailable or transmission failed
AND The system evaluates the next available notification channel
THEN:
- • Merlin channel is selected if available as the second priority option
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when merlin channel is available and selected for broker notification.
Trigger Criteria:
- Context: Merlin channel is available and selected for broker notification
- Applied to: Send via Merlin - GCX019
- Action: The system initiates Merlin transmission
Logic Flow:
IF Merlin channel is available and selected for broker notification
AND The system initiates Merlin transmission
THEN:
- • GCX019 program is invoked to process the Merlin notification
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when merlin transmission has been attempted via gcx019.
Trigger Criteria:
- Context: Merlin transmission has been attempted via GCX019
- Applied to: Merlin Transmission Successful?
- Action: The system checks the transmission result
Logic Flow:
IF Merlin transmission has been attempted via GCX019
AND The system checks the transmission result
THEN:
- • If successful, primary notification is marked complete,
otherwise fallback to next channel
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when both x12 edi and merlin channels are either unavailable or transmissions failed.
Trigger Criteria:
- Context: Both X12 EDI and Merlin channels are either unavailable or transmissions failed
- Applied to: Internet Channel Available?
- Action: The system evaluates the next available notification channel
Logic Flow:
IF Both X12 EDI and Merlin channels are either unavailable or transmissions failed
AND The system evaluates the next available notification channel
THEN:
- • Internet channel is selected if available as the third priority option
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when internet channel is available and selected for broker notification.
Trigger Criteria:
- Context: Internet channel is available and selected for broker notification
- Applied to: Send via Internet - GCX019
- Action: The system initiates Internet transmission
Logic Flow:
IF Internet channel is available and selected for broker notification
AND The system initiates Internet transmission
THEN:
- • GCX019 program is invoked to process the Internet notification
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when internet transmission has been attempted via gcx019.
Trigger Criteria:
- Context: Internet transmission has been attempted via GCX019
- Applied to: Internet Transmission Successful?
- Action: The system checks the transmission result
Logic Flow:
IF Internet transmission has been attempted via GCX019
AND The system checks the transmission result
THEN:
- • If successful, primary notification is marked complete,
otherwise fallback to next channel
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when x12 edi, merlin, and internet channels are either unavailable or transmissions failed.
Trigger Criteria:
- Context: X12 EDI, Merlin, and Internet channels are either unavailable or transmissions failed
- Applied to: FAX Channel Available?
- Action: The system evaluates the next available notification channel
Logic Flow:
IF X12 EDI, Merlin, and Internet channels are either unavailable or transmissions failed
AND The system evaluates the next available notification channel
THEN:
- • FAX channel is selected if available as the fourth priority option
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when fax channel is available and selected for broker notification.
Trigger Criteria:
- Context: FAX channel is available and selected for broker notification
- Applied to: Send via FAX - GCX019
- Action: The system initiates FAX transmission
Logic Flow:
IF FAX channel is available and selected for broker notification
AND The system initiates FAX transmission
THEN:
- • GCX019 program is invoked to process the FAX notification
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when fax transmission has been attempted via gcx019.
Trigger Criteria:
- Context: FAX transmission has been attempted via GCX019
- Applied to: FAX Transmission Successful?
- Action: The system checks the transmission result
Logic Flow:
IF FAX transmission has been attempted via GCX019
AND The system checks the transmission result
THEN:
- • If successful, primary notification is marked complete,
otherwise fallback to paper notification
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when all electronic notification channels (x12 edi, merlin, internet, fax) are either unavailable or failed.
Trigger Criteria:
- Context: All electronic notification channels (X12 EDI, Merlin, Internet, FAX) are either unavailable or failed
- Applied to: Generate Paper Notification
- Action: The system needs to complete broker notification
Logic Flow:
IF All electronic notification channels (X12 EDI, Merlin, Internet, FAX) are either unavailable or failed
AND The system needs to complete broker notification
THEN:
- • Paper notification is generated as the final fallback option
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when paper notification has been selected as the delivery method. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Paper notification has been selected as the delivery method
- Applied to: Call Batch Print Letters
- Action: The system processes the paper notification request
Logic Flow:
IF Paper notification has been selected as the delivery method
AND The system processes the paper notification request
THEN:
- • Batch print letters program is called to generate physical notification documents
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when primary broker notification has been completed (successfully or via paper).
Trigger Criteria:
- Context: Primary broker notification has been completed (successfully or via paper)
- Applied to: Secondary Broker Exists?
- Action: The system checks for additional broker notification requirements
Logic Flow:
IF Primary broker notification has been completed (successfully or via paper)
AND The system checks for additional broker notification requirements
THEN:
- • If secondary broker exists, the same channel priority process is repeated for secondary broker
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when secondary broker exists and requires notification.
Trigger Criteria:
- Context: Secondary broker exists and requires notification
- Applied to: Repeat Channel Priority for Secondary Broker
- Action: The system processes secondary broker notification
Logic Flow:
IF Secondary broker exists and requires notification
AND The system processes secondary broker notification
THEN:
- • The same channel priority sequence (X12 EDI, Merlin, Internet, FAX, Paper) is applied for secondary broker
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when any notification channel transmission fails (x12 edi, merlin, internet, or fax).
Trigger Criteria:
- Context: Any notification channel transmission fails (X12 EDI, Merlin, Internet, or FAX)
- Applied to: Log Failed Transmission
- Action: The system detects the transmission failure
Logic Flow:
IF Any notification channel transmission fails (X12 EDI, Merlin, Internet, or FAX)
AND The system detects the transmission failure
THEN:
- • The failed transmission is logged before attempting the next fallback channel
R-GCX146-cbl-01517 (+12) File: GCX146.cbl Business Rule: Email User List Processing and Validation
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when station code is provided for email configuration lookup.
Trigger Criteria:
- Context: A station code is provided for email configuration lookup
- Applied to: Access Station Configuration Table
- Action: The system accesses the station configuration table
Logic Flow:
IF A station code is provided for email configuration lookup
AND The system accesses the station configuration table
THEN:
- • The station's email configuration data is retrieved for processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when station configuration data is available.
Trigger Criteria:
- Context: Station configuration data is available
- Applied to: Retrieve AECWRKTB Email Configuration
- Action: The system queries AECWRKTB email configuration table
Logic Flow:
IF Station configuration data is available
AND The system queries AECWRKTB email configuration table
THEN:
- • Email user configuration data is retrieved for the station
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when email configuration data has been retrieved from aecwrktb table.
Trigger Criteria:
- Context: Email configuration data has been retrieved from AECWRKTB table
- Applied to: Email Users Found?
- Action: The system checks for the presence of email users
Logic Flow:
IF Email configuration data has been retrieved from AECWRKTB table
AND The system checks for the presence of email users
THEN:
- • Processing continues if email users are found,
otherwise an email configuration error is raised
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when email users are found in the configuration.
Trigger Criteria:
- Context: Email users are found in the configuration
- Applied to: Extract First Email User ID
- Action: The system processes the email user list
Logic Flow:
IF Email users are found in the configuration
AND The system processes the email user list
THEN:
- • The first email user ID is extracted for validation
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when email user id has been extracted from the configuration.
Trigger Criteria:
- Context: An email user ID has been extracted from the configuration
- Applied to: Validate Email User ID Format
- Action: The system validates the email user ID format
Logic Flow:
IF An email user ID has been extracted from the configuration
AND The system validates the email user ID format
THEN:
- • The user ID is accepted if it meets format requirements,
otherwise it is rejected
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when email user id has passed format validation.
Trigger Criteria:
- Context: An email user ID has passed format validation
- Applied to: Add User to Email Distribution List
- Action: The system processes the valid email user
Logic Flow:
IF An email user ID has passed format validation
AND The system processes the valid email user
THEN:
- • The user is added to the email distribution list
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when email user has been processed (valid or invalid).
Trigger Criteria:
- Context: An email user has been processed (valid or invalid)
- Applied to: Check for Additional Email Users
- Action: The system checks for additional email users in the configuration
Logic Flow:
IF An email user has been processed (valid or invalid)
AND The system checks for additional email users in the configuration
THEN:
- • Processing continues with next user if available,
otherwise proceeds to finalize the list
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when additional email users are available in the configuration.
Trigger Criteria:
- Context: Additional email users are available in the configuration
- Applied to: Extract Next Email User ID
- Action: The system processes the next email user
Logic Flow:
IF Additional email users are available in the configuration
AND The system processes the next email user
THEN:
- • The next email user ID is extracted for validation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when all email users have been processed and validated.
Trigger Criteria:
- Context: All email users have been processed and validated
- Applied to: Set Primary Email Distribution
- Action: The system sets up the primary email distribution
Logic Flow:
IF All email users have been processed and validated
AND The system sets up the primary email distribution
THEN:
- • A primary email distribution list is established with all valid users
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when primary email distribution has been attempted.
Trigger Criteria:
- Context: Primary email distribution has been attempted
- Applied to: Primary Email Failed?
- Action: The system checks the success of primary email setup
Logic Flow:
IF Primary email distribution has been attempted
AND The system checks the success of primary email setup
THEN:
- • Fallback procedures are initiated if primary email failed,
otherwise processing continues normally
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when primary email distribution has failed.
Trigger Criteria:
- Context: Primary email distribution has failed
- Applied to: Set Fallback Email Recipients
- Action: The system sets up fallback email recipients
Logic Flow:
IF Primary email distribution has failed
AND The system sets up fallback email recipients
THEN:
- • Alternative email recipients are configured to ensure message delivery
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when fallback email recipients are being configured.
Trigger Criteria:
- Context: Fallback email recipients are being configured
- Applied to: Use OM01247/AEI9999 as Backup
- Action: The system assigns backup email addresses
Logic Flow:
IF Fallback email recipients are being configured
AND The system assigns backup email addresses
THEN:
- • OM01247 and AEI9999 are set as backup email recipients
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when email distribution setup is complete (either primary or fallback).
Trigger Criteria:
- Context: Email distribution setup is complete (either primary or fallback)
- Applied to: Finalize Email User List
- Action: The system finalizes the email user list
Logic Flow:
IF Email distribution setup is complete (either primary or fallback)
AND The system finalizes the email user list
THEN:
- • The email user list is prepared and ready for message distribution
R-GCX146-cbl-01530 (+8) File: GCX146.cbl Business Rule: Report Line Segmentation and Buffer Management
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when email report processing session is starting. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: An email report processing session is starting
- Applied to: Initialize Line Counter WS-LINE-SUB
- Action: The system begins processing report lines for email transmission
Logic Flow:
IF An email report processing session is starting
AND The system begins processing report lines for email transmission
THEN:
- • The line counter should be initialized to zero to start counting from the beginning
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when email report is being processed with accumulated lines.
Trigger Criteria:
- Context: An email report is being processed with accumulated lines
- Applied to: Line Counter > 699?
- Action: The line counter exceeds 699 lines in the current email segment
Logic Flow:
IF An email report is being processed with accumulated lines
AND The line counter exceeds 699 lines in the current email segment
THEN:
- • The current email batch should be sent and a new email segment should be prepared
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when email report batch has reached the maximum line limit of 699 lines. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: An email report batch has reached the maximum line limit of 699 lines
- Applied to: Call X280-CALL-EMCSEND3 to Send Current Batch
- Action: The system needs to send the current batch
Logic Flow:
IF An email report batch has reached the maximum line limit of 699 lines
AND The system needs to send the current batch
THEN:
- • The email sending service should be invoked to transmit the current batch
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when email batch has been sent successfully.
Trigger Criteria:
- Context: An email batch has been sent successfully
- Applied to: Reset Message Buffer
- Action: The system needs to prepare for additional report lines
Logic Flow:
IF An email batch has been sent successfully
AND The system needs to prepare for additional report lines
THEN:
- • The message buffer should be cleared and reset for the next email segment
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when email report has been split into multiple segments due to line limits.
Trigger Criteria:
- Context: An email report has been split into multiple segments due to line limits
- Applied to: Add CONTINUATION OF REPORT Header
- Action: A new email segment is being prepared after the first segment
Logic Flow:
IF An email report has been split into multiple segments due to line limits
AND A new email segment is being prepared after the first segment
THEN:
- • A 'CONTINUATION OF REPORT' header should be added to identify the segment as a continuation
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when new email segment is being prepared after sending a previous batch.
Trigger Criteria:
- Context: A new email segment is being prepared after sending a previous batch
- Applied to: Reset Line Counter
- Action: The system starts processing lines for the new segment
Logic Flow:
IF A new email segment is being prepared after sending a previous batch
AND The system starts processing lines for the new segment
THEN:
- • The line counter should be reset to zero to track lines in the new segment
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when email report is being processed with multiple segments.
Trigger Criteria:
- Context: An email report is being processed with multiple segments
- Applied to: Reached Maximum 1981 Lines?
- Action: The total number of lines processed reaches 1981 lines
Logic Flow:
IF An email report is being processed with multiple segments
AND The total number of lines processed reaches 1981 lines
THEN:
- • The maximum lines reached flag should be set and no additional lines should be processed
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when email report processing has reached the maximum limit of 1981 lines.
Trigger Criteria:
- Context: The email report processing has reached the maximum limit of 1981 lines
- Applied to: Set MAX-LINES-REACHED Flag
- Action: The system detects the line limit has been exceeded
Logic Flow:
IF The email report processing has reached the maximum limit of 1981 lines
AND The system detects the line limit has been exceeded
THEN:
- • The MAX-LINES-REACHED flag should be set to prevent further line processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when all available report lines have been processed for email transmission.
Trigger Criteria:
- Context: All available report lines have been processed for email transmission
- Applied to: Set NO-MORE-EMAIL Flag
- Action: There are no more lines to process in the report
Logic Flow:
IF All available report lines have been processed for email transmission
AND There are no more lines to process in the report
THEN:
- • The NO-MORE-EMAIL flag should be set to indicate completion of email processing
R-GCX146-cbl-01539 (+10) File: GCX146.cbl Business Rule: FAX Routing Parameter Configuration
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when station configuration record exists in gcstbrt.
Trigger Criteria:
- Context: A station configuration record exists in GCSTBRT
- Applied to: Check Auto-FAX Setting
- Action: The system checks the Auto-FAX setting
Logic Flow:
IF A station configuration record exists in GCSTBRT
AND The system checks the Auto-FAX setting
THEN:
- • The system reads the GCSTBRT-AD-AUTO-FAX field to determine if automatic FAX is enabled
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when auto-fax setting has been retrieved from station configuration.
Trigger Criteria:
- Context: The Auto-FAX setting has been retrieved from station configuration
- Applied to: Auto-FAX Enabled?
- Action: The GCSTBRT-AD-AUTO-FAX field equals 'Y'
Logic Flow:
IF The Auto-FAX setting has been retrieved from station configuration
AND The GCSTBRT-AD-AUTO-FAX field equals 'Y'
THEN:
- • The system proceeds to set FAX routing flag,
otherwise skips FAX configuration
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when auto-fax is enabled (gcstbrt-ad-auto-fax = 'y'). ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Auto-FAX is enabled (GCSTBRT-AD-AUTO-FAX = 'Y')
- Applied to: Set FAX Routing Flag
- Action: The system processes FAX routing configuration
Logic Flow:
IF Auto-FAX is enabled (GCSTBRT-AD-AUTO-FAX = 'Y')
AND The system processes FAX routing configuration
THEN:
- • The system sets WS-FAX-ROUTING to 'Y' to enable FAX routing functionality
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when fax routing flag has been set to 'y'. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: FAX routing flag has been set to 'Y'
- Applied to: Configure Copy Distribution IDs
- Action: The system configures copy distribution parameters
Logic Flow:
IF FAX routing flag has been set to 'Y'
AND The system configures copy distribution parameters
THEN:
- • The system sets up copy distribution IDs for proper FAX message routing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when copy distribution ids have been configured. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Copy distribution IDs have been configured
- Applied to: Set External FAX Addressing
- Action: The system sets up external FAX addressing
Logic Flow:
IF Copy distribution IDs have been configured
AND The system sets up external FAX addressing
THEN:
- • The system configures external FAX address parameters for proper message delivery
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when external fax addressing has been configured.
Trigger Criteria:
- Context: External FAX addressing has been configured
- Applied to: Apply Station FAX Configuration
- Action: The system applies station FAX configuration
Logic Flow:
IF External FAX addressing has been configured
AND The system applies station FAX configuration
THEN:
- • The system retrieves and applies station-specific FAX settings from GCSTBRT configuration
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when station fax configuration has been applied.
Trigger Criteria:
- Context: Station FAX configuration has been applied
- Applied to: Station FAX Flag Set?
- Action: The system checks the station FAX flag (GCSTBRT-SC-FAX-FLAG)
Logic Flow:
IF Station FAX configuration has been applied
AND The system checks the station FAX flag (GCSTBRT-SC-FAX-FLAG)
THEN:
- • The system determines whether to enable FAX routing based on the flag setting
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when station fax flag is set in the configuration.
Trigger Criteria:
- Context: Station FAX flag is set in the configuration
- Applied to: Enable FAX Routing
- Action: The system enables FAX routing
Logic Flow:
IF Station FAX flag is set in the configuration
AND The system enables FAX routing
THEN:
- • The system activates FAX routing capabilities for the station
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when fax routing has been enabled.
Trigger Criteria:
- Context: FAX routing has been enabled
- Applied to: Configure FAX Parameters
- Action: The system configures FAX parameters
Logic Flow:
IF FAX routing has been enabled
AND The system configures FAX parameters
THEN:
- • The system applies final FAX routing settings and completes the configuration process
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when fax configuration process has been executed (either enabled or skipped).
Trigger Criteria:
- Context: FAX configuration process has been executed (either enabled or skipped)
- Applied to: Complete FAX Configuration
- Action: The system completes FAX configuration
Logic Flow:
IF FAX configuration process has been executed (either enabled or skipped)
AND The system completes FAX configuration
THEN:
- • The system finalizes the FAX routing configuration and continues with normal processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when either auto-fax is disabled (gcstbrt-ad-auto-fax ≠ 'y') or station fax flag is not set.
Trigger Criteria:
- Context: Either Auto-FAX is disabled (GCSTBRT-AD-AUTO-FAX ≠ 'Y') or station FAX flag is not set
- Applied to: Skip FAX Configuration
- Action: The system processes FAX configuration
Logic Flow:
IF Either Auto-FAX is disabled (GCSTBRT-AD-AUTO-FAX ≠ 'Y') or station FAX flag is not set
AND The system processes FAX configuration
THEN:
- • The system skips all FAX routing configuration steps and proceeds to completion
R-GCX146-cbl-01550 (+7) File: GCX146.cbl Business Rule: Message Line Formatting and Segmentation Rules
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when email message is being prepared for transmission.
Trigger Criteria:
- Context: An email message is being prepared for transmission
- Applied to: Line Count > 699?
- Action: The system counts the number of lines in the message
Logic Flow:
IF An email message is being prepared for transmission
AND The system counts the number of lines in the message
THEN:
- • If line count exceeds 699 lines, the system triggers message segmentation process
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when email message exceeds 699 lines.
Trigger Criteria:
- Context: An email message exceeds 699 lines
- Applied to: Apply Line Segmentation
- Action: The system applies line segmentation
Logic Flow:
IF An email message exceeds 699 lines
AND The system applies line segmentation
THEN:
- • The message is split into segments of maximum 699 lines each for separate transmission
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when message has been segmented due to line count exceeding 699.
Trigger Criteria:
- Context: A message has been segmented due to line count exceeding 699
- Applied to: Add Continuation Header
- Action: The system processes continuation segments
Logic Flow:
IF A message has been segmented due to line count exceeding 699
AND The system processes continuation segments
THEN:
- • Each continuation segment includes header 'CONTINUATION OF REPORT ....' to identify it as part of original message
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when message segment has been sent for transmission.
Trigger Criteria:
- Context: A message segment has been sent for transmission
- Applied to: Reset Message Buffer
- Action: The system prepares for the next message segment
Logic Flow:
IF A message segment has been sent for transmission
AND The system prepares for the next message segment
THEN:
- • The message buffer is reset to prepare for new content
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when message batch is ready for transmission.
Trigger Criteria:
- Context: A message batch is ready for transmission
- Applied to: Send Current Message Batch
- Action: The system initiates transmission process
Logic Flow:
IF A message batch is ready for transmission
AND The system initiates transmission process
THEN:
- • The EMCSEND3 email service is invoked to deliver the message
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when message content is ready for formatting.
Trigger Criteria:
- Context: Message content is ready for formatting
- Applied to: Apply Merlin Transmission Rules
- Action: The system applies Merlin transmission rules
Logic Flow:
IF Message content is ready for formatting
AND The system applies Merlin transmission rules
THEN:
- • Message is formatted according to Merlin system requirements for proper transmission
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when report lines are being processed for message formatting.
Trigger Criteria:
- Context: Report lines are being processed for message formatting
- Applied to: More Lines to Process?
- Action: The system checks for remaining unprocessed lines
Logic Flow:
IF Report lines are being processed for message formatting
AND The system checks for remaining unprocessed lines
THEN:
- • If more lines exist, processing continues;
otherwise, message formatting is finalized
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all report lines have been processed and formatted.
Trigger Criteria:
- Context: All report lines have been processed and formatted
- Applied to: Finalize Message Format
- Action: No more lines remain to be processed
Logic Flow:
IF All report lines have been processed and formatted
AND No more lines remain to be processed
THEN:
- • The system finalizes the message format and prepares it for transmission
R-GCX146-cbl-01558 (+11) File: GCX146.cbl Business Rule: Return Movement Pattern Analysis
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when cargo shipment with origin and destination information.
Trigger Criteria:
- Context: A cargo shipment with origin and destination information
- Applied to: Analyze Cargo Movement Patterns to Identify Valid Return Scenarios from US to Canada
- Action: The system analyzes the movement pattern
Logic Flow:
IF A cargo shipment with origin and destination information
AND The system analyzes the movement pattern
THEN:
- • The system determines if this represents a valid US to Canada return movement based on origin/destination codes
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when cargo with origin and destination location codes.
Trigger Criteria:
- Context: Cargo with origin and destination location codes
- Applied to: Cargo Moving from US to Canada?
- Action: The origin is a US state code and destination is a Canadian province code
Logic Flow:
IF Cargo with origin and destination location codes
AND The origin is a US state code and destination is a Canadian province code
THEN:
- • The system identifies this as a US to Canada movement eligible for return processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment identified for potential return movement.
Trigger Criteria:
- Context: Equipment identified for potential return movement
- Applied to: Check Equipment Waybill Data
- Action: The system checks for associated waybill data
Logic Flow:
IF Equipment identified for potential return movement
AND The system checks for associated waybill data
THEN:
- • The system retrieves waybill information including shipper, consignee, and routing details
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when destination location code from waybill data.
Trigger Criteria:
- Context: A destination location code from waybill data
- Applied to: Validate Canadian Destination
- Action: The destination code is checked against Canadian province list (NF, PE, NS, NB, PQ, ON, MB, SK, AB, BC, YT, NT)
Logic Flow:
IF A destination location code from waybill data
AND The destination code is checked against Canadian province list (NF, PE, NS, NB, PQ, ON, MB, SK, AB, BC, YT, NT)
THEN:
- • The system confirms if the destination is a valid Canadian location
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo movement from us to canada with valid waybill and destination data.
Trigger Criteria:
- Context: Cargo movement from US to Canada with valid waybill and destination data
- Applied to: Valid Return Scenario?
- Action: All return movement criteria are evaluated
Logic Flow:
IF Cargo movement from US to Canada with valid waybill and destination data
AND All return movement criteria are evaluated
THEN:
- • The system determines if this qualifies as a valid return scenario for CCN processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when valid waybill data for return movement.
Trigger Criteria:
- Context: Valid waybill data for return movement
- Applied to: Extract Shipper/Consignee Information
- Action: The system processes the waybill information
Logic Flow:
IF Valid waybill data for return movement
AND The system processes the waybill information
THEN:
- • The system extracts shipper name, consignee name, and related party information for CCN record creation
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when valid return movement with equipment and waybill data.
Trigger Criteria:
- Context: Valid return movement with equipment and waybill data
- Applied to: Build Return CCN with 6105E Prefix
- Action: A return CCN needs to be created
Logic Flow:
IF Valid return movement with equipment and waybill data
AND A return CCN needs to be created
THEN:
- • The system builds CCN key with format: '6' + '105' + 'E' + equipment_id + waybill_date + sequence_number
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid return movement scenario.
Trigger Criteria:
- Context: Valid return movement scenario
- Applied to: Set Transit Status to 'R' for Return
- Action: Transit status needs to be set for the cargo
Logic Flow:
IF Valid return movement scenario
AND Transit status needs to be set for the cargo
THEN:
- • The system assigns transit status 'R' to indicate return movement
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn record being created for return movement.
Trigger Criteria:
- Context: CCN record being created for return movement
- Applied to: Set CCN Status to 'RETURN'
- Action: CCN status needs to be assigned
Logic Flow:
IF CCN record being created for return movement
AND CCN status needs to be assigned
THEN:
- • The system sets CCN status to 'RETURN' to indicate return cargo processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when return ccn record structure and extracted waybill data.
Trigger Criteria:
- Context: Return CCN record structure and extracted waybill data
- Applied to: Populate Return Movement Data
- Action: Return movement data needs to be populated
Logic Flow:
IF Return CCN record structure and extracted waybill data
AND Return movement data needs to be populated
THEN:
- • The system populates shipper, consignee, origin station, destination station, and sets application type to '33' for Canadian customs
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when fully populated return movement data.
Trigger Criteria:
- Context: Fully populated return movement data
- Applied to: Create Return CCN Record
- Action: Return CCN record needs to be persisted
Logic Flow:
IF Fully populated return movement data
AND Return CCN record needs to be persisted
THEN:
- • The system creates the CCN database record with return status and all associated movement data
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when successfully created return ccn record.
Trigger Criteria:
- Context: Successfully created return CCN record
- Applied to: Log Return Movement Pattern
- Action: Return movement processing is complete
Logic Flow:
IF Successfully created return CCN record
AND Return movement processing is complete
THEN:
- • The system creates audit trail entry via GCX105 spawning to log the return movement pattern
R-GCX146-cbl-01570 (+11) File: GCX146.cbl Business Rule: CCN Number Compression and Formatting Rules
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn number needs to be compressed.
Trigger Criteria:
- Context: A CCN number needs to be compressed
- Applied to: Initialize CCN Compression Variables
- Action: The compression process begins
Logic Flow:
IF A CCN number needs to be compressed
AND The compression process begins
THEN:
- • All compression variables are initialized to their default values and workspace areas are cleared
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn number contains space characters.
Trigger Criteria:
- Context: A CCN number contains space characters
- Applied to: Remove Spaces from CCN Number
- Action: Space removal processing is performed
Logic Flow:
IF A CCN number contains space characters
AND Space removal processing is performed
THEN:
- • All spaces are removed from the CCN number and the result is stored for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn number without spaces exists.
Trigger Criteria:
- Context: A CCN number without spaces exists
- Applied to: Scan CCN Character by Character
- Action: Character-by-character scanning is performed
Logic Flow:
IF A CCN number without spaces exists
AND Character-by-character scanning is performed
THEN:
- • Each character is examined and categorized for appropriate processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when character from the ccn number is being examined.
Trigger Criteria:
- Context: A character from the CCN number is being examined
- Applied to: Character is Numeric?
- Action: Character type validation is performed
Logic Flow:
IF A character from the CCN number is being examined
AND Character type validation is performed
THEN:
- • The character is identified as either numeric (0-9) or non-numeric
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when character has been identified as numeric.
Trigger Criteria:
- Context: A character has been identified as numeric
- Applied to: Add to Numeric Sequence
- Action: Numeric sequence processing occurs
Logic Flow:
IF A character has been identified as numeric
AND Numeric sequence processing occurs
THEN:
- • The numeric character is added to the current numeric sequence
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when character has been identified as non-numeric.
Trigger Criteria:
- Context: A character has been identified as non-numeric
- Applied to: Process Non-Numeric Character
- Action: Non-numeric character processing occurs
Logic Flow:
IF A character has been identified as non-numeric
AND Non-numeric character processing occurs
THEN:
- • The character is processed according to CCN compression rules for non-numeric elements
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when numeric sequences have been collected from the ccn number.
Trigger Criteria:
- Context: Numeric sequences have been collected from the CCN number
- Applied to: Organize Numeric Sequences
- Action: Sequence organization processing occurs
Logic Flow:
IF Numeric sequences have been collected from the CCN number
AND Sequence organization processing occurs
THEN:
- • Numeric sequences are organized according to CCN compression algorithm requirements
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when numeric sequences have been organized and characters processed.
Trigger Criteria:
- Context: Numeric sequences have been organized and characters processed
- Applied to: Apply CCN Formatting Rules
- Action: CCN formatting rules are applied
Logic Flow:
IF Numeric sequences have been organized and characters processed
AND CCN formatting rules are applied
THEN:
- • The CCN is formatted according to standard compression formatting requirements
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn has been compressed and formatted.
Trigger Criteria:
- Context: A CCN has been compressed and formatted
- Applied to: Validate Compressed CCN Format
- Action: Format validation is performed
Logic Flow:
IF A CCN has been compressed and formatted
AND Format validation is performed
THEN:
- • The compressed CCN format is validated against business rules and either accepted or rejected
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn has passed compression format validation.
Trigger Criteria:
- Context: A CCN has passed compression format validation
- Applied to: Store Compressed CCN
- Action: CCN storage processing occurs
Logic Flow:
IF A CCN has passed compression format validation
AND CCN storage processing occurs
THEN:
- • The compressed CCN is stored and made available for subsequent business operations
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn has failed compression format validation.
Trigger Criteria:
- Context: A CCN has failed compression format validation
- Applied to: Set Compression Error Flag
- Action: Error handling processing occurs
Logic Flow:
IF A CCN has failed compression format validation
AND Error handling processing occurs
THEN:
- • Compression error flags are set to indicate the failure condition
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn compression processing has been performed.
Trigger Criteria:
- Context: CCN compression processing has been performed
- Applied to: Complete CCN Compression
- Action: Process completion occurs
Logic Flow:
IF CCN compression processing has been performed
AND Process completion occurs
THEN:
- • The CCN compression process is finalized with either successful compression or error status
R-GCX146-cbl-01582 (+4) File: GCX146.cbl Business Rule: Execute Enhanced Search with FWCARGET
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment id is available for waybill lookup. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: An equipment ID is available for waybill lookup
- Applied to: Call FWCARGET Module
- Action: The system calls FWCARGET module with the equipment ID as search key
Logic Flow:
IF An equipment ID is available for waybill lookup
AND The system calls FWCARGET module with the equipment ID as search key
THEN:
- • The system should attempt to retrieve waybill data from the shipment database
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when fwcarget module has completed the search operation.
Trigger Criteria:
- Context: FWCARGET module has completed the search operation
- Applied to: Search Successful?
- Action: The system checks the search result status
Logic Flow:
IF FWCARGET module has completed the search operation
AND The system checks the search result status
THEN:
- • The system should determine whether the search was successful or failed based on the return status
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when fwcarget search operation was successful. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: FWCARGET search operation was successful
- Applied to: Set WS-WAYBILL-FOUND Flag
- Action: Valid waybill data is available from the search result
Logic Flow:
IF FWCARGET search operation was successful
AND Valid waybill data is available from the search result
THEN:
- • The system should set the waybill found flag to indicate successful data retrieval
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when waybill data has been successfully retrieved from fwcarget.
Trigger Criteria:
- Context: Waybill data has been successfully retrieved from FWCARGET
- Applied to: Extract Waybill Information
- Action: The system processes the retrieved waybill record
Logic Flow:
IF Waybill data has been successfully retrieved from FWCARGET
AND The system processes the retrieved waybill record
THEN:
- • The system should extract and store the waybill information in working storage variables
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when fwcarget search operation failed to find waybill data. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: FWCARGET search operation failed to find waybill data
- Applied to: Set WS-WAYBILL-NOT-FOUND Flag
- Action: No valid waybill record is returned from the search
Logic Flow:
IF FWCARGET search operation failed to find waybill data
AND No valid waybill record is returned from the search
THEN:
- • The system should set the waybill not found flag and prepare for inquiry database fallback search
R-GCX146-cbl-01587 (+12) File: GCX146.cbl Business Rule: Process Individual Container
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when flat car is being processed for containers.
Trigger Criteria:
- Context: A flat car is being processed for containers
- Applied to: Access Container Record on Flat Car
- Action: The system attempts to access container records on the flat car
Logic Flow:
IF A flat car is being processed for containers
AND The system attempts to access container records on the flat car
THEN:
- • Container records are retrieved from the container database for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container record access has been attempted for a flat car.
Trigger Criteria:
- Context: Container record access has been attempted for a flat car
- Applied to: Container Record Found?
- Action: The system checks for container record existence
Logic Flow:
IF Container record access has been attempted for a flat car
AND The system checks for container record existence
THEN:
- • Processing continues if container records are found,
otherwise container processing terminates with error
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid container record has been found.
Trigger Criteria:
- Context: A valid container record has been found
- Applied to: Extract Container ID from Record
- Action: The system processes the container record
Logic Flow:
IF A valid container record has been found
AND The system processes the container record
THEN:
- • The container ID is extracted from the record for validation and further processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when container id has been extracted from the container record.
Trigger Criteria:
- Context: A container ID has been extracted from the container record
- Applied to: Validate Container ID Format
- Action: The system validates the container ID format
Logic Flow:
IF A container ID has been extracted from the container record
AND The system validates the container ID format
THEN:
- • Processing continues if the container ID format is valid,
otherwise container processing terminates with error
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container id has been validated as having correct format.
Trigger Criteria:
- Context: A container ID has been validated as having correct format
- Applied to: Perform Container Waybill Lookup
- Action: The system performs waybill lookup for the container
Logic Flow:
IF A container ID has been validated as having correct format
AND The system performs waybill lookup for the container
THEN:
- • Waybill information is retrieved from the waybill database for the container
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when waybill lookup has been performed for a container.
Trigger Criteria:
- Context: Waybill lookup has been performed for a container
- Applied to: Container Waybill Found?
- Action: The system checks for waybill existence
Logic Flow:
IF Waybill lookup has been performed for a container
AND The system checks for waybill existence
THEN:
- • If waybill is found, container details are extracted; if not found, system attempts inquiry database lookup
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when container waybill was not found in primary lookup.
Trigger Criteria:
- Context: Container waybill was not found in primary lookup
- Applied to: Access Container Inquiry Database
- Action: The system accesses the container inquiry database
Logic Flow:
IF Container waybill was not found in primary lookup
AND The system accesses the container inquiry database
THEN:
- • Alternative container information is retrieved from the inquiry database
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when container inquiry database has been accessed.
Trigger Criteria:
- Context: Container inquiry database has been accessed
- Applied to: Inquiry Data Available?
- Action: The system checks for inquiry data availability
Logic Flow:
IF Container inquiry database has been accessed
AND The system checks for inquiry data availability
THEN:
- • If inquiry data is available, container details are extracted;
otherwise container processing terminates with error
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when container information is available from either waybill or inquiry database.
Trigger Criteria:
- Context: Container information is available from either waybill or inquiry database
- Applied to: Extract Container Equipment Details
- Action: The system extracts container equipment details
Logic Flow:
IF Container information is available from either waybill or inquiry database
AND The system extracts container equipment details
THEN:
- • Complete container equipment information including specifications and characteristics is retrieved
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container equipment details have been extracted.
Trigger Criteria:
- Context: Container equipment details have been extracted
- Applied to: Set Container Processing Flags
- Action: The system sets container processing flags
Logic Flow:
IF Container equipment details have been extracted
AND The system sets container processing flags
THEN:
- • Processing flags are assigned to indicate container status, type, and processing requirements
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when container processing flags have been set.
Trigger Criteria:
- Context: Container processing flags have been set
- Applied to: Determine Container Load/Empty Status
- Action: The system determines container load status
Logic Flow:
IF Container processing flags have been set
AND The system determines container load status
THEN:
- • Container is classified as either loaded or empty based on cargo information and processing flags
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container load/empty status has been determined.
Trigger Criteria:
- Context: Container load/empty status has been determined
- Applied to: Assign Container to Equipment List
- Action: The system assigns the container to equipment list
Logic Flow:
IF Container load/empty status has been determined
AND The system assigns the container to equipment list
THEN:
- • Container is added to the train's equipment list with all relevant details and status information
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when current container has been assigned to equipment list.
Trigger Criteria:
- Context: Current container has been assigned to equipment list
- Applied to: Move to Next Container on Flat Car
- Action: The system moves to next container on flat car
Logic Flow:
IF Current container has been assigned to equipment list
AND The system moves to next container on flat car
THEN:
- • Processing continues with the next container on the same flat car, or completes if no more containers exist
R-GCX146-cbl-01600 (+17) File: GCX146.cbl Business Rule: Retrieve Current CCN Status
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment id is provided for ccn status lookup.
Trigger Criteria:
- Context: An equipment ID is provided for CCN status lookup
- Applied to: Access CCN Database Using Equipment ID
- Action: The system accesses the GCCCRT CCN database using the equipment ID
Logic Flow:
IF An equipment ID is provided for CCN status lookup
AND The system accesses the GCCCRT CCN database using the equipment ID
THEN:
- • The system retrieves the CCN record if it exists in the database
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when database lookup has been performed for an equipment id.
Trigger Criteria:
- Context: A database lookup has been performed for an equipment ID
- Applied to: CCN Record Found?
- Action: The system checks if a CCN record was found
Logic Flow:
IF A database lookup has been performed for an equipment ID
AND The system checks if a CCN record was found
THEN:
- • The system determines whether to proceed with status retrieval or handle missing CCN scenario
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when valid ccn record exists for the equipment.
Trigger Criteria:
- Context: A valid CCN record exists for the equipment
- Applied to: Retrieve Current CCN Status
- Action: The system accesses the CCN record
Logic Flow:
IF A valid CCN record exists for the equipment
AND The system accesses the CCN record
THEN:
- • The current CCN status is retrieved from the record
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid ccn record exists with current status retrieved.
Trigger Criteria:
- Context: A valid CCN record exists with current status retrieved
- Applied to: Retrieve Transit Status Code
- Action: The system accesses the transit status field in the CCN record
Logic Flow:
IF A valid CCN record exists with current status retrieved
AND The system accesses the transit status field in the CCN record
THEN:
- • The transit status code is retrieved for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn record with current status and transit status code.
Trigger Criteria:
- Context: A CCN record with current status and transit status code
- Applied to: Status = RELEASE?
- Action: The system evaluates if the current status equals RELEASE
Logic Flow:
IF A CCN record with current status and transit status code
AND The system evaluates if the current status equals RELEASE
THEN:
- • The system branches to release-specific status determination logic or continues to other status checks
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment has release status.
Trigger Criteria:
- Context: Equipment has RELEASE status
- Applied to: Transit Status = E or Z?
- Action: The transit status code is E (Export) or Z (Export Zone)
Logic Flow:
IF Equipment has RELEASE status
AND The transit status code is E (Export) or Z (Export Zone)
THEN:
- • The system sets the equipment status to EXPORT
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has release status and transit status is e or z.
Trigger Criteria:
- Context: Equipment has RELEASE status and transit status is E or Z
- Applied to: Set Status to EXPORT
- Action: The system processes the status assignment
Logic Flow:
IF Equipment has RELEASE status and transit status is E or Z
AND The system processes the status assignment
THEN:
- • The equipment status is set to EXPORT
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has release status and transit status is not e or z.
Trigger Criteria:
- Context: Equipment has RELEASE status and transit status is not E or Z
- Applied to: S.A.R. Release?
- Action: The system checks if the release is by S.A.R.
Logic Flow:
IF Equipment has RELEASE status and transit status is not E or Z
AND The system checks if the release is by S.A.R.
THEN:
- • The system determines whether to set S.A.R. status or keep standard RELEASE status
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment has release status and is identified as s.a.r. release.
Trigger Criteria:
- Context: Equipment has RELEASE status and is identified as S.A.R. release
- Applied to: Set Status to S.A.R.
- Action: The system processes the S.A.R. status assignment
Logic Flow:
IF Equipment has RELEASE status and is identified as S.A.R. release
AND The system processes the S.A.R. status assignment
THEN:
- • The equipment status is set to S.A.R.
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment has release status but is not export transit and not s.a.r. release.
Trigger Criteria:
- Context: Equipment has RELEASE status but is not export transit and not S.A.R. release
- Applied to: Keep Status as RELEASE
- Action: The system processes the status assignment
Logic Flow:
IF Equipment has RELEASE status but is not export transit and not S.A.R. release
AND The system processes the status assignment
THEN:
- • The equipment status remains as RELEASE
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment does not have release status.
Trigger Criteria:
- Context: Equipment does not have RELEASE status
- Applied to: Transit Status = T?
- Action: The transit status code is T (Transit)
Logic Flow:
IF Equipment does not have RELEASE status
AND The transit status code is T (Transit)
THEN:
- • The system sets the equipment status to TRANSIT
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has transit status code t.
Trigger Criteria:
- Context: Equipment has transit status code T
- Applied to: Set Status to TRANSIT
- Action: The system processes the status assignment
Logic Flow:
IF Equipment has transit status code T
AND The system processes the status assignment
THEN:
- • The equipment status is set to TRANSIT
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment does not have release status and transit status is not t.
Trigger Criteria:
- Context: Equipment does not have RELEASE status and transit status is not T
- Applied to: Transit Status = R?
- Action: The transit status code is R (Return)
Logic Flow:
IF Equipment does not have RELEASE status and transit status is not T
AND The transit status code is R (Return)
THEN:
- • The system sets the equipment status to RETURN
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment has transit status code r.
Trigger Criteria:
- Context: Equipment has transit status code R
- Applied to: Set Status to RETURN
- Action: The system processes the status assignment
Logic Flow:
IF Equipment has transit status code R
AND The system processes the status assignment
THEN:
- • The equipment status is set to RETURN
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment does not qualify for release, transit, or return status mapping.
Trigger Criteria:
- Context: Equipment does not qualify for RELEASE, TRANSIT, or RETURN status mapping
- Applied to: Keep Current Status
- Action: The system processes the status assignment
Logic Flow:
IF Equipment does not qualify for RELEASE, TRANSIT, or RETURN status mapping
AND The system processes the status assignment
THEN:
- • The equipment retains its original CCN status
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when status has been determined through the status mapping logic.
Trigger Criteria:
- Context: A status has been determined through the status mapping logic
- Applied to: Update Equipment Status Record
- Action: The system updates the equipment record
Logic Flow:
IF A status has been determined through the status mapping logic
AND The system updates the equipment record
THEN:
- • The equipment status record is updated with the final determined status
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment status has been determined and record updated.
Trigger Criteria:
- Context: The equipment status has been determined and record updated
- Applied to: Return Current CCN Status
- Action: The system completes the CCN status retrieval process
Logic Flow:
IF The equipment status has been determined and record updated
AND The system completes the CCN status retrieval process
THEN:
- • The final CCN status is returned to the calling process
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when no ccn record exists for the equipment id.
Trigger Criteria:
- Context: No CCN record exists for the equipment ID
- Applied to: CCN Not Found - Set Empty Status
- Action: The system processes the missing CCN scenario
Logic Flow:
IF No CCN record exists for the equipment ID
AND The system processes the missing CCN scenario
THEN:
- • The system sets an empty or default status and returns it
R-GCX146-cbl-01618 (+4) File: GCX146.cbl Business Rule: Check Container Load Status
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment record exists with load/empty indicator.
Trigger Criteria:
- Context: Equipment record exists with load/empty indicator
- Applied to: Check Container Load Status
- Action: Processing equipment for container identification
Logic Flow:
IF Equipment record exists with load/empty indicator
AND Processing equipment for container identification
THEN:
- • System categorizes equipment as loaded (L) or empty (E) based on the load/empty indicator field
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment is identified as a flat car that may contain containers.
Trigger Criteria:
- Context: Equipment is identified as a flat car that may contain containers
- Applied to: Check Container Load Status
- Action: Checking container load status
Logic Flow:
IF Equipment is identified as a flat car that may contain containers
AND Checking container load status
THEN:
- • System processes containers only if waybill is found for the equipment
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when flat car equipment record with potential multiple containers.
Trigger Criteria:
- Context: Flat car equipment record with potential multiple containers
- Applied to: Check Container Load Status
- Action: Processing container load status
Logic Flow:
IF Flat car equipment record with potential multiple containers
AND Processing container load status
THEN:
- • System extracts and processes each container ID from cross-reference records associated with the flat car
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment is marked as loaded and operation type is add.
Trigger Criteria:
- Context: Equipment is marked as loaded and operation type is ADD
- Applied to: Check Container Load Status
- Action: Checking container load status
Logic Flow:
IF Equipment is marked as loaded and operation type is ADD
AND Checking container load status
THEN:
- • System generates Error 21 if no waybill is found for loaded equipment
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment load/empty indicator shows 'e' (empty) and operation type is add.
Trigger Criteria:
- Context: Equipment load/empty indicator shows 'E' (empty) and operation type is ADD
- Applied to: Check Container Load Status
- Action: Checking container load status
Logic Flow:
IF Equipment load/empty indicator shows 'E' (empty) and operation type is ADD
AND Checking container load status
THEN:
- • System allows processing to continue without requiring waybill documentation
R-GCX146-cbl-01623 (+13) File: GCX146.cbl Business Rule: Check Trailer Load Status
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment waybill data is available with equipment type information.
Trigger Criteria:
- Context: Equipment waybill data is available with equipment type information
- Applied to: Extract Equipment Type from Waybill Data
- Action: System extracts equipment type from waybill data
Logic Flow:
IF Equipment waybill data is available with equipment type information
AND System extracts equipment type from waybill data
THEN:
- • Equipment type is classified to determine if it is a trailer requiring load status processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment type has been extracted from waybill data.
Trigger Criteria:
- Context: Equipment type has been extracted from waybill data
- Applied to: Is Equipment a Trailer?
- Action: System checks if equipment type indicates a trailer
Logic Flow:
IF Equipment type has been extracted from waybill data
AND System checks if equipment type indicates a trailer
THEN:
- • Equipment is identified as trailer or non-trailer for appropriate processing path
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment is identified as a trailer type.
Trigger Criteria:
- Context: Equipment is identified as a trailer type
- Applied to: Retrieve Waybill Load/Empty Indicator
- Action: System accesses waybill data for load/empty indicator
Logic Flow:
IF Equipment is identified as a trailer type
AND System accesses waybill data for load/empty indicator
THEN:
- • Load/empty status indicator is retrieved from waybill record
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when input load status is provided and waybill load status is retrieved.
Trigger Criteria:
- Context: Input load status is provided and waybill load status is retrieved
- Applied to: Compare Input Load Status vs Waybill Status
- Action: System compares input load status with waybill load status
Logic Flow:
IF Input load status is provided and waybill load status is retrieved
AND System compares input load status with waybill load status
THEN:
- • Status comparison result is determined for validation processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when input load status and waybill load status have been compared.
Trigger Criteria:
- Context: Input load status and waybill load status have been compared
- Applied to: Status Match?
- Action: System evaluates if the statuses match
Logic Flow:
IF Input load status and waybill load status have been compared
AND System evaluates if the statuses match
THEN:
- • Status match result determines whether to proceed with cargo analysis or set validation error
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when input load status matches waybill load status.
Trigger Criteria:
- Context: Input load status matches waybill load status
- Applied to: Analyze Cargo Origin/Destination
- Action: System analyzes cargo origin and destination data
Logic Flow:
IF Input load status matches waybill load status
AND System analyzes cargo origin and destination data
THEN:
- • Origin and destination information is evaluated for load status determination
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo origin and destination have been analyzed.
Trigger Criteria:
- Context: Cargo origin and destination have been analyzed
- Applied to: Origin = Destination?
- Action: System compares origin location with destination location
Logic Flow:
IF Cargo origin and destination have been analyzed
AND System compares origin location with destination location
THEN:
- • Load status flag is set to Empty if origin equals destination,
otherwise set to Load
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when cargo origin equals destination.
Trigger Criteria:
- Context: Cargo origin equals destination
- Applied to: Set Load Status Flag = Empty
- Action: System assigns load status flag
Logic Flow:
IF Cargo origin equals destination
AND System assigns load status flag
THEN:
- • Load status flag is set to Empty
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when cargo origin does not equal destination.
Trigger Criteria:
- Context: Cargo origin does not equal destination
- Applied to: Set Load Status Flag = Load
- Action: System assigns load status flag
Logic Flow:
IF Cargo origin does not equal destination
AND System assigns load status flag
THEN:
- • Load status flag is set to Load
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when load status flag has been set based on origin/destination analysis.
Trigger Criteria:
- Context: Load status flag has been set based on origin/destination analysis
- Applied to: Validate Load Status Requirements
- Action: System validates load status against business requirements
Logic Flow:
IF Load status flag has been set based on origin/destination analysis
AND System validates load status against business requirements
THEN:
- • Load status is determined as valid or invalid for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when load status has been validated against requirements.
Trigger Criteria:
- Context: Load status has been validated against requirements
- Applied to: Load Status Valid?
- Action: System checks load status validity
Logic Flow:
IF Load status has been validated against requirements
AND System checks load status validity
THEN:
- • Processing continues with status update if valid, or validation error is set if invalid
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when load status is determined as valid.
Trigger Criteria:
- Context: Load status is determined as valid
- Applied to: Update Equipment Load/Empty Status
- Action: System updates equipment load/empty status
Logic Flow:
IF Load status is determined as valid
AND System updates equipment load/empty status
THEN:
- • Equipment record is updated with the validated load/empty status
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when load status is invalid or input status does not match waybill status.
Trigger Criteria:
- Context: Load status is invalid or input status does not match waybill status
- Applied to: Set Status Validation Error
- Action: System encounters validation failure
Logic Flow:
IF Load status is invalid or input status does not match waybill status
AND System encounters validation failure
THEN:
- • Status validation error is set for the equipment
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when load status validation is complete (either successful update or error set).
Trigger Criteria:
- Context: Load status validation is complete (either successful update or error set)
- Applied to: Continue Equipment Processing
- Action: System proceeds to next processing phase
Logic Flow:
IF Load status validation is complete (either successful update or error set)
AND System proceeds to next processing phase
THEN:
- • Equipment processing continues to subsequent validation or processing steps
R-GCX146-cbl-01637 File: GCX146.cbl Business Rule: Validate CCN Format Structure
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn is being processed in the system.
Trigger Criteria:
- Context: A CCN is being processed in the system
- Applied to: CCN Format Structure Validation Not Found
- Action: The system attempts to validate the CCN format structure
Logic Flow:
IF A CCN is being processed in the system
AND The system attempts to validate the CCN format structure
THEN:
- • No specific format validation logic is executed and the CCN is accepted based on existence alone
R-GCX146-cbl-01638 (+7) File: GCX146.cbl Business Rule: Send via X12 EDI
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when valid ccn record exists with equipment id, status updates, and transit information.
Trigger Criteria:
- Context: A valid CCN record exists with equipment ID, status updates, and transit information
- Applied to: Prepare CCN Data for X12 Format
- Action: The system needs to send broker notification via X12 EDI
Logic Flow:
IF A valid CCN record exists with equipment ID, status updates, and transit information
AND The system needs to send broker notification via X12 EDI
THEN:
- • The CCN data is formatted according to X12 EDI message structure with broker-specific routing information
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn data has been prepared in x12 edi format. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: CCN data has been prepared in X12 EDI format
- Applied to: Call GCCS309C Module
- Action: The system is ready to transmit the broker notification
Logic Flow:
IF CCN data has been prepared in X12 EDI format
AND The system is ready to transmit the broker notification
THEN:
- • The GCCS309C module is called to process the X12 EDI transmission
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when gccs309c module has been called for x12 edi transmission.
Trigger Criteria:
- Context: The GCCS309C module has been called for X12 EDI transmission
- Applied to: X12 EDI Transmission Successful?
- Action: The transmission process completes
Logic Flow:
IF The GCCS309C module has been called for X12 EDI transmission
AND The transmission process completes
THEN:
- • The system determines if the transmission was successful or failed based on the module response
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when x12 edi transmission was successful.
Trigger Criteria:
- Context: X12 EDI transmission was successful
- Applied to: Log Successful X12 Transmission
- Action: The transmission completes successfully
Logic Flow:
IF X12 EDI transmission was successful
AND The transmission completes successfully
THEN:
- • The system logs the successful transmission details including timestamp and broker information
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when x12 edi transmission was successful and logged.
Trigger Criteria:
- Context: X12 EDI transmission was successful and logged
- Applied to: Set Broker Notification Complete Flag
- Action: The notification process completes
Logic Flow:
IF X12 EDI transmission was successful and logged
AND The notification process completes
THEN:
- • The broker notification complete flag is set to indicate successful delivery
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when x12 edi transmission failed.
Trigger Criteria:
- Context: X12 EDI transmission failed
- Applied to: Handle X12 Transmission Failure
- Action: The GCCS309C module returns a failure status
Logic Flow:
IF X12 EDI transmission failed
AND The GCCS309C module returns a failure status
THEN:
- • The system initiates failure handling procedures to manage the unsuccessful transmission
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when x12 edi transmission failed.
Trigger Criteria:
- Context: X12 EDI transmission failed
- Applied to: Log X12 Error Details
- Action: Error handling is initiated
Logic Flow:
IF X12 EDI transmission failed
AND Error handling is initiated
THEN:
- • The system logs detailed error information including failure reason and transmission details
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when x12 edi transmission failed and error details were logged.
Trigger Criteria:
- Context: X12 EDI transmission failed and error details were logged
- Applied to: Continue to Next Notification Channel
- Action: The current notification attempt is complete
Logic Flow:
IF X12 EDI transmission failed and error details were logged
AND The current notification attempt is complete
THEN:
- • The system continues processing to attempt notification through the next available channel (Merlin, Internet, FAX, or Paper)
R-GCX146-cbl-01646 (+8) File: GCX146.cbl Business Rule: Send via Merlin
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when broker notification needs to be sent via merlin system.
Trigger Criteria:
- Context: A broker notification needs to be sent via Merlin system
- Applied to: Prepare GCX019 Input Parameters
- Action: The system prepares GCX019 input parameters
Logic Flow:
IF A broker notification needs to be sent via Merlin system
AND The system prepares GCX019 input parameters
THEN:
- • The broker Merlin ID, notification message content, and message type are configured for the GCX019 module call
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when broker configuration data exists in gcstbrt and broker merlin ids are available.
Trigger Criteria:
- Context: Broker configuration data exists in GCSTBRT and broker Merlin IDs are available
- Applied to: Set Broker Merlin ID
- Action: The system needs to identify the broker's Merlin ID for notification
Logic Flow:
IF Broker configuration data exists in GCSTBRT and broker Merlin IDs are available
AND The system needs to identify the broker's Merlin ID for notification
THEN:
- • The correct Merlin ID is retrieved from broker configuration and set for the notification
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when broker notification data is available and message content needs to be prepared.
Trigger Criteria:
- Context: Broker notification data is available and message content needs to be prepared
- Applied to: Set Notification Message Content
- Action: The system sets up notification message content
Logic Flow:
IF Broker notification data is available and message content needs to be prepared
AND The system sets up notification message content
THEN:
- • The appropriate message content is formatted and configured for broker notification
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when broker notification is being prepared.
Trigger Criteria:
- Context: A broker notification is being prepared
- Applied to: Set Message Type for Broker
- Action: The system needs to classify the message type
Logic Flow:
IF A broker notification is being prepared
AND The system needs to classify the message type
THEN:
- • The correct message type is determined and set for the broker notification
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when all gcx019 input parameters are prepared and configured. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: All GCX019 input parameters are prepared and configured
- Applied to: Call GCX019 Module
- Action: The system calls the GCX019 module
Logic Flow:
IF All GCX019 input parameters are prepared and configured
AND The system calls the GCX019 module
THEN:
- • The GCX019 module is invoked to process the Merlin broker notification
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when gcx019 module has been called for merlin broker notification. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: The GCX019 module has been called for Merlin broker notification
- Applied to: GCX019 Call Successful?
- Action: The system checks the call result
Logic Flow:
IF The GCX019 module has been called for Merlin broker notification
AND The system checks the call result
THEN:
- • The system determines if the GCX019 call was successful or failed
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when gcx019 call was successful. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: The GCX019 call was successful
- Applied to: Log Successful Merlin Send
- Action: The system processes the successful result
Logic Flow:
IF The GCX019 call was successful
AND The system processes the successful result
THEN:
- • A log entry is created documenting the successful Merlin broker notification
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when gcx019 call failed. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: The GCX019 call failed
- Applied to: Log Merlin Send Failure
- Action: The system processes the failure result
Logic Flow:
IF The GCX019 call failed
AND The system processes the failure result
THEN:
- • A log entry is created documenting the failed Merlin broker notification attempt
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when merlin broker notification has failed.
Trigger Criteria:
- Context: The Merlin broker notification has failed
- Applied to: Try Alternative Notification Method
- Action: The system needs to ensure broker notification delivery
Logic Flow:
IF The Merlin broker notification has failed
AND The system needs to ensure broker notification delivery
THEN:
- • An alternative notification method is selected and attempted for the broker
R-GCX146-cbl-01655 File: GCX146.cbl Business Rule: Send via Internet
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when broker notification requires internet transmission method.
Trigger Criteria:
- Context: A broker notification requires internet transmission method
- Applied to: GCX019 Module Reference Found
- Action: The system attempts to process internet notification
Logic Flow:
IF A broker notification requires internet transmission method
AND The system attempts to process internet notification
THEN:
- • The system references GCX019 module but cannot execute the internet transmission logic due to missing implementation
R-GCX146-cbl-01656 (+9) File: GCX146.cbl Business Rule: Send via FAX
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when broker notification request requires fax transmission.
Trigger Criteria:
- Context: A broker notification request requires FAX transmission
- Applied to: Check Broker FAX Configuration
- Action: The system checks the broker's FAX configuration
Logic Flow:
IF A broker notification request requires FAX transmission
AND The system checks the broker's FAX configuration
THEN:
- • The system should verify FAX number is available and valid before proceeding
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when valid fax number is available for the broker.
Trigger Criteria:
- Context: A valid FAX number is available for the broker
- Applied to: Prepare FAX Message Content
- Action: The system prepares the FAX message content
Logic Flow:
IF A valid FAX number is available for the broker
AND The system prepares the FAX message content
THEN:
- • The system should format the notification data into appropriate FAX message format
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when fax message content is prepared.
Trigger Criteria:
- Context: FAX message content is prepared
- Applied to: Set FAX Routing Parameters
- Action: The system sets FAX routing parameters
Logic Flow:
IF FAX message content is prepared
AND The system sets FAX routing parameters
THEN:
- • The system should configure transmission settings including destination FAX number and routing information
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when fax routing parameters are configured. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: FAX routing parameters are configured
- Applied to: Call GCX019 for FAX Transmission
- Action: The system calls GCX019 for FAX transmission
Logic Flow:
IF FAX routing parameters are configured
AND The system calls GCX019 for FAX transmission
THEN:
- • The system should invoke GCX019 program to handle the actual FAX transmission
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when gcx019 fax transmission has been executed.
Trigger Criteria:
- Context: GCX019 FAX transmission has been executed
- Applied to: FAX Send Successful?
- Action: The system evaluates the transmission result
Logic Flow:
IF GCX019 FAX transmission has been executed
AND The system evaluates the transmission result
THEN:
- • The system should determine success or failure based on GCX019 return status
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when fax transmission was successful.
Trigger Criteria:
- Context: FAX transmission was successful
- Applied to: Log FAX Transmission Success
- Action: The system logs the transmission success
Logic Flow:
IF FAX transmission was successful
AND The system logs the transmission success
THEN:
- • The system should create audit trail entry recording successful FAX delivery
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when fax transmission success has been logged.
Trigger Criteria:
- Context: FAX transmission success has been logged
- Applied to: Update Broker Notification Status
- Action: The system updates broker notification status
Logic Flow:
IF FAX transmission success has been logged
AND The system updates broker notification status
THEN:
- • The system should mark the broker notification as successfully delivered via FAX
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when fax transmission failed.
Trigger Criteria:
- Context: FAX transmission failed
- Applied to: Handle FAX Transmission Error
- Action: The system handles the transmission error
Logic Flow:
IF FAX transmission failed
AND The system handles the transmission error
THEN:
- • The system should process the error and determine if alternative FAX methods are available
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when primary fax transmission failed.
Trigger Criteria:
- Context: Primary FAX transmission failed
- Applied to: Alternative Available?
- Action: The system checks for alternative FAX methods
Logic Flow:
IF Primary FAX transmission failed
AND The system checks for alternative FAX methods
THEN:
- • The system should determine if backup FAX numbers or alternative transmission methods are configured
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when fax transmission failed and no alternatives are available.
Trigger Criteria:
- Context: FAX transmission failed and no alternatives are available
- Applied to: Mark FAX Notification Failed
- Action: The system marks FAX notification as failed
Logic Flow:
IF FAX transmission failed and no alternatives are available
AND The system marks FAX notification as failed
THEN:
- • The system should update broker notification status to indicate FAX delivery failure
R-GCX146-cbl-01666 (+6) File: GCX146.cbl Business Rule: Validate Email User ID Format
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when station code exists in the system.
Trigger Criteria:
- Context: A station code exists in the system
- Applied to: Retrieve Email User List from Station Configuration
- Action: The system needs to retrieve email user configuration for that station
Logic Flow:
IF A station code exists in the system
AND The system needs to retrieve email user configuration for that station
THEN:
- • The system should lookup and retrieve the email user list from the station configuration table
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when email address is provided for validation.
Trigger Criteria:
- Context: An email address is provided for validation
- Applied to: Check Email User ID Format
- Action: The system checks the email format
Logic Flow:
IF An email address is provided for validation
AND The system checks the email format
THEN:
- • The email address must contain an @ symbol and have valid domain format to be considered valid
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when email address needs structural validation.
Trigger Criteria:
- Context: An email address needs structural validation
- Applied to: Validate Email Address Structure
- Action: The system validates the email structure
Logic Flow:
IF An email address needs structural validation
AND The system validates the email structure
THEN:
- • The email must contain exactly one @ symbol and the domain portion must follow valid domain naming conventions
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when primary email validation has failed.
Trigger Criteria:
- Context: Primary email validation has failed
- Applied to: Check for Fallback Email IDs
- Action: The system checks for available fallback options
Logic Flow:
IF Primary email validation has failed
AND The system checks for available fallback options
THEN:
- • The system should identify if alternative email addresses are configured and available for use
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when no valid email addresses are found in configuration and fallback options are available.
Trigger Criteria:
- Context: No valid email addresses are found in configuration and fallback options are available
- Applied to: Use Default Email OM01247/AEI9999
- Action: The system needs to assign a default email for notifications
Logic Flow:
IF No valid email addresses are found in configuration and fallback options are available
AND The system needs to assign a default email for notifications
THEN:
- • The system should use the default email addresses OM01247 and AEI9999 as recipients
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when email validation has failed and no fallback email addresses are available.
Trigger Criteria:
- Context: Email validation has failed and no fallback email addresses are available
- Applied to: Mark Email ID as Invalid
- Action: The system processes the validation result
Logic Flow:
IF Email validation has failed and no fallback email addresses are available
AND The system processes the validation result
THEN:
- • The system should mark the email ID as invalid and prevent its use for notifications
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid email address has been identified through validation or fallback assignment.
Trigger Criteria:
- Context: A valid email address has been identified through validation or fallback assignment
- Applied to: Continue with Valid Email ID
- Action: The system is ready to proceed with email operations
Logic Flow:
IF A valid email address has been identified through validation or fallback assignment
AND The system is ready to proceed with email operations
THEN:
- • The system should continue processing using the validated email address for notifications
R-GCX146-cbl-01673 (+17) File: GCX146.cbl Business Rule: Apply Merlin Transmission Rules
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when merlin transmission is being prepared.
Trigger Criteria:
- Context: A Merlin transmission is being prepared
- Applied to: Check Auto-FAX Configuration
- Action: The system checks the Auto-FAX configuration settings
Logic Flow:
IF A Merlin transmission is being prepared
AND The system checks the Auto-FAX configuration settings
THEN:
- • The system identifies whether Auto-FAX is enabled or disabled for routing decisions
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when auto-fax is enabled for the transmission.
Trigger Criteria:
- Context: Auto-FAX is enabled for the transmission
- Applied to: Set FAX Routing Parameters
- Action: The system prepares FAX routing parameters
Logic Flow:
IF Auto-FAX is enabled for the transmission
AND The system prepares FAX routing parameters
THEN:
- • FAX-specific routing configuration is applied to the message
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when fax routing parameters are being set. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: FAX routing parameters are being set
- Applied to: Configure Copy IDs for FAX
- Action: The system configures copy distribution
Logic Flow:
IF FAX routing parameters are being set
AND The system configures copy distribution
THEN:
- • Appropriate copy IDs are assigned for FAX recipients
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when copy ids for fax have been configured. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Copy IDs for FAX have been configured
- Applied to: Set External FAX Addressing
- Action: The system sets up external addressing
Logic Flow:
IF Copy IDs for FAX have been configured
AND The system sets up external addressing
THEN:
- • External FAX addresses are properly configured for message delivery
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when message needs to be transmitted via merlin.
Trigger Criteria:
- Context: A message needs to be transmitted via Merlin
- Applied to: Prepare Merlin Message Format
- Action: The system prepares the message format
Logic Flow:
IF A message needs to be transmitted via Merlin
AND The system prepares the message format
THEN:
- • The message is formatted according to Merlin transmission specifications
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when merlin message format has been prepared.
Trigger Criteria:
- Context: A Merlin message format has been prepared
- Applied to: Set Message Type and Routing
- Action: The system configures message type and routing
Logic Flow:
IF A Merlin message format has been prepared
AND The system configures message type and routing
THEN:
- • Appropriate message type classification and routing information is assigned
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when message type and routing have been configured.
Trigger Criteria:
- Context: Message type and routing have been configured
- Applied to: Apply Line Segmentation Rules
- Action: The system applies line segmentation rules
Logic Flow:
IF Message type and routing have been configured
AND The system applies line segmentation rules
THEN:
- • Message content is properly segmented according to transmission line limits
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when line segmentation rules have been applied to a message.
Trigger Criteria:
- Context: Line segmentation rules have been applied to a message
- Applied to: Message Exceeds Line Limit?
- Action: The system checks if the message exceeds the line limit
Logic Flow:
IF Line segmentation rules have been applied to a message
AND The system checks if the message exceeds the line limit
THEN:
- • The system determines whether message segmentation is required based on line count limits
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when message exceeds the maximum line limit.
Trigger Criteria:
- Context: A message exceeds the maximum line limit
- Applied to: Create Message Segments
- Action: The system creates message segments
Logic Flow:
IF A message exceeds the maximum line limit
AND The system creates message segments
THEN:
- • The message is divided into multiple segments that each comply with line limit requirements
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when message segments have been created for a multi-part transmission.
Trigger Criteria:
- Context: Message segments have been created for a multi-part transmission
- Applied to: Add Continuation Headers
- Action: The system adds continuation headers
Logic Flow:
IF Message segments have been created for a multi-part transmission
AND The system adds continuation headers
THEN:
- • Each continuation segment includes appropriate headers indicating it is part of a multi-part message
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when message formatting and segmentation is complete.
Trigger Criteria:
- Context: Message formatting and segmentation is complete
- Applied to: Set Merlin Transmission Parameters
- Action: The system sets Merlin transmission parameters
Logic Flow:
IF Message formatting and segmentation is complete
AND The system sets Merlin transmission parameters
THEN:
- • All necessary transmission parameters are configured for Merlin delivery
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when merlin transmission parameters have been set.
Trigger Criteria:
- Context: Merlin transmission parameters have been set
- Applied to: Route to Primary Merlin ID
- Action: The system routes to the primary Merlin ID
Logic Flow:
IF Merlin transmission parameters have been set
AND The system routes to the primary Merlin ID
THEN:
- • The message is directed to the primary Merlin ID for delivery
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when message has been routed to the primary merlin id.
Trigger Criteria:
- Context: A message has been routed to the primary Merlin ID
- Applied to: Primary Routing Success?
- Action: The system checks primary routing success
Logic Flow:
IF A message has been routed to the primary Merlin ID
AND The system checks primary routing success
THEN:
- • The system determines whether the primary routing succeeded or failed
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when primary merlin id routing has failed.
Trigger Criteria:
- Context: Primary Merlin ID routing has failed
- Applied to: Route to Backup Merlin ID
- Action: The system routes to backup Merlin ID
Logic Flow:
IF Primary Merlin ID routing has failed
AND The system routes to backup Merlin ID
THEN:
- • The message is redirected to the backup Merlin ID for delivery
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when message routing has been established (either primary or backup).
Trigger Criteria:
- Context: Message routing has been established (either primary or backup)
- Applied to: Apply Message Priority Rules
- Action: The system applies message priority rules
Logic Flow:
IF Message routing has been established (either primary or backup)
AND The system applies message priority rules
THEN:
- • Appropriate priority level is assigned to the message for transmission scheduling
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when message priority rules have been applied.
Trigger Criteria:
- Context: Message priority rules have been applied
- Applied to: Set Delivery Confirmation
- Action: The system sets delivery confirmation
Logic Flow:
IF Message priority rules have been applied
AND The system sets delivery confirmation
THEN:
- • Delivery confirmation requirements are configured according to message priority and business rules
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when all transmission parameters and confirmation settings are configured.
Trigger Criteria:
- Context: All transmission parameters and confirmation settings are configured
- Applied to: Execute Merlin Transmission
- Action: The system executes Merlin transmission
Logic Flow:
IF All transmission parameters and confirmation settings are configured
AND The system executes Merlin transmission
THEN:
- • The message is transmitted via Merlin with the configured parameters and routing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when merlin transmission has been executed.
Trigger Criteria:
- Context: Merlin transmission has been executed
- Applied to: Log Transmission Activity
- Action: The system logs transmission activity
Logic Flow:
IF Merlin transmission has been executed
AND The system logs transmission activity
THEN:
- • Transmission details are recorded in the system log for audit trail and monitoring
R-GCX146-cbl-01691 (+7) File: GCX146.cbl Business Rule: Check Equipment Waybill Data
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment id is provided for waybill lookup.
Trigger Criteria:
- Context: An equipment ID is provided for waybill lookup
- Applied to: Primary Waybill Lookup - FWIIROOT
- Action: The system searches the FWIIROOT database using the equipment ID
Logic Flow:
IF An equipment ID is provided for waybill lookup
AND The system searches the FWIIROOT database using the equipment ID
THEN:
- • The system retrieves waybill data if it exists or marks as not found for fallback processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when primary waybill lookup in fwiiroot has failed to find waybill data.
Trigger Criteria:
- Context: Primary waybill lookup in FWIIROOT has failed to find waybill data
- Applied to: Enhanced Waybill Search - SHIPROOT
- Action: The system performs enhanced search in SHIPROOT database using expanded search criteria
Logic Flow:
IF Primary waybill lookup in FWIIROOT has failed to find waybill data
AND The system performs enhanced search in SHIPROOT database using expanded search criteria
THEN:
- • The system retrieves waybill data if found or proceeds to inquiry database fallback
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when both primary fwiiroot lookup and enhanced shiproot search have failed.
Trigger Criteria:
- Context: Both primary FWIIROOT lookup and enhanced SHIPROOT search have failed
- Applied to: Inquiry Database Fallback - FW-IQ
- Action: The system performs fallback search in FW-IQ inquiry database
Logic Flow:
IF Both primary FWIIROOT lookup and enhanced SHIPROOT search have failed
AND The system performs fallback search in FW-IQ inquiry database
THEN:
- • The system retrieves waybill data if available or marks waybill as not found
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when any waybill lookup method (primary, enhanced, or inquiry) has successfully found waybill data.
Trigger Criteria:
- Context: Any waybill lookup method (primary, enhanced, or inquiry) has successfully found waybill data
- Applied to: Set Waybill Found Flag
- Action: The system processes the successful lookup result
Logic Flow:
IF Any waybill lookup method (primary, enhanced, or inquiry) has successfully found waybill data
AND The system processes the successful lookup result
THEN:
- • The system sets the waybill found flag to indicate successful retrieval
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when waybill data has been successfully found and waybill found flag is set.
Trigger Criteria:
- Context: Waybill data has been successfully found and waybill found flag is set
- Applied to: Extract Waybill Details
- Action: The system processes the retrieved waybill record
Logic Flow:
IF Waybill data has been successfully found and waybill found flag is set
AND The system processes the retrieved waybill record
THEN:
- • The system extracts all relevant waybill details for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when waybill details have been extracted from the retrieved record.
Trigger Criteria:
- Context: Waybill details have been extracted from the retrieved record
- Applied to: Validate Waybill Data Quality
- Action: The system validates the completeness and quality of the waybill data
Logic Flow:
IF Waybill details have been extracted from the retrieved record
AND The system validates the completeness and quality of the waybill data
THEN:
- • The system confirms data quality meets requirements for continued processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when all waybill lookup methods (primary, enhanced, and inquiry) have failed to find waybill data.
Trigger Criteria:
- Context: All waybill lookup methods (primary, enhanced, and inquiry) have failed to find waybill data
- Applied to: Set Waybill Not Found Flag
- Action: The system processes the failed lookup results
Logic Flow:
IF All waybill lookup methods (primary, enhanced, and inquiry) have failed to find waybill data
AND The system processes the failed lookup results
THEN:
- • The system sets the waybill not found flag to indicate no waybill data is available
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when waybill not found flag has been set after all lookup methods failed.
Trigger Criteria:
- Context: Waybill not found flag has been set after all lookup methods failed
- Applied to: Log Waybill Lookup Failure
- Action: The system processes the complete lookup failure
Logic Flow:
IF Waybill not found flag has been set after all lookup methods failed
AND The system processes the complete lookup failure
THEN:
- • The system logs the waybill lookup failure with relevant equipment and search details
R-GCX146-cbl-01699 (+12) File: GCX146.cbl Business Rule: Apply CCN Formatting Rules
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn formatting process needs to begin.
Trigger Criteria:
- Context: A CCN formatting process needs to begin
- Applied to: Initialize CCN Compression Variables
- Action: The system starts CCN formatting
Logic Flow:
IF A CCN formatting process needs to begin
AND The system starts CCN formatting
THEN:
- • All CCN compression variables are initialized to their default values
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn value exists in the input data.
Trigger Criteria:
- Context: A CCN value exists in the input data
- Applied to: Move CCN to Working Storage
- Action: The system begins CCN formatting
Logic Flow:
IF A CCN value exists in the input data
AND The system begins CCN formatting
THEN:
- • The CCN value is moved to working storage for manipulation
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn contains spaces within its structure.
Trigger Criteria:
- Context: A CCN contains spaces within its structure
- Applied to: Remove Spaces from CCN
- Action: The system processes the CCN for formatting
Logic Flow:
IF A CCN contains spaces within its structure
AND The system processes the CCN for formatting
THEN:
- • All spaces are removed from the CCN value
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn has been processed to remove spaces.
Trigger Criteria:
- Context: A CCN has been processed to remove spaces
- Applied to: Check for Numeric Sequences
- Action: The system examines the CCN structure
Logic Flow:
IF A CCN has been processed to remove spaces
AND The system examines the CCN structure
THEN:
- • Numeric sequences within the CCN are identified and flagged
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn has been analyzed for numeric sequences.
Trigger Criteria:
- Context: A CCN has been analyzed for numeric sequences
- Applied to: Contains Numeric Characters?
- Action: The system evaluates the CCN content
Logic Flow:
IF A CCN has been analyzed for numeric sequences
AND The system evaluates the CCN content
THEN:
- • The system determines whether numeric characters are present and routes processing accordingly
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn contains numeric characters.
Trigger Criteria:
- Context: The CCN contains numeric characters
- Applied to: Organize Numeric Sequences
- Action: The system processes the numeric sequences
Logic Flow:
IF The CCN contains numeric characters
AND The system processes the numeric sequences
THEN:
- • Numeric sequences are organized according to CCN formatting standards
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when numeric sequences have been organized within the ccn.
Trigger Criteria:
- Context: Numeric sequences have been organized within the CCN
- Applied to: Format Equipment ID Component
- Action: The system formats the equipment ID component
Logic Flow:
IF Numeric sequences have been organized within the CCN
AND The system formats the equipment ID component
THEN:
- • The equipment ID portion is formatted according to standard CCN structure requirements
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn components have been individually formatted.
Trigger Criteria:
- Context: CCN components have been individually formatted
- Applied to: Apply Standard CCN Structure
- Action: The system applies standard CCN structure
Logic Flow:
IF CCN components have been individually formatted
AND The system applies standard CCN structure
THEN:
- • The CCN is formatted according to standard structure requirements regardless of whether it contains numeric characters
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn has been formatted according to standard structure.
Trigger Criteria:
- Context: A CCN has been formatted according to standard structure
- Applied to: Validate Formatted CCN Length
- Action: The system validates the formatted CCN
Logic Flow:
IF A CCN has been formatted according to standard structure
AND The system validates the formatted CCN
THEN:
- • The CCN length is checked against acceptable length criteria
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when formatted ccn length has been validated.
Trigger Criteria:
- Context: The formatted CCN length has been validated
- Applied to: CCN Length Valid?
- Action: The system evaluates length compliance
Logic Flow:
IF The formatted CCN length has been validated
AND The system evaluates length compliance
THEN:
- • The system determines whether the CCN length is valid and routes processing to either storage or error handling
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn has passed length validation.
Trigger Criteria:
- Context: The CCN has passed length validation
- Applied to: Store Compressed CCN
- Action: The system stores the formatted CCN
Logic Flow:
IF The CCN has passed length validation
AND The system stores the formatted CCN
THEN:
- • The compressed CCN is stored for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn has been successfully stored in compressed format.
Trigger Criteria:
- Context: The CCN has been successfully stored in compressed format
- Applied to: Set Formatting Complete Flag
- Action: The system completes CCN formatting
Logic Flow:
IF The CCN has been successfully stored in compressed format
AND The system completes CCN formatting
THEN:
- • The formatting complete flag is set to indicate successful processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn fails length validation or other formatting requirements.
Trigger Criteria:
- Context: The CCN fails length validation or other formatting requirements
- Applied to: CCN Formatting Error
- Action: The system encounters a formatting error
Logic Flow:
IF The CCN fails length validation or other formatting requirements
AND The system encounters a formatting error
THEN:
- • An error condition is set and appropriate error handling is initiated
R-GCX146-cbl-01712 (+5) File: GCX146.cbl Business Rule: Set Equipment ID as Search Key
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when input message containing equipment information is received.
Trigger Criteria:
- Context: An input message containing equipment information is received
- Applied to: Extract Equipment ID from Input
- Action: The system processes the equipment data from the input message
Logic Flow:
IF An input message containing equipment information is received
AND The system processes the equipment data from the input message
THEN:
- • The equipment ID is extracted from the input message and made available for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment id has been extracted from the input message.
Trigger Criteria:
- Context: An equipment ID has been extracted from the input message
- Applied to: Format Equipment ID for Database Search
- Action: The system needs to prepare database search keys
Logic Flow:
IF An equipment ID has been extracted from the input message
AND The system needs to prepare database search keys
THEN:
- • The equipment ID is formatted and assigned to search key fields for FWIIROOT, SHIPROOT, and inquiry database lookups
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment id has been extracted and formatted.
Trigger Criteria:
- Context: An equipment ID has been extracted and formatted
- Applied to: Validate Equipment ID Format
- Action: The system validates the equipment ID format
Logic Flow:
IF An equipment ID has been extracted and formatted
AND The system validates the equipment ID format
THEN:
- • If the equipment ID format is valid, processing continues; if invalid, an error condition is set
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when valid equipment id is available for database search.
Trigger Criteria:
- Context: A valid equipment ID is available for database search
- Applied to: Set Search Key for FWIIROOT Lookup
- Action: The system prepares to search the FWIIROOT database
Logic Flow:
IF A valid equipment ID is available for database search
AND The system prepares to search the FWIIROOT database
THEN:
- • The equipment ID is set as the search key for the waybill root database lookup
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when valid equipment id is available for database search.
Trigger Criteria:
- Context: A valid equipment ID is available for database search
- Applied to: Set Search Key for SHIPROOT Lookup
- Action: The system prepares to search the SHIPROOT database
Logic Flow:
IF A valid equipment ID is available for database search
AND The system prepares to search the SHIPROOT database
THEN:
- • The equipment ID is set as the search key for the shipment root database lookup
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when valid equipment id is available for database search.
Trigger Criteria:
- Context: A valid equipment ID is available for database search
- Applied to: Set Search Key for Inquiry Database
- Action: The system prepares to search the inquiry database
Logic Flow:
IF A valid equipment ID is available for database search
AND The system prepares to search the inquiry database
THEN:
- • The equipment ID is set as the search key for the inquiry database lookup
R-GCX146-cbl-01718 (+10) File: GCX146.cbl Business Rule: Call FWCARGET Module
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment id is provided for waybill lookup. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: An equipment ID is provided for waybill lookup
- Applied to: Call FWCARGET Module
- Action: The FWCARGET module is called with the equipment ID parameter
Logic Flow:
IF An equipment ID is provided for waybill lookup
AND The FWCARGET module is called with the equipment ID parameter
THEN:
- • The system should retrieve enhanced waybill data from the SHIPROOT database and return comprehensive equipment and shipment details
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when waybill lookup request is initiated for specific equipment. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A waybill lookup request is initiated for specific equipment
- Applied to: Prepare Search Criteria
- Action: The system prepares search criteria for the FWCARGET module call
Logic Flow:
IF A waybill lookup request is initiated for specific equipment
AND The system prepares search criteria for the FWCARGET module call
THEN:
- • All required search parameters should be properly formatted and validated before the module call
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment id is available for waybill search.
Trigger Criteria:
- Context: An equipment ID is available for waybill search
- Applied to: Set Equipment ID Parameter
- Action: The system sets the equipment ID parameter for FWCARGET module
Logic Flow:
IF An equipment ID is available for waybill search
AND The system sets the equipment ID parameter for FWCARGET module
THEN:
- • The equipment ID should be properly formatted and assigned as the primary search key
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when primary equipment id parameter is set and additional search refinement is needed.
Trigger Criteria:
- Context: Primary equipment ID parameter is set and additional search refinement is needed
- Applied to: Set Additional Search Criteria
- Action: The system configures additional search criteria for FWCARGET module
Logic Flow:
IF Primary equipment ID parameter is set and additional search refinement is needed
AND The system configures additional search criteria for FWCARGET module
THEN:
- • All supplementary search parameters should be properly configured to optimize waybill retrieval results
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when fwcarget module has been called with proper search criteria. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: FWCARGET module has been called with proper search criteria
- Applied to: FWCARGET Successful?
- Action: The system evaluates the success status of the FWCARGET module call
Logic Flow:
IF FWCARGET module has been called with proper search criteria
AND The system evaluates the success status of the FWCARGET module call
THEN:
- • If the call is successful, the system should proceed to retrieve enhanced waybill data,
otherwise set waybill not found flag
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when fwcarget module call was successful and returned valid data. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: FWCARGET module call was successful and returned valid data
- Applied to: Retrieve Enhanced Waybill Data
- Action: The system retrieves enhanced waybill data from the module response
Logic Flow:
IF FWCARGET module call was successful and returned valid data
AND The system retrieves enhanced waybill data from the module response
THEN:
- • All available waybill information should be extracted and made available for equipment processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when enhanced waybill data has been successfully retrieved.
Trigger Criteria:
- Context: Enhanced waybill data has been successfully retrieved
- Applied to: Extract Equipment Details
- Action: The system extracts equipment details from the waybill data
Logic Flow:
IF Enhanced waybill data has been successfully retrieved
AND The system extracts equipment details from the waybill data
THEN:
- • All relevant equipment information should be parsed and structured for subsequent business rule processing
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment details have been successfully extracted from enhanced waybill data.
Trigger Criteria:
- Context: Equipment details have been successfully extracted from enhanced waybill data
- Applied to: Set Waybill Found Flag
- Action: The system sets the waybill found flag
Logic Flow:
IF Equipment details have been successfully extracted from enhanced waybill data
AND The system sets the waybill found flag
THEN:
- • The waybill found indicator should be set to true to indicate successful waybill retrieval
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when waybill found flag has been set and equipment details are available.
Trigger Criteria:
- Context: Waybill found flag has been set and equipment details are available
- Applied to: Return Enhanced Waybill Information
- Action: The system returns enhanced waybill information
Logic Flow:
IF Waybill found flag has been set and equipment details are available
AND The system returns enhanced waybill information
THEN:
- • All processed waybill and equipment data should be made available to the calling business process
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when fwcarget module call was unsuccessful or returned no valid data. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: FWCARGET module call was unsuccessful or returned no valid data
- Applied to: Set Waybill Not Found Flag
- Action: The system sets the waybill not found flag
Logic Flow:
IF FWCARGET module call was unsuccessful or returned no valid data
AND The system sets the waybill not found flag
THEN:
- • The waybill not found indicator should be set to indicate unsuccessful waybill retrieval
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when waybill not found flag has been set due to fwcarget failure.
Trigger Criteria:
- Context: Waybill not found flag has been set due to FWCARGET failure
- Applied to: Continue to Inquiry Database
- Action: The system continues to inquiry database lookup
Logic Flow:
IF Waybill not found flag has been set due to FWCARGET failure
AND The system continues to inquiry database lookup
THEN:
- • The process should proceed to alternative waybill lookup methods using inquiry database
R-GCX146-cbl-01729 (+9) File: GCX146.cbl Business Rule: Extract Container ID from Record
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill inquiry request is being processed.
Trigger Criteria:
- Context: A waybill inquiry request is being processed
- Applied to: Access Container Record
- Action: The system needs to access container records
Logic Flow:
IF A waybill inquiry request is being processed
AND The system needs to access container records
THEN:
- • The system retrieves container records from the FW-IQ inquiry database
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container record has been accessed from the database.
Trigger Criteria:
- Context: A container record has been accessed from the database
- Applied to: Record Type Check
- Action: The system checks the record type
Logic Flow:
IF A container record has been accessed from the database
AND The system checks the record type
THEN:
- • The system identifies if the record is a T/C XREF record type or another record type
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when t/c xref record has been identified.
Trigger Criteria:
- Context: A T/C XREF record has been identified
- Applied to: Extract from T/C XREF Record
- Action: The system processes the T/C XREF record
Logic Flow:
IF A T/C XREF record has been identified
AND The system processes the T/C XREF record
THEN:
- • The system extracts container ID information from the T/C XREF record
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container information has been extracted from a t/c xref record.
Trigger Criteria:
- Context: Container information has been extracted from a T/C XREF record
- Applied to: Parse Container ID Field
- Action: The system processes the container data
Logic Flow:
IF Container information has been extracted from a T/C XREF record
AND The system processes the container data
THEN:
- • The system parses the container ID field to extract the container identifier
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when container id has been parsed from the record.
Trigger Criteria:
- Context: A container ID has been parsed from the record
- Applied to: Container ID Valid?
- Action: The system validates the container ID
Logic Flow:
IF A container ID has been parsed from the record
AND The system validates the container ID
THEN:
- • The system determines if the container ID is valid based on format and content requirements
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid container id has been identified.
Trigger Criteria:
- Context: A valid container ID has been identified
- Applied to: Format Container ID
- Action: The system processes the valid container ID
Logic Flow:
IF A valid container ID has been identified
AND The system processes the valid container ID
THEN:
- • The system formats the container ID according to standard container identification format
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when container id has been formatted according to standards.
Trigger Criteria:
- Context: A container ID has been formatted according to standards
- Applied to: Store Container ID
- Action: The system completes container ID formatting
Logic Flow:
IF A container ID has been formatted according to standards
AND The system completes container ID formatting
THEN:
- • The system stores the formatted container ID for processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when container id has been successfully stored.
Trigger Criteria:
- Context: A container ID has been successfully stored
- Applied to: Set Container Found Flag
- Action: The container processing is completed successfully
Logic Flow:
IF A container ID has been successfully stored
AND The container processing is completed successfully
THEN:
- • The system sets the container found flag to indicate successful container identification
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container processing has been attempted.
Trigger Criteria:
- Context: Container processing has been attempted
- Applied to: Set Container Not Found Flag
- Action: The record is not a T/C XREF record type OR container ID is invalid
Logic Flow:
IF Container processing has been attempted
AND The record is not a T/C XREF record type OR container ID is invalid
THEN:
- • The system sets the container not found flag to indicate unsuccessful container identification
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when container id parsing has been attempted.
Trigger Criteria:
- Context: Container ID parsing has been attempted
- Applied to: Log Extraction Error
- Action: The container ID is determined to be invalid
Logic Flow:
IF Container ID parsing has been attempted
AND The container ID is determined to be invalid
THEN:
- • The system logs an extraction error for the invalid container ID
R-GCX146-cbl-01739 File: GCX146.cbl Business Rule: Validate Container ID Format
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when container processing operation is being performed.
Trigger Criteria:
- Context: A container processing operation is being performed
- Applied to: Container ID Format Validation Not Found
- Action: The system attempts to validate container ID format
Logic Flow:
IF A container processing operation is being performed
AND The system attempts to validate container ID format
THEN:
- • No specific container ID format validation is executed as this functionality is not implemented in the current system
R-GCX146-cbl-01740 (+8) File: GCX146.cbl Business Rule: Perform Container Waybill Lookup
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when container waybill lookup process is initiated.
Trigger Criteria:
- Context: A container waybill lookup process is initiated
- Applied to: Access FW-IQ Inquiry Database
- Action: The system needs to access container information
Logic Flow:
IF A container waybill lookup process is initiated
AND The system needs to access container information
THEN:
- • The FW-IQ inquiry database is accessed to retrieve container records
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when fw-iq inquiry database has been accessed for a specific container.
Trigger Criteria:
- Context: The FW-IQ inquiry database has been accessed for a specific container
- Applied to: Container Record Found?
- Action: The system searches for container records
Logic Flow:
IF The FW-IQ inquiry database has been accessed for a specific container
AND The system searches for container records
THEN:
- • The system determines if a valid container record exists and proceeds accordingly
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when container record has been found in the inquiry database.
Trigger Criteria:
- Context: A container record has been found in the inquiry database
- Applied to: Extract Container ID from T/C XREF
- Action: The system processes the container record
Logic Flow:
IF A container record has been found in the inquiry database
AND The system processes the container record
THEN:
- • The container ID is extracted from the T/C XREF data for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when container id has been extracted from the cross-reference records.
Trigger Criteria:
- Context: A container ID has been extracted from the cross-reference records
- Applied to: Retrieve Container Waybill Data
- Action: The system needs waybill information for the container
Logic Flow:
IF A container ID has been extracted from the cross-reference records
AND The system needs waybill information for the container
THEN:
- • The associated waybill data is retrieved from the inquiry database
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when waybill data has been retrieved for a container.
Trigger Criteria:
- Context: Waybill data has been retrieved for a container
- Applied to: Waybill Data Valid?
- Action: The system evaluates the waybill information
Logic Flow:
IF Waybill data has been retrieved for a container
AND The system evaluates the waybill information
THEN:
- • The system determines if the waybill data is valid and complete for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when valid waybill data has been confirmed for a container.
Trigger Criteria:
- Context: Valid waybill data has been confirmed for a container
- Applied to: Set Container Information
- Action: The system processes the validated information
Logic Flow:
IF Valid waybill data has been confirmed for a container
AND The system processes the validated information
THEN:
- • The container information is set and assigned to appropriate processing variables
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when container information has been successfully set with valid waybill data.
Trigger Criteria:
- Context: Container information has been successfully set with valid waybill data
- Applied to: Mark Waybill Found Flag
- Action: The system completes the container processing
Logic Flow:
IF Container information has been successfully set with valid waybill data
AND The system completes the container processing
THEN:
- • The waybill found flag is marked to indicate successful waybill retrieval
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when container has been processed in the waybill lookup.
Trigger Criteria:
- Context: A container has been processed in the waybill lookup
- Applied to: More Containers?
- Action: The system checks for additional containers to process
Logic Flow:
IF A container has been processed in the waybill lookup
AND The system checks for additional containers to process
THEN:
- • The system determines if more containers exist and continues processing or completes the operation
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when container record was not found or waybill data was invalid.
Trigger Criteria:
- Context: A container record was not found OR waybill data was invalid
- Applied to: Set Waybill Not Found Flag
- Action: The system cannot retrieve valid waybill information
Logic Flow:
IF A container record was not found OR waybill data was invalid
AND The system cannot retrieve valid waybill information
THEN:
- • The waybill not found flag is set to indicate unsuccessful waybill retrieval
R-GCX146-cbl-01749 (+5) File: GCX146.cbl Business Rule: Check Release Status Conditions
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment has current status of release.
Trigger Criteria:
- Context: Equipment has current status of RELEASE
- Applied to: Set Status to EXPORT
- Action: The transit status is either E (Export) or Z (Export Zone)
Logic Flow:
IF Equipment has current status of RELEASE
AND The transit status is either E (Export) or Z (Export Zone)
THEN:
- • The trip sheet status is set to EXPORT
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has current status of release and transit status is not e or z.
Trigger Criteria:
- Context: Equipment has current status of RELEASE and transit status is not E or Z
- Applied to: Set Status to S.A.R.
- Action: The equipment has S.A.R. (Special Administrative Release) designation
Logic Flow:
IF Equipment has current status of RELEASE and transit status is not E or Z
AND The equipment has S.A.R. (Special Administrative Release) designation
THEN:
- • The trip sheet status is set to S.A.R.
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment has current status of release and transit status is not e or z.
Trigger Criteria:
- Context: Equipment has current status of RELEASE and transit status is not E or Z
- Applied to: Set Status to RELEASE
- Action: The equipment does not have S.A.R. designation
Logic Flow:
IF Equipment has current status of RELEASE and transit status is not E or Z
AND The equipment does not have S.A.R. designation
THEN:
- • The trip sheet status is set to RELEASE
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment does not have current status of release.
Trigger Criteria:
- Context: Equipment does not have current status of RELEASE
- Applied to: Set Status to TRANSIT
- Action: The transit status is T (Transit)
Logic Flow:
IF Equipment does not have current status of RELEASE
AND The transit status is T (Transit)
THEN:
- • The trip sheet status is set to TRANSIT
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment does not have current status of release and transit status is not t.
Trigger Criteria:
- Context: Equipment does not have current status of RELEASE and transit status is not T
- Applied to: Set Status to RETURN
- Action: The transit status is R (Return)
Logic Flow:
IF Equipment does not have current status of RELEASE and transit status is not T
AND The transit status is R (Return)
THEN:
- • The trip sheet status is set to RETURN
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment does not have current status of release and transit status is not t or r.
Trigger Criteria:
- Context: Equipment does not have current status of RELEASE and transit status is not T or R
- Applied to: Keep Current Status
- Action: No special status conditions are met
Logic Flow:
IF Equipment does not have current status of RELEASE and transit status is not T or R
AND No special status conditions are met
THEN:
- • The trip sheet status remains as the current status
R-GCX146-cbl-01755 (+10) File: GCX146.cbl Business Rule: Analyze Cargo Origin/Destination
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when cargo equipment piece requires origin/destination analysis.
Trigger Criteria:
- Context: A cargo equipment piece requires origin/destination analysis
- Applied to: Retrieve Waybill Data
- Action: The system attempts to retrieve waybill data for the equipment
Logic Flow:
IF A cargo equipment piece requires origin/destination analysis
AND The system attempts to retrieve waybill data for the equipment
THEN:
- • The system should locate and extract the associated waybill information from the equipment records
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when waybill retrieval has been attempted for a cargo equipment piece.
Trigger Criteria:
- Context: Waybill retrieval has been attempted for a cargo equipment piece
- Applied to: Waybill Available?
- Action: The system checks if waybill data is available
Logic Flow:
IF Waybill retrieval has been attempted for a cargo equipment piece
AND The system checks if waybill data is available
THEN:
- • The system should determine if valid waybill information exists and route processing accordingly
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when valid waybill data is available for a cargo equipment piece.
Trigger Criteria:
- Context: Valid waybill data is available for a cargo equipment piece
- Applied to: Extract Origin Station Code
- Action: The system processes the waybill to extract origin information
Logic Flow:
IF Valid waybill data is available for a cargo equipment piece
AND The system processes the waybill to extract origin information
THEN:
- • The system should identify and extract the origin station code from the waybill data
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when valid waybill data is available and origin station code has been extracted.
Trigger Criteria:
- Context: Valid waybill data is available and origin station code has been extracted
- Applied to: Extract Destination Station Code
- Action: The system processes the waybill to extract destination information
Logic Flow:
IF Valid waybill data is available and origin station code has been extracted
AND The system processes the waybill to extract destination information
THEN:
- • The system should identify and extract the destination station code from the waybill data
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when origin station code has been extracted from waybill data.
Trigger Criteria:
- Context: An origin station code has been extracted from waybill data
- Applied to: Validate Origin Code Format
- Action: The system validates the origin code format
Logic Flow:
IF An origin station code has been extracted from waybill data
AND The system validates the origin code format
THEN:
- • The system should verify the origin code conforms to valid station code format requirements
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when destination station code has been extracted from waybill data.
Trigger Criteria:
- Context: A destination station code has been extracted from waybill data
- Applied to: Validate Destination Code Format
- Action: The system validates the destination code format
Logic Flow:
IF A destination station code has been extracted from waybill data
AND The system validates the destination code format
THEN:
- • The system should verify the destination code conforms to valid station code format requirements
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when origin and destination station codes have been extracted and format validated.
Trigger Criteria:
- Context: Origin and destination station codes have been extracted and format validated
- Applied to: Origin/Destination Valid?
- Action: The system evaluates the overall validity of origin and destination information
Logic Flow:
IF Origin and destination station codes have been extracted and format validated
AND The system evaluates the overall validity of origin and destination information
THEN:
- • The system should confirm both codes are valid and complete for cargo processing or route to default handling
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when valid origin and destination codes exist for cargo equipment.
Trigger Criteria:
- Context: Valid origin and destination codes exist for cargo equipment
- Applied to: Determine Load/Empty Status
- Action: The system analyzes the cargo to determine load status
Logic Flow:
IF Valid origin and destination codes exist for cargo equipment
AND The system analyzes the cargo to determine load status
THEN:
- • The system should classify the equipment as either loaded or empty based on waybill indicators and equipment characteristics
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when load/empty status has been determined for cargo equipment.
Trigger Criteria:
- Context: Load/empty status has been determined for cargo equipment
- Applied to: Set Equipment Status Flags
- Action: The system sets equipment status flags
Logic Flow:
IF Load/empty status has been determined for cargo equipment
AND The system sets equipment status flags
THEN:
- • The system should assign relevant status indicators that reflect the equipment's current operational state
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when equipment status flags have been set based on origin/destination analysis.
Trigger Criteria:
- Context: Equipment status flags have been set based on origin/destination analysis
- Applied to: Update Cargo Classification
- Action: The system updates cargo classification
Logic Flow:
IF Equipment status flags have been set based on origin/destination analysis
AND The system updates cargo classification
THEN:
- • The system should assign appropriate cargo classification categories based on the complete analysis results
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when either no waybill data is available or origin/destination codes are invalid.
Trigger Criteria:
- Context: Either no waybill data is available or origin/destination codes are invalid
- Applied to: Set Default Status
- Action: The system cannot complete normal cargo analysis
Logic Flow:
IF Either no waybill data is available or origin/destination codes are invalid
AND The system cannot complete normal cargo analysis
THEN:
- • The system should assign default status values to allow processing to continue
R-GCX146-cbl-01766 (+8) File: GCX146.cbl Business Rule: Validate Load Status Requirements
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when equipment record exists in the system with waybill data available.
Trigger Criteria:
- Context: An equipment record exists in the system with waybill data available
- Applied to: Retrieve Equipment Record
- Action: The system processes equipment for load status validation
Logic Flow:
IF An equipment record exists in the system with waybill data available
AND The system processes equipment for load status validation
THEN:
- • The equipment record is successfully retrieved for further validation
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when equipment record is being processed for load status validation.
Trigger Criteria:
- Context: An equipment record is being processed for load status validation
- Applied to: Check Waybill Data Available
- Action: The system checks for associated waybill data
Logic Flow:
IF An equipment record is being processed for load status validation
AND The system checks for associated waybill data
THEN:
- • The system determines whether waybill data is available or not available for the equipment
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when waybill data exists for the equipment.
Trigger Criteria:
- Context: Waybill data exists for the equipment
- Applied to: Extract Load/Empty Indicator from Waybill
- Action: The system processes the waybill record
Logic Flow:
IF Waybill data exists for the equipment
AND The system processes the waybill record
THEN:
- • The load or empty indicator is extracted from the waybill data for comparison
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when both input load status and waybill load status are available.
Trigger Criteria:
- Context: Both input load status and waybill load status are available
- Applied to: Compare Input Load Status vs Waybill Status
- Action: The system performs load status comparison
Logic Flow:
IF Both input load status and waybill load status are available
AND The system performs load status comparison
THEN:
- • The system determines if the input load status matches the waybill load status
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when input load status and waybill load status have been compared.
Trigger Criteria:
- Context: Input load status and waybill load status have been compared
- Applied to: Status Match?
- Action: The system evaluates the comparison result
Logic Flow:
IF Input load status and waybill load status have been compared
AND The system evaluates the comparison result
THEN:
- • The system determines if the statuses match or do not match and proceeds accordingly
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when either no waybill data exists or the input load status matches the waybill load status.
Trigger Criteria:
- Context: Either no waybill data exists or the input load status matches the waybill load status
- Applied to: Validate Load Requirements Met
- Action: The system processes load requirements validation
Logic Flow:
IF Either no waybill data exists or the input load status matches the waybill load status
AND The system processes load requirements validation
THEN:
- • The system validates that all load requirements are properly met
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when load requirements validation has been completed successfully.
Trigger Criteria:
- Context: Load requirements validation has been completed successfully
- Applied to: Set Load Status Flag
- Action: The system processes the validation result
Logic Flow:
IF Load requirements validation has been completed successfully
AND The system processes the validation result
THEN:
- • The appropriate load status flag is set to indicate successful validation
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when input load status does not match the waybill load status.
Trigger Criteria:
- Context: The input load status does not match the waybill load status
- Applied to: Generate Load Status Mismatch Error
- Action: The system detects the mismatch condition
Logic Flow:
IF The input load status does not match the waybill load status
AND The system detects the mismatch condition
THEN:
- • A load status mismatch error is generated to indicate the validation failure
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when load status mismatch error has been generated.
Trigger Criteria:
- Context: A load status mismatch error has been generated
- Applied to: Set Error Flag
- Action: The system processes the error condition
Logic Flow:
IF A load status mismatch error has been generated
AND The system processes the error condition
THEN:
- • An error flag is set to indicate that load status validation has failed
R-GCX146-cbl-01775 (+14) File: GCX146.cbl Business Rule: Prepare CCN Data for X12 Format
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn number exists in the system.
Trigger Criteria:
- Context: A CCN number exists in the system
- Applied to: Retrieve CCN Record from Database
- Action: The system needs to prepare CCN data for X12 transmission
Logic Flow:
IF A CCN number exists in the system
AND The system needs to prepare CCN data for X12 transmission
THEN:
- • The system retrieves the complete CCN record from the GCCCRT database
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn record has been retrieved from the database.
Trigger Criteria:
- Context: A CCN record has been retrieved from the database
- Applied to: Extract CCN Number
- Action: The system processes the CCN record
Logic Flow:
IF A CCN record has been retrieved from the database
AND The system processes the CCN record
THEN:
- • The system extracts the CCN number field from the record structure
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn number has been extracted from the database record.
Trigger Criteria:
- Context: A CCN number has been extracted from the database record
- Applied to: Format CCN for X12 Structure
- Action: The system prepares the CCN for X12 transmission
Logic Flow:
IF A CCN number has been extracted from the database record
AND The system prepares the CCN for X12 transmission
THEN:
- • The system formats the CCN data according to X12 EDI structure specifications
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn number is formatted for x12 structure.
Trigger Criteria:
- Context: A CCN number is formatted for X12 structure
- Applied to: Compress CCN Number
- Action: The system processes the CCN for compression
Logic Flow:
IF A CCN number is formatted for X12 structure
AND The system processes the CCN for compression
THEN:
- • The system compresses the CCN number by removing redundant characters and formatting
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn number contains spaces or padding characters.
Trigger Criteria:
- Context: A CCN number contains spaces or padding characters
- Applied to: Remove Spaces from CCN
- Action: The system compresses the CCN number
Logic Flow:
IF A CCN number contains spaces or padding characters
AND The system compresses the CCN number
THEN:
- • The system removes all spaces and padding characters from the CCN
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn contains numeric sequences that need organization.
Trigger Criteria:
- Context: A CCN contains numeric sequences that need organization
- Applied to: Organize Numeric Sequences
- Action: The system processes the compressed CCN
Logic Flow:
IF A CCN contains numeric sequences that need organization
AND The system processes the compressed CCN
THEN:
- • The system organizes numeric sequences according to X12 format requirements
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn has been processed and organized for x12 format.
Trigger Criteria:
- Context: A CCN has been processed and organized for X12 format
- Applied to: Validate CCN Format
- Action: The system validates the CCN format
Logic Flow:
IF A CCN has been processed and organized for X12 format
AND The system validates the CCN format
THEN:
- • The system checks that the CCN format complies with X12 EDI standards
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn format has been validated against x12 standards.
Trigger Criteria:
- Context: A CCN format has been validated against X12 standards
- Applied to: CCN Format Valid?
- Action: The system evaluates the validation results
Logic Flow:
IF A CCN format has been validated against X12 standards
AND The system evaluates the validation results
THEN:
- • The system determines if the CCN format is valid for transmission or if format errors exist
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when ccn format has been validated as correct for x12 transmission.
Trigger Criteria:
- Context: A CCN format has been validated as correct for X12 transmission
- Applied to: Set X12 CCN Field
- Action: The system processes the valid CCN
Logic Flow:
IF A CCN format has been validated as correct for X12 transmission
AND The system processes the valid CCN
THEN:
- • The system assigns the CCN to the appropriate X12 message field
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when equipment information is available in the system.
Trigger Criteria:
- Context: Equipment information is available in the system
- Applied to: Prepare Equipment ID for X12
- Action: The system prepares X12 message data
Logic Flow:
IF Equipment information is available in the system
AND The system prepares X12 message data
THEN:
- • The system formats equipment ID according to X12 requirements
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when waybill data is available for the ccn.
Trigger Criteria:
- Context: Waybill data is available for the CCN
- Applied to: Format Waybill Information
- Action: The system prepares X12 message components
Logic Flow:
IF Waybill data is available for the CCN
AND The system prepares X12 message components
THEN:
- • The system formats waybill information according to X12 EDI standards
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when cargo status information is available in the ccn record.
Trigger Criteria:
- Context: Cargo status information is available in the CCN record
- Applied to: Set Cargo Status Code
- Action: The system prepares X12 message data
Logic Flow:
IF Cargo status information is available in the CCN record
AND The system prepares X12 message data
THEN:
- • The system assigns the appropriate cargo status code for X12 transmission
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when shipper and consignee information exists in the system.
Trigger Criteria:
- Context: Shipper and consignee information exists in the system
- Applied to: Prepare Shipper/Consignee Data
- Action: The system builds X12 message components
Logic Flow:
IF Shipper and consignee information exists in the system
AND The system builds X12 message components
THEN:
- • The system formats shipper and consignee data according to X12 requirements
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when all x12 message components have been prepared and validated.
Trigger Criteria:
- Context: All X12 message components have been prepared and validated
- Applied to: Build X12 Message Structure
- Action: The system builds the complete X12 message
Logic Flow:
IF All X12 message components have been prepared and validated
AND The system builds the complete X12 message
THEN:
- • The system assembles all components into proper X12 EDI message structure
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn format validation has failed.
Trigger Criteria:
- Context: A CCN format validation has failed
- Applied to: Log Format Error
- Action: The system encounters invalid CCN format
Logic Flow:
IF A CCN format validation has failed
AND The system encounters invalid CCN format
THEN:
- • The system logs the format error for troubleshooting and audit purposes
R-GCX146-cbl-01790 (+12) File: GCX146.cbl Business Rule: Prepare GCX019 Input Parameters
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when broker notification needs to be sent.
Trigger Criteria:
- Context: A broker notification needs to be sent
- Applied to: Initialize GCX019 Input Structure
- Action: The system prepares GCX019 input parameters
Logic Flow:
IF A broker notification needs to be sent
AND The system prepares GCX019 input parameters
THEN:
- • The GCX019 input structure is initialized with spaces and default values
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when broker notification is configured for merlin delivery.
Trigger Criteria:
- Context: A broker notification is configured for Merlin delivery
- Applied to: Set Merlin Parameters
- Action: The communication method is Merlin
Logic Flow:
IF A broker notification is configured for Merlin delivery
AND The communication method is Merlin
THEN:
- • The system sets Merlin ID and communication type to 'M' in GCX019 parameters
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when broker notification is configured for internet delivery.
Trigger Criteria:
- Context: A broker notification is configured for Internet delivery
- Applied to: Set Internet Parameters
- Action: The communication method is Internet
Logic Flow:
IF A broker notification is configured for Internet delivery
AND The communication method is Internet
THEN:
- • The system sets Internet address and communication type to 'I' in GCX019 parameters
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when broker notification is configured for fax delivery.
Trigger Criteria:
- Context: A broker notification is configured for FAX delivery
- Applied to: Set FAX Parameters
- Action: The communication method is FAX
Logic Flow:
IF A broker notification is configured for FAX delivery
AND The communication method is FAX
THEN:
- • The system sets FAX number and communication type to 'F' in GCX019 parameters
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when broker notification is configured for paper delivery.
Trigger Criteria:
- Context: A broker notification is configured for Paper delivery
- Applied to: Set Paper Parameters
- Action: The communication method is Paper
Logic Flow:
IF A broker notification is configured for Paper delivery
AND The communication method is Paper
THEN:
- • The system sets mailing address and communication type to 'P' in GCX019 parameters
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when broker notification is being prepared with valid ccn data.
Trigger Criteria:
- Context: A broker notification is being prepared with valid CCN data
- Applied to: Populate CCN Information
- Action: CCN information is available
Logic Flow:
IF A broker notification is being prepared with valid CCN data
AND CCN information is available
THEN:
- • The system populates CCN number, status, and related customs information in GCX019 parameters
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when equipment information is available for the ccn.
Trigger Criteria:
- Context: Equipment information is available for the CCN
- Applied to: Set Equipment Details
- Action: Equipment details are being added to the notification
Logic Flow:
IF Equipment information is available for the CCN
AND Equipment details are being added to the notification
THEN:
- • The system populates equipment ID, type, and status in GCX019 parameters
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when waybill information exists for the equipment.
Trigger Criteria:
- Context: Waybill information exists for the equipment
- Applied to: Add Waybill Information
- Action: Waybill details are being added to the notification
Logic Flow:
IF Waybill information exists for the equipment
AND Waybill details are being added to the notification
THEN:
- • The system populates shipper, consignee, and commodity information in GCX019 parameters
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when station information is available from the manifest or waybill.
Trigger Criteria:
- Context: Station information is available from the manifest or waybill
- Applied to: Set Station Codes
- Action: Station codes are being set in the notification
Logic Flow:
IF Station information is available from the manifest or waybill
AND Station codes are being set in the notification
THEN:
- • The system populates origin station, destination station, and border crossing codes in GCX019 parameters
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when date and time information is available for the shipment.
Trigger Criteria:
- Context: Date and time information is available for the shipment
- Applied to: Add Date/Time Information
- Action: Temporal data is being added to the notification
Logic Flow:
IF Date and time information is available for the shipment
AND Temporal data is being added to the notification
THEN:
- • The system populates estimated arrival date, processing date, and current timestamp in GCX019 parameters
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when broker notification is being prepared.
Trigger Criteria:
- Context: A broker notification is being prepared
- Applied to: Set Message Priority
- Action: Message priority needs to be determined
Logic Flow:
IF A broker notification is being prepared
AND Message priority needs to be determined
THEN:
- • The system sets priority level based on cargo characteristics and delivery requirements in GCX019 parameters
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when gcx019 parameters have been populated.
Trigger Criteria:
- Context: GCX019 parameters have been populated
- Applied to: Validate Required Fields
- Action: The system validates required fields
Logic Flow:
IF GCX019 parameters have been populated
AND The system validates required fields
THEN:
- • All mandatory fields including communication method, CCN, equipment ID, and contact information must be present and valid
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when gcx019 parameters are being validated.
Trigger Criteria:
- Context: GCX019 parameters are being validated
- Applied to: Parameter Error
- Action: Required fields are missing or contain invalid data
Logic Flow:
IF GCX019 parameters are being validated
AND Required fields are missing or contain invalid data
THEN:
- • The system reports parameter error and does not proceed with broker notification
R-GCX146-cbl-01803 (+11) File: GCX146.cbl Business Rule: Prepare FAX Message Content
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when station has fax configuration settings in the system.
Trigger Criteria:
- Context: A station has FAX configuration settings in the system
- Applied to: Check Auto-FAX Configuration
- Action: The system checks the auto-FAX configuration status
Logic Flow:
IF A station has FAX configuration settings in the system
AND The system checks the auto-FAX configuration status
THEN:
- • The system should verify if auto-FAX is enabled based on station settings and user permissions
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when auto-fax configuration has been checked and fax flag status is available.
Trigger Criteria:
- Context: Auto-FAX configuration has been checked and FAX flag status is available
- Applied to: Auto-FAX Enabled?
- Action: The system evaluates if auto-FAX is enabled
Logic Flow:
IF Auto-FAX configuration has been checked and FAX flag status is available
AND The system evaluates if auto-FAX is enabled
THEN:
- • If auto-FAX is enabled, proceed with FAX routing setup,
otherwise skip FAX preparation
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when auto-fax is enabled for the current operation.
Trigger Criteria:
- Context: Auto-FAX is enabled for the current operation
- Applied to: Set FAX Routing Parameters
- Action: The system sets up FAX routing parameters
Logic Flow:
IF Auto-FAX is enabled for the current operation
AND The system sets up FAX routing parameters
THEN:
- • The system should configure destination routing, delivery options, and transmission parameters for the FAX
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when fax routing parameters have been established. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: FAX routing parameters have been established
- Applied to: Configure Copy IDs for FAX
- Action: The system configures copy IDs for the FAX transmission
Logic Flow:
IF FAX routing parameters have been established
AND The system configures copy IDs for the FAX transmission
THEN:
- • The system should assign unique copy identifiers for tracking and distribution management
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when copy ids have been configured for the fax. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Copy IDs have been configured for the FAX
- Applied to: Set External FAX Addressing
- Action: The system sets up external FAX addressing
Logic Flow:
IF Copy IDs have been configured for the FAX
AND The system sets up external FAX addressing
THEN:
- • The system should configure external FAX numbers, recipient information, and delivery addressing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when external fax addressing has been configured.
Trigger Criteria:
- Context: External FAX addressing has been configured
- Applied to: Prepare FAX Header Information
- Action: The system prepares FAX header information
Logic Flow:
IF External FAX addressing has been configured
AND The system prepares FAX header information
THEN:
- • The system should format sender information, recipient details, transmission date/time, and document identification in the FAX header
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when fax header information has been prepared.
Trigger Criteria:
- Context: FAX header information has been prepared
- Applied to: Format Message Content for FAX
- Action: The system formats message content for FAX transmission
Logic Flow:
IF FAX header information has been prepared
AND The system formats message content for FAX transmission
THEN:
- • The system should format the message content to meet FAX layout requirements, character limitations, and transmission standards
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when message content has been formatted for fax.
Trigger Criteria:
- Context: Message content has been formatted for FAX
- Applied to: Set FAX Transmission Flags
- Action: The system sets FAX transmission flags
Logic Flow:
IF Message content has been formatted for FAX
AND The system sets FAX transmission flags
THEN:
- • The system should configure transmission priority, delivery confirmation requirements, and retry options
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when fax transmission flags have been set.
Trigger Criteria:
- Context: FAX transmission flags have been set
- Applied to: Validate FAX Configuration
- Action: The system validates the FAX configuration
Logic Flow:
IF FAX transmission flags have been set
AND The system validates the FAX configuration
THEN:
- • The system should verify that all required FAX parameters are present, valid, and compatible for successful transmission
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when fax configuration validation has been performed.
Trigger Criteria:
- Context: FAX configuration validation has been performed
- Applied to: FAX Config Valid?
- Action: The system evaluates FAX configuration validity
Logic Flow:
IF FAX configuration validation has been performed
AND The system evaluates FAX configuration validity
THEN:
- • If configuration is valid, mark FAX message as ready; if invalid, prepare alternative routing options
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when fax configuration is determined to be invalid.
Trigger Criteria:
- Context: FAX configuration is determined to be invalid
- Applied to: Prepare Alternative Routing
- Action: The system prepares alternative routing
Logic Flow:
IF FAX configuration is determined to be invalid
AND The system prepares alternative routing
THEN:
- • The system should configure alternative delivery methods such as email, print queue, or manual processing
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when auto-fax is determined to be disabled.
Trigger Criteria:
- Context: Auto-FAX is determined to be disabled
- Applied to: Skip FAX Preparation
- Action: The system processes the skip FAX preparation path
Logic Flow:
IF Auto-FAX is determined to be disabled
AND The system processes the skip FAX preparation path
THEN:
- • The system should bypass all FAX configuration steps and proceed to message completion
R-GCX146-cbl-01815 (+7) File: GCX146.cbl Business Rule: Check Email User ID Format
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when station code exists in the system.
Trigger Criteria:
- Context: A station code exists in the system
- Applied to: Retrieve Email User ID from Station Configuration
- Action: The system needs to retrieve email user configuration for that station
Logic Flow:
IF A station code exists in the system
AND The system needs to retrieve email user configuration for that station
THEN:
- • The system should access the station configuration table and extract the email user ID associated with the station
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when station configuration data has been retrieved.
Trigger Criteria:
- Context: Station configuration data has been retrieved
- Applied to: Email User ID Present?
- Action: The system checks for email user ID configuration
Logic Flow:
IF Station configuration data has been retrieved
AND The system checks for email user ID configuration
THEN:
- • The system should determine if an email user ID is present and not empty in the configuration
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when email user id is present in the station configuration.
Trigger Criteria:
- Context: An email user ID is present in the station configuration
- Applied to: Validate Email Format Structure
- Action: The system validates the email format structure
Logic Flow:
IF An email user ID is present in the station configuration
AND The system validates the email format structure
THEN:
- • The system should verify the email follows standard email format conventions including proper domain and address structure
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when email format structure validation has been performed.
Trigger Criteria:
- Context: Email format structure validation has been performed
- Applied to: Valid Email Format?
- Action: The system evaluates the validation results
Logic Flow:
IF Email format structure validation has been performed
AND The system evaluates the validation results
THEN:
- • The system should determine if the email format is valid based on standard email formatting rules
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when email user id has passed format validation.
Trigger Criteria:
- Context: The email user ID has passed format validation
- Applied to: Set Email User ID as Valid
- Action: The system processes the validation success
Logic Flow:
IF The email user ID has passed format validation
AND The system processes the validation success
THEN:
- • The system should set the email user ID status as valid and enable email operations for the station
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when email user id is either not present or has failed format validation.
Trigger Criteria:
- Context: The email user ID is either not present or has failed format validation
- Applied to: Set Email User ID as Invalid
- Action: The system processes the validation failure
Logic Flow:
IF The email user ID is either not present or has failed format validation
AND The system processes the validation failure
THEN:
- • The system should set the email user ID status as invalid and prevent email operations for the station
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when email validation process has been completed with either valid or invalid result.
Trigger Criteria:
- Context: Email validation process has been completed with either valid or invalid result
- Applied to: Log Format Validation Result
- Action: The system logs the validation outcome
Logic Flow:
IF Email validation process has been completed with either valid or invalid result
AND The system logs the validation outcome
THEN:
- • The system should record the validation result including station code and email status for audit trail
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when email validation and logging have been completed.
Trigger Criteria:
- Context: Email validation and logging have been completed
- Applied to: Return Validation Status
- Action: The system returns the validation status
Logic Flow:
IF Email validation and logging have been completed
AND The system returns the validation status
THEN:
- • The system should provide the final validation result indicating whether email operations can proceed for the station
R-GCX146-cbl-01823 (+7) File: GCX146.cbl Business Rule: Check Auto
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when station configuration record exists in gcstbrt.
Trigger Criteria:
- Context: A station configuration record exists in GCSTBRT
- Applied to: Check GCSTBRT-AD-AUTO-FAX Setting
- Action: The system checks the Auto-FAX setting in the station configuration
Logic Flow:
IF A station configuration record exists in GCSTBRT
AND The system checks the Auto-FAX setting in the station configuration
THEN:
- • The system reads the GCSTBRT-AD-AUTO-FAX field value to determine if Auto-FAX is enabled
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when auto-fax setting has been retrieved from station configuration.
Trigger Criteria:
- Context: The Auto-FAX setting has been retrieved from station configuration
- Applied to: Auto-FAX = 'Y'?
- Action: The Auto-FAX setting equals 'Y'
Logic Flow:
IF The Auto-FAX setting has been retrieved from station configuration
AND The Auto-FAX setting equals 'Y'
THEN:
- • The system proceeds to check the FAX flag configuration,
otherwise it disables Auto-FAX and uses standard routing
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when auto-fax is enabled with setting 'y'.
Trigger Criteria:
- Context: Auto-FAX is enabled with setting 'Y'
- Applied to: Check GCSTBRT-SC-FAX-FLAG
- Action: The system checks the FAX flag configuration
Logic Flow:
IF Auto-FAX is enabled with setting 'Y'
AND The system checks the FAX flag configuration
THEN:
- • The system reads the GCSTBRT-SC-FAX-FLAG field value
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when auto-fax is enabled and fax flag has been retrieved.
Trigger Criteria:
- Context: Auto-FAX is enabled and FAX flag has been retrieved
- Applied to: FAX Flag = 'Y'?
- Action: The FAX flag equals 'Y'
Logic Flow:
IF Auto-FAX is enabled and FAX flag has been retrieved
AND The FAX flag equals 'Y'
THEN:
- • The system enables Auto-FAX functionality and proceeds with FAX routing configuration,
otherwise it disables Auto-FAX
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when both auto-fax setting and fax flag are set to 'y'.
Trigger Criteria:
- Context: Both Auto-FAX setting and FAX flag are set to 'Y'
- Applied to: Set Auto-FAX Enabled
- Action: The system processes the configuration
Logic Flow:
IF Both Auto-FAX setting and FAX flag are set to 'Y'
AND The system processes the configuration
THEN:
- • The system sets Auto-FAX as enabled and prepares for FAX routing configuration
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when auto-fax functionality is enabled. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Auto-FAX functionality is enabled
- Applied to: Configure FAX Routing with Copy IDs
- Action: The system configures FAX routing
Logic Flow:
IF Auto-FAX functionality is enabled
AND The system configures FAX routing
THEN:
- • The system sets up FAX routing parameters with appropriate copy IDs for message distribution
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when fax routing has been configured with copy ids. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: FAX routing has been configured with copy IDs
- Applied to: Set External FAX Addressing
- Action: The system sets up external addressing
Logic Flow:
IF FAX routing has been configured with copy IDs
AND The system sets up external addressing
THEN:
- • The system configures external FAX addressing parameters for proper message delivery
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when either auto-fax setting is not 'y' or fax flag is not 'y'.
Trigger Criteria:
- Context: Either Auto-FAX setting is not 'Y' or FAX flag is not 'Y'
- Applied to: Auto-FAX Disabled - Use Standard Routing
- Action: Auto-FAX cannot be enabled
Logic Flow:
IF Either Auto-FAX setting is not 'Y' or FAX flag is not 'Y'
AND Auto-FAX cannot be enabled
THEN:
- • The system disables Auto-FAX functionality and uses standard routing procedures
R-GCX146-cbl-01831 (+10) File: GCX146.cbl Business Rule: Apply Line Segmentation Rules
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when email report needs to be sent with multiple lines of content.
Trigger Criteria:
- Context: An email report needs to be sent with multiple lines of content
- Applied to: Apply Line Segmentation Rules
- Action: The system processes the email content for transmission
Logic Flow:
IF An email report needs to be sent with multiple lines of content
AND The system processes the email content for transmission
THEN:
- • The content is segmented into batches of maximum 699 lines each with proper continuation headers for subsequent segments
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when email segmentation processing is starting. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: Email segmentation processing is starting
- Applied to: Initialize Line Counter WS-LINE-SUB = 1
- Action: The system begins processing email content
Logic Flow:
IF Email segmentation processing is starting
AND The system begins processing email content
THEN:
- • The line counter is set to 1 to begin tracking from the first line
Rule Belongs to : GCX146.cbl
Business Justification: Defines the strict business conditions required to proceed when email content is being processed line by line.
Trigger Criteria:
- Context: Email content is being processed line by line
- Applied to: Line Counter > 699?
- Action: The line counter exceeds 699 lines in the current segment
Logic Flow:
IF Email content is being processed line by line
AND The line counter exceeds 699 lines in the current segment
THEN:
- • The current segment must be sent and a new segment must be started
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when email segment has reached the maximum line limit of 699 lines. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: An email segment has reached the maximum line limit of 699 lines
- Applied to: Call X280-CALL-EMCSEND3 to Send Current Batch
- Action: The segment transmission is triggered
Logic Flow:
IF An email segment has reached the maximum line limit of 699 lines
AND The segment transmission is triggered
THEN:
- • The EMCSEND3 service is invoked to send the current email batch
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when completed email segment has been sent.
Trigger Criteria:
- Context: A completed email segment has been sent
- Applied to: Reset Message Buffer
- Action: The system prepares for the next segment
Logic Flow:
IF A completed email segment has been sent
AND The system prepares for the next segment
THEN:
- • The message buffer is reset to empty state for new content
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when new email segment is being prepared after the first segment.
Trigger Criteria:
- Context: A new email segment is being prepared after the first segment
- Applied to: Add CONTINUATION OF REPORT Header
- Action: The message buffer is reset for continuation
Logic Flow:
IF A new email segment is being prepared after the first segment
AND The message buffer is reset for continuation
THEN:
- • A 'CONTINUATION OF REPORT' header is added to indicate this is a follow-up segment
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when continuation segment is being prepared with header added.
Trigger Criteria:
- Context: A continuation segment is being prepared with header added
- Applied to: Reset Line Counter for Next Batch
- Action: The system starts processing the next batch of lines
Logic Flow:
IF A continuation segment is being prepared with header added
AND The system starts processing the next batch of lines
THEN:
- • The line counter is reset to account for the continuation header and begin fresh counting
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when email content is being processed in segments.
Trigger Criteria:
- Context: Email content is being processed in segments
- Applied to: More Lines to Process?
- Action: The system completes processing a portion of content
Logic Flow:
IF Email content is being processed in segments
AND The system completes processing a portion of content
THEN:
- • The system checks if more lines remain to be processed for continuation or completion
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when email content lines are being processed sequentially.
Trigger Criteria:
- Context: Email content lines are being processed sequentially
- Applied to: Increment Line Counter
- Action: A line is processed and more lines remain
Logic Flow:
IF Email content lines are being processed sequentially
AND A line is processed and more lines remain
THEN:
- • The line counter is incremented by 1 to track progress within current segment
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when all email content has been processed and no more lines remain.
Trigger Criteria:
- Context: All email content has been processed and no more lines remain
- Applied to: Send Final Batch
- Action: The final segment is ready for transmission
Logic Flow:
IF All email content has been processed and no more lines remain
AND The final segment is ready for transmission
THEN:
- • The final email batch is sent containing the remaining content
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all email segments have been processed and sent.
Trigger Criteria:
- Context: All email segments have been processed and sent
- Applied to: Set NO-MORE-EMAIL Flag
- Action: The final segment transmission is complete
Logic Flow:
IF All email segments have been processed and sent
AND The final segment transmission is complete
THEN:
- • The NO-MORE-EMAIL flag is set to indicate processing completion
R-GCX146-cbl-01859 (+3) File: GCX146.cbl Business Rule: Remove Spaces from CCN
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn contains space characters within the number.
Trigger Criteria:
- Context: A CCN contains space characters within the number
- Applied to: Skip Space Character
- Action: The system processes the CCN for compression
Logic Flow:
IF A CCN contains space characters within the number
AND The system processes the CCN for compression
THEN:
- • All space characters are identified and excluded from the compressed CCN output
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn contains both space and non-space characters. ⚠️ COBOL Technical Logic
Trigger Criteria:
- Context: A CCN contains both space and non-space characters
- Applied to: Copy Character to Compressed CCN
- Action: The system encounters a non-space character during compression
Logic Flow:
IF A CCN contains both space and non-space characters
AND The system encounters a non-space character during compression
THEN:
- • The character is copied to the compressed CCN maintaining the original sequence
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn requires space removal processing.
Trigger Criteria:
- Context: A CCN requires space removal processing
- Applied to: Scan CCN Character by Character
- Action: The system begins compression
Logic Flow:
IF A CCN requires space removal processing
AND The system begins compression
THEN:
- • Each character position in the CCN is examined individually from start to end
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when all characters in the ccn have been processed and spaces removed.
Trigger Criteria:
- Context: All characters in the CCN have been processed and spaces removed
- Applied to: Format Compressed CCN
- Action: The compression process reaches completion
Logic Flow:
IF All characters in the CCN have been processed and spaces removed
AND The compression process reaches completion
THEN:
- • The compressed CCN is formatted and prepared for return to the calling process
R-GCX146-cbl-01863 (+9) File: GCX146.cbl Business Rule: Organize Numeric Sequences
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn input data is provided to the system.
Trigger Criteria:
- Context: A CCN input data is provided to the system
- Applied to: Receive CCN Input Data
- Action: The organize numeric sequences process is initiated
Logic Flow:
IF A CCN input data is provided to the system
AND The organize numeric sequences process is initiated
THEN:
- • The system accepts the CCN input data for further processing
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when ccn contains spaces within the string.
Trigger Criteria:
- Context: A CCN contains spaces within the string
- Applied to: Remove Spaces from CCN
- Action: The space removal process is executed
Logic Flow:
IF A CCN contains spaces within the string
AND The space removal process is executed
THEN:
- • All spaces are removed from the CCN string to create a continuous character sequence
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when ccn processing is about to begin.
Trigger Criteria:
- Context: The CCN processing is about to begin
- Applied to: Initialize Sequence Counter
- Action: The sequence counter initialization is performed
Logic Flow:
IF The CCN processing is about to begin
AND The sequence counter initialization is performed
THEN:
- • The sequence counter is set to its starting value for character position tracking
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when ccn string is ready for character-by-character analysis.
Trigger Criteria:
- Context: A CCN string is ready for character-by-character analysis
- Applied to: Scan CCN Characters
- Action: The character scanning process is executed
Logic Flow:
IF A CCN string is ready for character-by-character analysis
AND The character scanning process is executed
THEN:
- • Each character in the CCN string is examined in sequence
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when character from the ccn string is being examined.
Trigger Criteria:
- Context: A character from the CCN string is being examined
- Applied to: Character is Numeric?
- Action: The character type validation is performed
Logic Flow:
IF A character from the CCN string is being examined
AND The character type validation is performed
THEN:
- • The system identifies whether the character is numeric (0-9) or non-numeric
Rule Belongs to : GCX146.cbl
Business Justification: Governs the functional prerequisites and system routing when character has been identified as numeric.
Trigger Criteria:
- Context: A character has been identified as numeric
- Applied to: Add to Numeric Sequence
- Action: The numeric sequence building process is executed
Logic Flow:
IF A character has been identified as numeric
AND The numeric sequence building process is executed
THEN:
- • The numeric character is added to the current numeric sequence being organized
Rule Belongs to : GCX146.cbl
Business Justification: Dictates the expected operational logic and validation steps when character has been identified as non-numeric.
Trigger Criteria:
- Context: A character has been identified as non-numeric
- Applied to: Process Non-Numeric Character
- Action: The non-numeric character processing is executed
Logic Flow:
IF A character has been identified as non-numeric
AND The non-numeric character processing is executed
THEN:
- • The non-numeric character is handled according to the CCN organization rules
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when characters are being processed from the ccn string.
Trigger Criteria:
- Context: Characters are being processed from the CCN string
- Applied to: End of CCN String?
- Action: The string completion check is performed
Logic Flow:
IF Characters are being processed from the CCN string
AND The string completion check is performed
THEN:
- • The system determines if there are more characters to process or if the end of the string has been reached
Rule Belongs to : GCX146.cbl
Business Justification: Ensures correct system behavior and process compliance when all characters in the ccn have been processed and organized.
Trigger Criteria:
- Context: All characters in the CCN have been processed and organized
- Applied to: Format Organized Sequence
- Action: The sequence formatting process is executed
Logic Flow:
IF All characters in the CCN have been processed and organized
AND The sequence formatting process is executed
THEN:
- • The organized sequence is formatted according to the specified business format requirements
Rule Belongs to : GCX146.cbl
Business Justification: Establishes the required business protocol to be followed when ccn has been organized and formatted.
Trigger Criteria:
- Context: The CCN has been organized and formatted
- Applied to: Store Compressed CCN
- Action: The storage process is executed
Logic Flow:
IF The CCN has been organized and formatted
AND The storage process is executed
THEN:
- • The compressed CCN is stored in the designated location for further business processing